RoutingCosmosDBSqlApiProperties Class

The properties related to a cosmos DB sql collection endpoint.

All required parameters must be populated in order to send to Azure.

Constructor

RoutingCosmosDBSqlApiProperties(*, name: str, endpoint_uri: str, database_name: str, collection_name: str, id: str | None = None, subscription_id: str | None = None, resource_group: str | None = None, authentication_type: str | _models.AuthenticationType | None = None, identity: _models.ManagedIdentity | None = None, primary_key: str | None = None, secondary_key: str | None = None, partition_key_name: str | None = None, partition_key_template: str | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
name	str 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. Required.
id	str Id of the cosmos DB sql collection endpoint. Default value: None
subscription_id	str The subscription identifier of the cosmos DB account. Default value: None
resource_group	str The name of the resource group of the cosmos DB account. Default value: None
endpoint_uri	str The url of the cosmos DB account. It must include the protocol https://. Required.
authentication_type	str or AuthenticationType Method used to authenticate against the cosmos DB sql collection endpoint. Known values are: "keyBased" and "identityBased". Default value: None
identity	ManagedIdentity Managed identity properties of routing cosmos DB collection endpoint. Default value: None
primary_key	str The primary key of the cosmos DB account. Default value: None
secondary_key	str The secondary key of the cosmos DB account. Default value: None
database_name	str The name of the cosmos DB database in the cosmos DB account. Required.
collection_name	str The name of the cosmos DB sql collection in the cosmos DB database. Required.
partition_key_name	str The name of the partition key associated with this cosmos DB sql collection if one exists. This is an optional parameter. Default value: None
partition_key_template	str The template for generating a synthetic partition key value for use with this cosmos DB sql collection. 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. Default value: None

Variables

Name	Description
name	str 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. Required.
id	str Id of the cosmos DB sql collection endpoint.
subscription_id	str The subscription identifier of the cosmos DB account.
resource_group	str The name of the resource group of the cosmos DB account.
endpoint_uri	str The url of the cosmos DB account. It must include the protocol https://. Required.
authentication_type	str or AuthenticationType Method used to authenticate against the cosmos DB sql collection endpoint. Known values are: "keyBased" and "identityBased".
identity	ManagedIdentity Managed identity properties of routing cosmos DB collection endpoint.
primary_key	str The primary key of the cosmos DB account.
secondary_key	str The secondary key of the cosmos DB account.
database_name	str The name of the cosmos DB database in the cosmos DB account. Required.
collection_name	str The name of the cosmos DB sql collection in the cosmos DB database. Required.
partition_key_name	str The name of the partition key associated with this cosmos DB sql collection if one exists. This is an optional parameter.
partition_key_template	str The template for generating a synthetic partition key value for use with this cosmos DB sql collection. 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.