DatabaseAccountGetResults interface

Paquet:

@azure/arm-cosmosdb

Un compte de base de données Azure Cosmos DB.

Extends

ARMResourceProperties

Propriétés

analyticalStorageConfiguration	Propriétés spécifiques du stockage analytique.
apiProperties	Propriétés spécifiques de l’API.
backupPolicy	Objet représentant la stratégie pour effectuer des sauvegardes sur un compte.
capabilities	Liste des fonctionnalités de Cosmos DB pour le compte
capacity	Objet qui représente toutes les propriétés liées à l’application de la capacité sur un compte.
connectorOffer	Type d’offre du connecteur cassandra pour le compte C* de base de données Cosmos DB.
consistencyPolicy	Stratégie de cohérence pour le compte de base de données Cosmos DB.
cors	Stratégie CORS pour le compte de base de données Cosmos DB.
createMode	Énumération pour indiquer le mode de création de compte.
customerManagedKeyStatus	Indique l’état de la fonctionnalité Clé gérée par le client sur le compte. En cas d’erreurs, la propriété fournit des conseils de dépannage.
databaseAccountOfferType	Type d’offre pour le compte de base de données Cosmos DB. Valeur par défaut : Standard. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.
defaultIdentity	Identité par défaut pour accéder au coffre de clés utilisé dans les fonctionnalités telles que les clés gérées par le client. L’identité par défaut doit être définie explicitement par les utilisateurs. Il peut s’agir de « FirstPartyIdentity », « SystemAssignedIdentity » et bien plus encore.
defaultPriorityLevel	Énumération pour indiquer le niveau de priorité par défaut de la requête pour l’exécution basée sur la priorité.
disableKeyBasedMetadataWriteAccess	Désactiver les opérations d’écriture sur les ressources de métadonnées (bases de données, conteneurs, débit) via des clés de compte
disableLocalAuth	Désactivez l’authentification locale et assurez-vous que seul MSI et AAD peuvent être utilisés exclusivement pour l’authentification.
documentEndpoint	Point de terminaison de connexion pour le compte de base de données Cosmos DB. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.
enableAnalyticalStorage	Indicateur pour indiquer s’il faut activer l’analytique de stockage.
enableAutomaticFailover	Active le basculement automatique de la région d’écriture dans le cas rare où la région n’est pas disponible en raison d’une panne. Le basculement automatique entraîne une nouvelle région d’écriture pour le compte et est choisi en fonction des priorités de basculement configurées pour le compte.
enableBurstCapacity	Indicateur pour indiquer l’activation/désactivation de la fonctionnalité de capacité de rafale sur le compte
enableCassandraConnector	Active le connecteur cassandra sur le compte C* Cosmos DB
enableFreeTier	Indicateur pour indiquer si le niveau gratuit est activé.
enableMultipleWriteLocations	Permet au compte d’écrire dans plusieurs emplacements
enablePartitionMerge	Indicateur pour indiquer l’activation/désactivation de la fonctionnalité de fusion de partition sur le compte
enablePerRegionPerPartitionAutoscale	Indicateur pour indiquer l’activation/désactivation de la fonctionnalité PerRegionPerPartitionAutoscale sur le compte
enablePriorityBasedExecution	Indicateur pour indiquer l’activation/désactivation de la fonctionnalité Aperçu de l’exécution basée sur la priorité sur le compte
failoverPolicies	Tableau qui contient les régions classées par leurs priorités de basculement. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.
identity	Identité de la ressource.
instanceId	Identificateur unique affecté au compte de base de données REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.
ipRules	Liste d’IpRules.
isVirtualNetworkFilterEnabled	Indicateur pour indiquer s’il faut activer/désactiver des règles de liste de contrôle d’accès de réseau virtuel.
keysMetadata	Objet qui représente les métadonnées pour les clés de compte du compte Cosmos DB. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.
keyVaultKeyUri	URI du coffre de clés
keyVaultKeyUriVersion	La version de la clé gérée par le client actuellement utilisée par le compte REMARQUE : Cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.
kind	Indique le type de compte de base de données. Cela ne peut être défini qu’au moment de la création du compte de base de données.
locations	Tableau qui contient tous les emplacements activés pour le compte Cosmos DB. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.
minimalTlsVersion	Indique la version minimale autorisée de Tls. La valeur par défaut est Tls 1.2. Les API Cassandra et Mongo fonctionnent uniquement avec Tls 1.2.
networkAclBypass	Indique quels services sont autorisés à contourner les vérifications de pare-feu.
networkAclBypassResourceIds	Tableau qui contient les ID de ressource pour le contournement Acl réseau pour le compte Cosmos DB.
privateEndpointConnections	Liste des connexions de point de terminaison privé configurées pour le compte Cosmos DB. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.
provisioningState	État du compte Cosmos DB au moment de l’appel de l’opération. L’état peut être l’un des suivants. « Création » : le compte Cosmos DB est en cours de création. Lorsqu’un compte est en cours de création, seules les propriétés spécifiées comme entrée pour l’opération créer un compte Cosmos DB sont retournées. « Réussi » : le compte Cosmos DB est actif pour une utilisation. « Mise à jour » : le compte Cosmos DB est mis à jour. « Suppression » : le compte Cosmos DB est supprimé. « Échec » : échec de la création du compte Cosmos DB. « Suppression ayant échoué » : la suppression du compte Cosmos DB a échoué. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.
publicNetworkAccess	Indique si les demandes du réseau public sont autorisées
readLocations	Tableau qui contient les emplacements de lecture activés pour le compte Cosmos DB. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.
restoreParameters	Paramètres pour indiquer les informations relatives à la restauration.
systemData	Métadonnées système relatives à cette ressource. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.
virtualNetworkRules	Liste des règles de liste de contrôle d’accès de réseau virtuel configurées pour le compte Cosmos DB.
writeLocations	Tableau qui contient l’emplacement d’écriture du compte Cosmos DB. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

Propriétés héritées

id	Identificateur de ressource unique de la ressource ARM. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.
location	Emplacement du groupe de ressources auquel appartient la ressource.
name	Nom de la ressource ARM. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.
tags	Les balises sont une liste de paires clé-valeur qui décrivent la ressource. Ces balises peuvent être utilisées dans l’affichage et le regroupement de cette ressource (entre les groupes de ressources). Un maximum de 15 balises peut être fourni pour une ressource. Chaque balise doit avoir une clé supérieure à 128 caractères et une valeur supérieure à 256 caractères. Par exemple, l’expérience par défaut d’un type de modèle est définie avec « defaultExperience » : « Cassandra ». Les valeurs « defaultExperience » actuelles incluent également « Table », « Graph », « DocumentDB » et « MongoDB ».
type	Type de ressource Azure. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

Détails de la propriété

analyticalStorageConfiguration

Propriétés spécifiques du stockage analytique.

analyticalStorageConfiguration?: AnalyticalStorageConfiguration

Valeur de propriété

AnalyticalStorageConfiguration

apiProperties

Propriétés spécifiques de l’API.

apiProperties?: ApiProperties

Valeur de propriété

ApiProperties

backupPolicy

Objet représentant la stratégie pour effectuer des sauvegardes sur un compte.

backupPolicy?: BackupPolicyUnion

Valeur de propriété

BackupPolicyUnion

capabilities

Liste des fonctionnalités de Cosmos DB pour le compte

capabilities?: Capability[]

Valeur de propriété

Capability[]

capacity

Objet qui représente toutes les propriétés liées à l’application de la capacité sur un compte.

capacity?: Capacity

Valeur de propriété

Capacity

connectorOffer

Type d’offre du connecteur cassandra pour le compte C* de base de données Cosmos DB.

connectorOffer?: string

Valeur de propriété

string

consistencyPolicy

Stratégie de cohérence pour le compte de base de données Cosmos DB.

consistencyPolicy?: ConsistencyPolicy

Valeur de propriété

ConsistencyPolicy

cors

Stratégie CORS pour le compte de base de données Cosmos DB.

cors?: CorsPolicy[]

Valeur de propriété

CorsPolicy[]

createMode

Énumération pour indiquer le mode de création de compte.

createMode?: string

Valeur de propriété

string

customerManagedKeyStatus

Indique l’état de la fonctionnalité Clé gérée par le client sur le compte. En cas d’erreurs, la propriété fournit des conseils de dépannage.

customerManagedKeyStatus?: string

Valeur de propriété

string

databaseAccountOfferType

Type d’offre pour le compte de base de données Cosmos DB. Valeur par défaut : Standard. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

databaseAccountOfferType?: "Standard"

Valeur de propriété

"Standard"

defaultIdentity

Identité par défaut pour accéder au coffre de clés utilisé dans les fonctionnalités telles que les clés gérées par le client. L’identité par défaut doit être définie explicitement par les utilisateurs. Il peut s’agir de « FirstPartyIdentity », « SystemAssignedIdentity » et bien plus encore.

defaultIdentity?: string

Valeur de propriété

string

defaultPriorityLevel

Énumération pour indiquer le niveau de priorité par défaut de la requête pour l’exécution basée sur la priorité.

defaultPriorityLevel?: string

Valeur de propriété

string

disableKeyBasedMetadataWriteAccess

Désactiver les opérations d’écriture sur les ressources de métadonnées (bases de données, conteneurs, débit) via des clés de compte

disableKeyBasedMetadataWriteAccess?: boolean

Valeur de propriété

boolean

disableLocalAuth

Désactivez l’authentification locale et assurez-vous que seul MSI et AAD peuvent être utilisés exclusivement pour l’authentification.

disableLocalAuth?: boolean

Valeur de propriété

boolean

documentEndpoint

Point de terminaison de connexion pour le compte de base de données Cosmos DB. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

documentEndpoint?: string

Valeur de propriété

string

enableAnalyticalStorage

Indicateur pour indiquer s’il faut activer l’analytique de stockage.

enableAnalyticalStorage?: boolean

Valeur de propriété

boolean

enableAutomaticFailover

Active le basculement automatique de la région d’écriture dans le cas rare où la région n’est pas disponible en raison d’une panne. Le basculement automatique entraîne une nouvelle région d’écriture pour le compte et est choisi en fonction des priorités de basculement configurées pour le compte.

enableAutomaticFailover?: boolean

Valeur de propriété

boolean

enableBurstCapacity

Indicateur pour indiquer l’activation/désactivation de la fonctionnalité de capacité de rafale sur le compte

enableBurstCapacity?: boolean

Valeur de propriété

boolean

enableCassandraConnector

Active le connecteur cassandra sur le compte C* Cosmos DB

enableCassandraConnector?: boolean

Valeur de propriété

boolean

enableFreeTier

Indicateur pour indiquer si le niveau gratuit est activé.

enableFreeTier?: boolean

Valeur de propriété

boolean

enableMultipleWriteLocations

Permet au compte d’écrire dans plusieurs emplacements

enableMultipleWriteLocations?: boolean

Valeur de propriété

boolean

enablePartitionMerge

Indicateur pour indiquer l’activation/désactivation de la fonctionnalité de fusion de partition sur le compte

enablePartitionMerge?: boolean

Valeur de propriété

boolean

enablePerRegionPerPartitionAutoscale

Indicateur pour indiquer l’activation/désactivation de la fonctionnalité PerRegionPerPartitionAutoscale sur le compte

enablePerRegionPerPartitionAutoscale?: boolean

Valeur de propriété

boolean

enablePriorityBasedExecution

Indicateur pour indiquer l’activation/désactivation de la fonctionnalité Aperçu de l’exécution basée sur la priorité sur le compte

enablePriorityBasedExecution?: boolean

Valeur de propriété

boolean

failoverPolicies

Tableau qui contient les régions classées par leurs priorités de basculement. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

failoverPolicies?: FailoverPolicy[]

Valeur de propriété

FailoverPolicy[]

identity

Identité de la ressource.

identity?: ManagedServiceIdentity

Valeur de propriété

ManagedServiceIdentity

instanceId

Identificateur unique affecté au compte de base de données REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

instanceId?: string

Valeur de propriété

string

ipRules

Liste d’IpRules.

ipRules?: IpAddressOrRange[]

Valeur de propriété

IpAddressOrRange[]

isVirtualNetworkFilterEnabled

Indicateur pour indiquer s’il faut activer/désactiver des règles de liste de contrôle d’accès de réseau virtuel.

isVirtualNetworkFilterEnabled?: boolean

Valeur de propriété

boolean

keysMetadata

Objet qui représente les métadonnées pour les clés de compte du compte Cosmos DB. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

keysMetadata?: DatabaseAccountKeysMetadata

Valeur de propriété

DatabaseAccountKeysMetadata

keyVaultKeyUri

URI du coffre de clés

keyVaultKeyUri?: string

Valeur de propriété

string

keyVaultKeyUriVersion

La version de la clé gérée par le client actuellement utilisée par le compte REMARQUE : Cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

keyVaultKeyUriVersion?: string

Valeur de propriété

string

kind

Indique le type de compte de base de données. Cela ne peut être défini qu’au moment de la création du compte de base de données.

kind?: string

Valeur de propriété

string

locations

Tableau qui contient tous les emplacements activés pour le compte Cosmos DB. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

locations?: Location[]

Valeur de propriété

Location[]

minimalTlsVersion

Indique la version minimale autorisée de Tls. La valeur par défaut est Tls 1.2. Les API Cassandra et Mongo fonctionnent uniquement avec Tls 1.2.

minimalTlsVersion?: string

Valeur de propriété

string

networkAclBypass

Indique quels services sont autorisés à contourner les vérifications de pare-feu.

networkAclBypass?: NetworkAclBypass

Valeur de propriété

NetworkAclBypass

networkAclBypassResourceIds

Tableau qui contient les ID de ressource pour le contournement Acl réseau pour le compte Cosmos DB.

networkAclBypassResourceIds?: string[]

Valeur de propriété

string[]

privateEndpointConnections

Liste des connexions de point de terminaison privé configurées pour le compte Cosmos DB. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

privateEndpointConnections?: PrivateEndpointConnection[]

Valeur de propriété

PrivateEndpointConnection[]

provisioningState

État du compte Cosmos DB au moment de l’appel de l’opération. L’état peut être l’un des suivants. « Création » : le compte Cosmos DB est en cours de création. Lorsqu’un compte est en cours de création, seules les propriétés spécifiées comme entrée pour l’opération créer un compte Cosmos DB sont retournées. « Réussi » : le compte Cosmos DB est actif pour une utilisation. « Mise à jour » : le compte Cosmos DB est mis à jour. « Suppression » : le compte Cosmos DB est supprimé. « Échec » : échec de la création du compte Cosmos DB. « Suppression ayant échoué » : la suppression du compte Cosmos DB a échoué. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

provisioningState?: string

Valeur de propriété

string

publicNetworkAccess

Indique si les demandes du réseau public sont autorisées

publicNetworkAccess?: string

Valeur de propriété

string

readLocations

Tableau qui contient les emplacements de lecture activés pour le compte Cosmos DB. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

readLocations?: Location[]

Valeur de propriété

Location[]

restoreParameters

Paramètres pour indiquer les informations relatives à la restauration.

restoreParameters?: RestoreParameters

Valeur de propriété

RestoreParameters

systemData

Métadonnées système relatives à cette ressource. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

systemData?: SystemData

Valeur de propriété

SystemData

virtualNetworkRules

Liste des règles de liste de contrôle d’accès de réseau virtuel configurées pour le compte Cosmos DB.

virtualNetworkRules?: VirtualNetworkRule[]

Valeur de propriété

VirtualNetworkRule[]

writeLocations

Tableau qui contient l’emplacement d’écriture du compte Cosmos DB. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

writeLocations?: Location[]

Valeur de propriété

Location[]

Détails de la propriété héritée

id

Identificateur de ressource unique de la ressource ARM. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

id?: string

Valeur de propriété

string

héritée deARMResourceProperties.id

location

Emplacement du groupe de ressources auquel appartient la ressource.

location?: string

Valeur de propriété

string

héritée deARMResourceProperties.location

name

Nom de la ressource ARM. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

name?: string

Valeur de propriété

string

héritée deARMResourceProperties.name

tags

Les balises sont une liste de paires clé-valeur qui décrivent la ressource. Ces balises peuvent être utilisées dans l’affichage et le regroupement de cette ressource (entre les groupes de ressources). Un maximum de 15 balises peut être fourni pour une ressource. Chaque balise doit avoir une clé supérieure à 128 caractères et une valeur supérieure à 256 caractères. Par exemple, l’expérience par défaut d’un type de modèle est définie avec « defaultExperience » : « Cassandra ». Les valeurs « defaultExperience » actuelles incluent également « Table », « Graph », « DocumentDB » et « MongoDB ».

tags?: {[propertyName: string]: string}

Valeur de propriété

{[propertyName: string]: string}

héritée deARMResourceProperties.tags

type

Type de ressource Azure. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

type?: string

Valeur de propriété

string

héritée deARMResourceProperties.type