az cosmosdb keys

Note

Deze opdrachtgroep bevat opdrachten die zijn gedefinieerd in zowel Azure CLI als ten minste één extensie. Installeer elke extensie om te profiteren van de uitgebreide mogelijkheden. Meer informatie over uitbreidingen.

Beheer Azure Cosmos DB sleutels.

Opdracht

Name Description Type Status
az cosmosdb keys list

Vermeld de toegangssleutels of verbindingsreeksen voor een Azure Cosmos DB-databaseaccount.

 Core GA
az cosmosdb keys regenerate

Genereer een toegangssleutel opnieuw voor een Azure Cosmos DB databaseaccount.

 Core GA
az cosmosdb keys regenerate (cosmosdb-preview extensie)

Genereer een toegangssleutel opnieuw voor een Azure Cosmos DB databaseaccount.

 Extension GA

az cosmosdb keys list

Bewerken

Vermeld de toegangssleutels of verbindingsreeksen voor een Azure Cosmos DB-databaseaccount.

az cosmosdb keys list --name
                      --resource-group
                      [--type {connection-strings, keys, read-only-keys}]

Voorbeelden

Vermeld de toegangssleutels of verbindingsreeksen voor een Azure Cosmos DB-databaseaccount. (autogenerated)

az cosmosdb keys list --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup --subscription MySubscription --type keys

Vereiste parameters

--name -n

Cosmosdb-accountnaam.

--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--type

Het type accountsleutel.

Eigenschap Waarde
Default value: keys
Geaccepteerde waarden: connection-strings, keys, read-only-keys
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False

az cosmosdb keys regenerate

Bewerken

Genereer een toegangssleutel opnieuw voor een Azure Cosmos DB databaseaccount.

az cosmosdb keys regenerate --key-kind {primary, primaryReadonly, secondary, secondaryReadonly}
                            [--acquire-policy-token]
                            [--change-reference]
                            [--ids]
                            [--name]
                            [--resource-group]
                            [--subscription]

Voorbeelden

Genereer de primaire Toegangssleutelreadonly opnieuw voor een Azure Cosmos DB-databaseaccount.

az cosmosdb keys regenerate --key-kind primaryReadonly --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup --subscription MySubscription

Vereiste parameters

--key-kind

De toegangssleutel om opnieuw te genereren.

Eigenschap Waarde
Geaccepteerde waarden: primary, primaryReadonly, secondary, secondaryReadonly

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--acquire-policy-token

Automatisch een Azure Policy token verkrijgen voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--change-reference

De gerelateerde wijzigingsverwijzings-id voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. U moet ofwel --id's of andere 'Resource Id'-argumenten opgeven.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--name -n

Naam van het Cosmos DB-databaseaccount.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False

az cosmosdb keys regenerate (cosmosdb-preview extensie)

Genereer een toegangssleutel opnieuw voor een Azure Cosmos DB databaseaccount.

az cosmosdb keys regenerate --key-kind {primary, primaryReadonly, secondary, secondaryReadonly}
                            [--acquire-policy-token]
                            [--change-reference]
                            [--ids]
                            [--name]
                            [--resource-group]
                            [--skip-safe-rotation {false, true}]
                            [--subscription]

Voorbeelden

Genereer een toegangssleutel opnieuw voor een Azure Cosmos DB databaseaccount.

az cosmosdb keys regenerate --resource-group MyResourceGroup --name MyAccount --key-kind primary

Genereer een toegangssleutel opnieuw, waarbij de accountsleutels voor het laatst worden gecontroleerd.

az cosmosdb keys regenerate --resource-group MyResourceGroup --name MyAccount --key-kind primary --skip-safe-rotation true

Vereiste parameters

--key-kind

De toegangssleutel om opnieuw te genereren.

Eigenschap Waarde
Geaccepteerde waarden: primary, primaryReadonly, secondary, secondaryReadonly

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--acquire-policy-token

Automatisch een Azure Policy token verkrijgen voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--change-reference

De gerelateerde wijzigingsverwijzings-id voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. U moet ofwel --id's of andere 'Resource Id'-argumenten opgeven.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--name -n

Naam van het Cosmos DB-databaseaccount.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--skip-safe-rotation
Preview

Sla de laatste gebruikscontrole van de accountsleutels over die het opnieuw genereren van sleutels blokkeert wanneer de sleutel onlangs is gebruikt.

Eigenschap Waarde
Geaccepteerde waarden: false, true
--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False