Partilhar via


RoutingCosmosDBSqlApiProperties Classe

As propriedades relacionadas com um ponto final de contentor sql do cosmos DB.

As variáveis só são preenchidas pelo servidor e serão ignoradas ao enviar um pedido.

Todos os parâmetros necessários têm de ser preenchidos para serem enviados para o Azure.

Herança
azure.mgmt.iothub._serialization.Model
RoutingCosmosDBSqlApiProperties

Construtor

RoutingCosmosDBSqlApiProperties(*, name: str, endpoint_uri: str, database_name: str, container_name: str, 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)

Parâmetros Só de Palavra-Chave

Name Description
name
str

O nome que identifica este ponto final. O nome só pode incluir carateres alfanuméricos, períodos, sublinhados, hífenes e tem um comprimento máximo de 64 carateres. Os nomes seguintes são reservados: eventos, fileNotifications, $default. Os nomes dos pontos finais têm de ser exclusivos entre tipos de pontos finais. Obrigatório.

subscription_id
str

O identificador de subscrição da conta do Cosmos DB.

resource_group
str

O nome do grupo de recursos da conta cosmos DB.

endpoint_uri
str

O URL da conta do Cosmos DB. Tem de incluir o protocolo https://. Obrigatório.

authentication_type

Método utilizado para autenticar no ponto final do contentor sql do cosmos DB. Os valores conhecidos são: "keyBased" e "identityBased".

identity

Propriedades de identidade gerida do ponto final de contentor do cosmos DB de encaminhamento.

primary_key
str

A chave primária da conta do Cosmos DB.

secondary_key
str

A chave secundária da conta do Cosmos DB.

database_name
str

O nome da base de dados cosmos DB na conta do cosmos DB. Obrigatório.

container_name
str

O nome do contentor sql do cosmos DB na base de dados cosmos DB. Obrigatório.

partition_key_name
str

O nome da chave de partição associada a este contentor sql do cosmos DB, se existir. Este é um parâmetro opcional.

partition_key_template
str

O modelo para gerar um valor de chave de partição sintética para utilização com este contentor sql do cosmos DB. O modelo tem de incluir, pelo menos, um dos seguintes marcadores de posição: {iothub}, {deviceid}, {DD}, {MM}, e {YYYY}. Qualquer marcador de posição pode ser especificado no máximo uma vez, mas os componentes de encomenda e não marcador de posição são arbitrários. Este parâmetro só é necessário se PartitionKeyName for especificado.

Variáveis

Name Description
name
str

O nome que identifica este ponto final. O nome só pode incluir carateres alfanuméricos, períodos, sublinhados, hífenes e tem um comprimento máximo de 64 carateres. Os nomes seguintes são reservados: eventos, fileNotifications, $default. Os nomes dos pontos finais têm de ser exclusivos entre tipos de pontos finais. Obrigatório.

id
str

ID do ponto final do contentor sql do Cosmos DB.

subscription_id
str

O identificador de subscrição da conta do Cosmos DB.

resource_group
str

O nome do grupo de recursos da conta cosmos DB.

endpoint_uri
str

O URL da conta do Cosmos DB. Tem de incluir o protocolo https://. Obrigatório.

authentication_type

Método utilizado para autenticar no ponto final do contentor sql do cosmos DB. Os valores conhecidos são: "keyBased" e "identityBased".

identity

Propriedades de identidade gerida do ponto final de contentor do cosmos DB de encaminhamento.

primary_key
str

A chave primária da conta do Cosmos DB.

secondary_key
str

A chave secundária da conta do Cosmos DB.

database_name
str

O nome da base de dados cosmos DB na conta do cosmos DB. Obrigatório.

container_name
str

O nome do contentor sql do cosmos DB na base de dados cosmos DB. Obrigatório.

partition_key_name
str

O nome da chave de partição associada a este contentor sql do cosmos DB, se existir. Este é um parâmetro opcional.

partition_key_template
str

O modelo para gerar um valor de chave de partição sintética para utilização com este contentor sql do cosmos DB. O modelo tem de incluir, pelo menos, um dos seguintes marcadores de posição: {iothub}, {deviceid}, {DD}, {MM}, e {YYYY}. Qualquer marcador de posição pode ser especificado no máximo uma vez, mas os componentes de encomenda e não marcador de posição são arbitrários. Este parâmetro só é necessário se PartitionKeyName for especificado.