RoutingCosmosDBSqlApiProperties interface
The properties related to a cosmos DB sql container endpoint.
Properties
| authentication |
Method used to authenticate against the cosmos DB sql container endpoint |
| container |
The name of the cosmos DB sql container in the cosmos DB database. |
| database |
The name of the cosmos DB database in the cosmos DB account. |
| endpoint |
The url of the cosmos DB account. It must include the protocol https:// |
| id | Id of the cosmos DB sql container endpoint NOTE: This property will not be serialized. It can only be populated by the server. |
| identity | Managed identity properties of routing cosmos DB container endpoint. |
| name | The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. |
| partition |
The name of the partition key associated with this cosmos DB sql container if one exists. This is an optional parameter. |
| partition |
The template for generating a synthetic partition key value for use with this cosmos DB sql container. The template must include at least one of the following placeholders: {iothub}, {deviceid}, {DD}, {MM}, and {YYYY}. Any one placeholder may be specified at most once, but order and non-placeholder components are arbitrary. This parameter is only required if PartitionKeyName is specified. |
| primary |
The primary key of the cosmos DB account. |
| resource |
The name of the resource group of the cosmos DB account. |
| secondary |
The secondary key of the cosmos DB account. |
| subscription |
The subscription identifier of the cosmos DB account. |
Property Details
authenticationType
Method used to authenticate against the cosmos DB sql container endpoint
authenticationType?: stringProperty Value
string
containerName
The name of the cosmos DB sql container in the cosmos DB database.
containerName: stringProperty Value
string
databaseName
The name of the cosmos DB database in the cosmos DB account.
databaseName: stringProperty Value
string
endpointUri
The url of the cosmos DB account. It must include the protocol https://
endpointUri: stringProperty Value
string
id
Id of the cosmos DB sql container endpoint NOTE: This property will not be serialized. It can only be populated by the server.
id?: stringProperty Value
string
identity
Managed identity properties of routing cosmos DB container endpoint.
identity?: ManagedIdentityProperty Value
name
The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.
name: stringProperty Value
string
partitionKeyName
The name of the partition key associated with this cosmos DB sql container if one exists. This is an optional parameter.
partitionKeyName?: stringProperty Value
string
partitionKeyTemplate
The template for generating a synthetic partition key value for use with this cosmos DB sql container. The template must include at least one of the following placeholders: {iothub}, {deviceid}, {DD}, {MM}, and {YYYY}. Any one placeholder may be specified at most once, but order and non-placeholder components are arbitrary. This parameter is only required if PartitionKeyName is specified.
partitionKeyTemplate?: stringProperty Value
string
primaryKey
The primary key of the cosmos DB account.
primaryKey?: stringProperty Value
string
resourceGroup
The name of the resource group of the cosmos DB account.
resourceGroup?: stringProperty Value
string
secondaryKey
The secondary key of the cosmos DB account.
secondaryKey?: stringProperty Value
string
subscriptionId
The subscription identifier of the cosmos DB account.
subscriptionId?: stringProperty Value
string