共用方式為

az cosmosdb keys

  • 參考

管理 Azure Cosmos DB 金鑰。

命令

名稱 Description 類型 狀態
az cosmosdb keys list

列出 Azure Cosmos DB 資料庫帳戶的存取金鑰或連接字串。

 核心 GA
az cosmosdb keys regenerate

重新產生 Azure Cosmos DB 資料庫帳戶的存取金鑰。

 核心 GA

az cosmosdb keys list

編輯

列出 Azure Cosmos DB 資料庫帳戶的存取金鑰或連接字串。

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

範例

列出 Azure Cosmos DB 資料庫帳戶的存取金鑰或連接字串。 （自動產生）

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

必要參數

--name -n

Cosmosdb 帳戶名稱。

--resource-group -g

資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name> 。

選擇性參數

--type

帳戶金鑰的類型。

接受的值: connection-strings, keys, read-only-keys
預設值: keys
全域參數
--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az cosmosdb keys regenerate

編輯

重新產生 Azure Cosmos DB 資料庫帳戶的存取金鑰。

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

範例

重新產生 Azure Cosmos DB 資料庫帳戶的 primaryReadonly 存取金鑰。

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

必要參數

--key-kind

要重新產生的存取金鑰。

接受的值: primary, primaryReadonly, secondary, secondaryReadonly

選擇性參數

--ids

一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源識別碼」引數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」引數。

--name -n

Cosmos DB 資料庫帳戶的名稱。

--resource-group -g

資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name> 。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

全域參數
--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。