CosmosDbDataConnection interface
Class representing a CosmosDb data connection.
- Extends
Properties
| cosmos |
The resource ID of the Cosmos DB account used to create the data connection. |
| cosmos |
The name of an existing container in the Cosmos DB database. |
| cosmos |
The name of an existing database in the Cosmos DB account. |
| kind | Kind of the endpoint for the data connection |
| managed |
The object ID of the managed identity resource. |
| managed |
The resource ID of a managed system or user-assigned identity. The identity is used to authenticate with Cosmos DB. |
| mapping |
The name of an existing mapping rule to use when ingesting the retrieved data. |
| provisioning |
The provisioned state of the resource. |
| retrieval |
Optional. If defined, the data connection retrieves Cosmos DB documents created or updated after the specified retrieval start date. |
| table |
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} |
| location | Resource location. |
| name | The name of the resource |
| system |
Azure Resource Manager metadata containing createdBy and modifiedBy information. |
| type | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
Property Details
cosmosDbAccountResourceId
The resource ID of the Cosmos DB account used to create the data connection.
cosmosDbAccountResourceId?: stringProperty Value
string
cosmosDbContainer
The name of an existing container in the Cosmos DB database.
cosmosDbContainer?: stringProperty Value
string
cosmosDbDatabase
The name of an existing database in the Cosmos DB account.
cosmosDbDatabase?: stringProperty Value
string
kind
Kind of the endpoint for the data connection
kind: "CosmosDb"Property Value
"CosmosDb"
managedIdentityObjectId
The object ID of the managed identity resource.
managedIdentityObjectId?: stringProperty Value
string
managedIdentityResourceId
The resource ID of a managed system or user-assigned identity. The identity is used to authenticate with Cosmos DB.
managedIdentityResourceId?: stringProperty Value
string
mappingRuleName
The name of an existing mapping rule to use when ingesting the retrieved data.
mappingRuleName?: stringProperty Value
string
provisioningState
The provisioned state of the resource.
provisioningState?: stringProperty Value
string
retrievalStartDate
Optional. If defined, the data connection retrieves Cosmos DB documents created or updated after the specified retrieval start date.
retrievalStartDate?: DateProperty Value
Date
tableName
The case-sensitive name of the existing target table in your cluster. Retrieved data is ingested into this table.
tableName?: stringProperty Value
string
Inherited Property Details
id
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
id?: stringProperty Value
string
Inherited From DataConnection.id
location
name
systemData
Azure Resource Manager metadata containing createdBy and modifiedBy information.
systemData?: SystemDataProperty Value
Inherited From DataConnection.systemData
type
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
type?: stringProperty Value
string
Inherited From DataConnection.type