mirror of
https://github.com/microsoft/fabric-rest-api-specs.git
synced 2026-11-04 12:04:23 +00:00
2549 lines
99 KiB
JSON
2549 lines
99 KiB
JSON
{
|
|
"swagger": "2.0",
|
|
"info": {
|
|
"version": "v1",
|
|
"title": "Eventstream source data types"
|
|
},
|
|
"paths": {},
|
|
"definitions": {
|
|
"SourceType": {
|
|
"type": "string",
|
|
"description": "Represents the type of the source. Additional source types may be added over time.",
|
|
"enum": [
|
|
"AmazonKinesis",
|
|
"AmazonMSKKafka",
|
|
"ApacheKafka",
|
|
"AzureBlobStorageEvents",
|
|
"AzureCosmosDBCDC",
|
|
"AzureDataExplorer",
|
|
"AzureEventGridNamespace",
|
|
"AzureEventHub",
|
|
"AzureEventHubExtended",
|
|
"AzureIoTHub",
|
|
"AzureSQLDBCDC",
|
|
"AzureSQLMIDBCDC",
|
|
"AzureServiceBus",
|
|
"ConfluentCloud",
|
|
"CustomEndpoint",
|
|
"FabricAnomalyDetectionEvents",
|
|
"FabricCapacityOverviewEvents",
|
|
"FabricJobEvents",
|
|
"FabricOneLakeEvents",
|
|
"FabricWorkspaceItemEvents",
|
|
"GooglePubSub",
|
|
"Http",
|
|
"MongoDBCDC",
|
|
"Mqtt",
|
|
"MySQLCDC",
|
|
"PostgreSQLCDC",
|
|
"RealTimeWeather",
|
|
"SQLServerOnVMDBCDC",
|
|
"SampleData",
|
|
"SolacePubSub"
|
|
],
|
|
"x-ms-enum": {
|
|
"name": "SourceType",
|
|
"modelAsString": true,
|
|
"values": [
|
|
{
|
|
"value": "AmazonKinesis",
|
|
"description": "The Amazon Kinesis source type."
|
|
},
|
|
{
|
|
"value": "AmazonMSKKafka",
|
|
"description": "The Amazon MSK Kafka source type."
|
|
},
|
|
{
|
|
"value": "ApacheKafka",
|
|
"description": "The Apache Kafka source type."
|
|
},
|
|
{
|
|
"value": "AzureBlobStorageEvents",
|
|
"description": "The Azure Blob Storage Events source type."
|
|
},
|
|
{
|
|
"value": "AzureCosmosDBCDC",
|
|
"description": "The Azure Cosmos DB CDC source type."
|
|
},
|
|
{
|
|
"value": "AzureDataExplorer",
|
|
"description": "The Azure Data Explorer source type."
|
|
},
|
|
{
|
|
"value": "AzureEventGridNamespace",
|
|
"description": "The Azure Event Grid Namespace source type."
|
|
},
|
|
{
|
|
"value": "AzureEventHub",
|
|
"description": "The Azure Event Hub source type."
|
|
},
|
|
{
|
|
"value": "AzureEventHubExtended",
|
|
"description": "The Azure Event Hub Extended source type."
|
|
},
|
|
{
|
|
"value": "AzureIoTHub",
|
|
"description": "The Azure IoT Hub source type."
|
|
},
|
|
{
|
|
"value": "AzureSQLDBCDC",
|
|
"description": "The Azure SQL DB CDC source type."
|
|
},
|
|
{
|
|
"value": "AzureSQLMIDBCDC",
|
|
"description": "The Azure SQL MI DB CDC source type."
|
|
},
|
|
{
|
|
"value": "AzureServiceBus",
|
|
"description": "The Azure Service Bus source type."
|
|
},
|
|
{
|
|
"value": "ConfluentCloud",
|
|
"description": "The Confluent Cloud source type."
|
|
},
|
|
{
|
|
"value": "CustomEndpoint",
|
|
"description": "The Custom Endpoint source type."
|
|
},
|
|
{
|
|
"value": "FabricAnomalyDetectionEvents",
|
|
"description": "The Fabric Anomaly Detection Events source type."
|
|
},
|
|
{
|
|
"value": "FabricCapacityOverviewEvents",
|
|
"description": "The Fabric Capacity Overview Events source type."
|
|
},
|
|
{
|
|
"value": "FabricJobEvents",
|
|
"description": "The Fabric Job Events source type."
|
|
},
|
|
{
|
|
"value": "FabricOneLakeEvents",
|
|
"description": "The Fabric OneLake Events source type."
|
|
},
|
|
{
|
|
"value": "FabricWorkspaceItemEvents",
|
|
"description": "The Fabric Workspace Item Events source type."
|
|
},
|
|
{
|
|
"value": "GooglePubSub",
|
|
"description": "The Google PubSub source type."
|
|
},
|
|
{
|
|
"value": "Http",
|
|
"description": "The HTTP source type."
|
|
},
|
|
{
|
|
"value": "MongoDBCDC",
|
|
"description": "The MongoDB CDC source type."
|
|
},
|
|
{
|
|
"value": "Mqtt",
|
|
"description": "The MQTT source type."
|
|
},
|
|
{
|
|
"value": "MySQLCDC",
|
|
"description": "The MySQL CDC source type."
|
|
},
|
|
{
|
|
"value": "PostgreSQLCDC",
|
|
"description": "The PostgreSQL CDC source type."
|
|
},
|
|
{
|
|
"value": "RealTimeWeather",
|
|
"description": "The Real Time Weather source type."
|
|
},
|
|
{
|
|
"value": "SQLServerOnVMDBCDC",
|
|
"description": "The SQL Server on VM DB CDC source type."
|
|
},
|
|
{
|
|
"value": "SampleData",
|
|
"description": "The Sample Data source type."
|
|
},
|
|
{
|
|
"value": "SolacePubSub",
|
|
"description": "The Solace PubSub source type."
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"BaseSource": {
|
|
"type": "object",
|
|
"description": "Represents an Eventstream source.",
|
|
"required": [
|
|
"name"
|
|
],
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "The unique identifier of the source.",
|
|
"format": "uuid"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"description": "The unique name of the source."
|
|
},
|
|
"inputSchemas": {
|
|
"type": "array",
|
|
"description": "The input schemas of the source.",
|
|
"items": {
|
|
"$ref": "operatorCommon.json#/definitions/InputSchema"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"SourceResponse": {
|
|
"type": "object",
|
|
"description": "Represents an Eventstream source response.",
|
|
"required": [
|
|
"type"
|
|
],
|
|
"properties": {
|
|
"type": {
|
|
"description": "The type of the source.",
|
|
"$ref": "#/definitions/SourceType"
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/BaseSource"
|
|
},
|
|
{
|
|
"$ref": "common.json#/definitions/RuntimeInformation"
|
|
}
|
|
],
|
|
"discriminator": "type"
|
|
},
|
|
"SourceConnectionResponse": {
|
|
"type": "object",
|
|
"description": "Represents the connection information for a source custom endpoint.",
|
|
"allOf": [
|
|
{
|
|
"$ref": "common.json#/definitions/BaseCustomEndpointConnection"
|
|
}
|
|
]
|
|
},
|
|
"AzureEventGridNamespaceSourceResponse": {
|
|
"type": "object",
|
|
"description": "Azure Event Grid Namespace source response.",
|
|
"required": [
|
|
"properties"
|
|
],
|
|
"properties": {
|
|
"properties": {
|
|
"description": "The properties of the Azure Event Grid Namespace source.",
|
|
"$ref": "#/definitions/AzureEventGridNamespaceSourceProperties"
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/SourceResponse"
|
|
}
|
|
],
|
|
"x-ms-discriminator-value": "AzureEventGridNamespace"
|
|
},
|
|
"AzureEventHubSourceResponse": {
|
|
"type": "object",
|
|
"description": "Azure Event Hub source response.",
|
|
"required": [
|
|
"properties"
|
|
],
|
|
"properties": {
|
|
"properties": {
|
|
"description": "The properties of the Azure Event Hub source.",
|
|
"$ref": "#/definitions/AzureEventHubSourceProperties"
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/SourceResponse"
|
|
}
|
|
],
|
|
"x-ms-discriminator-value": "AzureEventHub"
|
|
},
|
|
"AzureEventHubExtendedSourceResponse": {
|
|
"type": "object",
|
|
"description": "Azure Event Hub Extended source response.",
|
|
"required": [
|
|
"properties"
|
|
],
|
|
"properties": {
|
|
"properties": {
|
|
"description": "The properties of the Azure Event Hub Extended source.",
|
|
"$ref": "#/definitions/AzureEventHubExtendedSourceProperties"
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/SourceResponse"
|
|
}
|
|
],
|
|
"x-ms-discriminator-value": "AzureEventHubExtended"
|
|
},
|
|
"AzureIoTHubSourceResponse": {
|
|
"type": "object",
|
|
"description": "Azure IoT Hub source response.",
|
|
"required": [
|
|
"properties"
|
|
],
|
|
"properties": {
|
|
"properties": {
|
|
"description": "The properties of the Azure IoT Hub source.",
|
|
"$ref": "#/definitions/AzureIoTHubSourceProperties"
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/SourceResponse"
|
|
}
|
|
],
|
|
"x-ms-discriminator-value": "AzureIoTHub"
|
|
},
|
|
"AzureBlobStorageEventsSourceResponse": {
|
|
"type": "object",
|
|
"description": "Azure Blob Storage events source response.",
|
|
"required": [
|
|
"properties"
|
|
],
|
|
"properties": {
|
|
"properties": {
|
|
"description": "The properties of the Azure Blob Storage events source.",
|
|
"$ref": "#/definitions/AzureBlobStorageEventsSourceProperties"
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/SourceResponse"
|
|
}
|
|
],
|
|
"x-ms-discriminator-value": "AzureBlobStorageEvents"
|
|
},
|
|
"AzureServiceBusSourceResponse": {
|
|
"type": "object",
|
|
"description": "Azure Service Bus source response.",
|
|
"required": [
|
|
"properties"
|
|
],
|
|
"properties": {
|
|
"properties": {
|
|
"description": "The properties of the Azure Service Bus source.",
|
|
"$ref": "#/definitions/AzureServiceBusSourceProperties"
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/SourceResponse"
|
|
}
|
|
],
|
|
"x-ms-discriminator-value": "AzureServiceBus"
|
|
},
|
|
"CustomEndpointSourceResponse": {
|
|
"type": "object",
|
|
"description": "Custom endpoint events source response.",
|
|
"required": [
|
|
"properties"
|
|
],
|
|
"properties": {
|
|
"properties": {
|
|
"description": "The properties of the custom endpoint events source.",
|
|
"$ref": "#/definitions/CustomEndpointSourceProperties"
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/SourceResponse"
|
|
}
|
|
],
|
|
"x-ms-discriminator-value": "CustomEndpoint"
|
|
},
|
|
"FabricAnomalyDetectionEventsSourceResponse": {
|
|
"type": "object",
|
|
"description": "Fabric Anomaly Detection Events source response.",
|
|
"required": [
|
|
"properties"
|
|
],
|
|
"properties": {
|
|
"properties": {
|
|
"description": "The properties of the Fabric Anomaly Detection Events source.",
|
|
"$ref": "#/definitions/FabricAnomalyDetectionEventsSourceProperties"
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/SourceResponse"
|
|
}
|
|
],
|
|
"x-ms-discriminator-value": "FabricAnomalyDetectionEvents"
|
|
},
|
|
"FabricCapacityOverviewEventsSourceResponse": {
|
|
"type": "object",
|
|
"description": "Fabric Capacity Overview Events source response.",
|
|
"required": [
|
|
"properties"
|
|
],
|
|
"properties": {
|
|
"properties": {
|
|
"description": "The properties of the Fabric Capacity Overview Events source.",
|
|
"$ref": "#/definitions/FabricCapacityOverviewEventsSourceProperties"
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/SourceResponse"
|
|
}
|
|
],
|
|
"x-ms-discriminator-value": "FabricCapacityOverviewEvents"
|
|
},
|
|
"SampleDataSourceResponse": {
|
|
"type": "object",
|
|
"description": "Sample data events source response.",
|
|
"required": [
|
|
"properties"
|
|
],
|
|
"properties": {
|
|
"properties": {
|
|
"description": "The properties of the sample data events source.",
|
|
"$ref": "#/definitions/SampleDataSourceProperties"
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/SourceResponse"
|
|
}
|
|
],
|
|
"x-ms-discriminator-value": "SampleData"
|
|
},
|
|
"SolacePubSubSourceResponse": {
|
|
"type": "object",
|
|
"description": "Solace PubSub source response.",
|
|
"required": [
|
|
"properties"
|
|
],
|
|
"properties": {
|
|
"properties": {
|
|
"description": "The properties of the Solace PubSub source.",
|
|
"$ref": "#/definitions/SolacePubSubSourceProperties"
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/SourceResponse"
|
|
}
|
|
],
|
|
"x-ms-discriminator-value": "SolacePubSub"
|
|
},
|
|
"AmazonKinesisSourceResponse": {
|
|
"type": "object",
|
|
"description": "Amazon Kinesis source properties response.",
|
|
"required": [
|
|
"properties"
|
|
],
|
|
"properties": {
|
|
"properties": {
|
|
"description": "The properties of the Amazon Kinesis source.",
|
|
"$ref": "#/definitions/AmazonKinesisSourceProperties"
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/SourceResponse"
|
|
}
|
|
],
|
|
"x-ms-discriminator-value": "AmazonKinesis"
|
|
},
|
|
"AmazonMSKKafkaSourceResponse": {
|
|
"type": "object",
|
|
"description": "Amazon MSK Kafka source response.",
|
|
"required": [
|
|
"properties"
|
|
],
|
|
"properties": {
|
|
"properties": {
|
|
"description": "The properties of the Amazon MSK Kafka source.",
|
|
"$ref": "#/definitions/AmazonMSKKafkaSourceProperties"
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/SourceResponse"
|
|
}
|
|
],
|
|
"x-ms-discriminator-value": "AmazonMSKKafka"
|
|
},
|
|
"ApacheKafkaSourceResponse": {
|
|
"type": "object",
|
|
"description": "Apache Kafka source response.",
|
|
"required": [
|
|
"properties"
|
|
],
|
|
"properties": {
|
|
"properties": {
|
|
"description": "The properties of the Apache Kafka source.",
|
|
"$ref": "#/definitions/ApacheKafkaSourceProperties"
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/SourceResponse"
|
|
}
|
|
],
|
|
"x-ms-discriminator-value": "ApacheKafka"
|
|
},
|
|
"ConfluentCloudSourceResponse": {
|
|
"type": "object",
|
|
"description": "Confluent Cloud source response.",
|
|
"required": [
|
|
"properties"
|
|
],
|
|
"properties": {
|
|
"properties": {
|
|
"$ref": "#/definitions/BaseKafkaSourceProperties"
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/SourceResponse"
|
|
}
|
|
],
|
|
"x-ms-discriminator-value": "ConfluentCloud"
|
|
},
|
|
"AzureCosmosDBCDCSourceResponse": {
|
|
"type": "object",
|
|
"description": "Azure Cosmos DB CDC source response.",
|
|
"required": [
|
|
"properties"
|
|
],
|
|
"properties": {
|
|
"properties": {
|
|
"description": "The properties of the Azure Cosmos DB CDC source.",
|
|
"$ref": "#/definitions/AzureCosmosDBCDCSourceProperties"
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/SourceResponse"
|
|
}
|
|
],
|
|
"x-ms-discriminator-value": "AzureCosmosDBCDC"
|
|
},
|
|
"AzureDataExplorerSourceResponse": {
|
|
"type": "object",
|
|
"description": "Azure Data Explorer source response.",
|
|
"required": [
|
|
"properties"
|
|
],
|
|
"properties": {
|
|
"properties": {
|
|
"description": "The properties of the Azure Data Explorer source.",
|
|
"$ref": "#/definitions/AzureDataExplorerSourceProperties"
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/SourceResponse"
|
|
}
|
|
],
|
|
"x-ms-discriminator-value": "AzureDataExplorer"
|
|
},
|
|
"AzureSQLDBCDCSourceResponse": {
|
|
"type": "object",
|
|
"description": "Azure SQL DB CDC source response.",
|
|
"required": [
|
|
"properties"
|
|
],
|
|
"properties": {
|
|
"properties": {
|
|
"description": "The properties of the Azure SQL DB CDC source.",
|
|
"$ref": "#/definitions/BaseSQLServerCDCSourceProperties"
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/SourceResponse"
|
|
}
|
|
],
|
|
"x-ms-discriminator-value": "AzureSQLDBCDC"
|
|
},
|
|
"AzureSQLMIDBCDCSourceResponse": {
|
|
"type": "object",
|
|
"description": "Azure SQL MI DB CDC source response.",
|
|
"required": [
|
|
"properties"
|
|
],
|
|
"properties": {
|
|
"properties": {
|
|
"description": "The properties of the Azure SQL MI DB CDC source.",
|
|
"$ref": "#/definitions/BaseSQLServerCDCSourceProperties"
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/SourceResponse"
|
|
}
|
|
],
|
|
"x-ms-discriminator-value": "AzureSQLMIDBCDC"
|
|
},
|
|
"SQLServerOnVMDBCDCSourceResponse": {
|
|
"type": "object",
|
|
"description": "Azure SQL Server on VM DB CDC source response.",
|
|
"required": [
|
|
"properties"
|
|
],
|
|
"properties": {
|
|
"properties": {
|
|
"description": "The properties of the SQL Server on VM DB CDC source.",
|
|
"$ref": "#/definitions/BaseSQLServerCDCSourceProperties"
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/SourceResponse"
|
|
}
|
|
],
|
|
"x-ms-discriminator-value": "SQLServerOnVMDBCDC"
|
|
},
|
|
"MySQLCDCSourceResponse": {
|
|
"type": "object",
|
|
"description": "MySQL CDC source response.",
|
|
"required": [
|
|
"properties"
|
|
],
|
|
"properties": {
|
|
"properties": {
|
|
"description": "The properties of the MySQL CDC source.",
|
|
"$ref": "#/definitions/MySQLCDCSourceProperties"
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/SourceResponse"
|
|
}
|
|
],
|
|
"x-ms-discriminator-value": "MySQLCDC"
|
|
},
|
|
"PostgreSQLCDCSourceResponse": {
|
|
"type": "object",
|
|
"description": "PostgreSQL CDC source response.",
|
|
"required": [
|
|
"properties"
|
|
],
|
|
"properties": {
|
|
"properties": {
|
|
"description": "The properties of the PostgreSQL CDC source.",
|
|
"$ref": "#/definitions/PostgreSQLCDCSourceProperties"
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/SourceResponse"
|
|
}
|
|
],
|
|
"x-ms-discriminator-value": "PostgreSQLCDC"
|
|
},
|
|
"RealTimeWeatherSourceResponse": {
|
|
"type": "object",
|
|
"description": "Real Time Weather source response.",
|
|
"required": [
|
|
"properties"
|
|
],
|
|
"properties": {
|
|
"properties": {
|
|
"description": "The properties of the Real Time Weather source.",
|
|
"$ref": "#/definitions/RealTimeWeatherSourceProperties"
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/SourceResponse"
|
|
}
|
|
],
|
|
"x-ms-discriminator-value": "RealTimeWeather"
|
|
},
|
|
"GooglePubSubSourceResponse": {
|
|
"type": "object",
|
|
"description": "Google Pub/Sub source response.",
|
|
"required": [
|
|
"properties"
|
|
],
|
|
"properties": {
|
|
"properties": {
|
|
"description": "The properties of the Google Pub/Sub source.",
|
|
"$ref": "#/definitions/GooglePubSubSourceProperties"
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/SourceResponse"
|
|
}
|
|
],
|
|
"x-ms-discriminator-value": "GooglePubSub"
|
|
},
|
|
"HttpSourceResponse": {
|
|
"type": "object",
|
|
"description": "HTTP source response.",
|
|
"required": [
|
|
"properties"
|
|
],
|
|
"properties": {
|
|
"properties": {
|
|
"description": "The properties of the HTTP source.",
|
|
"$ref": "#/definitions/HttpSourceProperties"
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/SourceResponse"
|
|
}
|
|
],
|
|
"x-ms-discriminator-value": "Http"
|
|
},
|
|
"MongoDBCDCSourceResponse": {
|
|
"type": "object",
|
|
"description": "MongoDB CDC source response.",
|
|
"required": [
|
|
"properties"
|
|
],
|
|
"properties": {
|
|
"properties": {
|
|
"description": "The properties of the MongoDB CDC source.",
|
|
"$ref": "#/definitions/MongoDBCDCSourceProperties"
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/SourceResponse"
|
|
}
|
|
],
|
|
"x-ms-discriminator-value": "MongoDBCDC"
|
|
},
|
|
"MqttSourceResponse": {
|
|
"type": "object",
|
|
"description": "MQTT source response.",
|
|
"required": [
|
|
"properties"
|
|
],
|
|
"properties": {
|
|
"properties": {
|
|
"description": "The properties of the MQTT source.",
|
|
"$ref": "#/definitions/MqttSourceProperties"
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/SourceResponse"
|
|
}
|
|
],
|
|
"x-ms-discriminator-value": "Mqtt"
|
|
},
|
|
"FabricJobEventsSourceResponse": {
|
|
"type": "object",
|
|
"description": "Fabric Job Events source response.",
|
|
"required": [
|
|
"properties"
|
|
],
|
|
"properties": {
|
|
"properties": {
|
|
"description": "The properties of the Fabric Job Events source.",
|
|
"$ref": "#/definitions/FabricJobEventsSourceProperties"
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/SourceResponse"
|
|
}
|
|
],
|
|
"x-ms-discriminator-value": "FabricJobEvents"
|
|
},
|
|
"FabricOneLakeEventsSourceResponse": {
|
|
"type": "object",
|
|
"description": "Fabric OneLake Events source response.",
|
|
"required": [
|
|
"properties"
|
|
],
|
|
"properties": {
|
|
"properties": {
|
|
"description": "The properties of the Fabric OneLake Events source.",
|
|
"$ref": "#/definitions/FabricOneLakeEventsSourceProperties"
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/SourceResponse"
|
|
}
|
|
],
|
|
"x-ms-discriminator-value": "FabricOneLakeEvents"
|
|
},
|
|
"FabricWorkspaceItemEventsSourceResponse": {
|
|
"type": "object",
|
|
"description": "Fabric Workspace Item Events source response.",
|
|
"required": [
|
|
"properties"
|
|
],
|
|
"properties": {
|
|
"properties": {
|
|
"description": "The properties of the Fabric Workspace Item Events source.",
|
|
"$ref": "#/definitions/FabricWorkspaceItemEventsSourceProperties"
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/SourceResponse"
|
|
}
|
|
],
|
|
"x-ms-discriminator-value": "FabricWorkspaceItemEvents"
|
|
},
|
|
"AzureEventGridNamespaceSourceProperties": {
|
|
"type": "object",
|
|
"description": "Azure Event Grid Namespace source properties.",
|
|
"required": [
|
|
"namespaceResourceId",
|
|
"topic"
|
|
],
|
|
"properties": {
|
|
"namespaceResourceId": {
|
|
"type": "string",
|
|
"description": "The Azure Event Grid Namespace resource identifier."
|
|
},
|
|
"topic": {
|
|
"type": "string",
|
|
"description": "The topic name."
|
|
}
|
|
}
|
|
},
|
|
"AzureEventHubSourceProperties": {
|
|
"type": "object",
|
|
"description": "Azure Event Hub source properties.",
|
|
"required": [
|
|
"dataConnectionId",
|
|
"consumerGroupName",
|
|
"inputSerialization"
|
|
],
|
|
"properties": {
|
|
"dataConnectionId": {
|
|
"type": "string",
|
|
"description": "The Azure Event Hub data connection identifier.",
|
|
"format": "uuid"
|
|
},
|
|
"consumerGroupName": {
|
|
"type": "string",
|
|
"description": "The consumer group name."
|
|
},
|
|
"inputSerialization": {
|
|
"$ref": "./serialization.json#/definitions/SerializationInfo"
|
|
}
|
|
}
|
|
},
|
|
"AzureEventHubExtendedSourceProperties": {
|
|
"type": "object",
|
|
"description": "Azure Event Hub Extended source properties.",
|
|
"required": [
|
|
"dataConnectionId",
|
|
"consumerGroupName",
|
|
"startPosition"
|
|
],
|
|
"properties": {
|
|
"dataConnectionId": {
|
|
"type": "string",
|
|
"description": "The Azure Event Hub data connection identifier.",
|
|
"format": "uuid"
|
|
},
|
|
"consumerGroupName": {
|
|
"type": "string",
|
|
"description": "The consumer group name."
|
|
},
|
|
"startPosition": {
|
|
"type": "string",
|
|
"description": "The start position in the Azure Event Hub stream.",
|
|
"enum": [
|
|
"Earliest",
|
|
"Latest"
|
|
],
|
|
"x-ms-enum": {
|
|
"name": "StartPosition",
|
|
"modelAsString": true,
|
|
"values": [
|
|
{
|
|
"value": "Earliest",
|
|
"description": "Start from the earliest event."
|
|
},
|
|
{
|
|
"value": "Latest",
|
|
"description": "Start from the latest event."
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"AzureIoTHubSourceProperties": {
|
|
"type": "object",
|
|
"description": "Azure IoT Hub source properties.",
|
|
"required": [
|
|
"dataConnectionId",
|
|
"consumerGroupName",
|
|
"inputSerialization"
|
|
],
|
|
"properties": {
|
|
"dataConnectionId": {
|
|
"type": "string",
|
|
"description": "The Azure IoT Hub data connection identifier.",
|
|
"format": "uuid"
|
|
},
|
|
"consumerGroupName": {
|
|
"type": "string",
|
|
"description": "The consumer group name."
|
|
},
|
|
"inputSerialization": {
|
|
"$ref": "./serialization.json#/definitions/SerializationInfo"
|
|
}
|
|
}
|
|
},
|
|
"AzureBlobStorageEventsSourceProperties": {
|
|
"type": "object",
|
|
"description": "Azure Blob Storage events source properties.",
|
|
"required": [
|
|
"azureBlobStorageEvents",
|
|
"streamEvents"
|
|
],
|
|
"properties": {
|
|
"azureBlobStorageEvents": {
|
|
"type": "array",
|
|
"description": "The Azure Blob Storage events.",
|
|
"items": {
|
|
"$ref": "#/definitions/AzureBlobStorageEvents"
|
|
}
|
|
},
|
|
"streamEvents": {
|
|
"type": "boolean",
|
|
"description": "Indicates whether to stream events."
|
|
}
|
|
}
|
|
},
|
|
"AzureBlobStorageEvents": {
|
|
"type": "object",
|
|
"description": "Azure Blob Storage events source.",
|
|
"required": [
|
|
"azureResourceId",
|
|
"includedEventTypes"
|
|
],
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "The unique identifier of the source.",
|
|
"format": "uuid"
|
|
},
|
|
"azureResourceId": {
|
|
"type": "string",
|
|
"description": "The Azure resource identifier of the blob storage."
|
|
},
|
|
"includedEventTypes": {
|
|
"type": "array",
|
|
"description": "The included event types. Additional event types may be added over time.",
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Microsoft.Storage.BlobCreated",
|
|
"Microsoft.Storage.BlobDeleted",
|
|
"Microsoft.Storage.BlobRenamed",
|
|
"Microsoft.Storage.BlobTierChanged",
|
|
"Microsoft.Storage.DirectoryCreated",
|
|
"Microsoft.Storage.DirectoryDeleted",
|
|
"Microsoft.Storage.DirectoryRenamed",
|
|
"Microsoft.Storage.BlobInventoryPolicyCompleted",
|
|
"Microsoft.Storage.AsyncOperationInitiated",
|
|
"Microsoft.Storage.LifecyclePolicyCompleted"
|
|
],
|
|
"x-ms-enum": {
|
|
"name": "IncludedEventTypes",
|
|
"modelAsString": true,
|
|
"values": [
|
|
{
|
|
"value": "Microsoft.Storage.BlobCreated",
|
|
"description": "Blob created event."
|
|
},
|
|
{
|
|
"value": "Microsoft.Storage.BlobDeleted",
|
|
"description": "Blob deleted event."
|
|
},
|
|
{
|
|
"value": "Microsoft.Storage.BlobRenamed",
|
|
"description": "Blob renamed event."
|
|
},
|
|
{
|
|
"value": "Microsoft.Storage.BlobTierChanged",
|
|
"description": "Blob tier changed event."
|
|
},
|
|
{
|
|
"value": "Microsoft.Storage.DirectoryCreated",
|
|
"description": "Directory created event."
|
|
},
|
|
{
|
|
"value": "Microsoft.Storage.DirectoryDeleted",
|
|
"description": "Directory deleted event."
|
|
},
|
|
{
|
|
"value": "Microsoft.Storage.DirectoryRenamed",
|
|
"description": "Directory renamed event."
|
|
},
|
|
{
|
|
"value": "Microsoft.Storage.BlobInventoryPolicyCompleted",
|
|
"description": "Blob inventory policy completed event."
|
|
},
|
|
{
|
|
"value": "Microsoft.Storage.AsyncOperationInitiated",
|
|
"description": "Async operation initiated event."
|
|
},
|
|
{
|
|
"value": "Microsoft.Storage.LifecyclePolicyCompleted",
|
|
"description": "Lifecycle policy completed event."
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"AzureServiceBusSourceProperties": {
|
|
"type": "object",
|
|
"description": "Azure Service Bus source properties.",
|
|
"required": [
|
|
"dataConnectionId",
|
|
"serviceBusType",
|
|
"topicOrQueueName"
|
|
],
|
|
"properties": {
|
|
"dataConnectionId": {
|
|
"type": "string",
|
|
"description": "The Azure Service Bus data connection identifier.",
|
|
"format": "uuid"
|
|
},
|
|
"serviceBusType": {
|
|
"type": "string",
|
|
"description": "The type of the Azure Service Bus source.",
|
|
"enum": [
|
|
"Topic",
|
|
"Queue"
|
|
]
|
|
},
|
|
"topicOrQueueName": {
|
|
"type": "string",
|
|
"description": "The name of the Azure Service Bus topic or queue."
|
|
},
|
|
"subscriptionName": {
|
|
"type": "string",
|
|
"description": "The name of the Azure Service Bus subscription. This property is required when the entity type is `Topic`."
|
|
|
|
}
|
|
}
|
|
},
|
|
"CustomEndpointSourceProperties": {
|
|
"type": "object",
|
|
"description": "Custom endpoint events source properties.",
|
|
"properties": {}
|
|
},
|
|
"FabricAnomalyDetectionEventsSourceProperties": {
|
|
"type": "object",
|
|
"description": "Fabric Anomaly Detection Events source properties.",
|
|
"properties": {
|
|
"workspaceId": {
|
|
"type": "string",
|
|
"description": "The workspace identifier.",
|
|
"format": "uuid"
|
|
},
|
|
"itemId": {
|
|
"type": "string",
|
|
"description": "The item identifier.",
|
|
"format": "uuid"
|
|
},
|
|
"configurationId": {
|
|
"type": "string",
|
|
"description": "The anomaly detection configuration identifier.",
|
|
"format": "uuid"
|
|
},
|
|
"includedEventTypes": {
|
|
"type": "array",
|
|
"description": "The list of event types to include. Supported values: Microsoft.Fabric.AnomalyDetection.AnomalyDetected. Additional event types may be added over time.",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"filters": {
|
|
"type": "array",
|
|
"description": "The Azure Event Grid advanced filters to apply. Each entry is an advanced filter object as defined by Azure Event Grid. For details, see https://learn.microsoft.com/azure/event-grid/event-filtering#advanced-filtering.",
|
|
"items": {
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"FabricCapacityOverviewEventsSourceProperties": {
|
|
"type": "object",
|
|
"description": "Fabric Capacity Overview Events source properties.",
|
|
"required": [
|
|
"eventScope",
|
|
"capacityId"
|
|
],
|
|
"properties": {
|
|
"eventScope": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Tenant",
|
|
"Capacity",
|
|
"Workspace",
|
|
"Item",
|
|
"SubItem"
|
|
],
|
|
"x-ms-enum": {
|
|
"name": "EventScope",
|
|
"modelAsString": true,
|
|
"values": [
|
|
{
|
|
"value": "Tenant",
|
|
"description": "The event scope is Tenant."
|
|
},
|
|
{
|
|
"value": "Capacity",
|
|
"description": "The event scope is Capacity."
|
|
},
|
|
{
|
|
"value": "Workspace",
|
|
"description": "The event scope is Workspace."
|
|
},
|
|
{
|
|
"value": "Item",
|
|
"description": "The event scope is Item."
|
|
},
|
|
{
|
|
"value": "SubItem",
|
|
"description": "The event scope is SubItem."
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"capacityId": {
|
|
"type": "string",
|
|
"description": "The capacity identifier.",
|
|
"format": "uuid"
|
|
},
|
|
"includedEventTypes": {
|
|
"type": "array",
|
|
"description": "The list of event types to include. Supported values: Microsoft.Fabric.Capacity.State, Microsoft.Fabric.Capacity.Summary. Additional event types may be added over time.",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"filters": {
|
|
"type": "array",
|
|
"description": "The Azure Event Grid advanced filters to apply. Each entry is an advanced filter object as defined by Azure Event Grid. For details, see https://learn.microsoft.com/azure/event-grid/event-filtering#advanced-filtering.",
|
|
"items": {
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"SampleDataSourceProperties": {
|
|
"type": "object",
|
|
"description": "Sample data source properties.",
|
|
"required": [
|
|
"type"
|
|
],
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"description": "The sample data type. Additional sample data types may be added over time.",
|
|
"enum": [
|
|
"YellowTaxi",
|
|
"StockMarket",
|
|
"Bicycles",
|
|
"Buses",
|
|
"SP500Stocks",
|
|
"SemanticModelLogs"
|
|
],
|
|
"x-ms-enum": {
|
|
"name": "Type",
|
|
"modelAsString": true,
|
|
"values": [
|
|
{
|
|
"value": "YellowTaxi",
|
|
"description": "Yellow Taxi sample data."
|
|
},
|
|
{
|
|
"value": "StockMarket",
|
|
"description": "Stock Market sample data."
|
|
},
|
|
{
|
|
"value": "Bicycles",
|
|
"description": "Bicycles sample data."
|
|
},
|
|
{
|
|
"value": "Buses",
|
|
"description": "Buses sample data."
|
|
},
|
|
{
|
|
"value": "SP500Stocks",
|
|
"description": "S&P 500 Stocks sample data."
|
|
},
|
|
{
|
|
"value": "SemanticModelLogs",
|
|
"description": "Semantic Model Logs sample data."
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"SolacePubSubSourceProperties": {
|
|
"type": "object",
|
|
"description": "Solace PubSub source properties.",
|
|
"required": [
|
|
"dataConnectionId",
|
|
"pubSubType",
|
|
"messageVpnName"
|
|
],
|
|
"properties": {
|
|
"dataConnectionId": {
|
|
"type": "string",
|
|
"description": "The Solace PubSub data connection identifier.",
|
|
"format": "uuid"
|
|
},
|
|
"pubSubType": {
|
|
"type": "string",
|
|
"description": "The Solace PubSub type.",
|
|
"enum": [
|
|
"Topics",
|
|
"Queue"
|
|
],
|
|
"x-ms-enum": {
|
|
"name": "PubSubType",
|
|
"modelAsString": true,
|
|
"values": [
|
|
{
|
|
"value": "Topics",
|
|
"description": "The Solace PubSub topics type."
|
|
},
|
|
{
|
|
"value": "Queue",
|
|
"description": "The Solace PubSub queue type."
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"messageVpnName": {
|
|
"type": "string",
|
|
"description": "The Solace PubSub message VPN name."
|
|
},
|
|
"mapUserProperties": {
|
|
"type": "boolean",
|
|
"description": "Indicates whether to map user properties from Solace message to Kafka record headers."
|
|
},
|
|
"mapSolaceProperties": {
|
|
"type": "boolean",
|
|
"description": "Indicates whether to map Solace standard message properties to Kafka record headers."
|
|
}
|
|
},
|
|
"discriminator": "pubSubType"
|
|
},
|
|
"SolacePubSubTopicsSourceProperties": {
|
|
"type": "object",
|
|
"description": "Solace PubSub topics source properties.",
|
|
"required": [
|
|
"topics"
|
|
],
|
|
"properties": {
|
|
"topics": {
|
|
"type": "array",
|
|
"description": "The Solace PubSub topics.",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/SolacePubSubSourceProperties"
|
|
}
|
|
],
|
|
"x-ms-discriminator-value": "Topics"
|
|
},
|
|
"SolacePubSubQueueSourceProperties": {
|
|
"type": "object",
|
|
"description": "Solace PubSub queue source properties.",
|
|
"required": [
|
|
"queue"
|
|
],
|
|
"properties": {
|
|
"queue": {
|
|
"type": "string",
|
|
"description": "The Solace PubSub queue name."
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/SolacePubSubSourceProperties"
|
|
}
|
|
],
|
|
"x-ms-discriminator-value": "Queue"
|
|
},
|
|
"AmazonKinesisSourceProperties": {
|
|
"type": "object",
|
|
"description": "Amazon Kinesis source properties.",
|
|
"required": [
|
|
"dataConnectionId",
|
|
"region"
|
|
],
|
|
"properties": {
|
|
"dataConnectionId": {
|
|
"type": "string",
|
|
"description": "The Amazon Kinesis data connection identifier.",
|
|
"format": "uuid"
|
|
},
|
|
"region": {
|
|
"type": "string",
|
|
"description": "The Amazon Kinesis region name. Additional regions may be added over time.",
|
|
"enum": [
|
|
"af-south-1",
|
|
"ap-east-1",
|
|
"ap-northeast-1",
|
|
"ap-northeast-2",
|
|
"ap-northeast-3",
|
|
"ap-south-1",
|
|
"ap-south-2",
|
|
"ap-southeast-1",
|
|
"ap-southeast-2",
|
|
"ap-southeast-3",
|
|
"ap-southeast-4",
|
|
"ap-southeast-5",
|
|
"ca-central-1",
|
|
"ca-west-1",
|
|
"eu-central-1",
|
|
"eu-central-2",
|
|
"eu-north-1",
|
|
"eu-south-1",
|
|
"eu-south-2",
|
|
"eu-west-1",
|
|
"eu-west-2",
|
|
"eu-west-3",
|
|
"il-central-1",
|
|
"me-central-1",
|
|
"me-south-1",
|
|
"sa-east-1",
|
|
"us-east-1",
|
|
"us-east-2",
|
|
"us-gov-east-1",
|
|
"us-gov-west-1",
|
|
"us-west-1",
|
|
"us-west-2"
|
|
],
|
|
"x-ms-enum": {
|
|
"name": "Region",
|
|
"modelAsString": true,
|
|
"values": [
|
|
{
|
|
"value": "af-south-1",
|
|
"description": "Africa (Cape Town) region."
|
|
},
|
|
{
|
|
"value": "ap-east-1",
|
|
"description": "Asia Pacific (Hong Kong) region."
|
|
},
|
|
{
|
|
"value": "ap-northeast-1",
|
|
"description": "Asia Pacific (Tokyo) region."
|
|
},
|
|
{
|
|
"value": "ap-northeast-2",
|
|
"description": "Asia Pacific (Seoul) region."
|
|
},
|
|
{
|
|
"value": "ap-northeast-3",
|
|
"description": "Asia Pacific (Osaka) region."
|
|
},
|
|
{
|
|
"value": "ap-south-1",
|
|
"description": "Asia Pacific (Mumbai) region."
|
|
},
|
|
{
|
|
"value": "ap-south-2",
|
|
"description": "Asia Pacific (Hyderabad) region."
|
|
},
|
|
{
|
|
"value": "ap-southeast-1",
|
|
"description": "Asia Pacific (Singapore) region."
|
|
},
|
|
{
|
|
"value": "ap-southeast-2",
|
|
"description": "Asia Pacific (Sydney) region."
|
|
},
|
|
{
|
|
"value": "ap-southeast-3",
|
|
"description": "Asia Pacific (Jakarta) region."
|
|
},
|
|
{
|
|
"value": "ap-southeast-4",
|
|
"description": "Asia Pacific (Melbourne) region."
|
|
},
|
|
{
|
|
"value": "ap-southeast-5",
|
|
"description": "Asia Pacific (Malaysia) region."
|
|
},
|
|
{
|
|
"value": "ca-central-1",
|
|
"description": "Canada (Central) region."
|
|
},
|
|
{
|
|
"value": "ca-west-1",
|
|
"description": "Canada West (Calgary) region."
|
|
},
|
|
{
|
|
"value": "eu-central-1",
|
|
"description": "Europe (Frankfurt) region."
|
|
},
|
|
{
|
|
"value": "eu-central-2",
|
|
"description": "Europe (Zurich) region."
|
|
},
|
|
{
|
|
"value": "eu-north-1",
|
|
"description": "Europe (Stockholm) region."
|
|
},
|
|
{
|
|
"value": "eu-south-1",
|
|
"description": "Europe (Milan) region."
|
|
},
|
|
{
|
|
"value": "eu-south-2",
|
|
"description": "Europe (Spain) region."
|
|
},
|
|
{
|
|
"value": "eu-west-1",
|
|
"description": "Europe (Ireland) region."
|
|
},
|
|
{
|
|
"value": "eu-west-2",
|
|
"description": "Europe (London) region."
|
|
},
|
|
{
|
|
"value": "eu-west-3",
|
|
"description": "Europe (Paris) region."
|
|
},
|
|
{
|
|
"value": "il-central-1",
|
|
"description": "Israel (Tel Aviv) region."
|
|
},
|
|
{
|
|
"value": "me-central-1",
|
|
"description": "Middle East (UAE) region."
|
|
},
|
|
{
|
|
"value": "me-south-1",
|
|
"description": "Middle East (Bahrain) region."
|
|
},
|
|
{
|
|
"value": "sa-east-1",
|
|
"description": "South America (São Paulo) region."
|
|
},
|
|
{
|
|
"value": "us-east-1",
|
|
"description": "US East (N. Virginia) region."
|
|
},
|
|
{
|
|
"value": "us-east-2",
|
|
"description": "US East (Ohio) region."
|
|
},
|
|
{
|
|
"value": "us-gov-east-1",
|
|
"description": "AWS GovCloud (US-East) region."
|
|
},
|
|
{
|
|
"value": "us-gov-west-1",
|
|
"description": "AWS GovCloud (US-West) region."
|
|
},
|
|
{
|
|
"value": "us-west-1",
|
|
"description": "US West (N. California) region."
|
|
},
|
|
{
|
|
"value": "us-west-2",
|
|
"description": "US West (Oregon) region."
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"startPosition": {
|
|
"type": "string",
|
|
"description": "The start position in the stream.",
|
|
"enum": [
|
|
"Latest",
|
|
"TrimHorizon",
|
|
"AtTimestamp"
|
|
],
|
|
"x-ms-enum": {
|
|
"name": "StartPosition",
|
|
"modelAsString": true,
|
|
"values": [
|
|
{
|
|
"value": "Latest",
|
|
"description": "Start from the latest record."
|
|
},
|
|
{
|
|
"value": "TrimHorizon",
|
|
"description": "Start from the last untrimmed record."
|
|
},
|
|
{
|
|
"value": "AtTimestamp",
|
|
"description": "Start from a specific timestamp."
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"startTimestamp": {
|
|
"type": "string",
|
|
"description": "The start timestamp in ISO 8601 format (for example, '2024-01-15T10:30:00Z'). Required when `startPosition` is `AtTimestamp`."
|
|
}
|
|
}
|
|
},
|
|
"BaseKafkaSourceProperties": {
|
|
"type": "object",
|
|
"description": "Base Kafka source properties.",
|
|
"required": [
|
|
"dataConnectionId",
|
|
"topic",
|
|
"consumerGroupName",
|
|
"autoOffsetReset"
|
|
],
|
|
"properties": {
|
|
"dataConnectionId": {
|
|
"type": "string",
|
|
"description": "The Kafka data connection identifier.",
|
|
"format": "uuid"
|
|
},
|
|
"topic": {
|
|
"type": "string",
|
|
"description": "The Kafka topic."
|
|
},
|
|
"consumerGroupName": {
|
|
"type": "string",
|
|
"description": "The consumer group name."
|
|
},
|
|
"autoOffsetReset": {
|
|
"type": "string",
|
|
"description": "The auto offset reset property. Default is None.",
|
|
"enum": [
|
|
"None",
|
|
"Earliest",
|
|
"Latest"
|
|
],
|
|
"x-ms-enum": {
|
|
"name": "AutoOffsetReset",
|
|
"modelAsString": true,
|
|
"values": [
|
|
{
|
|
"value": "None",
|
|
"description": "The auto offset reset is None."
|
|
},
|
|
{
|
|
"value": "Earliest",
|
|
"description": "The auto offset reset is Earliest."
|
|
},
|
|
{
|
|
"value": "Latest",
|
|
"description": "The auto offset reset is Latest."
|
|
}
|
|
]
|
|
},
|
|
"default": "None"
|
|
},
|
|
"tlsSettings": {
|
|
"description": "The TLS settings for the Kafka connection.",
|
|
"$ref": "#/definitions/TLSSettings"
|
|
}
|
|
}
|
|
},
|
|
"AmazonMSKKafkaSourceProperties": {
|
|
"type": "object",
|
|
"description": "Amazon MSK Kafka source properties.",
|
|
"required": [
|
|
"saslMechanism",
|
|
"securityProtocol"
|
|
],
|
|
"properties": {
|
|
"saslMechanism": {
|
|
"type": "string",
|
|
"description": "The SASL mechanism. Additional SASL mechanisms may be added over time.",
|
|
"enum": [
|
|
"PLAIN",
|
|
"SCRAM-SHA-256",
|
|
"SCRAM-SHA-512"
|
|
],
|
|
"x-ms-enum": {
|
|
"name": "SaslMechanism",
|
|
"modelAsString": true,
|
|
"values": [
|
|
{
|
|
"value": "PLAIN",
|
|
"description": "The SASL mechanism is PLAIN."
|
|
},
|
|
{
|
|
"value": "SCRAM-SHA-256",
|
|
"description": "The SASL mechanism is SCRAM-SHA-256."
|
|
},
|
|
{
|
|
"value": "SCRAM-SHA-512",
|
|
"description": "The SASL mechanism is SCRAM-SHA-512."
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"securityProtocol": {
|
|
"type": "string",
|
|
"description": "The security protocol.",
|
|
"enum": [
|
|
"SASL_PLAINTEXT",
|
|
"PLAINTEXT",
|
|
"SASL_SSL",
|
|
"SSL"
|
|
],
|
|
"x-ms-enum": {
|
|
"name": "SecurityProtocol",
|
|
"modelAsString": true,
|
|
"values": [
|
|
{
|
|
"value": "SASL_PLAINTEXT",
|
|
"description": "The security protocol is SASL_PLAINTEXT."
|
|
},
|
|
{
|
|
"value": "PLAINTEXT",
|
|
"description": "The security protocol is PLAINTEXT."
|
|
},
|
|
{
|
|
"value": "SASL_SSL",
|
|
"description": "The security protocol is SASL_SSL."
|
|
},
|
|
{
|
|
"value": "SSL",
|
|
"description": "The security protocol is SSL."
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/BaseKafkaSourceProperties"
|
|
}
|
|
]
|
|
},
|
|
"ApacheKafkaSourceProperties": {
|
|
"type": "object",
|
|
"description": "Apache Kafka source properties.",
|
|
"required": [
|
|
"saslMechanism",
|
|
"securityProtocol"
|
|
],
|
|
"properties": {
|
|
"saslMechanism": {
|
|
"type": "string",
|
|
"description": "The SASL mechanism. Additional SASL mechanisms may be added over time.",
|
|
"enum": [
|
|
"PLAIN",
|
|
"SCRAM-SHA-256",
|
|
"SCRAM-SHA-512"
|
|
],
|
|
"x-ms-enum": {
|
|
"name": "SaslMechanism",
|
|
"modelAsString": true,
|
|
"values": [
|
|
{
|
|
"value": "PLAIN",
|
|
"description": "The SASL mechanism is PLAIN."
|
|
},
|
|
{
|
|
"value": "SCRAM-SHA-256",
|
|
"description": "The SASL mechanism is SCRAM-SHA-256."
|
|
},
|
|
{
|
|
"value": "SCRAM-SHA-512",
|
|
"description": "The SASL mechanism is SCRAM-SHA-512."
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"securityProtocol": {
|
|
"type": "string",
|
|
"description": "The security protocol.",
|
|
"enum": [
|
|
"SASL_PLAINTEXT",
|
|
"PLAINTEXT",
|
|
"SASL_SSL",
|
|
"SSL"
|
|
],
|
|
"x-ms-enum": {
|
|
"name": "SecurityProtocol",
|
|
"modelAsString": true,
|
|
"values": [
|
|
{
|
|
"value": "SASL_PLAINTEXT",
|
|
"description": "The security protocol is SASL_PLAINTEXT."
|
|
},
|
|
{
|
|
"value": "PLAINTEXT",
|
|
"description": "The security protocol is PLAINTEXT."
|
|
},
|
|
{
|
|
"value": "SASL_SSL",
|
|
"description": "The security protocol is SASL_SSL."
|
|
},
|
|
{
|
|
"value": "SSL",
|
|
"description": "The security protocol is SSL."
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/BaseKafkaSourceProperties"
|
|
}
|
|
]
|
|
},
|
|
"AzureCosmosDBCDCSourceProperties": {
|
|
"type": "object",
|
|
"description": "Azure Cosmos DB CDC source properties.",
|
|
"required": [
|
|
"dataConnectionId",
|
|
"containerName",
|
|
"databaseName",
|
|
"offsetPolicy"
|
|
],
|
|
"properties": {
|
|
"dataConnectionId": {
|
|
"type": "string",
|
|
"description": "The Azure Cosmos DB CDC data connection identifier.",
|
|
"format": "uuid"
|
|
},
|
|
"containerName": {
|
|
"type": "string",
|
|
"description": "The container name."
|
|
},
|
|
"databaseName": {
|
|
"type": "string",
|
|
"description": "The database name."
|
|
},
|
|
"offsetPolicy": {
|
|
"type": "string",
|
|
"description": "The offset policy.",
|
|
"enum": [
|
|
"Earliest",
|
|
"Latest"
|
|
],
|
|
"x-ms-enum": {
|
|
"name": "OffsetPolicy",
|
|
"modelAsString": true,
|
|
"values": [
|
|
{
|
|
"value": "Earliest",
|
|
"description": "The offset policy is Earliest."
|
|
},
|
|
{
|
|
"value": "Latest",
|
|
"description": "The offset policy is Latest."
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"AzureDataExplorerSourceProperties": {
|
|
"type": "object",
|
|
"description": "Azure Data Explorer source properties.",
|
|
"required": [
|
|
"dataConnectionId",
|
|
"databaseName",
|
|
"tableNames"
|
|
],
|
|
"properties": {
|
|
"dataConnectionId": {
|
|
"type": "string",
|
|
"description": "The Azure Data Explorer data connection identifier.",
|
|
"format": "uuid"
|
|
},
|
|
"databaseName": {
|
|
"type": "string",
|
|
"description": "The database name."
|
|
},
|
|
"tableNames": {
|
|
"type": "string",
|
|
"description": "The list of comma-separated table names."
|
|
}
|
|
}
|
|
},
|
|
"BaseSQLCDCSourceProperties": {
|
|
"type": "object",
|
|
"description": "Base SQL CDC source properties.",
|
|
"required": [
|
|
"dataConnectionId",
|
|
"tableName"
|
|
],
|
|
"properties": {
|
|
"dataConnectionId": {
|
|
"type": "string",
|
|
"description": "The SQL CDC data connection identifier.",
|
|
"format": "uuid"
|
|
},
|
|
"tableName": {
|
|
"type": "string",
|
|
"description": "The table name."
|
|
},
|
|
"decimalHandlingMode": {
|
|
"type": "string",
|
|
"description": "Specifies how decimal values are represented by the connector (precise decimal, double, or string).",
|
|
"enum": [
|
|
"Precise",
|
|
"Double",
|
|
"String"
|
|
],
|
|
"x-ms-enum": {
|
|
"name": "DecimalHandlingMode",
|
|
"modelAsString": true,
|
|
"values": [
|
|
{
|
|
"value": "Precise",
|
|
"description": "The decimal handling mode is Precise."
|
|
},
|
|
{
|
|
"value": "Double",
|
|
"description": "The decimal handling mode is Double."
|
|
},
|
|
{
|
|
"value": "String",
|
|
"description": "The decimal handling mode is String."
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"snapshotMode": {
|
|
"type": "string",
|
|
"description": "Specifies how the initial snapshot of data is taken (for example, initial load, initial only, or no data).",
|
|
"enum": [
|
|
"Initial",
|
|
"InitialOnly",
|
|
"NoData"
|
|
],
|
|
"x-ms-enum": {
|
|
"name": "SnapshotMode",
|
|
"modelAsString": true,
|
|
"values": [
|
|
{
|
|
"value": "Initial",
|
|
"description": "The snapshot mode is Initial."
|
|
},
|
|
{
|
|
"value": "InitialOnly",
|
|
"description": "The snapshot mode is InitialOnly."
|
|
},
|
|
{
|
|
"value": "NoData",
|
|
"description": "The snapshot mode is NoData."
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"BaseSQLServerCDCSourceProperties": {
|
|
"type": "object",
|
|
"description": "Base SQL Server CDC source properties. Extends BaseSQLCDCSourceProperties with SQL Server-specific settings.",
|
|
"properties": {
|
|
"excludedColumns": {
|
|
"type": "string",
|
|
"description": "The comma-separated list of columns to exclude from capture."
|
|
},
|
|
"databaseApplicationIntent": {
|
|
"type": "string",
|
|
"description": "Specifies the application intent for the database connection.",
|
|
"enum": [
|
|
"ReadWrite",
|
|
"ReadOnly"
|
|
],
|
|
"x-ms-enum": {
|
|
"name": "DatabaseApplicationIntent",
|
|
"modelAsString": true,
|
|
"values": [
|
|
{
|
|
"value": "ReadWrite",
|
|
"description": "The database application intent is ReadWrite."
|
|
},
|
|
{
|
|
"value": "ReadOnly",
|
|
"description": "The database application intent is ReadOnly."
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"snapshotSelectStatementOverrides": {
|
|
"type": "array",
|
|
"description": "The snapshot select statement overrides. Each entry specifies a table and a custom SELECT statement to use for the initial snapshot.",
|
|
"items": {
|
|
"$ref": "#/definitions/SnapshotSelectStatementOverrideItem"
|
|
}
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/BaseSQLCDCSourceProperties"
|
|
}
|
|
]
|
|
},
|
|
"SnapshotSelectStatementOverrideItem": {
|
|
"type": "object",
|
|
"description": "Represents a snapshot select statement override for a specific table.",
|
|
"required": [
|
|
"tableName",
|
|
"selectStatement"
|
|
],
|
|
"properties": {
|
|
"tableName": {
|
|
"type": "string",
|
|
"description": "The table name."
|
|
},
|
|
"selectStatement": {
|
|
"type": "string",
|
|
"description": "The custom SELECT statement to use for the initial snapshot."
|
|
}
|
|
}
|
|
},
|
|
"MySQLCDCSourceProperties": {
|
|
"type": "object",
|
|
"description": "MySQL CDC source properties.",
|
|
"required": [
|
|
"serverId"
|
|
],
|
|
"properties": {
|
|
"serverId": {
|
|
"type": "integer",
|
|
"description": "The server identifier for the CDC connector."
|
|
},
|
|
"port": {
|
|
"type": "integer",
|
|
"description": "The port number. Default is 3306.",
|
|
"default": 3306
|
|
},
|
|
"snapshotLockingMode": {
|
|
"type": "string",
|
|
"description": "Specifies the locking strategy used when taking the initial snapshot (for example, minimal locks vs extended locking for stronger consistency).",
|
|
"enum": [
|
|
"Minimal",
|
|
"Extended",
|
|
"None"
|
|
],
|
|
"x-ms-enum": {
|
|
"name": "SnapshotLockingMode",
|
|
"modelAsString": true,
|
|
"values": [
|
|
{
|
|
"value": "Minimal",
|
|
"description": "The snapshot locking mode is Minimal."
|
|
},
|
|
{
|
|
"value": "Extended",
|
|
"description": "The snapshot locking mode is Extended."
|
|
},
|
|
{
|
|
"value": "None",
|
|
"description": "The snapshot locking mode is None."
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/BaseSQLCDCSourceProperties"
|
|
}
|
|
]
|
|
},
|
|
"PostgreSQLCDCSourceProperties": {
|
|
"type": "object",
|
|
"description": "PostgreSQL CDC source properties.",
|
|
"required": [
|
|
"slotName"
|
|
],
|
|
"properties": {
|
|
"slotName": {
|
|
"type": "string",
|
|
"description": "The slot name for the CDC connector."
|
|
},
|
|
"port": {
|
|
"type": "integer",
|
|
"description": "The port number. Default is 5432.",
|
|
"default": 5432
|
|
},
|
|
"publicationName": {
|
|
"type": "string",
|
|
"description": "The publication name for the CDC connector."
|
|
},
|
|
"publicationAutoCreateMode": {
|
|
"type": "string",
|
|
"description": "The publication auto-create mode.",
|
|
"enum": [
|
|
"Filtered",
|
|
"AllTables",
|
|
"Disabled"
|
|
],
|
|
"x-ms-enum": {
|
|
"name": "PublicationAutoCreateMode",
|
|
"modelAsString": true,
|
|
"values": [
|
|
{
|
|
"value": "Filtered",
|
|
"description": "The publication auto-create mode is Filtered."
|
|
},
|
|
{
|
|
"value": "AllTables",
|
|
"description": "The publication auto-create mode is AllTables."
|
|
},
|
|
{
|
|
"value": "Disabled",
|
|
"description": "The publication auto-create mode is Disabled."
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"heartbeatActionQuery": {
|
|
"type": "string",
|
|
"description": "The heartbeat action query. A SQL statement executed periodically to keep the replication slot active."
|
|
},
|
|
"snapshotSelectStatementOverrides": {
|
|
"type": "array",
|
|
"description": "The snapshot select statement overrides. Each entry specifies a table and a custom SELECT statement to use for the initial snapshot.",
|
|
"items": {
|
|
"$ref": "#/definitions/SnapshotSelectStatementOverrideItem"
|
|
}
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/BaseSQLCDCSourceProperties"
|
|
}
|
|
]
|
|
},
|
|
"RealTimeWeatherSourceProperties": {
|
|
"type": "object",
|
|
"description": "Real Time Weather source properties.",
|
|
"required": [
|
|
"latitude",
|
|
"longitude"
|
|
],
|
|
"properties": {
|
|
"latitude": {
|
|
"type": "number",
|
|
"description": "The latitude for the weather data."
|
|
},
|
|
"longitude": {
|
|
"type": "number",
|
|
"description": "The longitude for the weather data."
|
|
}
|
|
}
|
|
},
|
|
"GooglePubSubSourceProperties": {
|
|
"type": "object",
|
|
"description": "Google Pub/Sub source properties.",
|
|
"required": [
|
|
"dataConnectionId"
|
|
],
|
|
"properties": {
|
|
"dataConnectionId": {
|
|
"type": "string",
|
|
"description": "The Google Pub/Sub data connection identifier.",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
},
|
|
"HttpSourceProperties": {
|
|
"type": "object",
|
|
"description": "HTTP source properties.",
|
|
"required": [
|
|
"dataConnectionId",
|
|
"method"
|
|
],
|
|
"properties": {
|
|
"dataConnectionId": {
|
|
"type": "string",
|
|
"description": "The HTTP data connection identifier.",
|
|
"format": "uuid"
|
|
},
|
|
"method": {
|
|
"type": "string",
|
|
"description": "The HTTP method. Additional methods may be added over time.",
|
|
"enum": [
|
|
"GET",
|
|
"POST"
|
|
],
|
|
"x-ms-enum": {
|
|
"name": "HttpMethod",
|
|
"modelAsString": true,
|
|
"values": [
|
|
{
|
|
"value": "GET",
|
|
"description": "The HTTP GET method."
|
|
},
|
|
{
|
|
"value": "POST",
|
|
"description": "The HTTP POST method."
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"requestHeaders": {
|
|
"type": "array",
|
|
"description": "The HTTP request headers.",
|
|
"items": {
|
|
"$ref": "common.json#/definitions/KeyStringValuePair"
|
|
}
|
|
},
|
|
"requestParameters": {
|
|
"type": "array",
|
|
"description": "The HTTP request parameters.",
|
|
"items": {
|
|
"$ref": "common.json#/definitions/KeyStringValuePair"
|
|
}
|
|
},
|
|
"requestBody": {
|
|
"type": "string",
|
|
"description": "The HTTP request body."
|
|
},
|
|
"pollIntervalMs": {
|
|
"type": "integer",
|
|
"description": "The polling interval in milliseconds."
|
|
},
|
|
"maxRetries": {
|
|
"type": "integer",
|
|
"description": "The maximum number of retries for failed requests."
|
|
},
|
|
"retryBackoffMs": {
|
|
"type": "integer",
|
|
"description": "The retry backoff time in milliseconds."
|
|
},
|
|
"retriableHttpStatusCodes": {
|
|
"type": "string",
|
|
"description": "The retriable HTTP status codes as a comma-separated string."
|
|
}
|
|
}
|
|
},
|
|
"MongoDBCDCSourceProperties": {
|
|
"type": "object",
|
|
"description": "MongoDB CDC source properties.",
|
|
"required": [
|
|
"dataConnectionId",
|
|
"includedDatabases",
|
|
"includedCollections"
|
|
],
|
|
"properties": {
|
|
"dataConnectionId": {
|
|
"type": "string",
|
|
"description": "The MongoDB CDC data connection identifier.",
|
|
"format": "uuid"
|
|
},
|
|
"includedDatabases": {
|
|
"type": "string",
|
|
"description": "The comma-separated list of regular expressions that match database names to include."
|
|
},
|
|
"includedCollections": {
|
|
"type": "string",
|
|
"description": "The comma-separated list of regular expressions that match collection names to include."
|
|
},
|
|
"snapshotMode": {
|
|
"type": "string",
|
|
"description": "The snapshot mode.",
|
|
"enum": [
|
|
"Initial",
|
|
"InitialOnly",
|
|
"NoData"
|
|
],
|
|
"x-ms-enum": {
|
|
"name": "SnapshotMode",
|
|
"modelAsString": true,
|
|
"values": [
|
|
{
|
|
"value": "Initial",
|
|
"description": "The snapshot mode is Initial."
|
|
},
|
|
{
|
|
"value": "InitialOnly",
|
|
"description": "The snapshot mode is InitialOnly."
|
|
},
|
|
{
|
|
"value": "NoData",
|
|
"description": "The snapshot mode is NoData."
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"MqttSourceProperties": {
|
|
"type": "object",
|
|
"description": "MQTT source properties.",
|
|
"required": [
|
|
"dataConnectionId",
|
|
"serverVersion",
|
|
"topic"
|
|
],
|
|
"properties": {
|
|
"dataConnectionId": {
|
|
"type": "string",
|
|
"description": "The MQTT data connection identifier.",
|
|
"format": "uuid"
|
|
},
|
|
"serverVersion": {
|
|
"type": "string",
|
|
"description": "The MQTT server version.",
|
|
"enum": [
|
|
"V3",
|
|
"V5"
|
|
],
|
|
"x-ms-enum": {
|
|
"name": "ServerVersion",
|
|
"modelAsString": true,
|
|
"values": [
|
|
{
|
|
"value": "V3",
|
|
"description": "The MQTT server version is V3."
|
|
},
|
|
{
|
|
"value": "V5",
|
|
"description": "The MQTT server version is V5."
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"topic": {
|
|
"type": "string",
|
|
"description": "The MQTT topic."
|
|
},
|
|
"tlsSettings": {
|
|
"description": "The TLS settings for the MQTT connection.",
|
|
"$ref": "#/definitions/TLSSettings"
|
|
}
|
|
}
|
|
},
|
|
"FabricJobEventsSourceProperties": {
|
|
"type": "object",
|
|
"description": "Fabric Job Events source properties.",
|
|
"required": [
|
|
"eventScope",
|
|
"workspaceId",
|
|
"itemId"
|
|
],
|
|
"properties": {
|
|
"eventScope": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Tenant",
|
|
"Capacity",
|
|
"Workspace",
|
|
"Item",
|
|
"SubItem"
|
|
],
|
|
"x-ms-enum": {
|
|
"name": "EventScope",
|
|
"modelAsString": true,
|
|
"values": [
|
|
{
|
|
"value": "Tenant",
|
|
"description": "The event scope is Tenant."
|
|
},
|
|
{
|
|
"value": "Capacity",
|
|
"description": "The event scope is Capacity."
|
|
},
|
|
{
|
|
"value": "Workspace",
|
|
"description": "The event scope is Workspace."
|
|
},
|
|
{
|
|
"value": "Item",
|
|
"description": "The event scope is Item."
|
|
},
|
|
{
|
|
"value": "SubItem",
|
|
"description": "The event scope is SubItem."
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"workspaceId": {
|
|
"type": "string",
|
|
"description": "The workspace identifier.",
|
|
"format": "uuid"
|
|
},
|
|
"itemId": {
|
|
"type": "string",
|
|
"description": "The item identifier.",
|
|
"format": "uuid"
|
|
},
|
|
"includedEventTypes": {
|
|
"type": "array",
|
|
"description": "The list of event types to include. Supported values: Microsoft.Fabric.JobEvents.ItemJobCreated, Microsoft.Fabric.JobEvents.ItemJobStatusChanged, Microsoft.Fabric.JobEvents.ItemJobSucceeded, Microsoft.Fabric.JobEvents.ItemJobFailed. Additional event types may be added over time.",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"filters": {
|
|
"type": "object",
|
|
"description": "The advanced filters defined in https://learn.microsoft.com/en-us/azure/event-grid/event-filtering#advanced-filtering."
|
|
}
|
|
}
|
|
},
|
|
"FabricOneLakeEventsSourceProperties": {
|
|
"type": "object",
|
|
"description": "Fabric OneLake Events source properties.",
|
|
"required": [
|
|
"tenantId",
|
|
"workspaceId",
|
|
"itemId",
|
|
"oneLakePaths"
|
|
],
|
|
"properties": {
|
|
"tenantId": {
|
|
"type": "string",
|
|
"description": "The tenant identifier.",
|
|
"format": "uuid"
|
|
},
|
|
"workspaceId": {
|
|
"type": "string",
|
|
"description": "The workspace identifier.",
|
|
"format": "uuid"
|
|
},
|
|
"itemId": {
|
|
"type": "string",
|
|
"description": "The item identifier.",
|
|
"format": "uuid"
|
|
},
|
|
"oneLakePaths": {
|
|
"type": "array",
|
|
"description": "The OneLake paths.",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"includedEventTypes": {
|
|
"type": "array",
|
|
"description": "The list of event types to include. Supported values: Microsoft.Fabric.OneLake.FileCreated, Microsoft.Fabric.OneLake.FileDeleted, Microsoft.Fabric.OneLake.FileRenamed, Microsoft.Fabric.OneLake.FolderCreated, Microsoft.Fabric.OneLake.FolderDeleted, Microsoft.Fabric.OneLake.FolderRenamed. Additional event types may be added over time.",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"filters": {
|
|
"type": "object",
|
|
"description": "The advanced filters defined in https://learn.microsoft.com/en-us/azure/event-grid/event-filtering#advanced-filtering."
|
|
}
|
|
}
|
|
},
|
|
"FabricWorkspaceItemEventsSourceProperties": {
|
|
"type": "object",
|
|
"description": "Fabric Workspace Item Events source properties.",
|
|
"required": [
|
|
"eventScope",
|
|
"workspaceId"
|
|
],
|
|
"properties": {
|
|
"eventScope": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Tenant",
|
|
"Capacity",
|
|
"Workspace",
|
|
"Item",
|
|
"SubItem"
|
|
],
|
|
"x-ms-enum": {
|
|
"name": "EventScope",
|
|
"modelAsString": true,
|
|
"values": [
|
|
{
|
|
"value": "Tenant",
|
|
"description": "The event scope is Tenant."
|
|
},
|
|
{
|
|
"value": "Capacity",
|
|
"description": "The event scope is Capacity."
|
|
},
|
|
{
|
|
"value": "Workspace",
|
|
"description": "The event scope is Workspace."
|
|
},
|
|
{
|
|
"value": "Item",
|
|
"description": "The event scope is Item."
|
|
},
|
|
{
|
|
"value": "SubItem",
|
|
"description": "The event scope is SubItem."
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"workspaceId": {
|
|
"type": "string",
|
|
"description": "The workspace identifier.",
|
|
"format": "uuid"
|
|
},
|
|
"itemId": {
|
|
"type": "string",
|
|
"description": "The item identifier.",
|
|
"format": "uuid"
|
|
},
|
|
"includedEventTypes": {
|
|
"type": "array",
|
|
"description": "The list of event types to include. Supported values: Microsoft.Fabric.ItemCreateSucceeded, Microsoft.Fabric.ItemCreateFailed, Microsoft.Fabric.ItemUpdateSucceeded, Microsoft.Fabric.ItemUpdateFailed, Microsoft.Fabric.ItemDeleteSucceeded, Microsoft.Fabric.ItemDeleteFailed. Additional event types may be added over time.",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"filters": {
|
|
"type": "object",
|
|
"description": "The advanced filters defined in https://learn.microsoft.com/en-us/azure/event-grid/event-filtering#advanced-filtering."
|
|
}
|
|
}
|
|
},
|
|
"TLSSettings": {
|
|
"type": "object",
|
|
"description": "Represents the TLS settings for a source connection.",
|
|
"properties": {
|
|
"trustCACertificate": {
|
|
"description": "The trust CA certificate settings.",
|
|
"$ref": "#/definitions/TrustCACertificate"
|
|
},
|
|
"clientCertificate": {
|
|
"description": "The client certificate settings.",
|
|
"$ref": "#/definitions/ClientCertificate"
|
|
}
|
|
}
|
|
},
|
|
"TrustCACertificate": {
|
|
"type": "object",
|
|
"description": "Represents the trust CA certificate settings.",
|
|
"required": [
|
|
"verifyHostname"
|
|
],
|
|
"properties": {
|
|
"certificate": {
|
|
"description": "The certificate resource.",
|
|
"$ref": "#/definitions/CertificateResource"
|
|
},
|
|
"verifyHostname": {
|
|
"type": "boolean",
|
|
"description": "Determines whether the client verifies the broker's certificate hostname during the TLS handshake. When false, the client can connect even if the broker's certificate does not match its hostname."
|
|
},
|
|
"cipherSuites": {
|
|
"type": "string",
|
|
"description": "The cipher suites to use for the TLS connection."
|
|
}
|
|
}
|
|
},
|
|
"ClientCertificate": {
|
|
"type": "object",
|
|
"description": "Represents the client certificate settings.",
|
|
"properties": {
|
|
"certificate": {
|
|
"description": "The certificate resource.",
|
|
"$ref": "#/definitions/CertificateResource"
|
|
},
|
|
"revocationMode": {
|
|
"type": "string",
|
|
"description": "The TLS certificate revocation mode. Additional modes may be added over time.",
|
|
"enum": [
|
|
"Off",
|
|
"CRL",
|
|
"OCSP",
|
|
"CRLAndOCSP"
|
|
],
|
|
"x-ms-enum": {
|
|
"name": "TLSRevocationMode",
|
|
"modelAsString": true,
|
|
"values": [
|
|
{
|
|
"value": "Off",
|
|
"description": "Revocation checking is disabled."
|
|
},
|
|
{
|
|
"value": "CRL",
|
|
"description": "Revocation checking uses CRL (Certificate Revocation List)."
|
|
},
|
|
{
|
|
"value": "OCSP",
|
|
"description": "Revocation checking uses OCSP (Online Certificate Status Protocol)."
|
|
},
|
|
{
|
|
"value": "CRLAndOCSP",
|
|
"description": "Revocation checking uses both CRL and OCSP."
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"CertificateResource": {
|
|
"type": "object",
|
|
"description": "Base type for certificate resources. Additional types may be added over time.",
|
|
"discriminator": "type",
|
|
"required": [
|
|
"type"
|
|
],
|
|
"properties": {
|
|
"type": {
|
|
"description": "The certificate resource type.",
|
|
"$ref": "#/definitions/CertificateResourceType"
|
|
}
|
|
}
|
|
},
|
|
"CertificateResourceType": {
|
|
"type": "string",
|
|
"description": "The certificate resource type. Additional types may be added over time.",
|
|
"enum": [
|
|
"KeyVault"
|
|
],
|
|
"x-ms-enum": {
|
|
"name": "CertificateResourceType",
|
|
"modelAsString": true,
|
|
"values": [
|
|
{
|
|
"value": "KeyVault",
|
|
"description": "The certificate is stored in Azure Key Vault."
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"KeyVaultCertificateResource": {
|
|
"type": "object",
|
|
"description": "A certificate stored in Azure Key Vault.",
|
|
"x-ms-discriminator-value": "KeyVault",
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/CertificateResource"
|
|
},
|
|
{
|
|
"type": "object",
|
|
"required": [
|
|
"azureKeyVaultResourceId",
|
|
"certificateName"
|
|
],
|
|
"properties": {
|
|
"azureKeyVaultResourceId": {
|
|
"type": "string",
|
|
"description": "The Azure Key Vault resource ID (Azure Resource Manager (ARM) resource ID, not a UUID)."
|
|
},
|
|
"certificateName": {
|
|
"type": "string",
|
|
"description": "The certificate name in the Key Vault."
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|