Topology - Get Eventstream Source

Service:: Eventstream

API Version:: v1

Returns the specified source of the eventstream.

Permissions

The caller must have read permissions for the eventstream.

Required Delegated Scopes

Eventstream.Read.All or Eventstream.ReadWrite.All or Item.Read.All or Item.ReadWrite.All

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity	Support
User	Yes
Service principal and Managed identities	Yes

Interface

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/eventstreams/{eventstreamId}/sources/{sourceId}

URI Parameters

Name	In	Required	Type	Description
eventstreamId	path	True	string (uuid)	The eventstream ID.
sourceId	path	True	string (uuid)	The source ID.
workspaceId	path	True	string (uuid)	The workspace ID.

Responses

Name Type Description

200 OK

Name	Type	Description
200 OK	SourceResponse: AzureEventGridNamespaceSourceResponse AzureEventHubSourceResponse AzureEventHubExtendedSourceResponse AzureIoTHubSourceResponse AzureBlobStorageEventsSourceResponse AzureServiceBusSourceResponse CustomEndpointSourceResponse FabricCapacityOverviewEventsSourceResponse SampleDataSourceResponse SolacePubSubSourceResponse AmazonKinesisSourceResponse AmazonMSKKafkaSourceResponse ApacheKafkaSourceResponse ConfluentCloudSourceResponse AzureCosmosDBCDCSourceResponse AzureDataExplorerSourceResponse AzureSQLDBCDCSourceResponse AzureSQLMIDBCDCSourceResponse SQLServerOnVMDBCDCSourceResponse MySQLCDCSourceResponse PostgreSQLCDCSourceResponse RealTimeWeatherSourceResponse GooglePubSubSourceResponse HttpSourceResponse MongoDBCDCSourceResponse MqttSourceResponse FabricJobEventsSourceResponse FabricOneLakeEventsSourceResponse FabricWorkspaceItemEventsSourceResponse	Request completed successfully.
429 Too Many Requests	ErrorResponse	The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests. Headers Retry-After: integer
Other Status Codes	ErrorResponse	Common error codes: ItemNotFound - The requested item was not found.

SourceResponse:

AzureEventGridNamespaceSourceResponse
AzureEventHubSourceResponse
AzureEventHubExtendedSourceResponse
AzureIoTHubSourceResponse
AzureBlobStorageEventsSourceResponse
AzureServiceBusSourceResponse
CustomEndpointSourceResponse
FabricCapacityOverviewEventsSourceResponse
SampleDataSourceResponse
SolacePubSubSourceResponse
AmazonKinesisSourceResponse
AmazonMSKKafkaSourceResponse
ApacheKafkaSourceResponse
ConfluentCloudSourceResponse
AzureCosmosDBCDCSourceResponse
AzureDataExplorerSourceResponse
AzureSQLDBCDCSourceResponse
AzureSQLMIDBCDCSourceResponse
SQLServerOnVMDBCDCSourceResponse
MySQLCDCSourceResponse
PostgreSQLCDCSourceResponse
RealTimeWeatherSourceResponse
GooglePubSubSourceResponse
HttpSourceResponse
MongoDBCDCSourceResponse
MqttSourceResponse
FabricJobEventsSourceResponse
FabricOneLakeEventsSourceResponse
FabricWorkspaceItemEventsSourceResponse

Request completed successfully.

429 Too Many Requests

ErrorResponse

The service rate limit was exceeded. The server returns a Retry-After header indicating, in seconds, how long the client must wait before sending additional requests.

Headers

Retry-After: integer

Other Status Codes

ErrorResponse

Common error codes:

ItemNotFound - The requested item was not found.

Examples

Get an eventstream source example

Sample request

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/eventstreams/8c500070-073f-4a88-b478-8fabe1941c52/sources/e2886002-d696-4c05-969c-51361365cc24

Sample response

Status code:: 200

{
  "id": "e2886002-d696-4c05-969c-51361365cc24",
  "name": "AzureEventHubSource",
  "type": "AzureEventHub",
  "properties": {
    "dataConnectionId": "9c500070-073f-4a88-b478-8fabe1941c52",
    "consumerGroupName": "$Default",
    "inputSerialization": {
      "type": "Json",
      "properties": {
        "encoding": "UTF8"
      }
    }
  },
  "status": "Running",
  "error": null
}

Definitions

Name	Description
AmazonKinesisSourceProperties	Amazon Kinesis source properties.
AmazonKinesisSourceResponse	Amazon Kinesis source properties response.
AmazonMSKKafkaSourceProperties	Amazon MSK Kafka source properties.
AmazonMSKKafkaSourceResponse	Amazon MSK Kafka source response.
ApacheKafkaSourceProperties	Apache Kafka source properties.
ApacheKafkaSourceResponse	Apache Kafka source response.
AutoOffsetReset	The auto offset reset property. Default is None.
AvroSerializationInfo	Avro serialization information.
AvroSerializationProperties	Avro serialization properties.
AzureBlobStorageEvents	Azure Blob Storage events source.
AzureBlobStorageEventsSourceProperties	Azure Blob Storage events source properties.
AzureBlobStorageEventsSourceResponse	Azure Blob Storage events source response.
AzureCosmosDBCDCSourceProperties	Azure Cosmos DB CDC source properties.
AzureCosmosDBCDCSourceResponse	Azure Cosmos DB CDC source response.
AzureDataExplorerSourceProperties	Azure Data Explorer source properties.
AzureDataExplorerSourceResponse	Azure Data Explorer source response.
AzureEventGridNamespaceSourceProperties	Azure Event Grid Namespace source properties.
AzureEventGridNamespaceSourceResponse	Azure Event Grid Namespace source response.
AzureEventHubExtendedSourceProperties	Azure Event Hub Extended source properties.
AzureEventHubExtendedSourceResponse	Azure Event Hub Extended source response.
AzureEventHubSourceProperties	Azure Event Hub source properties.
AzureEventHubSourceResponse	Azure Event Hub source response.
AzureIoTHubSourceProperties	Azure IoT Hub source properties.
AzureIoTHubSourceResponse	Azure IoT Hub source response.
AzureServiceBusSourceProperties	Azure Service Bus source properties.
AzureServiceBusSourceResponse	Azure Service Bus source response.
AzureSQLDBCDCSourceResponse	Azure SQL DB CDC source response.
AzureSQLMIDBCDCSourceResponse	Azure SQL MI DB CDC source response.
BaseKafkaSourceProperties	Base Kafka source properties.
BaseSQLCDCSourceProperties	Base SQL CDC source properties.
ColumnSchema	Represents the schema of a column.
ConfluentCloudSourceResponse	Confluent Cloud source response.
CsvSerializationInfo	CSV serialization information.
CsvSerializationProperties	CSV serialization properties.
CustomEndpointSourceProperties	Custom endpoint events source properties.
CustomEndpointSourceResponse	Custom endpoint events source response.
DataType	Represents the data type. Additional data types may be added over time.
DecimalHandlingMode	Specifies how decimal values are represented by the connector (precise decimal, double, or string).
Encoding	The encoding type.
ErrorInfo	Represents the error information.
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.
EventScope
FabricCapacityOverviewEventsSourceProperties	Fabric Capacity Overview Events source properties.
FabricCapacityOverviewEventsSourceResponse	Fabric Capacity Overview Events source response.
FabricJobEventsSourceProperties	Fabric Job Events source properties.
FabricJobEventsSourceResponse	Fabric Job Events source response.
FabricOneLakeEventsSourceProperties	Fabric OneLake Events source properties.
FabricOneLakeEventsSourceResponse	Fabric OneLake Events source response.
FabricWorkspaceItemEventsSourceProperties	Fabric Workspace Item Events source properties.
FabricWorkspaceItemEventsSourceResponse	Fabric Workspace Item Events source response.
Format	The format type.
GooglePubSubSourceProperties	Google Pub/Sub source properties.
GooglePubSubSourceResponse	Google Pub/Sub source response.
HttpMethod	The HTTP method. Additional methods may be added over time.
HttpSourceProperties	HTTP source properties.
HttpSourceResponse	HTTP source response.
IncludedEventTypes	The included event types. Additional event types may be added over time.
InputSchema	Represents the input schema of the source, destination, or operator.
JsonSerializationInfo	JSON serialization information.
JsonSerializationProperties	JSON serialization properties.
KeyStringValuePair
MongoDBCDCSourceProperties	MongoDB CDC source properties.
MongoDBCDCSourceResponse	MongoDB CDC source response.
MqttSourceProperties	MQTT source properties.
MqttSourceResponse	MQTT source response.
MySQLCDCSourceProperties	MySQL CDC source properties.
MySQLCDCSourceResponse	MySQL CDC source response.
NodeStatus	The status of the node. Additional node status may be added over time.
OffsetPolicy	The offset policy.
PostgreSQLCDCSourceProperties	PostgreSQL CDC source properties.
PostgreSQLCDCSourceResponse	PostgreSQL CDC source response.
PublicationAutoCreateMode	The publication auto-create mode.
RealTimeWeatherSourceProperties	Real Time Weather source properties.
RealTimeWeatherSourceResponse	Real Time Weather source response.
Region	The Amazon Kinesis region name. Additional regions may be added over time.
SampleDataSourceProperties	Sample data source properties.
SampleDataSourceResponse	Sample data events source response.
SaslMechanism	The SASL mechanism. Additional SASL mechanisms may be added over time.
Schema	Represents the schema of the data.
SecurityProtocol	The security protocol.
SerializationType	The serialization type. Additional serialization types may be added over time.
ServerVersion	The MQTT server version.
SnapshotLockingMode	Specifies the locking strategy used when taking the initial snapshot (for example, minimal locks vs extended locking for stronger consistency).
SnapshotMode	The snapshot mode.
SolacePubSubQueueSourceProperties	Solace PubSub queue source properties.
SolacePubSubSourceResponse	Solace PubSub source response.
SolacePubSubTopicsSourceProperties	Solace PubSub topics source properties.
SourceType	Represents the type of the source. Additional source types may be added over time.
SQLServerOnVMDBCDCSourceResponse	Azure SQL Server on VM DB CDC source response.
StartPosition	The start position in the Azure Event Hub stream.
Type	The sample data type. Additional sample data types may be added over time.

AmazonKinesisSourceProperties

Object

Amazon Kinesis source properties.

Name	Type	Description
dataConnectionId	string (uuid)	The Amazon Kinesis data connection identifier.
region	Region	The Amazon Kinesis region name. Additional regions may be added over time.
startPosition	StartPosition	The start position in the stream.
startTimestamp	string	The start timestamp in ISO 8601 format (for example, '2024-01-15T10:30:00Z'). Required when `startPosition` is `AtTimestamp`.

AmazonKinesisSourceResponse

Object

Amazon Kinesis source properties response.

Name	Type	Description
error	ErrorInfo	The error information.
id	string (uuid)	The unique identifier of the source.
inputSchemas	InputSchema[]	The input schemas of the source.
name	string	The unique name of the source.
properties	AmazonKinesisSourceProperties	The properties of the Amazon Kinesis source.
status	NodeStatus	The status of the node. Additional node status may be added over time.
type	string: AmazonKinesis	The type of the source.

AmazonMSKKafkaSourceProperties

Object

Amazon MSK Kafka source properties.

Name	Type	Default value	Description
autoOffsetReset	AutoOffsetReset	None	The auto offset reset property. Default is None.
consumerGroupName	string		The consumer group name.
dataConnectionId	string (uuid)		The Kafka data connection identifier.
saslMechanism	SaslMechanism		The SASL mechanism. Additional SASL mechanisms may be added over time.
securityProtocol	SecurityProtocol		The security protocol.
topic	string		The Kafka topic.

AmazonMSKKafkaSourceResponse

Object

Amazon MSK Kafka source response.

Name	Type	Description
error	ErrorInfo	The error information.
id	string (uuid)	The unique identifier of the source.
inputSchemas	InputSchema[]	The input schemas of the source.
name	string	The unique name of the source.
properties	AmazonMSKKafkaSourceProperties	The properties of the Amazon MSK Kafka source.
status	NodeStatus	The status of the node. Additional node status may be added over time.
type	string: AmazonMSKKafka	The type of the source.

ApacheKafkaSourceProperties

Object

Apache Kafka source properties.

Name	Type	Default value	Description
autoOffsetReset	AutoOffsetReset	None	The auto offset reset property. Default is None.
consumerGroupName	string		The consumer group name.
dataConnectionId	string (uuid)		The Kafka data connection identifier.
saslMechanism	SaslMechanism		The SASL mechanism. Additional SASL mechanisms may be added over time.
securityProtocol	SecurityProtocol		The security protocol.
topic	string		The Kafka topic.

ApacheKafkaSourceResponse

Object

Apache Kafka source response.

Name	Type	Description
error	ErrorInfo	The error information.
id	string (uuid)	The unique identifier of the source.
inputSchemas	InputSchema[]	The input schemas of the source.
name	string	The unique name of the source.
properties	ApacheKafkaSourceProperties	The properties of the Apache Kafka source.
status	NodeStatus	The status of the node. Additional node status may be added over time.
type	string: ApacheKafka	The type of the source.

AutoOffsetReset

Enumeration

The auto offset reset property. Default is None.

Value	Description
None	The auto offset reset is None.
Earliest	The auto offset reset is Earliest.
Latest	The auto offset reset is Latest.

AvroSerializationInfo

Object

Avro serialization information.

Name	Type	Description
properties	AvroSerializationProperties	Avro serialization properties.
type	string: Avro	The serialization type.

AvroSerializationProperties

Object

Avro serialization properties.

AzureBlobStorageEvents

Object

Azure Blob Storage events source.

Name	Type	Description
azureResourceId	string	The Azure resource identifier of the blob storage.
id	string (uuid)	The unique identifier of the source.
includedEventTypes	IncludedEventTypes[]	The included event types. Additional event types may be added over time.

AzureBlobStorageEventsSourceProperties

Object

Azure Blob Storage events source properties.

Name	Type	Description
azureBlobStorageEvents	AzureBlobStorageEvents[]	The Azure Blob Storage events.
streamEvents	boolean	Indicates whether to stream events.

AzureBlobStorageEventsSourceResponse

Object

Azure Blob Storage events source response.

Name	Type	Description
error	ErrorInfo	The error information.
id	string (uuid)	The unique identifier of the source.
inputSchemas	InputSchema[]	The input schemas of the source.
name	string	The unique name of the source.
properties	AzureBlobStorageEventsSourceProperties	The properties of the Azure Blob Storage events source.
status	NodeStatus	The status of the node. Additional node status may be added over time.
type	string: AzureBlobStorageEvents	The type of the source.

AzureCosmosDBCDCSourceProperties

Object

Azure Cosmos DB CDC source properties.

Name	Type	Description
containerName	string	The container name.
dataConnectionId	string (uuid)	The Azure Cosmos DB CDC data connection identifier.
databaseName	string	The database name.
offsetPolicy	OffsetPolicy	The offset policy.

AzureCosmosDBCDCSourceResponse

Object

Azure Cosmos DB CDC source response.

Name	Type	Description
error	ErrorInfo	The error information.
id	string (uuid)	The unique identifier of the source.
inputSchemas	InputSchema[]	The input schemas of the source.
name	string	The unique name of the source.
properties	AzureCosmosDBCDCSourceProperties	The properties of the Azure Cosmos DB CDC source.
status	NodeStatus	The status of the node. Additional node status may be added over time.
type	string: AzureCosmosDBCDC	The type of the source.

AzureDataExplorerSourceProperties

Object

Azure Data Explorer source properties.

Name	Type	Description
dataConnectionId	string (uuid)	The Azure Data Explorer data connection identifier.
databaseName	string	The database name.
tableNames	string	The list of comma-separated table names.

AzureDataExplorerSourceResponse

Object

Azure Data Explorer source response.

Name	Type	Description
error	ErrorInfo	The error information.
id	string (uuid)	The unique identifier of the source.
inputSchemas	InputSchema[]	The input schemas of the source.
name	string	The unique name of the source.
properties	AzureDataExplorerSourceProperties	The properties of the Azure Data Explorer source.
status	NodeStatus	The status of the node. Additional node status may be added over time.
type	string: AzureDataExplorer	The type of the source.

AzureEventGridNamespaceSourceProperties

Object

Azure Event Grid Namespace source properties.

Name	Type	Description
namespaceResourceId	string	The Azure Event Grid Namespace resource identifier.
topic	string	The topic name.

AzureEventGridNamespaceSourceResponse

Object

Azure Event Grid Namespace source response.

Name	Type	Description
error	ErrorInfo	The error information.
id	string (uuid)	The unique identifier of the source.
inputSchemas	InputSchema[]	The input schemas of the source.
name	string	The unique name of the source.
properties	AzureEventGridNamespaceSourceProperties	The properties of the Azure Event Grid Namespace source.
status	NodeStatus	The status of the node. Additional node status may be added over time.
type	string: AzureEventGridNamespace	The type of the source.

AzureEventHubExtendedSourceProperties

Object

Azure Event Hub Extended source properties.

Name	Type	Description
consumerGroupName	string	The consumer group name.
dataConnectionId	string (uuid)	The Azure Event Hub data connection identifier.
startPosition	StartPosition	The start position in the Azure Event Hub stream.

AzureEventHubExtendedSourceResponse

Object

Azure Event Hub Extended source response.

Name	Type	Description
error	ErrorInfo	The error information.
id	string (uuid)	The unique identifier of the source.
inputSchemas	InputSchema[]	The input schemas of the source.
name	string	The unique name of the source.
properties	AzureEventHubExtendedSourceProperties	The properties of the Azure Event Hub Extended source.
status	NodeStatus	The status of the node. Additional node status may be added over time.
type	string: AzureEventHubExtended	The type of the source.

AzureEventHubSourceProperties

Object

Azure Event Hub source properties.

Name	Type	Description
consumerGroupName	string	The consumer group name.
dataConnectionId	string (uuid)	The Azure Event Hub data connection identifier.
inputSerialization	SerializationInfo: AvroSerializationInfo CsvSerializationInfo JsonSerializationInfo	Serialization information.

AzureEventHubSourceResponse

Object

Azure Event Hub source response.

Name	Type	Description
error	ErrorInfo	The error information.
id	string (uuid)	The unique identifier of the source.
inputSchemas	InputSchema[]	The input schemas of the source.
name	string	The unique name of the source.
properties	AzureEventHubSourceProperties	The properties of the Azure Event Hub source.
status	NodeStatus	The status of the node. Additional node status may be added over time.
type	string: AzureEventHub	The type of the source.

AzureIoTHubSourceProperties

Object

Azure IoT Hub source properties.

Name	Type	Description
consumerGroupName	string	The consumer group name.
dataConnectionId	string (uuid)	The Azure IoT Hub data connection identifier.
inputSerialization	SerializationInfo: AvroSerializationInfo CsvSerializationInfo JsonSerializationInfo	Serialization information.

AzureIoTHubSourceResponse

Object

Azure IoT Hub source response.

Name	Type	Description
error	ErrorInfo	The error information.
id	string (uuid)	The unique identifier of the source.
inputSchemas	InputSchema[]	The input schemas of the source.
name	string	The unique name of the source.
properties	AzureIoTHubSourceProperties	The properties of the Azure IoT Hub source.
status	NodeStatus	The status of the node. Additional node status may be added over time.
type	string: AzureIoTHub	The type of the source.

AzureServiceBusSourceProperties

Object

Azure Service Bus source properties.

Name	Type	Description
dataConnectionId	string (uuid)	The Azure Service Bus data connection identifier.
serviceBusType	enum: Queue Topic	The type of the Azure Service Bus source.
subscriptionName	string	The name of the Azure Service Bus subscription. This property is required when the entity type is `Topic`.
topicOrQueueName	string	The name of the Azure Service Bus topic or queue.

AzureServiceBusSourceResponse

Object

Azure Service Bus source response.

Name	Type	Description
error	ErrorInfo	The error information.
id	string (uuid)	The unique identifier of the source.
inputSchemas	InputSchema[]	The input schemas of the source.
name	string	The unique name of the source.
properties	AzureServiceBusSourceProperties	The properties of the Azure Service Bus source.
status	NodeStatus	The status of the node. Additional node status may be added over time.
type	string: AzureServiceBus	The type of the source.

AzureSQLDBCDCSourceResponse

Object

Azure SQL DB CDC source response.

Name	Type	Description
error	ErrorInfo	The error information.
id	string (uuid)	The unique identifier of the source.
inputSchemas	InputSchema[]	The input schemas of the source.
name	string	The unique name of the source.
properties	BaseSQLCDCSourceProperties	Base SQL CDC source properties.
status	NodeStatus	The status of the node. Additional node status may be added over time.
type	string: AzureSQLDBCDC	The type of the source.

AzureSQLMIDBCDCSourceResponse

Object

Azure SQL MI DB CDC source response.

Name	Type	Description
error	ErrorInfo	The error information.
id	string (uuid)	The unique identifier of the source.
inputSchemas	InputSchema[]	The input schemas of the source.
name	string	The unique name of the source.
properties	BaseSQLCDCSourceProperties	Base SQL CDC source properties.
status	NodeStatus	The status of the node. Additional node status may be added over time.
type	string: AzureSQLMIDBCDC	The type of the source.

BaseKafkaSourceProperties

Object

Base Kafka source properties.

Name	Type	Default value	Description
autoOffsetReset	AutoOffsetReset	None	The auto offset reset property. Default is None.
consumerGroupName	string		The consumer group name.
dataConnectionId	string (uuid)		The Kafka data connection identifier.
topic	string		The Kafka topic.

BaseSQLCDCSourceProperties

Object

Base SQL CDC source properties.

Name	Type	Description
dataConnectionId	string (uuid)	The SQL CDC data connection identifier.
decimalHandlingMode	DecimalHandlingMode	Specifies how decimal values are represented by the connector (precise decimal, double, or string).
tableName	string	The table name.

ColumnSchema

Object

Represents the schema of a column.

Name	Type	Description
fields	ColumnSchema[]	A list of the fields for the record or array data type.
items	ColumnSchema	The schema of the array items.
name	string	The name of the column.
type	DataType	The data type of the column.

ConfluentCloudSourceResponse

Object

Confluent Cloud source response.

Name	Type	Description
error	ErrorInfo	The error information.
id	string (uuid)	The unique identifier of the source.
inputSchemas	InputSchema[]	The input schemas of the source.
name	string	The unique name of the source.
properties	BaseKafkaSourceProperties	Base Kafka source properties.
status	NodeStatus	The status of the node. Additional node status may be added over time.
type	string: ConfluentCloud	The type of the source.

CsvSerializationInfo

Object

CSV serialization information.

Name	Type	Description
properties	CsvSerializationProperties	CSV serialization properties.
type	string: Csv	The serialization type.

CsvSerializationProperties

Object

CSV serialization properties.

Name	Type	Description
encoding	Encoding	The encoding type.
fieldDelimiter	string	The field delimiter.
format	Format	The format type.

CustomEndpointSourceProperties

Object

Custom endpoint events source properties.

CustomEndpointSourceResponse

Object

Custom endpoint events source response.

Name	Type	Description
error	ErrorInfo	The error information.
id	string (uuid)	The unique identifier of the source.
inputSchemas	InputSchema[]	The input schemas of the source.
name	string	The unique name of the source.
properties	CustomEndpointSourceProperties	The properties of the custom endpoint events source.
status	NodeStatus	The status of the node. Additional node status may be added over time.
type	string: CustomEndpoint	The type of the source.

DataType

Enumeration

Represents the data type. Additional data types may be added over time.

Value	Description
BigInt	BigInt data type.
Float	Float data type.
Nvarchar(max)	Nvarchar(max) data type.
DateTime	DateTime data type.
Bit	Bit data type.
Record	Record data type.
Array	Array data type.
Any	Unknown data type.

DecimalHandlingMode

Enumeration

Specifies how decimal values are represented by the connector (precise decimal, double, or string).

Value	Description
Precise	The decimal handling mode is Precise.
Double	The decimal handling mode is Double.
String	The decimal handling mode is String.

Encoding

Enumeration

The encoding type.

Value	Description
UTF8	The encoding type is UTF8.

ErrorInfo

Object

Represents the error information.

Name	Type	Description
errorCode	string	The error code.
errorDetails	string[]	The error details.
errorMessage	string	The error message.

ErrorRelatedResource

Object

The error related resource details object.

Name	Type	Description
resourceId	string	The resource ID that's involved in the error.
resourceType	string	The type of the resource that's involved in the error.

ErrorResponse

Object

The error response.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
isRetriable	boolean	When true, the request can be retried. Use the `Retry-After` response header to determine the delay, if available.
message	string	A human readable representation of the error.
moreDetails	ErrorResponseDetails[]	List of additional error details.
relatedResource	ErrorRelatedResource	The error related resource details.
requestId	string (uuid)	ID of the request associated with the error.

ErrorResponseDetails

Object

The error response details.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
relatedResource	ErrorRelatedResource	The error related resource details.

EventScope

Enumeration

Value	Description
Tenant	The event scope is Tenant.
Capacity	The event scope is Capacity.
Workspace	The event scope is Workspace.
Item	The event scope is Item.
SubItem	The event scope is SubItem.

FabricCapacityOverviewEventsSourceProperties

Object

Fabric Capacity Overview Events source properties.

Name	Type	Description
capacityId	string (uuid)	The capacity identifier.
eventScope	EventScope
filters	object[]	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.
includedEventTypes	string[]	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.

FabricCapacityOverviewEventsSourceResponse

Object

Fabric Capacity Overview Events source response.

Name	Type	Description
error	ErrorInfo	The error information.
id	string (uuid)	The unique identifier of the source.
inputSchemas	InputSchema[]	The input schemas of the source.
name	string	The unique name of the source.
properties	FabricCapacityOverviewEventsSourceProperties	The properties of the Fabric Capacity Overview Events source.
status	NodeStatus	The status of the node. Additional node status may be added over time.
type	string: FabricCapacityOverviewEvents	The type of the source.

FabricJobEventsSourceProperties

Object

Fabric Job Events source properties.

Name	Type	Description
eventScope	EventScope
filters	object	The advanced filters defined in https://learn.microsoft.com/en-us/azure/event-grid/event-filtering#advanced-filtering.
includedEventTypes	string[]	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.
itemId	string (uuid)	The item identifier.
workspaceId	string (uuid)	The workspace identifier.

FabricJobEventsSourceResponse

Object

Fabric Job Events source response.

Name	Type	Description
error	ErrorInfo	The error information.
id	string (uuid)	The unique identifier of the source.
inputSchemas	InputSchema[]	The input schemas of the source.
name	string	The unique name of the source.
properties	FabricJobEventsSourceProperties	The properties of the Fabric Job Events source.
status	NodeStatus	The status of the node. Additional node status may be added over time.
type	string: FabricJobEvents	The type of the source.

FabricOneLakeEventsSourceProperties

Object

Fabric OneLake Events source properties.

Name	Type	Description
filters	object	The advanced filters defined in https://learn.microsoft.com/en-us/azure/event-grid/event-filtering#advanced-filtering.
includedEventTypes	string[]	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.
itemId	string (uuid)	The item identifier.
oneLakePaths	string[]	The OneLake paths.
tenantId	string (uuid)	The tenant identifier.
workspaceId	string (uuid)	The workspace identifier.

FabricOneLakeEventsSourceResponse

Object

Fabric OneLake Events source response.

Name	Type	Description
error	ErrorInfo	The error information.
id	string (uuid)	The unique identifier of the source.
inputSchemas	InputSchema[]	The input schemas of the source.
name	string	The unique name of the source.
properties	FabricOneLakeEventsSourceProperties	The properties of the Fabric OneLake Events source.
status	NodeStatus	The status of the node. Additional node status may be added over time.
type	string: FabricOneLakeEvents	The type of the source.

FabricWorkspaceItemEventsSourceProperties

Object

Fabric Workspace Item Events source properties.

Name	Type	Description
eventScope	EventScope
filters	object	The advanced filters defined in https://learn.microsoft.com/en-us/azure/event-grid/event-filtering#advanced-filtering.
includedEventTypes	string[]	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.
itemId	string (uuid)	The item identifier.
workspaceId	string (uuid)	The workspace identifier.

FabricWorkspaceItemEventsSourceResponse

Object

Fabric Workspace Item Events source response.

Name	Type	Description
error	ErrorInfo	The error information.
id	string (uuid)	The unique identifier of the source.
inputSchemas	InputSchema[]	The input schemas of the source.
name	string	The unique name of the source.
properties	FabricWorkspaceItemEventsSourceProperties	The properties of the Fabric Workspace Item Events source.
status	NodeStatus	The status of the node. Additional node status may be added over time.
type	string: FabricWorkspaceItemEvents	The type of the source.

Format

Enumeration

The format type.

Value	Description
WithHeaders	The format includes headers.
WithoutHeaders	The format does not include headers.

GooglePubSubSourceProperties

Object

Google Pub/Sub source properties.

Name	Type	Description
dataConnectionId	string (uuid)	The Google Pub/Sub data connection identifier.

GooglePubSubSourceResponse

Object

Google Pub/Sub source response.

Name	Type	Description
error	ErrorInfo	The error information.
id	string (uuid)	The unique identifier of the source.
inputSchemas	InputSchema[]	The input schemas of the source.
name	string	The unique name of the source.
properties	GooglePubSubSourceProperties	The properties of the Google Pub/Sub source.
status	NodeStatus	The status of the node. Additional node status may be added over time.
type	string: GooglePubSub	The type of the source.

HttpMethod

Enumeration

The HTTP method. Additional methods may be added over time.

Value	Description
GET	The HTTP GET method.
POST	The HTTP POST method.

HttpSourceProperties

Object

HTTP source properties.

Name	Type	Description
dataConnectionId	string (uuid)	The HTTP data connection identifier.
maxRetries	integer	The maximum number of retries for failed requests.
method	HttpMethod	The HTTP method. Additional methods may be added over time.
pollIntervalMs	integer	The polling interval in milliseconds.
requestBody	string	The HTTP request body.
requestHeaders	KeyStringValuePair[]	The HTTP request headers.
requestParameters	KeyStringValuePair[]	The HTTP request parameters.
retriableHttpStatusCodes	string	The retriable HTTP status codes as a comma-separated string.
retryBackoffMs	integer	The retry backoff time in milliseconds.

HttpSourceResponse

Object

HTTP source response.

Name	Type	Description
error	ErrorInfo	The error information.
id	string (uuid)	The unique identifier of the source.
inputSchemas	InputSchema[]	The input schemas of the source.
name	string	The unique name of the source.
properties	HttpSourceProperties	The properties of the HTTP source.
status	NodeStatus	The status of the node. Additional node status may be added over time.
type	string: Http	The type of the source.

IncludedEventTypes

Enumeration

The included event types. Additional event types may be added over time.

Value	Description
Microsoft.Storage.BlobCreated	Blob created event.
Microsoft.Storage.BlobDeleted	Blob deleted event.
Microsoft.Storage.BlobRenamed	Blob renamed event.
Microsoft.Storage.BlobTierChanged	Blob tier changed event.
Microsoft.Storage.DirectoryCreated	Directory created event.
Microsoft.Storage.DirectoryDeleted	Directory deleted event.
Microsoft.Storage.DirectoryRenamed	Directory renamed event.
Microsoft.Storage.BlobInventoryPolicyCompleted	Blob inventory policy completed event.
Microsoft.Storage.AsyncOperationInitiated	Async operation initiated event.
Microsoft.Storage.LifecyclePolicyCompleted	Lifecycle policy completed event.

InputSchema

Object

Represents the input schema of the source, destination, or operator.

Name	Type	Description
name	string	The name of the input schema.
schema	Schema	Represents the schema of the data.

JsonSerializationInfo

Object

JSON serialization information.

Name	Type	Description
properties	JsonSerializationProperties	JSON serialization properties.
type	string: Json	The serialization type.

JsonSerializationProperties

Object

JSON serialization properties.

Name	Type	Description
encoding	Encoding	The encoding type.

KeyStringValuePair

Object

Name	Type	Description
key	string	The key.
value	string	The value.

MongoDBCDCSourceProperties

Object

MongoDB CDC source properties.

Name	Type	Description
dataConnectionId	string (uuid)	The MongoDB CDC data connection identifier.
includedCollections	string	The comma-separated list of regular expressions that match collection names to include.
includedDatabases	string	The comma-separated list of regular expressions that match database names to include.
snapshotMode	SnapshotMode	The snapshot mode.

MongoDBCDCSourceResponse

Object

MongoDB CDC source response.

Name	Type	Description
error	ErrorInfo	The error information.
id	string (uuid)	The unique identifier of the source.
inputSchemas	InputSchema[]	The input schemas of the source.
name	string	The unique name of the source.
properties	MongoDBCDCSourceProperties	The properties of the MongoDB CDC source.
status	NodeStatus	The status of the node. Additional node status may be added over time.
type	string: MongoDBCDC	The type of the source.

MqttSourceProperties

Object

MQTT source properties.

Name	Type	Description
dataConnectionId	string (uuid)	The MQTT data connection identifier.
serverVersion	ServerVersion	The MQTT server version.
topic	string	The MQTT topic.

MqttSourceResponse

Object

MQTT source response.

Name	Type	Description
error	ErrorInfo	The error information.
id	string (uuid)	The unique identifier of the source.
inputSchemas	InputSchema[]	The input schemas of the source.
name	string	The unique name of the source.
properties	MqttSourceProperties	The properties of the MQTT source.
status	NodeStatus	The status of the node. Additional node status may be added over time.
type	string: Mqtt	The type of the source.

MySQLCDCSourceProperties

Object

MySQL CDC source properties.

Name	Type	Default value	Description
dataConnectionId	string (uuid)		The SQL CDC data connection identifier.
decimalHandlingMode	DecimalHandlingMode		Specifies how decimal values are represented by the connector (precise decimal, double, or string).
port	integer	3306	The port number. Default is 3306.
serverId	integer		The server identifier for the CDC connector.
snapshotLockingMode	SnapshotLockingMode		Specifies the locking strategy used when taking the initial snapshot (for example, minimal locks vs extended locking for stronger consistency).
tableName	string		The table name.

MySQLCDCSourceResponse

Object

MySQL CDC source response.

Name	Type	Description
error	ErrorInfo	The error information.
id	string (uuid)	The unique identifier of the source.
inputSchemas	InputSchema[]	The input schemas of the source.
name	string	The unique name of the source.
properties	MySQLCDCSourceProperties	The properties of the MySQL CDC source.
status	NodeStatus	The status of the node. Additional node status may be added over time.
type	string: MySQLCDC	The type of the source.

NodeStatus

Enumeration

The status of the node. Additional node status may be added over time.

Value	Description
Unknown	The status of the node is unknown.
Creating	The node is being created.
Created	The node has been created.
Updating	The node is being updated.
Running	The node is running.
Paused	The node is paused.
Failed	The node has failed.
Warning	The node has a warning.
Deleting	The node is being deleted.
Pausing	The node is being paused.
Resuming	The node is being resumed.
External	The node status depends on an external service.

OffsetPolicy

Enumeration

The offset policy.

Value	Description
Earliest	The offset policy is Earliest.
Latest	The offset policy is Latest.

PostgreSQLCDCSourceProperties

Object

PostgreSQL CDC source properties.

Name	Type	Default value	Description
dataConnectionId	string (uuid)		The SQL CDC data connection identifier.
decimalHandlingMode	DecimalHandlingMode		Specifies how decimal values are represented by the connector (precise decimal, double, or string).
port	integer	5432	The port number. Default is 5432.
publicationAutoCreateMode	PublicationAutoCreateMode		The publication auto-create mode.
publicationName	string		The publication name for the CDC connector.
slotName	string		The slot name for the CDC connector.
tableName	string		The table name.

PostgreSQLCDCSourceResponse

Object

PostgreSQL CDC source response.

Name	Type	Description
error	ErrorInfo	The error information.
id	string (uuid)	The unique identifier of the source.
inputSchemas	InputSchema[]	The input schemas of the source.
name	string	The unique name of the source.
properties	PostgreSQLCDCSourceProperties	The properties of the PostgreSQL CDC source.
status	NodeStatus	The status of the node. Additional node status may be added over time.
type	string: PostgreSQLCDC	The type of the source.

PublicationAutoCreateMode

Enumeration

The publication auto-create mode.

Value	Description
Filtered	The publication auto-create mode is Filtered.
AllTables	The publication auto-create mode is AllTables.
Disabled	The publication auto-create mode is Disabled.

RealTimeWeatherSourceProperties

Object

Real Time Weather source properties.

Name	Type	Description
latitude	number	The latitude for the weather data.
longitude	number	The longitude for the weather data.

RealTimeWeatherSourceResponse

Object

Real Time Weather source response.

Name	Type	Description
error	ErrorInfo	The error information.
id	string (uuid)	The unique identifier of the source.
inputSchemas	InputSchema[]	The input schemas of the source.
name	string	The unique name of the source.
properties	RealTimeWeatherSourceProperties	The properties of the Real Time Weather source.
status	NodeStatus	The status of the node. Additional node status may be added over time.
type	string: RealTimeWeather	The type of the source.

Region

Enumeration

The Amazon Kinesis region name. Additional regions may be added over time.

Value	Description
af-south-1	Africa (Cape Town) region.
ap-east-1	Asia Pacific (Hong Kong) region.
ap-northeast-1	Asia Pacific (Tokyo) region.
ap-northeast-2	Asia Pacific (Seoul) region.
ap-northeast-3	Asia Pacific (Osaka) region.
ap-south-1	Asia Pacific (Mumbai) region.
ap-south-2	Asia Pacific (Hyderabad) region.
ap-southeast-1	Asia Pacific (Singapore) region.
ap-southeast-2	Asia Pacific (Sydney) region.
ap-southeast-3	Asia Pacific (Jakarta) region.
ap-southeast-4	Asia Pacific (Melbourne) region.
ap-southeast-5	Asia Pacific (Malaysia) region.
ca-central-1	Canada (Central) region.
ca-west-1	Canada West (Calgary) region.
eu-central-1	Europe (Frankfurt) region.
eu-central-2	Europe (Zurich) region.
eu-north-1	Europe (Stockholm) region.
eu-south-1	Europe (Milan) region.
eu-south-2	Europe (Spain) region.
eu-west-1	Europe (Ireland) region.
eu-west-2	Europe (London) region.
eu-west-3	Europe (Paris) region.
il-central-1	Israel (Tel Aviv) region.
me-central-1	Middle East (UAE) region.
me-south-1	Middle East (Bahrain) region.
sa-east-1	South America (São Paulo) region.
us-east-1	US East (N. Virginia) region.
us-east-2	US East (Ohio) region.
us-gov-east-1	AWS GovCloud (US-East) region.
us-gov-west-1	AWS GovCloud (US-West) region.
us-west-1	US West (N. California) region.
us-west-2	US West (Oregon) region.

SampleDataSourceProperties

Object

Sample data source properties.

Name	Type	Description
type	Type	The sample data type. Additional sample data types may be added over time.

SampleDataSourceResponse

Object

Sample data events source response.

Name	Type	Description
error	ErrorInfo	The error information.
id	string (uuid)	The unique identifier of the source.
inputSchemas	InputSchema[]	The input schemas of the source.
name	string	The unique name of the source.
properties	SampleDataSourceProperties	The properties of the sample data events source.
status	NodeStatus	The status of the node. Additional node status may be added over time.
type	string: SampleData	The type of the source.

SaslMechanism

Enumeration

The SASL mechanism. Additional SASL mechanisms may be added over time.

Value	Description
PLAIN	The SASL mechanism is PLAIN.
SCRAM-SHA-256	The SASL mechanism is SCRAM-SHA-256.
SCRAM-SHA-512	The SASL mechanism is SCRAM-SHA-512.

Schema

Object

Represents the schema of the data.

Name	Type	Description
columns	ColumnSchema[]	A list of the columns in the schema.

SecurityProtocol

Enumeration

The security protocol.

Value	Description
SASL_PLAINTEXT	The security protocol is SASL_PLAINTEXT.
PLAINTEXT	The security protocol is PLAINTEXT.
SASL_SSL	The security protocol is SASL_SSL.
SSL	The security protocol is SSL.

SerializationType

Enumeration

The serialization type. Additional serialization types may be added over time.

Value	Description
Avro	The serialization type is Avro.
Json	The serialization type is JSON.
Csv	The serialization type is CSV.

ServerVersion

Enumeration

The MQTT server version.

Value	Description
V3	The MQTT server version is V3.
V5	The MQTT server version is V5.

SnapshotLockingMode

Enumeration

Specifies the locking strategy used when taking the initial snapshot (for example, minimal locks vs extended locking for stronger consistency).

Value	Description
Minimal	The snapshot locking mode is Minimal.
Extended	The snapshot locking mode is Extended.

SnapshotMode

Enumeration

The snapshot mode.

Value	Description
Initial	The snapshot mode is Initial.
InitialOnly	The snapshot mode is InitialOnly.
NoData	The snapshot mode is NoData.

SolacePubSubQueueSourceProperties

Object

Solace PubSub queue source properties.

Name	Type	Description
dataConnectionId	string (uuid)	The Solace PubSub data connection identifier.
mapSolaceProperties	boolean	Indicates whether to map Solace standard message properties to Kafka record headers.
mapUserProperties	boolean	Indicates whether to map user properties from Solace message to Kafka record headers.
messageVpnName	string	The Solace PubSub message VPN name.
pubSubType	string: Queue	The Solace PubSub type.
queue	string	The Solace PubSub queue name.

SolacePubSubSourceResponse

Object

Solace PubSub source response.

Name	Type	Description
error	ErrorInfo	The error information.
id	string (uuid)	The unique identifier of the source.
inputSchemas	InputSchema[]	The input schemas of the source.
name	string	The unique name of the source.
properties	SolacePubSubSourceProperties: SolacePubSubQueueSourceProperties SolacePubSubTopicsSourceProperties	The properties of the Solace PubSub source.
status	NodeStatus	The status of the node. Additional node status may be added over time.
type	string: SolacePubSub	The type of the source.

SolacePubSubTopicsSourceProperties

Object

Solace PubSub topics source properties.

Name	Type	Description
dataConnectionId	string (uuid)	The Solace PubSub data connection identifier.
mapSolaceProperties	boolean	Indicates whether to map Solace standard message properties to Kafka record headers.
mapUserProperties	boolean	Indicates whether to map user properties from Solace message to Kafka record headers.
messageVpnName	string	The Solace PubSub message VPN name.
pubSubType	string: Topics	The Solace PubSub type.
topics	string[]	The Solace PubSub topics.

SourceType

Enumeration

Represents the type of the source. Additional source types may be added over time.

Value	Description
AmazonKinesis	The Amazon Kinesis source type.
AmazonMSKKafka	The Amazon MSK Kafka source type.
ApacheKafka	The Apache Kafka source type.
AzureBlobStorageEvents	The Azure Blob Storage Events source type.
AzureCosmosDBCDC	The Azure Cosmos DB CDC source type.
AzureDataExplorer	The Azure Data Explorer source type.
AzureEventGridNamespace	The Azure Event Grid Namespace source type.
AzureEventHub	The Azure Event Hub source type.
AzureEventHubExtended	The Azure Event Hub Extended source type.
AzureIoTHub	The Azure IoT Hub source type.
AzureSQLDBCDC	The Azure SQL DB CDC source type.
AzureSQLMIDBCDC	The Azure SQL MI DB CDC source type.
AzureServiceBus	The Azure Service Bus source type.
ConfluentCloud	The Confluent Cloud source type.
CustomEndpoint	The Custom Endpoint source type.
FabricCapacityOverviewEvents	The Fabric Capacity Overview Events source type.
FabricJobEvents	The Fabric Job Events source type.
FabricOneLakeEvents	The Fabric OneLake Events source type.
FabricWorkspaceItemEvents	The Fabric Workspace Item Events source type.
GooglePubSub	The Google PubSub source type.
Http	The HTTP source type.
MongoDBCDC	The MongoDB CDC source type.
Mqtt	The MQTT source type.
MySQLCDC	The MySQL CDC source type.
PostgreSQLCDC	The PostgreSQL CDC source type.
RealTimeWeather	The Real Time Weather source type.
SQLServerOnVMDBCDC	The SQL Server on VM DB CDC source type.
SampleData	The Sample Data source type.
SolacePubSub	The Solace PubSub source type.

SQLServerOnVMDBCDCSourceResponse

Object

Azure SQL Server on VM DB CDC source response.

Name	Type	Description
error	ErrorInfo	The error information.
id	string (uuid)	The unique identifier of the source.
inputSchemas	InputSchema[]	The input schemas of the source.
name	string	The unique name of the source.
properties	BaseSQLCDCSourceProperties	Base SQL CDC source properties.
status	NodeStatus	The status of the node. Additional node status may be added over time.
type	string: SQLServerOnVMDBCDC	The type of the source.

StartPosition

Enumeration

The start position in the Azure Event Hub stream.

Value	Description
Earliest	Start from the earliest event.
Latest	Start from the latest event.

Type

Enumeration

The sample data type. Additional sample data types may be added over time.

Value	Description
YellowTaxi	Yellow Taxi sample data.
StockMarket	Stock Market sample data.
Bicycles	Bicycles sample data.
Buses	Buses sample data.
SP500Stocks	S&P 500 Stocks sample data.
SemanticModelLogs	Semantic Model Logs sample data.