Partager via


RoutingCosmosDBSqlApiProperties Classe

Propriétés liées à un point de terminaison de collection sql cosmos DB.

Tous les paramètres requis doivent être renseignés pour pouvoir être envoyés à Azure.

Héritage
azure.mgmt.iothub._serialization.Model
RoutingCosmosDBSqlApiProperties

Constructeur

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)

Paramètres de mot clé uniquement

Nom Description
name
str

Nom qui identifie ce point de terminaison. Le nom ne peut inclure que des caractères alphanumériques, des points, des traits de soulignement, des traits d’union et a une longueur maximale de 64 caractères. Les noms suivants sont réservés : événements, fileNotifications, $default. Les noms de points de terminaison doivent être uniques parmi les types de points de terminaison. Obligatoire.

id
str

ID du point de terminaison de la collection sql cosmos DB.

subscription_id
str

Identificateur d’abonnement du compte cosmos DB.

resource_group
str

Nom du groupe de ressources du compte cosmos DB.

endpoint_uri
str

URL du compte cosmos DB. Il doit inclure le protocole https://. Obligatoire.

authentication_type

Méthode utilisée pour l’authentification auprès du point de terminaison de collection sql cosmos DB. Les valeurs connues sont : « keyBased » et « identityBased ».

identity

Propriétés d’identité managée du point de terminaison de collecte cosmos DB de routage.

primary_key
str

Clé primaire du compte cosmos DB.

secondary_key
str

Clé secondaire du compte cosmos DB.

database_name
str

Nom de la base de données cosmos DB dans le compte cosmos DB. Obligatoire.

collection_name
str

Nom de la collection sql cosmos DB dans la base de données cosmos DB. Obligatoire.

partition_key_name
str

Nom de la clé de partition associée à cette collection sql cosmos DB, le cas échéant. Il s'agit d'un paramètre facultatif.

partition_key_template
str

Modèle de génération d’une valeur de clé de partition synthétique à utiliser avec cette collection sql cosmos DB. Le modèle doit inclure au moins un des espaces réservés suivants : {iothub}, {deviceid}, {DD}, {MM} et {AAAA}. N’importe quel espace réservé peut être spécifié au maximum une fois, mais les composants d’ordre et non d’espace réservé sont arbitraires. Ce paramètre n’est requis que si PartitionKeyName est spécifié.

Variables

Nom Description
name
str

Nom qui identifie ce point de terminaison. Le nom ne peut inclure que des caractères alphanumériques, des points, des traits de soulignement, des traits d’union et a une longueur maximale de 64 caractères. Les noms suivants sont réservés : événements, fileNotifications, $default. Les noms de points de terminaison doivent être uniques parmi les types de points de terminaison. Obligatoire.

id
str

ID du point de terminaison de la collection sql cosmos DB.

subscription_id
str

Identificateur d’abonnement du compte cosmos DB.

resource_group
str

Nom du groupe de ressources du compte cosmos DB.

endpoint_uri
str

URL du compte cosmos DB. Il doit inclure le protocole https://. Obligatoire.

authentication_type

Méthode utilisée pour l’authentification auprès du point de terminaison de collection sql cosmos DB. Les valeurs connues sont : « keyBased » et « identityBased ».

identity

Propriétés d’identité managée du point de terminaison de collecte cosmos DB de routage.

primary_key
str

Clé primaire du compte cosmos DB.

secondary_key
str

Clé secondaire du compte cosmos DB.

database_name
str

Nom de la base de données cosmos DB dans le compte cosmos DB. Obligatoire.

collection_name
str

Nom de la collection sql cosmos DB dans la base de données cosmos DB. Obligatoire.

partition_key_name
str

Nom de la clé de partition associée à cette collection sql cosmos DB, le cas échéant. Il s'agit d'un paramètre facultatif.

partition_key_template
str

Modèle de génération d’une valeur de clé de partition synthétique à utiliser avec cette collection sql cosmos DB. Le modèle doit inclure au moins un des espaces réservés suivants : {iothub}, {deviceid}, {DD}, {MM} et {AAAA}. N’importe quel espace réservé peut être spécifié au maximum une fois, mais les composants d’ordre et non d’espace réservé sont arbitraires. Ce paramètre n’est requis que si PartitionKeyName est spécifié.