Share via

CosmosDbDataConnection interface

  • Reference
Package:
@azure/arm-kusto

Class representing a CosmosDb data connection.

Extends
DataConnection

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.
kind

Polymorphic discriminator, which specifies the different types this object can be
managedIdentityObjectId

The object ID of the managed identity resource. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
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.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
location

Resource location.
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

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

kind

Polymorphic discriminator, which specifies the different types this object can be

kind: "CosmosDb"

Property Value

"CosmosDb"

managedIdentityObjectId

The object ID of the managed identity resource. NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

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

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From DataConnection.id

location

Resource location.

location?: string

Property Value

string

Inherited From DataConnection.location

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From DataConnection.name

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From DataConnection.type