Data Connections - Create Or Update
Creates or updates a data connection.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/dataConnections/{dataConnectionName}?api-version=2023-08-15
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
cluster
|
path | True |
string |
The name of the Kusto cluster. Regex pattern: |
database
|
path | True |
string |
The name of the database in the Kusto cluster. Regex pattern: |
data
|
path | True |
string |
The name of the data connection. Regex pattern: |
resource
|
path | True |
string |
The name of the resource group. The name is case insensitive. |
subscription
|
path | True |
string |
The ID of the target subscription. |
api-version
|
query | True |
string |
The API version to use for this operation. |
Request Body
The request body can be one of the following:
Name | Description |
---|---|
Cosmos |
Class representing a CosmosDb data connection. |
Event |
Class representing an Event Grid data connection. |
Event |
Class representing an event hub data connection. |
Iot |
Class representing an iot hub data connection. |
CosmosDbDataConnection
Class representing a CosmosDb data connection.
Name | Required | Type | Description |
---|---|---|---|
kind | True |
string:
Cosmos |
Kind of the endpoint for the data connection |
properties.cosmosDbAccountResourceId | True |
string |
The resource ID of the Cosmos DB account used to create the data connection. |
properties.cosmosDbContainer | True |
string |
The name of an existing container in the Cosmos DB database. |
properties.cosmosDbDatabase | True |
string |
The name of an existing database in the Cosmos DB account. |
properties.managedIdentityResourceId | True |
string |
The resource ID of a managed system or user-assigned identity. The identity is used to authenticate with Cosmos DB. |
properties.tableName | True |
string |
The case-sensitive name of the existing target table in your cluster. Retrieved data is ingested into this table. |
location |
string |
Resource location. |
|
properties.mappingRuleName |
string |
The name of an existing mapping rule to use when ingesting the retrieved data. |
|
properties.retrievalStartDate |
string |
Optional. If defined, the data connection retrieves Cosmos DB documents created or updated after the specified retrieval start date. |
EventGridDataConnection
Class representing an Event Grid data connection.
Name | Required | Type | Description |
---|---|---|---|
kind | True |
string:
Event |
Kind of the endpoint for the data connection |
properties.consumerGroup | True |
string |
The event hub consumer group. |
properties.eventHubResourceId | True |
string |
The resource ID where the event grid is configured to send events. |
properties.storageAccountResourceId | True |
string |
The resource ID of the storage account where the data resides. |
location |
string |
Resource location. |
|
properties.blobStorageEventType |
The name of blob storage event type to process. |
||
properties.dataFormat |
The data format of the message. Optionally the data format can be added to each message. |
||
properties.databaseRouting |
Indication for database routing information from the data connection, by default only database routing information is allowed |
||
properties.eventGridResourceId |
string |
The resource ID of the event grid that is subscribed to the storage account events. |
|
properties.ignoreFirstRecord |
boolean |
A Boolean value that, if set to true, indicates that ingestion should ignore the first record of every file |
|
properties.managedIdentityResourceId |
string |
The resource ID of a managed identity (system or user assigned) to be used to authenticate with event hub and storage account. |
|
properties.mappingRuleName |
string |
The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. |
|
properties.tableName |
string |
The table where the data should be ingested. Optionally the table information can be added to each message. |
EventHubDataConnection
Class representing an event hub data connection.
Name | Required | Type | Description |
---|---|---|---|
kind | True |
string:
Event |
Kind of the endpoint for the data connection |
properties.consumerGroup | True |
string |
The event hub consumer group. |
properties.eventHubResourceId | True |
string |
The resource ID of the event hub to be used to create a data connection. |
location |
string |
Resource location. |
|
properties.compression |
The event hub messages compression type |
||
properties.dataFormat |
The data format of the message. Optionally the data format can be added to each message. |
||
properties.databaseRouting |
Indication for database routing information from the data connection, by default only database routing information is allowed |
||
properties.eventSystemProperties |
string[] |
System properties of the event hub |
|
properties.managedIdentityResourceId |
string |
The resource ID of a managed identity (system or user assigned) to be used to authenticate with event hub. |
|
properties.mappingRuleName |
string |
The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. |
|
properties.retrievalStartDate |
string |
When defined, the data connection retrieves existing Event hub events created since the Retrieval start date. It can only retrieve events retained by the Event hub, based on its retention period. |
|
properties.tableName |
string |
The table where the data should be ingested. Optionally the table information can be added to each message. |
IotHubDataConnection
Class representing an iot hub data connection.
Name | Required | Type | Description |
---|---|---|---|
kind | True |
string:
Iot |
Kind of the endpoint for the data connection |
properties.consumerGroup | True |
string |
The iot hub consumer group. |
properties.iotHubResourceId | True |
string |
The resource ID of the Iot hub to be used to create a data connection. |
properties.sharedAccessPolicyName | True |
string |
The name of the share access policy |
location |
string |
Resource location. |
|
properties.dataFormat |
The data format of the message. Optionally the data format can be added to each message. |
||
properties.databaseRouting |
Indication for database routing information from the data connection, by default only database routing information is allowed |
||
properties.eventSystemProperties |
string[] |
System properties of the iot hub |
|
properties.mappingRuleName |
string |
The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. |
|
properties.retrievalStartDate |
string |
When defined, the data connection retrieves existing Event hub events created since the Retrieval start date. It can only retrieve events retained by the Event hub, based on its retention period. |
|
properties.tableName |
string |
The table where the data should be ingested. Optionally the table information can be added to each message. |
Responses
Name | Type | Description |
---|---|---|
200 OK | DataConnection: |
Successfully updated the data connection. |
201 Created | DataConnection: |
Successfully created the data connection. |
202 Accepted | DataConnection: |
Accepted the create data connection request. Headers Azure-AsyncOperation: string |
Other Status Codes |
Error response describing why the operation failed. |
Examples
Kusto |
Kusto |
Kusto |
KustoDataConnectionsCosmosDbCreateOrUpdate
Sample Request
PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/clusters/kustoCluster/databases/KustoDatabase1/dataConnections/dataConnectionTest?api-version=2023-08-15
{
"location": "westus",
"kind": "CosmosDb",
"properties": {
"tableName": "TestTable",
"mappingRuleName": "TestMapping",
"managedIdentityResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.ManagedIdentity/userAssignedIdentities/managedidentityTest1",
"cosmosDbAccountResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.DocumentDb/databaseAccounts/cosmosDbAccountTest1",
"cosmosDbDatabase": "cosmosDbDatabaseTest",
"cosmosDbContainer": "cosmosDbContainerTest",
"retrievalStartDate": "2022-07-29T12:00:00.6554616Z"
}
}
Sample Response
Azure-AsyncOperation: https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789098/providers/Microsoft.Kusto/locations/westus/operationResults/742bef43-608b-4b58-ba96-6f7a32ec5f0f?api-version=2022-12-29
{
"id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/KustoDatabase1/DataConnections/dataConnectionTest",
"name": "kustoCluster/KustoDatabase1/dataConnectionTest",
"type": "Microsoft.Kusto/Clusters/Databases/DataConnections",
"location": "westus",
"kind": "CosmosDb",
"properties": {
"tableName": "TestTable",
"mappingRuleName": "TestMapping",
"managedIdentityResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.ManagedIdentity/userAssignedIdentities/managedidentityTest1",
"managedIdentityObjectId": "87654321-1234-1234-1234-123456789123",
"cosmosDbAccountResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.DocumentDb/databaseAccounts/cosmosDbAccountTest1",
"cosmosDbDatabase": "cosmosDbDatabaseTest",
"cosmosDbContainer": "cosmosDbContainerTest",
"retrievalStartDate": "2022-07-29T12:00:00.6554616Z"
}
}
Azure-AsyncOperation: https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789098/providers/Microsoft.Kusto/locations/westus/operationResults/742bef43-608b-4b58-ba96-6f7a32ec5f0f?api-version=2022-12-29
{
"id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/KustoDatabase1/DataConnections/dataConnectionTest",
"name": "kustoCluster/KustoDatabase1/dataConnectionTest",
"type": "Microsoft.Kusto/Clusters/Databases/DataConnections",
"location": "westus",
"kind": "CosmosDb",
"properties": {
"tableName": "TestTable",
"mappingRuleName": "TestMapping",
"managedIdentityResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.ManagedIdentity/userAssignedIdentities/managedidentityTest1",
"managedIdentityObjectId": "87654321-1234-1234-1234-123456789123",
"cosmosDbAccountResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.DocumentDb/databaseAccounts/cosmosDbAccountTest1",
"cosmosDbDatabase": "cosmosDbDatabaseTest",
"cosmosDbContainer": "cosmosDbContainerTest",
"retrievalStartDate": "2022-07-29T12:00:00.6554616Z"
}
}
Azure-AsyncOperation: https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789098/providers/Microsoft.Kusto/locations/westus/operationResults/742bef43-608b-4b58-ba96-6f7a32ec5f0f?api-version=2022-12-29
{
"id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/KustoDatabase1/DataConnections/dataConnectionTest",
"name": "kustoCluster/KustoDatabase1/dataConnectionTest",
"type": "Microsoft.Kusto/Clusters/Databases/DataConnections",
"location": "westus",
"kind": "CosmosDb",
"properties": {
"tableName": "TestTable",
"mappingRuleName": "TestMapping",
"managedIdentityResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.ManagedIdentity/userAssignedIdentities/managedidentityTest1",
"managedIdentityObjectId": "87654321-1234-1234-1234-123456789123",
"cosmosDbAccountResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.DocumentDb/databaseAccounts/cosmosDbAccountTest1",
"cosmosDbDatabase": "cosmosDbDatabaseTest",
"cosmosDbContainer": "cosmosDbContainerTest",
"retrievalStartDate": "2022-07-29T12:00:00.6554616Z"
}
}
KustoDataConnectionsCreateOrUpdate
Sample Request
PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/clusters/kustoCluster/databases/KustoDatabase8/dataConnections/dataConnectionTest?api-version=2023-08-15
{
"location": "westus",
"kind": "EventHub",
"properties": {
"eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1",
"managedIdentityResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.ManagedIdentity/userAssignedIdentities/managedidentityTest1",
"consumerGroup": "testConsumerGroup1"
}
}
Sample Response
{
"id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/KustoDatabase8/DataConnections/dataConnectionTest",
"name": "kustoCluster/KustoDatabase8/dataConnectionTest",
"type": "Microsoft.Kusto/Clusters/Databases/DataConnections",
"location": "westus",
"kind": "EventHub",
"properties": {
"eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1",
"managedIdentityResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.ManagedIdentity/userAssignedIdentities/managedidentityTest1",
"consumerGroup": "testConsumerGroup1",
"compression": "None"
}
}
{
"id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/KustoDatabase8/DataConnections/dataConnectionTest",
"name": "kustoCluster/KustoDatabase8/dataConnectionTest",
"type": "Microsoft.Kusto/Clusters/Databases/DataConnections",
"location": "westus",
"kind": "EventHub",
"properties": {
"eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1",
"managedIdentityResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.ManagedIdentity/userAssignedIdentities/managedidentityTest1",
"consumerGroup": "testConsumerGroup1",
"compression": "None"
}
}
{
"id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/KustoDatabase8/DataConnections/dataConnectionTest",
"name": "kustoCluster/KustoDatabase8/dataConnectionTest",
"type": "Microsoft.Kusto/Clusters/Databases/DataConnections",
"location": "westus",
"kind": "EventHub",
"properties": {
"eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1",
"managedIdentityResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.ManagedIdentity/userAssignedIdentities/managedidentityTest1",
"consumerGroup": "testConsumerGroup1",
"compression": "None"
}
}
KustoDataConnectionsEventGridCreateOrUpdate
Sample Request
PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/clusters/kustoCluster/databases/KustoDatabase8/dataConnections/dataConnectionTest?api-version=2023-08-15
{
"location": "westus",
"kind": "EventGrid",
"properties": {
"ignoreFirstRecord": false,
"storageAccountResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Storage/storageAccounts/teststorageaccount",
"eventGridResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Storage/storageAccounts/teststorageaccount/providers/Microsoft.EventGrid/eventSubscriptions/eventSubscriptionTest",
"eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest2",
"consumerGroup": "$Default",
"tableName": "TestTable",
"mappingRuleName": "TestMapping",
"dataFormat": "JSON",
"blobStorageEventType": "Microsoft.Storage.BlobCreated",
"managedIdentityResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.ManagedIdentity/userAssignedIdentities/managedidentityTest1",
"databaseRouting": "Single"
}
}
Sample Response
{
"id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/KustoDatabase8/DataConnections/KustoDataConnection9",
"name": "kustoCluster/KustoDatabase8/dataConnectionTest",
"type": "Microsoft.Kusto/Clusters/Databases/DataConnections",
"location": "westus",
"kind": "EventGrid",
"properties": {
"ignoreFirstRecord": false,
"storageAccountResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Storage/storageAccounts/teststorageaccount",
"eventGridResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Storage/storageAccounts/teststorageaccount/providers/Microsoft.EventGrid/eventSubscriptions/eventSubscriptionTest",
"eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest2",
"consumerGroup": "$Default",
"tableName": "TestTable",
"mappingRuleName": "TestMapping",
"dataFormat": "JSON",
"blobStorageEventType": "Microsoft.Storage.BlobCreated",
"managedIdentityResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.ManagedIdentity/userAssignedIdentities/managedidentityTest1",
"managedIdentityObjectId": "87654321-1234-1234-1234-123456789123",
"databaseRouting": "Single"
}
}
{
"id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/KustoDatabase8/DataConnections/KustoDataConnection9",
"name": "kustoCluster/KustoDatabase8/dataConnectionTest",
"type": "Microsoft.Kusto/Clusters/Databases/DataConnections",
"location": "westus",
"kind": "EventGrid",
"properties": {
"ignoreFirstRecord": false,
"storageAccountResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Storage/storageAccounts/teststorageaccount",
"eventGridResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Storage/storageAccounts/teststorageaccount/providers/Microsoft.EventGrid/eventSubscriptions/eventSubscriptionTest",
"eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest2",
"consumerGroup": "$Default",
"tableName": "TestTable",
"mappingRuleName": "TestMapping",
"dataFormat": "JSON",
"blobStorageEventType": "Microsoft.Storage.BlobCreated",
"managedIdentityResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.ManagedIdentity/userAssignedIdentities/managedidentityTest1",
"managedIdentityObjectId": "87654321-1234-1234-1234-123456789123",
"databaseRouting": "Single"
}
}
{
"id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/KustoDatabase8/DataConnections/KustoDataConnection9",
"name": "kustoCluster/KustoDatabase8/dataConnectionTest",
"type": "Microsoft.Kusto/Clusters/Databases/DataConnections",
"location": "westus",
"kind": "EventGrid",
"properties": {
"ignoreFirstRecord": false,
"storageAccountResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Storage/storageAccounts/teststorageaccount",
"eventGridResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Storage/storageAccounts/teststorageaccount/providers/Microsoft.EventGrid/eventSubscriptions/eventSubscriptionTest",
"eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest2",
"consumerGroup": "$Default",
"tableName": "TestTable",
"mappingRuleName": "TestMapping",
"dataFormat": "JSON",
"blobStorageEventType": "Microsoft.Storage.BlobCreated",
"managedIdentityResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.ManagedIdentity/userAssignedIdentities/managedidentityTest1",
"managedIdentityObjectId": "87654321-1234-1234-1234-123456789123",
"databaseRouting": "Single"
}
}
Definitions
Name | Description |
---|---|
blob |
The name of blob storage event type to process. |
compression |
The event hub messages compression type |
Cosmos |
Class representing a CosmosDb data connection. |
Database |
Indication for database routing information from the data connection, by default only database routing information is allowed |
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Error response |
Event |
Class representing an Event Grid data connection. |
event |
The data format of the message. Optionally the data format can be added to each message. |
Event |
Class representing an event hub data connection. |
event |
The data format of the message. Optionally the data format can be added to each message. |
Iot |
Class representing an iot hub data connection. |
iot |
The data format of the message. Optionally the data format can be added to each message. |
Provisioning |
The provisioned state of the resource. |
blobStorageEventType
The name of blob storage event type to process.
Name | Type | Description |
---|---|---|
Microsoft.Storage.BlobCreated |
string |
|
Microsoft.Storage.BlobRenamed |
string |
compression
The event hub messages compression type
Name | Type | Description |
---|---|---|
GZip |
string |
|
None |
string |
CosmosDbDataConnection
Class representing a CosmosDb data connection.
Name | Type | Description |
---|---|---|
id |
string |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
kind |
string:
Cosmos |
Kind of the endpoint for the data connection |
location |
string |
Resource location. |
name |
string |
The name of the resource |
properties.cosmosDbAccountResourceId |
string |
The resource ID of the Cosmos DB account used to create the data connection. |
properties.cosmosDbContainer |
string |
The name of an existing container in the Cosmos DB database. |
properties.cosmosDbDatabase |
string |
The name of an existing database in the Cosmos DB account. |
properties.managedIdentityObjectId |
string |
The object ID of the managed identity resource. |
properties.managedIdentityResourceId |
string |
The resource ID of a managed system or user-assigned identity. The identity is used to authenticate with Cosmos DB. |
properties.mappingRuleName |
string |
The name of an existing mapping rule to use when ingesting the retrieved data. |
properties.provisioningState |
The provisioned state of the resource. |
|
properties.retrievalStartDate |
string |
Optional. If defined, the data connection retrieves Cosmos DB documents created or updated after the specified retrieval start date. |
properties.tableName |
string |
The case-sensitive name of the existing target table in your cluster. Retrieved data is ingested into this table. |
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
DatabaseRouting
Indication for database routing information from the data connection, by default only database routing information is allowed
Name | Type | Description |
---|---|---|
Multi |
string |
|
Single |
string |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
ErrorDetail
The error detail.
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
ErrorResponse
Error response
Name | Type | Description |
---|---|---|
error |
The error object. |
EventGridDataConnection
Class representing an Event Grid data connection.
Name | Type | Default Value | Description |
---|---|---|---|
id |
string |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
|
kind |
string:
Event |
Kind of the endpoint for the data connection |
|
location |
string |
Resource location. |
|
name |
string |
The name of the resource |
|
properties.blobStorageEventType |
The name of blob storage event type to process. |
||
properties.consumerGroup |
string |
The event hub consumer group. |
|
properties.dataFormat |
The data format of the message. Optionally the data format can be added to each message. |
||
properties.databaseRouting | Single |
Indication for database routing information from the data connection, by default only database routing information is allowed |
|
properties.eventGridResourceId |
string |
The resource ID of the event grid that is subscribed to the storage account events. |
|
properties.eventHubResourceId |
string |
The resource ID where the event grid is configured to send events. |
|
properties.ignoreFirstRecord |
boolean |
A Boolean value that, if set to true, indicates that ingestion should ignore the first record of every file |
|
properties.managedIdentityObjectId |
string |
The object ID of managedIdentityResourceId |
|
properties.managedIdentityResourceId |
string |
The resource ID of a managed identity (system or user assigned) to be used to authenticate with event hub and storage account. |
|
properties.mappingRuleName |
string |
The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. |
|
properties.provisioningState |
The provisioned state of the resource. |
||
properties.storageAccountResourceId |
string |
The resource ID of the storage account where the data resides. |
|
properties.tableName |
string |
The table where the data should be ingested. Optionally the table information can be added to each message. |
|
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
eventGridDataFormat
The data format of the message. Optionally the data format can be added to each message.
Name | Type | Description |
---|---|---|
APACHEAVRO |
string |
|
AVRO |
string |
|
CSV |
string |
|
JSON |
string |
|
MULTIJSON |
string |
|
ORC |
string |
|
PARQUET |
string |
|
PSV |
string |
|
RAW |
string |
|
SCSV |
string |
|
SINGLEJSON |
string |
|
SOHSV |
string |
|
TSV |
string |
|
TSVE |
string |
|
TXT |
string |
|
W3CLOGFILE |
string |
EventHubDataConnection
Class representing an event hub data connection.
Name | Type | Default Value | Description |
---|---|---|---|
id |
string |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
|
kind |
string:
Event |
Kind of the endpoint for the data connection |
|
location |
string |
Resource location. |
|
name |
string |
The name of the resource |
|
properties.compression | None |
The event hub messages compression type |
|
properties.consumerGroup |
string |
The event hub consumer group. |
|
properties.dataFormat |
The data format of the message. Optionally the data format can be added to each message. |
||
properties.databaseRouting | Single |
Indication for database routing information from the data connection, by default only database routing information is allowed |
|
properties.eventHubResourceId |
string |
The resource ID of the event hub to be used to create a data connection. |
|
properties.eventSystemProperties |
string[] |
System properties of the event hub |
|
properties.managedIdentityObjectId |
string |
The object ID of the managedIdentityResourceId |
|
properties.managedIdentityResourceId |
string |
The resource ID of a managed identity (system or user assigned) to be used to authenticate with event hub. |
|
properties.mappingRuleName |
string |
The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. |
|
properties.provisioningState |
The provisioned state of the resource. |
||
properties.retrievalStartDate |
string |
When defined, the data connection retrieves existing Event hub events created since the Retrieval start date. It can only retrieve events retained by the Event hub, based on its retention period. |
|
properties.tableName |
string |
The table where the data should be ingested. Optionally the table information can be added to each message. |
|
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
eventHubDataFormat
The data format of the message. Optionally the data format can be added to each message.
Name | Type | Description |
---|---|---|
APACHEAVRO |
string |
|
AVRO |
string |
|
CSV |
string |
|
JSON |
string |
|
MULTIJSON |
string |
|
ORC |
string |
|
PARQUET |
string |
|
PSV |
string |
|
RAW |
string |
|
SCSV |
string |
|
SINGLEJSON |
string |
|
SOHSV |
string |
|
TSV |
string |
|
TSVE |
string |
|
TXT |
string |
|
W3CLOGFILE |
string |
IotHubDataConnection
Class representing an iot hub data connection.
Name | Type | Default Value | Description |
---|---|---|---|
id |
string |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
|
kind |
string:
Iot |
Kind of the endpoint for the data connection |
|
location |
string |
Resource location. |
|
name |
string |
The name of the resource |
|
properties.consumerGroup |
string |
The iot hub consumer group. |
|
properties.dataFormat |
The data format of the message. Optionally the data format can be added to each message. |
||
properties.databaseRouting | Single |
Indication for database routing information from the data connection, by default only database routing information is allowed |
|
properties.eventSystemProperties |
string[] |
System properties of the iot hub |
|
properties.iotHubResourceId |
string |
The resource ID of the Iot hub to be used to create a data connection. |
|
properties.mappingRuleName |
string |
The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. |
|
properties.provisioningState |
The provisioned state of the resource. |
||
properties.retrievalStartDate |
string |
When defined, the data connection retrieves existing Event hub events created since the Retrieval start date. It can only retrieve events retained by the Event hub, based on its retention period. |
|
properties.sharedAccessPolicyName |
string |
The name of the share access policy |
|
properties.tableName |
string |
The table where the data should be ingested. Optionally the table information can be added to each message. |
|
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
iotHubDataFormat
The data format of the message. Optionally the data format can be added to each message.
Name | Type | Description |
---|---|---|
APACHEAVRO |
string |
|
AVRO |
string |
|
CSV |
string |
|
JSON |
string |
|
MULTIJSON |
string |
|
ORC |
string |
|
PARQUET |
string |
|
PSV |
string |
|
RAW |
string |
|
SCSV |
string |
|
SINGLEJSON |
string |
|
SOHSV |
string |
|
TSV |
string |
|
TSVE |
string |
|
TXT |
string |
|
W3CLOGFILE |
string |
ProvisioningState
The provisioned state of the resource.
Name | Type | Description |
---|---|---|
Canceled |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Moving |
string |
|
Running |
string |
|
Succeeded |
string |