az cosmosdb keys

Note

Ta grupa poleceń zawiera polecenia zdefiniowane w obu Azure CLI i co najmniej jednym rozszerzeniu. Zainstaluj każde rozszerzenie, aby korzystać z rozszerzonych możliwości. Dowiedz się więcej o rozszerzeniach.

Zarządzanie kluczami Azure Cosmos DB.

Polecenia

Nazwa Opis Typ Stan
az cosmosdb keys list

Wyświetl listę kluczy dostępu lub parametrów połączenia dla konta bazy danych Azure Cosmos DB.

 Core ogólna dostępność
az cosmosdb keys regenerate

Wygeneruj ponownie klucz dostępu dla konta bazy danych Azure Cosmos DB.

 Core ogólna dostępność
az cosmosdb keys regenerate (cosmosdb-preview rozszerzenie)

Wygeneruj ponownie klucz dostępu dla konta bazy danych Azure Cosmos DB.

 Rozszerzenie ogólna dostępność

az cosmosdb keys list

Edytuj

Wyświetl listę kluczy dostępu lub parametrów połączenia dla konta bazy danych Azure Cosmos DB.

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

Przykłady

Wyświetl listę kluczy dostępu lub parametrów połączenia dla konta bazy danych Azure Cosmos DB. (autogenerated)

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

Parametry wymagane

--name -n

Nazwa konta usługi Cosmosdb.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu az configure --defaults group=<name>.

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--type

Typ klucza konta.

Właściwość Wartość
Domyślna wartość: keys
Dopuszczalne wartości: connection-strings, keys, read-only-keys
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az cosmosdb keys regenerate

Edytuj

Wygeneruj ponownie klucz dostępu dla konta bazy danych Azure Cosmos DB.

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

Przykłady

Wygeneruj ponownie klucz dostępu primaryReadonly dla konta bazy danych Azure Cosmos DB.

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

Parametry wymagane

--key-kind

Klucz dostępu do ponownego wygenerowania.

Właściwość Wartość
Dopuszczalne wartości: primary, primaryReadonly, secondary, secondaryReadonly

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--acquire-policy-token

Automatyczne uzyskiwanie tokenu Azure Policy dla tej operacji zasobu.

Właściwość Wartość
Grupa parametrów: Global Policy Arguments
--change-reference

Powiązany identyfikator odwołania do zmiany dla tej operacji zasobu.

Właściwość Wartość
Grupa parametrów: Global Policy Arguments
--ids

Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być kompletny identyfikator zasobu, zawierający wszystkie informacje dotyczące argumentów „Identyfikator zasobu”. Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--name -n

Nazwa konta bazy danych usługi Cosmos DB.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu az configure --defaults group=<name>.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az cosmosdb keys regenerate (cosmosdb-preview rozszerzenie)

Wygeneruj ponownie klucz dostępu dla konta bazy danych Azure Cosmos DB.

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]

Przykłady

Wygeneruj ponownie klucz dostępu dla konta bazy danych Azure Cosmos DB.

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

Wygeneruj ponownie klucz dostępu, pomijając ostatnie sprawdzenie użycia kluczy konta.

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

Parametry wymagane

--key-kind

Klucz dostępu do ponownego wygenerowania.

Właściwość Wartość
Dopuszczalne wartości: primary, primaryReadonly, secondary, secondaryReadonly

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--acquire-policy-token

Automatyczne uzyskiwanie tokenu Azure Policy dla tej operacji zasobu.

Właściwość Wartość
Grupa parametrów: Global Policy Arguments
--change-reference

Powiązany identyfikator odwołania do zmiany dla tej operacji zasobu.

Właściwość Wartość
Grupa parametrów: Global Policy Arguments
--ids

Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być kompletny identyfikator zasobu, zawierający wszystkie informacje dotyczące argumentów „Identyfikator zasobu”. Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--name -n

Nazwa konta bazy danych usługi Cosmos DB.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu az configure --defaults group=<name>.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--skip-safe-rotation
Wersja zapoznawcza

Pomiń ostatnie sprawdzenie użycia kluczy konta, które blokuje ponowne odzyskiwanie klucza, gdy klucz był ostatnio używany.

Właściwość Wartość
Dopuszczalne wartości: false, true
--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False