az cosmosdb keys

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

コマンド

名前	説明	型	状態
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

サブスクリプションの名前または ID。 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

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

--name -n

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

--resource-group -g

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

--subscription

サブスクリプションの名前または ID。 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

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。