Compartilhar via


RoutingCosmosDBSqlApiProperties Classe

As propriedades relacionadas a um ponto de extremidade de contêiner sql do Cosmos DB.

Todos os parâmetros necessários devem ser preenchidos para enviar ao Azure.

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

Construtor

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

Parâmetros somente de palavra-chave

Nome Description
name
str

O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, pontos, sublinhados, hifens e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, fileNotifications $default. Os nomes de ponto de extremidade devem ser exclusivos entre tipos de ponto de extremidade. Obrigatórios.

id
str

ID do ponto de extremidade do contêiner sql do Cosmos DB.

subscription_id
str

O identificador de assinatura da conta do Cosmos DB.

resource_group
str

O nome do grupo de recursos da conta do Cosmos DB.

endpoint_uri
str

A URL da conta do Cosmos DB. Ele deve incluir o protocolo https://. Obrigatórios.

authentication_type

Método usado para autenticar no ponto de extremidade do contêiner sql do Cosmos DB. Os valores conhecidos são: "keyBased" e "identityBased".

identity

Propriedades de identidade gerenciada do ponto de extremidade de contêiner do Cosmos DB de roteamento.

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 do banco de dados cosmos DB na conta do Cosmos DB. Obrigatórios.

container_name
str

O nome do contêiner sql do Cosmos DB no banco de dados cosmos DB. Obrigatórios.

partition_key_name
str

O nome da chave de partição associada a esse contêiner sql do Cosmos DB, se houver. Esse é um parâmetro opcional.

partition_key_template
str

O modelo para gerar um valor de chave de partição sintética para uso com esse contêiner sql do Cosmos DB. O modelo deve incluir pelo menos um dos seguintes espaços reservados: {iothub}, {deviceid}, {DD}, {MM}e {YYYY}. Qualquer espaço reservado pode ser especificado no máximo uma vez, mas os componentes de ordem e não espaço reservado são arbitrários. Esse parâmetro só será necessário se PartitionKeyName for especificado.

Variáveis

Nome Description
name
str

O nome que identifica esse ponto de extremidade. O nome só pode incluir caracteres alfanuméricos, pontos, sublinhados, hifens e tem um comprimento máximo de 64 caracteres. Os seguintes nomes são reservados: eventos, fileNotifications $default. Os nomes de ponto de extremidade devem ser exclusivos entre tipos de ponto de extremidade. Obrigatórios.

id
str

ID do ponto de extremidade do contêiner sql do Cosmos DB.

subscription_id
str

O identificador de assinatura da conta do Cosmos DB.

resource_group
str

O nome do grupo de recursos da conta do Cosmos DB.

endpoint_uri
str

A URL da conta do Cosmos DB. Ele deve incluir o protocolo https://. Obrigatórios.

authentication_type

Método usado para autenticar no ponto de extremidade do contêiner sql do Cosmos DB. Os valores conhecidos são: "keyBased" e "identityBased".

identity

Propriedades de identidade gerenciada do ponto de extremidade de contêiner do Cosmos DB de roteamento.

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 do banco de dados cosmos DB na conta do Cosmos DB. Obrigatórios.

container_name
str

O nome do contêiner sql do Cosmos DB no banco de dados cosmos DB. Obrigatórios.

partition_key_name
str

O nome da chave de partição associada a esse contêiner sql do Cosmos DB, se houver. Esse é um parâmetro opcional.

partition_key_template
str

O modelo para gerar um valor de chave de partição sintética para uso com esse contêiner sql do Cosmos DB. O modelo deve incluir pelo menos um dos seguintes espaços reservados: {iothub}, {deviceid}, {DD}, {MM}e {YYYY}. Qualquer espaço reservado pode ser especificado no máximo uma vez, mas os componentes de ordem e não espaço reservado são arbitrários. Esse parâmetro só será necessário se PartitionKeyName for especificado.