Database Accounts - Update

Référence

Service:: Cosmos DB Resource Provider

Version d'API:: 2024-11-15

Met à jour les propriétés d’un compte de base de données Azure Cosmos DB existant.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}?api-version=2024-11-15

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
accountName	path	True	string	Nom du compte de base de données Cosmos DB. Modèle d’expression régulière: `^[a-z0-9]+(-[a-z0-9]+)*`
resourceGroupName	path	True	string	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string	ID de l’abonnement cible.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Type	Description
identity	ManagedServiceIdentity	Identité de la ressource.
location	string	Emplacement du groupe de ressources auquel appartient la ressource.
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration	Propriétés spécifiques du stockage analytique.
properties.apiProperties	ApiProperties	Propriétés spécifiques de l’API. Actuellement, pris en charge uniquement pour l’API MongoDB.
properties.backupPolicy	BackupPolicy: PeriodicModeBackupPolicy ContinuousModeBackupPolicy	Objet représentant la stratégie pour effectuer des sauvegardes sur un compte.
properties.capabilities	Capability[]	Liste des fonctionnalités de Cosmos DB pour le compte
properties.capacity	Capacity	Objet qui représente toutes les propriétés liées à l’application de la capacité sur un compte.
properties.connectorOffer	ConnectorOffer	Type d’offre du connecteur cassandra pour le compte C* de base de données Cosmos DB.
properties.consistencyPolicy	ConsistencyPolicy	Stratégie de cohérence pour le compte Cosmos DB.
properties.cors	CorsPolicy[]	Stratégie CORS pour le compte de base de données Cosmos DB.
properties.customerManagedKeyStatus	string	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.
properties.defaultIdentity	string	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.
properties.disableKeyBasedMetadataWriteAccess	boolean	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
properties.disableLocalAuth	boolean	Désactivez l’authentification locale et assurez-vous que seul MSI et AAD peuvent être utilisés exclusivement pour l’authentification.
properties.enableAnalyticalStorage	boolean	Indicateur pour indiquer s’il faut activer l’analytique de stockage.
properties.enableAutomaticFailover	boolean	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.
properties.enableBurstCapacity	boolean	Indicateur pour indiquer l’activation/désactivation de la fonctionnalité de capacité de rafale sur le compte
properties.enableCassandraConnector	boolean	Active le connecteur cassandra sur le compte C* Cosmos DB
properties.enableFreeTier	boolean	Indicateur pour indiquer si le niveau gratuit est activé.
properties.enableMultipleWriteLocations	boolean	Permet au compte d’écrire dans plusieurs emplacements
properties.enablePartitionMerge	boolean	Indicateur pour indiquer l’activation/désactivation de la fonctionnalité de fusion de partition sur le compte
properties.enablePerRegionPerPartitionAutoscale	boolean	Indicateur pour indiquer l’activation/désactivation de la fonctionnalité PerRegionPerPartitionAutoscale sur le compte
properties.ipRules	IpAddressOrRange[]	Liste d’IpRules.
properties.isVirtualNetworkFilterEnabled	boolean	Indicateur pour indiquer s’il faut activer/désactiver des règles de liste de contrôle d’accès de réseau virtuel.
properties.keyVaultKeyUri	string	URI du coffre de clés
properties.locations	Location[]	Tableau qui contient les emplacements de géoréplication activés pour le compte Cosmos DB.
properties.minimalTlsVersion	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.
properties.networkAclBypass	NetworkAclBypass	Indique quels services sont autorisés à contourner les vérifications de pare-feu.
properties.networkAclBypassResourceIds	string[]	Tableau qui contient les ID de ressource pour le contournement Acl réseau pour le compte Cosmos DB.
properties.publicNetworkAccess	PublicNetworkAccess	Indique si les demandes du réseau public sont autorisées
properties.virtualNetworkRules	VirtualNetworkRule[]	Liste des règles de liste de contrôle d’accès de réseau virtuel configurées pour le compte Cosmos DB.
tags	object	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 ».

Réponses

Nom	Type	Description
200 OK	DatabaseAccountGetResults	L’opération de mise à jour du compte de base de données se termine de manière asynchrone.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

CosmosDBDatabaseAccountPatch

Exemple de requête

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1?api-version=2024-11-15

{
  "location": "westus",
  "tags": {
    "dept": "finance"
  },
  "identity": {
    "type": "SystemAssigned,UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {}
    }
  },
  "properties": {
    "ipRules": [
      {
        "ipAddressOrRange": "23.43.230.120"
      },
      {
        "ipAddressOrRange": "110.12.240.0/12"
      }
    ],
    "isVirtualNetworkFilterEnabled": true,
    "virtualNetworkRules": [
      {
        "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
        "ignoreMissingVNetServiceEndpoint": false
      }
    ],
    "consistencyPolicy": {
      "defaultConsistencyLevel": "BoundedStaleness",
      "maxIntervalInSeconds": 10,
      "maxStalenessPrefix": 200
    },
    "defaultIdentity": "FirstPartyIdentity",
    "enableFreeTier": false,
    "enableAnalyticalStorage": true,
    "enableBurstCapacity": true,
    "enablePerRegionPerPartitionAutoscale": true,
    "analyticalStorageConfiguration": {
      "schemaType": "WellDefined"
    },
    "backupPolicy": {
      "type": "Periodic",
      "periodicModeProperties": {
        "backupIntervalInMinutes": 240,
        "backupRetentionIntervalInHours": 720,
        "backupStorageRedundancy": "Local"
      }
    },
    "networkAclBypass": "AzureServices",
    "networkAclBypassResourceIds": [
      "/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName"
    ],
    "capacity": {
      "totalThroughputLimit": 2000
    },
    "enablePartitionMerge": true,
    "minimalTlsVersion": "Tls"
  }
}

Exemple de réponse

Code d’état:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1",
  "name": "ddb1",
  "location": "West US",
  "type": "Microsoft.DocumentDB/databaseAccounts",
  "kind": "GlobalDocumentDB",
  "tags": {
    "dept": "finance"
  },
  "identity": {
    "type": "SystemAssigned,UserAssigned",
    "principalId": "52f4fef3-3c3f-4ff3-b52e-b5c9eeb68656",
    "tenantId": "33e01921-4d64-4f8c-a055-5bdaffd5e33d",
    "userAssignedIdentities": {
      "/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {
        "clientId": "fbe75b66-01c5-4f87-a220-233af3270436",
        "principalId": "33e01921-4d64-4f8c-a055-5bdaffd5e33d"
      }
    }
  },
  "properties": {
    "provisioningState": "Succeeded",
    "documentEndpoint": "https://ddb1.documents.azure.com:443/",
    "databaseAccountOfferType": "Standard",
    "ipRules": [
      {
        "ipAddressOrRange": "23.43.230.120"
      },
      {
        "ipAddressOrRange": "110.12.240.0/12"
      }
    ],
    "isVirtualNetworkFilterEnabled": true,
    "disableKeyBasedMetadataWriteAccess": false,
    "consistencyPolicy": {
      "defaultConsistencyLevel": "BoundedStaleness",
      "maxIntervalInSeconds": 10,
      "maxStalenessPrefix": 200
    },
    "writeLocations": [
      {
        "id": "ddb1-eastus",
        "locationName": "East US",
        "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/",
        "provisioningState": "Succeeded",
        "failoverPriority": 0
      }
    ],
    "readLocations": [
      {
        "id": "ddb1-eastus",
        "locationName": "East US",
        "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/",
        "provisioningState": "Succeeded",
        "failoverPriority": 0
      }
    ],
    "locations": [
      {
        "id": "ddb1-eastus",
        "locationName": "East US",
        "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/",
        "provisioningState": "Succeeded",
        "failoverPriority": 0
      }
    ],
    "failoverPolicies": [
      {
        "id": "ddb1-eastus",
        "locationName": "East US",
        "failoverPriority": 0
      }
    ],
    "virtualNetworkRules": [
      {
        "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
        "ignoreMissingVNetServiceEndpoint": false
      }
    ],
    "privateEndpointConnections": [
      {
        "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.DocumentDB/databaseAccounts/account1/privateEndpointConnections/pe1",
        "properties": {
          "privateEndpoint": {
            "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/privateEndpoints/pe1"
          },
          "privateLinkServiceConnectionState": {
            "status": "Approved",
            "actionsRequired": "None"
          }
        }
      }
    ],
    "cors": [],
    "defaultIdentity": "FirstPartyIdentity",
    "enableFreeTier": false,
    "apiProperties": {},
    "enableAnalyticalStorage": true,
    "enableBurstCapacity": true,
    "analyticalStorageConfiguration": {
      "schemaType": "WellDefined"
    },
    "backupPolicy": {
      "type": "Periodic",
      "periodicModeProperties": {
        "backupIntervalInMinutes": 240,
        "backupRetentionIntervalInHours": 720,
        "backupStorageRedundancy": "Local"
      }
    },
    "networkAclBypass": "AzureServices",
    "networkAclBypassResourceIds": [
      "/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName"
    ],
    "capacity": {
      "totalThroughputLimit": 2000
    },
    "keysMetadata": {
      "primaryMasterKey": {
        "generationTime": "2022-02-25T20:30:11Z"
      },
      "secondaryMasterKey": {
        "generationTime": "2022-02-25T20:30:11Z"
      },
      "primaryReadonlyMasterKey": {
        "generationTime": "2022-02-25T20:30:11Z"
      },
      "secondaryReadonlyMasterKey": {
        "generationTime": "2022-02-25T20:30:11Z"
      }
    },
    "enablePartitionMerge": true,
    "minimalTlsVersion": "Tls"
  }
}

Définitions

Nom	Description
AccountKeyMetadata	Métadonnées liées à une clé d’accès pour un compte de base de données donné.
AnalyticalStorageConfiguration	Propriétés spécifiques du stockage analytique.
AnalyticalStorageSchemaType	Décrit les types de schémas pour le stockage analytique.
ApiProperties
BackupPolicyMigrationState	Objet représentant l’état de la migration entre les stratégies de sauvegarde.
BackupPolicyMigrationStatus	Décrit l’état de la migration entre les types de stratégie de sauvegarde.
BackupPolicyType	Décrit le mode de sauvegarde.
BackupStorageRedundancy	Énumération pour indiquer le type de redondance du stockage de sauvegarde.
Capability	Objet de capacité Cosmos DB
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 de base de données C* Cosmos DB.
ConsistencyPolicy	Stratégie de cohérence pour le compte de base de données Cosmos DB.
ContinuousModeBackupPolicy	Objet représentant la stratégie de sauvegarde en mode continu.
ContinuousModeProperties	Valeurs de configuration pour la sauvegarde en mode périodique
ContinuousTier	Énumération pour indiquer le type de niveau de sauvegarde continue.
CorsPolicy	Stratégie CORS pour le compte de base de données Cosmos DB.
createdByType	Type d’identité qui a créé la ressource.
CreateMode	Énumération pour indiquer le mode de création de compte.
DatabaseAccountGetResults	Un compte de base de données Azure Cosmos DB.
DatabaseAccountKeysMetadata	Métadonnées associées à chaque clé d’accès pour le compte de base de données Cosmos DB donné.
DatabaseAccountKind	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.
DatabaseAccountOfferType	Type d’offre pour le compte de base de données Cosmos DB.
DatabaseAccountUpdateParameters	Paramètres de mise à jour corrective des propriétés du compte de base de données Azure Cosmos DB.
DatabaseRestoreResource	Bases de données spécifiques à restaurer.
DefaultConsistencyLevel	Niveau de cohérence et paramètres de configuration par défaut du compte Cosmos DB.
FailoverPolicy	Stratégie de basculement pour une région donnée d’un compte de base de données.
GremlinDatabaseRestoreResource	Bases de données Gremlin spécifiques à restaurer.
IpAddressOrRange	Objet IpAddressOrRange
Location	Région dans laquelle le compte de base de données Azure Cosmos DB est déployé.
ManagedServiceIdentity	Identité de la ressource.
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.
PeriodicModeBackupPolicy	Objet représentant une stratégie de sauvegarde en mode périodique.
PeriodicModeProperties	Valeurs de configuration pour la sauvegarde en mode périodique
PrivateEndpointConnection	Une connexion de point de terminaison privé
PrivateEndpointProperty	Point de terminaison privé auquel la connexion appartient.
PrivateLinkServiceConnectionStateProperty	État de connexion de la connexion de point de terminaison privé.
PublicNetworkAccess	Indique si les demandes du réseau public sont autorisées
ResourceIdentityType	Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités du service.
RestoreMode	Décrit le mode de restauration.
RestoreParameters	Paramètres pour indiquer les informations relatives à la restauration.
ServerVersion	Décrit la version du compte MongoDB.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
UserAssignedIdentities	Liste des identités utilisateur associées à la ressource. Les références de clé de dictionnaire d’identité utilisateur seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ».
VirtualNetworkRule	Objet de règle de liste de contrôle d’accès au réseau virtuel

AccountKeyMetadata

Métadonnées liées à une clé d’accès pour un compte de base de données donné.

Nom	Type	Description
generationTime	string	Heure de génération au format UTC de la clé au format ISO-8601. Si la valeur est manquante dans l’objet, cela signifie que la dernière régénération de clé a été déclenchée avant 2022-06-18.

AnalyticalStorageConfiguration

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

Nom	Type	Description
schemaType	AnalyticalStorageSchemaType	Décrit les types de schémas pour le stockage analytique.

AnalyticalStorageSchemaType

Décrit les types de schémas pour le stockage analytique.

Nom	Type	Description
FullFidelity	string
WellDefined	string

ApiProperties

Nom	Type	Description
serverVersion	ServerVersion	Décrit la version du compte MongoDB.

BackupPolicyMigrationState

Objet représentant l’état de la migration entre les stratégies de sauvegarde.

Nom	Type	Description
startTime	string	Heure à laquelle la migration de la stratégie de sauvegarde a démarré (format ISO-8601).
status	BackupPolicyMigrationStatus	Décrit l’état de la migration entre les types de stratégie de sauvegarde.
targetType	BackupPolicyType	Décrit le type de stratégie de sauvegarde cible de la migration de la stratégie de sauvegarde.

BackupPolicyMigrationStatus

Décrit l’état de la migration entre les types de stratégie de sauvegarde.

Nom	Type	Description
Completed	string
Failed	string
InProgress	string
Invalid	string

BackupPolicyType

Décrit le mode de sauvegarde.

Nom	Type	Description
Continuous	string
Periodic	string

BackupStorageRedundancy

Énumération pour indiquer le type de redondance du stockage de sauvegarde.

Nom	Type	Description
Geo	string
Local	string
Zone	string

Capability

Objet de capacité Cosmos DB

Nom	Type	Description
name	string	Nom de la fonctionnalité Cosmos DB. Par exemple, « name » : « EnableCassandra ». Les valeurs actuelles incluent également « EnableTable » et « EnableGremlin ».

Capacity

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

Nom	Type	Description
totalThroughputLimit	integer	Limite de débit totale imposée au compte. Un totalThroughputLimit de 2000 impose une limite stricte de débit maximal pouvant être provisionné sur ce compte pour être 2000. Un totalThroughputLimit de -1 indique aucune limite de provisionnement du débit.

ConnectorOffer

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

Nom	Type	Description
Small	string

ConsistencyPolicy

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

Nom	Type	Description
defaultConsistencyLevel	DefaultConsistencyLevel	Niveau de cohérence et paramètres de configuration par défaut du compte Cosmos DB.
maxIntervalInSeconds	integer	Lorsqu’elle est utilisée avec le niveau de cohérence de l’obsolescence limitée, cette valeur représente la durée d’obsolescence (en secondes) tolérée. La plage acceptée pour cette valeur est 5 à 86400. Obligatoire lorsque defaultConsistencyPolicy est défini sur « BoundedStaleness ».
maxStalenessPrefix	integer	Lorsqu’elle est utilisée avec le niveau de cohérence de l’obsolescence limitée, cette valeur représente le nombre de demandes obsolètes tolérées. La plage acceptée pour cette valeur est de 1 à 2 147 483 647. Obligatoire lorsque defaultConsistencyPolicy est défini sur « BoundedStaleness ».

ContinuousModeBackupPolicy

Objet représentant la stratégie de sauvegarde en mode continu.

Nom	Type	Description
continuousModeProperties	ContinuousModeProperties	Valeurs de configuration pour la sauvegarde en mode continu
migrationState	BackupPolicyMigrationState	Objet représentant l’état de la migration entre les stratégies de sauvegarde.
type	string: Continuous	Décrit le mode de sauvegarde.

ContinuousModeProperties

Valeurs de configuration pour la sauvegarde en mode périodique

Nom	Type	Description
tier	ContinuousTier	Énumération pour indiquer le type de mode de sauvegarde continue

ContinuousTier

Énumération pour indiquer le type de niveau de sauvegarde continue.

Nom	Type	Description
Continuous30Days	string
Continuous7Days	string

CorsPolicy

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

Nom	Type	Description
allowedHeaders	string	En-têtes de requête que le domaine d’origine peut spécifier sur la requête CORS.
allowedMethods	string	Méthodes (verbes de requête HTTP) que le domaine d’origine peut utiliser pour une requête CORS.
allowedOrigins	string	Domaines d’origine autorisés à effectuer une demande auprès du service via CORS.
exposedHeaders	string	En-têtes de réponse qui peuvent être envoyés dans la réponse à la demande CORS et exposés par le navigateur à l’émetteur de la requête.
maxAgeInSeconds	integer	Durée maximale pendant laquelle un navigateur doit mettre en cache la requête OPTIONS préliminaire.

createdByType

Type d’identité qui a créé la ressource.

Nom	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CreateMode

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

Nom	Type	Description
Default	string
Restore	string

DatabaseAccountGetResults

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

Nom	Type	Valeur par défaut	Description
id	string		Identificateur de ressource unique de la ressource ARM.
identity	ManagedServiceIdentity		Identité de la ressource.
kind	DatabaseAccountKind	GlobalDocumentDB	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.
location	string		Emplacement du groupe de ressources auquel appartient la ressource.
name	string		Nom de la ressource ARM.
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration		Propriétés spécifiques du stockage analytique.
properties.apiProperties	ApiProperties		Propriétés spécifiques de l’API.
properties.backupPolicy	BackupPolicy: ContinuousModeBackupPolicy PeriodicModeBackupPolicy		Objet représentant la stratégie pour effectuer des sauvegardes sur un compte.
properties.capabilities	Capability[]		Liste des fonctionnalités de Cosmos DB pour le compte
properties.capacity	Capacity		Objet qui représente toutes les propriétés liées à l’application de la capacité sur un compte.
properties.connectorOffer	ConnectorOffer		Type d’offre du connecteur cassandra pour le compte C* de base de données Cosmos DB.
properties.consistencyPolicy	ConsistencyPolicy		Stratégie de cohérence pour le compte de base de données Cosmos DB.
properties.cors	CorsPolicy[]		Stratégie CORS pour le compte de base de données Cosmos DB.
properties.createMode	CreateMode	Default	Énumération pour indiquer le mode de création de compte.
properties.customerManagedKeyStatus	string		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.
properties.databaseAccountOfferType	DatabaseAccountOfferType		Type d’offre pour le compte de base de données Cosmos DB. Valeur par défaut : Standard.
properties.defaultIdentity	string		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.
properties.disableKeyBasedMetadataWriteAccess	boolean		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
properties.disableLocalAuth	boolean		Désactivez l’authentification locale et assurez-vous que seul MSI et AAD peuvent être utilisés exclusivement pour l’authentification.
properties.documentEndpoint	string		Point de terminaison de connexion pour le compte de base de données Cosmos DB.
properties.enableAnalyticalStorage	boolean		Indicateur pour indiquer s’il faut activer l’analytique de stockage.
properties.enableAutomaticFailover	boolean		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.
properties.enableBurstCapacity	boolean		Indicateur pour indiquer l’activation/désactivation de la fonctionnalité de capacité de rafale sur le compte
properties.enableCassandraConnector	boolean		Active le connecteur cassandra sur le compte C* Cosmos DB
properties.enableFreeTier	boolean		Indicateur pour indiquer si le niveau gratuit est activé.
properties.enableMultipleWriteLocations	boolean		Permet au compte d’écrire dans plusieurs emplacements
properties.enablePartitionMerge	boolean		Indicateur pour indiquer l’activation/désactivation de la fonctionnalité de fusion de partition sur le compte
properties.enablePerRegionPerPartitionAutoscale	boolean		Indicateur pour indiquer l’activation/désactivation de la fonctionnalité PerRegionPerPartitionAutoscale sur le compte
properties.failoverPolicies	FailoverPolicy[]		Tableau qui contient les régions classées par leurs priorités de basculement.
properties.instanceId	string		Identificateur unique affecté au compte de base de données
properties.ipRules	IpAddressOrRange[]		Liste d’IpRules.
properties.isVirtualNetworkFilterEnabled	boolean		Indicateur pour indiquer s’il faut activer/désactiver des règles de liste de contrôle d’accès de réseau virtuel.
properties.keyVaultKeyUri	string		URI du coffre de clés
properties.keysMetadata	DatabaseAccountKeysMetadata		Objet qui représente les métadonnées pour les clés de compte du compte Cosmos DB.
properties.locations	Location[]		Tableau qui contient tous les emplacements activés pour le compte Cosmos DB.
properties.minimalTlsVersion	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.
properties.networkAclBypass	NetworkAclBypass		Indique quels services sont autorisés à contourner les vérifications de pare-feu.
properties.networkAclBypassResourceIds	string[]		Tableau qui contient les ID de ressource pour le contournement Acl réseau pour le compte Cosmos DB.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Liste des connexions de point de terminaison privé configurées pour le compte Cosmos DB.
properties.provisioningState	string		É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é.
properties.publicNetworkAccess	PublicNetworkAccess		Indique si les demandes du réseau public sont autorisées
properties.readLocations	Location[]		Tableau qui contient les emplacements de lecture activés pour le compte Cosmos DB.
properties.restoreParameters	RestoreParameters		Paramètres pour indiquer les informations relatives à la restauration.
properties.virtualNetworkRules	VirtualNetworkRule[]		Liste des règles de liste de contrôle d’accès de réseau virtuel configurées pour le compte Cosmos DB.
properties.writeLocations	Location[]		Tableau qui contient l’emplacement d’écriture du compte Cosmos DB.
systemData	systemData		Métadonnées système relatives à cette ressource.
tags	object		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	string		Type de ressource Azure.

DatabaseAccountKeysMetadata

Métadonnées associées à chaque clé d’accès pour le compte de base de données Cosmos DB donné.

Nom	Type	Description
primaryMasterKey	AccountKeyMetadata	Métadonnées relatives à la clé de Read-Write primaire pour le compte de base de données Cosmos DB donné.
primaryReadonlyMasterKey	AccountKeyMetadata	Métadonnées relatives à la clé de Read-Only primaire pour le compte de base de données Cosmos DB donné.
secondaryMasterKey	AccountKeyMetadata	Métadonnées relatives à la clé de Read-Write secondaire pour le compte de base de données Cosmos DB donné.
secondaryReadonlyMasterKey	AccountKeyMetadata	Métadonnées relatives à la clé de Read-Only secondaire pour le compte de base de données Cosmos DB donné.

DatabaseAccountKind

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.

Nom	Type	Description
GlobalDocumentDB	string
MongoDB	string
Parse	string

DatabaseAccountOfferType

Type d’offre pour le compte de base de données Cosmos DB.

Nom	Type	Description
Standard	string

DatabaseAccountUpdateParameters

Paramètres de mise à jour corrective des propriétés du compte de base de données Azure Cosmos DB.

Nom	Type	Description
identity	ManagedServiceIdentity	Identité de la ressource.
location	string	Emplacement du groupe de ressources auquel appartient la ressource.
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration	Propriétés spécifiques du stockage analytique.
properties.apiProperties	ApiProperties	Propriétés spécifiques de l’API. Actuellement, pris en charge uniquement pour l’API MongoDB.
properties.backupPolicy	BackupPolicy: ContinuousModeBackupPolicy PeriodicModeBackupPolicy	Objet représentant la stratégie pour effectuer des sauvegardes sur un compte.
properties.capabilities	Capability[]	Liste des fonctionnalités de Cosmos DB pour le compte
properties.capacity	Capacity	Objet qui représente toutes les propriétés liées à l’application de la capacité sur un compte.
properties.connectorOffer	ConnectorOffer	Type d’offre du connecteur cassandra pour le compte C* de base de données Cosmos DB.
properties.consistencyPolicy	ConsistencyPolicy	Stratégie de cohérence pour le compte Cosmos DB.
properties.cors	CorsPolicy[]	Stratégie CORS pour le compte de base de données Cosmos DB.
properties.customerManagedKeyStatus	string	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.
properties.defaultIdentity	string	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.
properties.disableKeyBasedMetadataWriteAccess	boolean	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
properties.disableLocalAuth	boolean	Désactivez l’authentification locale et assurez-vous que seul MSI et AAD peuvent être utilisés exclusivement pour l’authentification.
properties.enableAnalyticalStorage	boolean	Indicateur pour indiquer s’il faut activer l’analytique de stockage.
properties.enableAutomaticFailover	boolean	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.
properties.enableBurstCapacity	boolean	Indicateur pour indiquer l’activation/désactivation de la fonctionnalité de capacité de rafale sur le compte
properties.enableCassandraConnector	boolean	Active le connecteur cassandra sur le compte C* Cosmos DB
properties.enableFreeTier	boolean	Indicateur pour indiquer si le niveau gratuit est activé.
properties.enableMultipleWriteLocations	boolean	Permet au compte d’écrire dans plusieurs emplacements
properties.enablePartitionMerge	boolean	Indicateur pour indiquer l’activation/désactivation de la fonctionnalité de fusion de partition sur le compte
properties.enablePerRegionPerPartitionAutoscale	boolean	Indicateur pour indiquer l’activation/désactivation de la fonctionnalité PerRegionPerPartitionAutoscale sur le compte
properties.ipRules	IpAddressOrRange[]	Liste d’IpRules.
properties.isVirtualNetworkFilterEnabled	boolean	Indicateur pour indiquer s’il faut activer/désactiver des règles de liste de contrôle d’accès de réseau virtuel.
properties.keyVaultKeyUri	string	URI du coffre de clés
properties.keysMetadata	DatabaseAccountKeysMetadata	Cette propriété est ignorée pendant l’opération de mise à jour, car les métadonnées sont en lecture seule. L’objet représente les métadonnées pour les clés de compte du compte Cosmos DB.
properties.locations	Location[]	Tableau qui contient les emplacements de géoréplication activés pour le compte Cosmos DB.
properties.minimalTlsVersion	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.
properties.networkAclBypass	NetworkAclBypass	Indique quels services sont autorisés à contourner les vérifications de pare-feu.
properties.networkAclBypassResourceIds	string[]	Tableau qui contient les ID de ressource pour le contournement Acl réseau pour le compte Cosmos DB.
properties.publicNetworkAccess	PublicNetworkAccess	Indique si les demandes du réseau public sont autorisées
properties.virtualNetworkRules	VirtualNetworkRule[]	Liste des règles de liste de contrôle d’accès de réseau virtuel configurées pour le compte Cosmos DB.
tags	object	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 ».

DatabaseRestoreResource

Bases de données spécifiques à restaurer.

Nom	Type	Description
collectionNames	string[]	Noms des collections disponibles pour la restauration.
databaseName	string	Nom de la base de données disponible pour la restauration.

DefaultConsistencyLevel

Niveau de cohérence et paramètres de configuration par défaut du compte Cosmos DB.

Nom	Type	Description
BoundedStaleness	string
ConsistentPrefix	string
Eventual	string
Session	string
Strong	string

FailoverPolicy

Stratégie de basculement pour une région donnée d’un compte de base de données.

Nom	Type	Description
failoverPriority	integer	Priorité de basculement de la région. Une priorité de basculement de 0 indique une région d’écriture. Valeur maximale d’une priorité de basculement = (nombre total de régions - 1). Les valeurs de priorité de basculement doivent être uniques pour chacune des régions dans lesquelles le compte de base de données existe.
id	string	Identificateur unique de la région dans laquelle le compte de base de données est répliqué. Exemple : <accountName>-<locationName>.
locationName	string	Nom de la région dans laquelle le compte de base de données existe.

GremlinDatabaseRestoreResource

Bases de données Gremlin spécifiques à restaurer.

Nom	Type	Description
databaseName	string	Nom de la base de données gremlin disponible pour la restauration.
graphNames	string[]	Noms des graphiques disponibles pour la restauration.

IpAddressOrRange

Objet IpAddressOrRange

Nom	Type	Description
ipAddressOrRange	string	Une seule adresse IPv4 ou une seule plage d’adresses IPv4 au format CIDR. Les adresses IP fournies doivent être bien mises en forme et ne peuvent pas être contenues dans l’une des plages suivantes : 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, car elles ne peuvent pas être appliquées par le filtre d’adresse IP. Exemple d’entrées valides : « 23.40.210.245 » ou « 23.40.210.0/8 ».

Location

Région dans laquelle le compte de base de données Azure Cosmos DB est déployé.

Nom	Type	Description
documentEndpoint	string	Point de terminaison de connexion pour la région spécifique. Exemple : https://<accountName>-<locationName>.documents.azure.com:443/
failoverPriority	integer	Priorité de basculement de la région. Une priorité de basculement de 0 indique une région d’écriture. Valeur maximale d’une priorité de basculement = (nombre total de régions - 1). Les valeurs de priorité de basculement doivent être uniques pour chacune des régions dans lesquelles le compte de base de données existe.
id	string	Identificateur unique de la région dans le compte de base de données. Exemple : <accountName>-<locationName>.
isZoneRedundant	boolean	Indicateur pour indiquer si cette région est une région AvailabilityZone
locationName	string	Nom de la région.
provisioningState	string	É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é.

ManagedServiceIdentity

Identité de la ressource.

Nom	Type	Description
principalId	string	ID principal de l’identité affectée par le système. Cette propriété est fournie uniquement pour une identité affectée par le système.
tenantId	string	ID de locataire de l’identité affectée par le système. Cette propriété est fournie uniquement pour une identité affectée par le système.
type	ResourceIdentityType	Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités du service.
userAssignedIdentities	UserAssignedIdentities	Liste des identités utilisateur associées à la ressource. Les références de clé de dictionnaire d’identité utilisateur seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ».

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.

Nom	Type	Description
Tls	string
Tls11	string
Tls12	string

NetworkAclBypass

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

Nom	Type	Description
AzureServices	string
None	string

PeriodicModeBackupPolicy

Objet représentant une stratégie de sauvegarde en mode périodique.

Nom	Type	Description
migrationState	BackupPolicyMigrationState	Objet représentant l’état de la migration entre les stratégies de sauvegarde.
periodicModeProperties	PeriodicModeProperties	Valeurs de configuration pour la sauvegarde en mode périodique
type	string: Periodic	Décrit le mode de sauvegarde.

PeriodicModeProperties

Valeurs de configuration pour la sauvegarde en mode périodique

Nom	Type	Description
backupIntervalInMinutes	integer	Entier représentant l’intervalle en minutes entre deux sauvegardes
backupRetentionIntervalInHours	integer	Entier représentant l’heure (en heures) de conservation de chaque sauvegarde
backupStorageRedundancy	BackupStorageRedundancy	Énumération pour indiquer le type de résidence de sauvegarde

PrivateEndpointConnection

Une connexion de point de terminaison privé

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nom de la ressource
properties.groupId	string	ID de groupe du point de terminaison privé.
properties.privateEndpoint	PrivateEndpointProperty	Point de terminaison privé auquel la connexion appartient.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	État de connexion de la connexion de point de terminaison privé.
properties.provisioningState	string	État d’approvisionnement du point de terminaison privé.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

PrivateEndpointProperty

Point de terminaison privé auquel la connexion appartient.

Nom	Type	Description
id	string	ID de ressource du point de terminaison privé.

PrivateLinkServiceConnectionStateProperty

État de connexion de la connexion de point de terminaison privé.

Nom	Type	Description
actionsRequired	string	Toute action requise au-delà du flux de travail de base (approuver/rejeter/déconnecter)
description	string	Description de la connexion du service private link.
status	string	État de connexion du service de liaison privée.

PublicNetworkAccess

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

Nom	Type	Description
Disabled	string
Enabled	string
SecuredByPerimeter	string

ResourceIdentityType

Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités du service.

Nom	Type	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

RestoreMode

Décrit le mode de restauration.

Nom	Type	Description
PointInTime	string

RestoreParameters

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

Nom	Type	Description
databasesToRestore	DatabaseRestoreResource[]	Liste des bases de données spécifiques disponibles pour la restauration.
gremlinDatabasesToRestore	GremlinDatabaseRestoreResource[]	Liste des bases de données gremlin spécifiques disponibles pour la restauration.
restoreMode	RestoreMode	Décrit le mode de restauration.
restoreSource	string	ID du compte de base de données pouvant être restauré à partir duquel la restauration doit être lancée. Par exemple : /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccounts}}
restoreTimestampInUtc	string	Heure à laquelle le compte doit être restauré (format ISO-8601).
restoreWithTtlDisabled	boolean	Spécifie si le compte restauré aura le délai d'To-Live désactivé lors de la restauration réussie.
tablesToRestore	string[]	Liste des tables spécifiques disponibles pour la restauration.

ServerVersion

Décrit la version du compte MongoDB.

Nom	Type	Description
3.2	string
3.6	string
4.0	string
4.2	string
5.0	string
6.0	string
7.0	string

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

UserAssignedIdentities

Liste des identités utilisateur associées à la ressource. Les références de clé de dictionnaire d’identité utilisateur seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ».

Nom	Type	Description

VirtualNetworkRule

Objet de règle de liste de contrôle d’accès au réseau virtuel

Nom	Type	Description
id	string	ID de ressource d’un sous-réseau, par exemple : /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.
ignoreMissingVNetServiceEndpoint	boolean	Créez une règle de pare-feu avant que le point de terminaison de service de réseau virtuel soit activé.

Partager via

Database Accounts - Update

Paramètres URI

Corps de la demande

Réponses

Sécurité

azure_auth

Étendues

Exemples

CosmosDBDatabaseAccountPatch

Exemple de requête

Exemple de réponse

Définitions

AccountKeyMetadata

AnalyticalStorageConfiguration

AnalyticalStorageSchemaType

ApiProperties

BackupPolicyMigrationState

BackupPolicyMigrationStatus

BackupPolicyType

BackupStorageRedundancy

Capability

Capacity

ConnectorOffer

ConsistencyPolicy

ContinuousModeBackupPolicy

ContinuousModeProperties

ContinuousTier

CorsPolicy

createdByType

CreateMode

DatabaseAccountGetResults

DatabaseAccountKeysMetadata

DatabaseAccountKind

DatabaseAccountOfferType

DatabaseAccountUpdateParameters

DatabaseRestoreResource

DefaultConsistencyLevel

FailoverPolicy

GremlinDatabaseRestoreResource

IpAddressOrRange

Location

ManagedServiceIdentity

MinimalTlsVersion

NetworkAclBypass

PeriodicModeBackupPolicy

PeriodicModeProperties

PrivateEndpointConnection

PrivateEndpointProperty

PrivateLinkServiceConnectionStateProperty

PublicNetworkAccess

ResourceIdentityType

RestoreMode

RestoreParameters

ServerVersion

systemData

UserAssignedIdentities

VirtualNetworkRule

Ressources supplémentaires