CosmosDbDataConnectionProperties interface

Package:

@azure/arm-kusto

Class representing the Kusto CosmosDb data connection properties.

Properties

cosmosDbAccountResourceId	The resource ID of the Cosmos DB account used to create the data connection.
cosmosDbContainer	The name of an existing container in the Cosmos DB database.
cosmosDbDatabase	The name of an existing database in the Cosmos DB account.
managedIdentityObjectId	The object ID of the managed identity resource.
managedIdentityResourceId	The resource ID of a managed system or user-assigned identity. The identity is used to authenticate with Cosmos DB.
mappingRuleName	The name of an existing mapping rule to use when ingesting the retrieved data.
provisioningState	The provisioned state of the resource.
retrievalStartDate	Optional. If defined, the data connection retrieves Cosmos DB documents created or updated after the specified retrieval start date.
tableName	The case-sensitive name of the existing target table in your cluster. Retrieved data is ingested into this table.

Property Details

cosmosDbAccountResourceId

The resource ID of the Cosmos DB account used to create the data connection.

cosmosDbAccountResourceId: string

Property Value

string

cosmosDbContainer

The name of an existing container in the Cosmos DB database.

cosmosDbContainer: string

Property Value

string

cosmosDbDatabase

The name of an existing database in the Cosmos DB account.

cosmosDbDatabase: string

Property Value

string

managedIdentityObjectId

The object ID of the managed identity resource.

managedIdentityObjectId?: string

Property Value

string

managedIdentityResourceId

The resource ID of a managed system or user-assigned identity. The identity is used to authenticate with Cosmos DB.

managedIdentityResourceId: string

Property Value

string

mappingRuleName

The name of an existing mapping rule to use when ingesting the retrieved data.

mappingRuleName?: string

Property Value

string

provisioningState

The provisioned state of the resource.

provisioningState?: string

Property Value

string

retrievalStartDate

Optional. If defined, the data connection retrieves Cosmos DB documents created or updated after the specified retrieval start date.

retrievalStartDate?: Date

Property Value

Date

tableName

The case-sensitive name of the existing target table in your cluster. Retrieved data is ingested into this table.

tableName: string

Property Value

string