Obtenir des clés primaires, secondaires, lues ou en lecture-écriture dans Azure Cosmos DB

Utilisez la Portail Azure pour obtenir l’une des quatre clés intégrées :

• Lecture-écriture principale
• Lecture seule principale
• Lecture-écriture secondaire
• Lecture seule secondaire

1. Connectez-vous au portail Azure (https://portal.azure.com).

2. Accédez à votre compte Azure Cosmos DB existant.

3. Dans le volet de ressources du compte, sélectionnez Clés dans la section Paramètres du menu de service.

4. Recherchez et enregistrez la valeur des champs Clé primaire ou Clé secondaire dans la section Clés en lecture seule ou en lecture seule .

   Conseil

   Vous devrez peut-être afficher les clés avant d’enregistrer leurs valeurs. Par défaut, les clés sont masquées.

Utilisez ce script Azure CLI pour obtenir des clés ou des chaîne de connexion à partir de votre compte Azure Cosmos DB.

az cosmosdb keys list \
    --resource-group "<name-of-existing-resource-group>" \
    --name "<name-of-existing-account>" \
    --type "keys"

--type les options d’argument sont les suivantes :

• connection-strings
• keys
• read-only-keys

Pour plus d’informations, consultez az cosmosdb keys list.

Utilisez ce script Azure PowerShell pour obtenir des clés ou des chaîne de connexion à partir de votre compte Azure Cosmos DB.

$parameters = @{
    ResourceGroupName = "<name-of-existing-resource-group>"
    Name = "<name-of-existing-account>"
    Type = "Keys"
}
Get-AzCosmosDBAccountKey @parameters

Type Les options de paramètre sont les suivantes :

• ConnectionStrings
• Keys
• ReadOnlyKeys

Pour plus d’informations, consultez Get-AzCosmosDBAccountKey.

Cet exemple de modèle Bicep génère toutes les informations d’identification d’un compte Azure Cosmos DB existant.

metadata description = 'Gets all keys and connection strings for an Azure Cosmos DB account.'

@description('The name of the Azure Cosmos DB account.')
param accountName string

resource account 'Microsoft.DocumentDB/databaseAccounts@2024-05-15' existing = {
  name: accountName
}

output endpoint string = account.properties.documentEndpoint

var keys = account.listKeys()

output keys object = {
  primary: {
    readWrite: keys.primaryMasterKey
    readOnly: keys.primaryReadonlyMasterKey
  }
  secondary: {
    readWrite: keys.secondaryMasterKey
    readOnly: keys.secondaryReadonlyMasterKey
  }
}

var connectionStrings = account.listConnectionStrings()

output connectionStrings object = {
  primary: {
    readWrite: connectionStrings.connectionStrings[0].connectionString
    readOnly: connectionStrings.connectionStrings[1].connectionString
  }
  secondary: {
    readWrite: connectionStrings.connectionStrings[2].connectionString
    readOnly: connectionStrings.connectionStrings[3].connectionString
  }
}