az cosmosdb keys

Note

Den här kommandogruppen har kommandon som definieras i både Azure CLI och minst ett tillägg. Installera varje tillägg för att dra nytta av dess utökade funktioner. Läs mer om tillägg.

Hantera Azure Cosmos DB nycklar.

Kommandon

Name Description Typ Status
az cosmosdb keys list

Visa en lista över åtkomstnycklar eller anslutningssträngar för ett Azure Cosmos DB databaskonto.

 Core GA
az cosmosdb keys regenerate

Återskapa en åtkomstnyckel för ett Azure Cosmos DB databaskonto.

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

Återskapa en åtkomstnyckel för ett Azure Cosmos DB databaskonto.

 Förlängning GA

az cosmosdb keys list

Redigera

Visa en lista över åtkomstnycklar eller anslutningssträngar för ett Azure Cosmos DB databaskonto.

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

Exempel

Visa en lista över åtkomstnycklar eller anslutningssträngar för ett Azure Cosmos DB databaskonto. (autogenerated)

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

Obligatoriska parametrar

--name -n

Cosmosdb-kontonamn.

--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--type

Typ av kontonyckel.

Egenskap Värde
Standardvärde: keys
Godkända värden: connection-strings, keys, read-only-keys
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az cosmosdb keys regenerate

Redigera

Återskapa en åtkomstnyckel för ett Azure Cosmos DB databaskonto.

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

Exempel

Återskapa primaryReadonly-åtkomstnyckeln för ett Azure Cosmos DB databaskonto.

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

Obligatoriska parametrar

--key-kind

Åtkomstnyckeln som ska återskapas.

Egenskap Värde
Godkända värden: primary, primaryReadonly, secondary, secondaryReadonly

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--acquire-policy-token

Hämtar en Azure Policy token automatiskt för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--change-reference

Det relaterade ändringsreferens-ID:t för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om 'resurs-ID' argumenten. Du bör ange antingen --id eller andra "Resurs-ID"-argument.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--name -n

Namnet på Cosmos DB-databaskontot.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

Egenskap Värde
Parametergrupp: Resource Id Arguments
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az cosmosdb keys regenerate (cosmosdb-preview anknytning)

Återskapa en åtkomstnyckel för ett Azure Cosmos DB databaskonto.

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]

Exempel

Återskapa en åtkomstnyckel för ett Azure Cosmos DB databaskonto.

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

Återskapa en åtkomstnyckel och hoppa över den senaste användningskontrollen för kontonycklarna.

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

Obligatoriska parametrar

--key-kind

Åtkomstnyckeln som ska återskapas.

Egenskap Värde
Godkända värden: primary, primaryReadonly, secondary, secondaryReadonly

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--acquire-policy-token

Hämtar en Azure Policy token automatiskt för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--change-reference

Det relaterade ändringsreferens-ID:t för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om 'resurs-ID' argumenten. Du bör ange antingen --id eller andra "Resurs-ID"-argument.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--name -n

Namnet på Cosmos DB-databaskontot.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--skip-safe-rotation
Förhandsgranskning

Hoppa över den senaste användningskontrollen för kontonycklar som blockerar nyckelregenerering när nyckeln nyligen användes.

Egenskap Värde
Godkända värden: false, true
--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

Egenskap Värde
Parametergrupp: Resource Id Arguments
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False