次の方法で共有

az cosmosdb keys

Azure Cosmos DB のキーを管理します。

コマンド

名前 説明 型 状態
az cosmosdb keys list

Azure Cosmos DB データベース アカウントのアクセス キーまたは接続文字列を一覧表示します。

 Core GA
az cosmosdb keys regenerate

Azure Cosmos DB データベース アカウントのアクセス キーを再生成します。

 Core 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 データベース アカウントのアクセス キーまたは接続文字列を一覧表示します。 (autogenerated)

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

必須のパラメーター

--name -n

Cosmosdb アカウント名。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--type

アカウント キーの種類。

プロパティ 値
規定値: keys
指定可能な値: connection-strings, keys, read-only-keys
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

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

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

プロパティ 値
パラメーター グループ: Resource Id Arguments
--name -n

Cosmos DB データベース アカウントの名前。

プロパティ 値
パラメーター グループ: Resource Id Arguments
--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

プロパティ 値
パラメーター グループ: Resource Id Arguments
--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

プロパティ 値
パラメーター グループ: Resource Id Arguments
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False