az keyvault

KeyVault キー、シークレット、証明書を管理します。

コマンド

名前	説明	型	状態
az keyvault backup	HSM の完全バックアップを管理します。	Core	GA
az keyvault backup start	HSM の完全バックアップを開始します。	Core	GA
az keyvault certificate	Manage certificates.	Core	GA
az keyvault certificate backup	指定した証明書をバックアップします。	Core	GA
az keyvault certificate contact	証明書管理の連絡先を管理します。	Core	GA
az keyvault certificate contact add	指定したコンテナーに連絡先を追加して、証明書操作の通知を受け取ります。	Core	GA
az keyvault certificate contact delete	指定したコンテナーから証明書の連絡先を削除します。	Core	GA
az keyvault certificate contact list	指定したキー コンテナーの証明書の連絡先を一覧表示します。	Core	GA
az keyvault certificate create	Key Vault 証明書を作成します。	Core	GA
az keyvault certificate delete	指定したキー コンテナーから証明書を削除します。	Core	Deprecated
az keyvault certificate download	Key Vault 証明書の公開部分をダウンロードします。	Core	GA
az keyvault certificate get-default-policy	自己署名証明書の既定のポリシーを取得します。	Core	GA
az keyvault certificate import	証明書を KeyVault にインポートします。	Core	GA
az keyvault certificate issuer	証明書の発行者情報を管理します。	Core	GA
az keyvault certificate issuer admin	証明書発行者の管理者情報を管理します。	Core	GA
az keyvault certificate issuer admin add	指定した証明書発行者の管理者の詳細を追加します。	Core	GA
az keyvault certificate issuer admin delete	指定した証明書発行者の管理者の詳細を削除します。	Core	GA
az keyvault certificate issuer admin list	指定した証明書発行者の管理者を一覧表示します。	Core	GA
az keyvault certificate issuer create	証明書発行者レコードを作成します。	Core	GA
az keyvault certificate issuer delete	指定した証明書発行者を削除します。	Core	GA
az keyvault certificate issuer list	キー コンテナーの証明書発行者のプロパティを一覧表示します。	Core	GA
az keyvault certificate issuer show	指定した証明書発行者を取得します。	Core	GA
az keyvault certificate issuer update	証明書発行者レコードを更新します。	Core	GA
az keyvault certificate list	指定したキー コンテナー内の証明書を一覧表示します。	Core	GA
az keyvault certificate list-deleted	現在回復可能な削除済み証明書を一覧表示します。	Core	GA
az keyvault certificate list-versions	証明書のバージョンを一覧表示します。	Core	GA
az keyvault certificate pending	保留中の証明書作成操作を管理します。	Core	GA
az keyvault certificate pending delete	特定の証明書の作成操作を削除します。	Core	GA
az keyvault certificate pending merge	証明書または証明書チェーンを、サーバー上に存在するキー ペアとマージします。	Core	GA
az keyvault certificate pending show	証明書の作成操作を取得します。	Core	GA
az keyvault certificate purge	指定した削除された証明書を完全に削除します。	Core	GA
az keyvault certificate recover	削除された証明書を最新バージョンに回復します。	Core	GA
az keyvault certificate restore	バックアップされた証明書をコンテナーに復元します。	Core	GA
az keyvault certificate set-attributes	特定の証明書に関連付けられている、指定された属性を更新します。	Core	GA
az keyvault certificate show	証明書に関する情報を取得します。	Core	GA
az keyvault certificate show-deleted	削除された証明書を取得します。	Core	GA
az keyvault check-name	指定された名前が有効であり、まだ使用されていないことを確認します。	Core	GA
az keyvault create	コンテナーまたは HSM を作成します。	Core	GA
az keyvault delete	コンテナーまたは HSM を削除します。	Core	GA
az keyvault delete-policy	Key Vault のセキュリティ ポリシー設定を削除します。	Core	GA
az keyvault key	Manage keys.	Core	GA
az keyvault key backup	指定したキーのバックアップをクライアントにダウンロードするように要求します。	Core	GA
az keyvault key create	新しいキーを作成して格納し、キー パラメーターと属性をクライアントに返します。	Core	GA
az keyvault key decrypt	暗号化されたデータの 1 つのブロックを復号化します。	Core	Preview
az keyvault key delete	コンテナーまたは HSM のストレージから任意の種類のキーを削除します。	Core	GA
az keyvault key download	保存されているキーの公開部分をダウンロードします。	Core	GA
az keyvault key encrypt	コンテナーまたは HSM に格納されている暗号化キーを使用して、任意のバイト シーケンスを暗号化します。	Core	Preview
az keyvault key get-attestation	キーの構成証明 BLOB を取得します。	Core	GA
az keyvault key get-policy-template	ポリシー テンプレートを JSON でエンコードされたポリシー定義として返します。	Core	Preview
az keyvault key import	秘密キーをインポートします。	Core	GA
az keyvault key list	指定したコンテナーまたは HSM のキーを一覧表示します。	Core	GA
az keyvault key list-deleted	指定したコンテナーまたは HSM で削除されたキーを一覧表示します。	Core	GA
az keyvault key list-versions	キーのバージョンの識別子とプロパティを一覧表示します。	Core	GA
az keyvault key purge	指定したキーを完全に削除します。	Core	GA
az keyvault key random	マネージド HSM から要求されたランダム バイト数を取得します。	Core	GA
az keyvault key recover	削除したキーを最新バージョンに回復します。	Core	GA
az keyvault key restore	バックアップされたキーをコンテナーまたは HSM に復元します。	Core	GA
az keyvault key rotate	キーの新しいバージョンを生成して、キー ポリシーに基づいてキーをローテーションします。	Core	GA
az keyvault key rotation-policy	キーのローテーション ポリシーを管理します。	Core	GA
az keyvault key rotation-policy show	Key Vault キーのローテーション ポリシーを取得します。	Core	GA
az keyvault key rotation-policy update	Key Vault キーのローテーション ポリシーを更新します。	Core	GA
az keyvault key set-attributes	更新キー操作では、格納されているキーの指定された属性が変更され、コンテナーまたは HSM に格納されている任意のキーの種類とキー バージョンに適用できます。	Core	GA
az keyvault key show	キーの属性を取得し、非対称キーの場合は公開資料を取得します。	Core	GA
az keyvault key show-deleted	削除されたキーの公開部分を取得します。	Core	GA
az keyvault key sign	コンテナーまたは HSM に格納されているキーを使用して、ダイジェストから署名を作成します。	Core	GA
az keyvault key verify	コンテナーまたは HSM に格納されているキーを使用して署名を確認します。	Core	GA
az keyvault list	コンテナーや HSM を一覧表示します。	Core	GA
az keyvault list-deleted	サブスクリプション内の削除されたコンテナーまたは HSM に関する情報を取得します。	Core	GA
az keyvault network-rule	コンテナー ネットワーク ACL を管理します。	Core	GA
az keyvault network-rule add	Key Vault のネットワーク ACL にネットワーク規則を追加します。	Core	GA
az keyvault network-rule list	Key Vault のネットワーク ACL のネットワーク 規則を一覧表示します。	Core	GA
az keyvault network-rule remove	Key Vault のネットワーク ACL からネットワーク規則を削除します。	Core	GA
az keyvault network-rule wait	コンテナーの条件が満たされるまで、CLI を待機状態にします。	Core	GA
az keyvault private-endpoint-connection	コンテナー/HSM プライベート エンドポイント接続を管理します。	Core	GA
az keyvault private-endpoint-connection approve	Key Vault/HSM のプライベート エンドポイント接続要求を承認します。	Core	GA
az keyvault private-endpoint-connection delete	Key Vault/HSM に関連付けられている指定されたプライベート エンドポイント接続を削除します。	Core	GA
az keyvault private-endpoint-connection list	HSM に関連付けられているすべてのプライベート エンドポイント接続を一覧表示します。	Core	GA
az keyvault private-endpoint-connection reject	Key Vault/HSM のプライベート エンドポイント接続要求を拒否します。	Core	GA
az keyvault private-endpoint-connection show	Key Vault/HSM に関連付けられているプライベート エンドポイント接続の詳細を表示します。	Core	GA
az keyvault private-endpoint-connection wait	プライベート エンドポイント接続の条件が満たされるまで、CLI を待機状態にします。	Core	GA
az keyvault private-link-resource	コンテナー/HSM プライベート リンク リソースを管理します。	Core	GA
az keyvault private-link-resource list	Key Vault/HSM でサポートされているプライベート リンク リソースを一覧表示します。	Core	GA
az keyvault purge	指定したコンテナーまたは HSM を完全に削除します。 Aka 削除されたコンテナーまたは HSM を消去します。	Core	GA
az keyvault recover	コンテナーまたは HSM を復旧します。	Core	GA
az keyvault region	MHSM マルチリージョンを管理します。	Core	GA
az keyvault region add	マネージド HSM プールのリージョンを追加します。	Core	GA
az keyvault region list	マネージド HSM プールに関連付けられているリージョン情報を取得します。	Core	GA
az keyvault region remove	マネージド HSM プールのリージョンを削除します。	Core	GA
az keyvault region wait	HSM の条件が満たされるまで、CLI を待機状態にします。	Core	GA
az keyvault restore	HSM の完全復元を管理します。	Core	GA
az keyvault restore start	HSM の完全バックアップを復元します。	Core	GA
az keyvault role	アクセス制御のユーザー ロールを管理します。	Core	GA
az keyvault role assignment	ロールの割り当てを管理します。	Core	GA
az keyvault role assignment create	ユーザー、グループ、またはサービス プリンシパルに対して、新しいロール割り当てを作成します。	Core	GA
az keyvault role assignment delete	ロールの割り当てを削除します。	Core	GA
az keyvault role assignment list	ロールの割り当てを一覧表示します。	Core	GA
az keyvault role definition	ロール定義を管理します。	Core	GA
az keyvault role definition create	カスタム ロール定義を作成します。	Core	GA
az keyvault role definition delete	ロール定義を削除します。	Core	GA
az keyvault role definition list	ロール定義を一覧表示します。	Core	GA
az keyvault role definition show	ロール定義の詳細を表示します。	Core	GA
az keyvault role definition update	ロール定義を更新します。	Core	GA
az keyvault secret	Manage secrets.	Core	GA
az keyvault secret backup	指定したシークレットをバックアップします。	Core	GA
az keyvault secret delete	シークレットのすべてのバージョンを削除します。	Core	Deprecated
az keyvault secret download	KeyVault からシークレットをダウンロードします。	Core	GA
az keyvault secret list	指定したキー コンテナー内のシークレットを一覧表示します。	Core	GA
az keyvault secret list-deleted	指定したコンテナーの削除されたシークレットを一覧表示します。	Core	GA
az keyvault secret list-versions	指定したシークレットのすべてのバージョンを一覧表示します。	Core	GA
az keyvault secret purge	指定したシークレットを完全に削除します。	Core	GA
az keyvault secret recover	削除されたシークレットを最新バージョンに回復します。	Core	GA
az keyvault secret restore	バックアップされたシークレットをコンテナーに復元します。	Core	GA
az keyvault secret set	シークレット (存在しない場合) を作成するか、KeyVault でシークレットを更新します。	Core	GA
az keyvault secret set-attributes	特定のキー コンテナー内の指定されたシークレットに関連付けられている属性を更新します。	Core	GA
az keyvault secret show	特定のキー コンテナーから指定されたシークレットを取得します。	Core	GA
az keyvault secret show-deleted	指定した削除されたシークレットを取得します。	Core	GA
az keyvault security-domain	セキュリティ ドメインの操作を管理します。	Core	GA
az keyvault security-domain download	HSM からセキュリティ ドメイン ファイルをダウンロードします。	Core	GA
az keyvault security-domain init-recovery	HSM の交換キーを取得します。	Core	GA
az keyvault security-domain restore-blob	セキュリティ ドメイン ファイルを暗号化解除して BLOB として暗号化できるようにします。 セキュリティ ドメインのアップロードを使用してファイルを HSM にアップロードする前に、オフライン環境で実行できます。	Core	GA
az keyvault security-domain upload	HSM の復元を開始します。	Core	GA
az keyvault security-domain wait	HSM セキュリティ ドメインの操作が完了するまで、CLI を待機状態にします。	Core	GA
az keyvault set-policy	Key Vault のセキュリティ ポリシー設定を更新します。	Core	GA
az keyvault setting	MHSM 設定を管理します。	Core	GA
az keyvault setting list	マネージド HSM に関連付けられているすべての設定を取得します。	Core	GA
az keyvault setting show	マネージド HSM に関連付けられている特定の設定を取得します。	Core	GA
az keyvault setting update	マネージド HSM に関連付けられている特定の設定を更新します。	Core	GA
az keyvault show	コンテナーまたは HSM の詳細を表示します。	Core	GA
az keyvault show-deleted	削除されたコンテナーまたは HSM の詳細を表示します。	Core	GA
az keyvault update	コンテナーのプロパティを更新します。	Core	GA
az keyvault update-hsm	HSM のプロパティを更新します。	Core	GA
az keyvault wait	コンテナーの条件が満たされるまで、CLI を待機状態にします。	Core	GA
az keyvault wait-hsm	HSM の条件が満たされるまで、CLI を待機状態にします。	Core	GA

az keyvault check-name

指定された名前が有効であり、まだ使用されていないことを確認します。

az keyvault check-name --name
                       [--resource-type {hsm}]

必須のパラメーター

--name -n

指定したリソース グループ内の HSM の名前。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-type

リソースの種類。

プロパティ	値
規定値:	hsm
指定可能な値:	hsm

グローバル パラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	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 keyvault create

コンテナーまたは HSM を作成します。

RBAC 承認は既定で有効になっています。 --enable-rbac-authorizationが手動でfalseに指定されていて、--no-self-perms フラグが指定されていない場合、現在のユーザーまたはサービス プリンシパルに対する既定のアクセス許可が作成されます。

既定のアクセス許可を割り当てる場合は、az account setを使用するのではなく、最初に --subscription を使用して既定のサブスクリプションを変更する必要があります。

az keyvault create --resource-group
                   [--administrators]
                   [--bypass {AzureServices, None}]
                   [--default-action {Allow, Deny}]
                   [--enable-purge-protection {false, true}]
                   [--enable-rbac-authorization {false, true}]
                   [--enabled-for-deployment {false, true}]
                   [--enabled-for-disk-encryption {false, true}]
                   [--enabled-for-template-deployment {false, true}]
                   [--hsm-name]
                   [--location]
                   [--mi-user-assigned]
                   [--name]
                   [--network-acls]
                   [--network-acls-ips]
                   [--network-acls-vnets]
                   [--no-self-perms {false, true}]
                   [--no-wait]
                   [--public-network-access {Disabled, Enabled}]
                   [--retention-days]
                   [--sku]
                   [--tags]

例

ネットワーク ACL が指定されたキー コンテナーを作成します (--network-acls を使用して、JSON 文字列を使用して IP と VNet の規則を指定します)。

az keyvault create --location westus2 --name MyKeyVault --resource-group MyResourceGroup --network-acls "{\"ip\": [\"1.2.3.4\", \"2.3.4.0/24\"], \"vnet\": [\"vnet_name_1/subnet_name1\", \"vnet_name_2/subnet_name2\", \"/subscriptions/000000-0000-0000/resourceGroups/MyResourceGroup/providers/Microsoft.Network/virtualNetworks/MyVNet/subnets/MySubnet\"]}"

ネットワーク ACL が指定されたキー コンテナーを作成します (--network-acls を使用して、JSON ファイルを使用して IP と VNet の規則を指定します)。

az keyvault create --location westus2 --name MyKeyVault --resource-group MyResourceGroup --network-acls network-acls-example.json

ネットワーク ACL が指定されたキー コンテナーを作成します (--network-acls-ips を使用して IP 規則を指定します)。

az keyvault create --location westus2 --name MyKeyVault --resource-group MyResourceGroup --network-acls-ips 3.4.5.0/24 4.5.6.0/24

ネットワーク ACL が指定されたキー コンテナーを作成します (--network-acls-vnets を使用して VNet ルールを指定します)。

az keyvault create --location westus2 --name MyKeyVault --resource-group MyResourceGroup --network-acls-vnets vnet_name_2/subnet_name_2 vnet_name_3/subnet_name_3 /subscriptions/000000-0000-0000/resourceGroups/MyResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet_name_4/subnets/subnet_name_4

ネットワーク ACL が指定されたキー コンテナーを作成します (--network-acls、--network-acls-ips、--network-acls-vnets を一緒に使用し、冗長な規則が削除され、最後に 4 つの IP 規則と 3 つの VNet 規則が存在します)。

az keyvault create --location westus2 --name MyKeyVault --resource-group MyResourceGroup --network-acls "{\"ip\": [\"1.2.3.4\", \"2.3.4.0/24\"], \"vnet\": [\"vnet_name_1/subnet_name1\", \"vnet_name_2/subnet_name2\"]}" --network-acls-ips 3.4.5.0/24 4.5.6.0/24 --network-acls-vnets vnet_name_2/subnet_name_2 vnet_name_3/subnet_name_3 /subscriptions/000000-0000-0000/resourceGroups/MyResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet_name_4/subnets/subnet_name_4

キー コンテナーを作成してください。 (autogenerated)

az keyvault create --location westus2 --name MyKeyVault --resource-group MyResourceGroup

必須のパラメーター

--resource-group -g

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

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--administrators

[HSM のみ]Managed HSM のデータ プレーン操作の管理者ロール。 割り当てられる OID のスペース区切りリストを受け入れます。

--bypass

スペース区切りの使用のためにトラフィックをバイパスします。

プロパティ	値
Parameter group:	Network Rule Arguments
指定可能な値:	AzureServices, None

--default-action

ルールが一致しない場合に適用される既定のアクション。

プロパティ	値
Parameter group:	Network Rule Arguments
指定可能な値:	Allow, Deny

--enable-purge-protection

このコンテナー/マネージド HSM プールに対して消去に対する保護を有効にするかどうかを指定するプロパティ。 このプロパティを true に設定すると、このコンテナー/マネージド HSM プールとそのコンテンツの消去に対する保護がアクティブになります。回復不可能なハード削除を開始できるのは、Key Vault/Managed HSM サービスだけです。 この設定は、論理的な削除も有効になっている場合にのみ有効です。 この機能を有効にすることは元に戻すことはできません。

プロパティ	値
指定可能な値:	false, true

--enable-rbac-authorization

データ アクションの承認方法を制御するプロパティ。 true の場合、キー コンテナーはデータ アクションの承認にロール ベースのアクセス制御 (RBAC) を使用し、コンテナーのプロパティで指定されたアクセス ポリシーは無視されます。 false の場合、キー コンテナーはコンテナーのプロパティで指定されたアクセス ポリシーを使用し、Azure Resource Manager に格納されているポリシーはすべて無視されます。 null または指定されていない場合、既定値が true のコンテナーが作成されます。 管理アクションは常に RBAC で承認されることに注意してください。

プロパティ	値
規定値:	True
指定可能な値:	false, true

--enabled-for-deployment

[コンテナーのみ]キー コンテナーからシークレットとして格納されている証明書を Azure Virtual Machines が取得できるかどうかを指定するプロパティ。

プロパティ	値
指定可能な値:	false, true

--enabled-for-disk-encryption

[コンテナーのみ]コンテナーからシークレットを取得してキーのラップを解除することを Azure Disk Encryption で許可するかどうかを指定するプロパティ。

プロパティ	値
指定可能な値:	false, true

--enabled-for-template-deployment

[コンテナーのみ]Azure Resource Manager がキー コンテナーからシークレットを取得できるかどうかを指定するプロパティ。

プロパティ	値
指定可能な値:	false, true

--hsm-name

HSM の名前。 (--hsm-name と --name/-n は相互に排他的です。そのうちの 1 つだけを指定してください)。

--location -l

Location. 値のソース: az account list-locations az configure --defaults location=<location>を使用して、既定の場所を構成できます。

--mi-user-assigned

[HSM のみ]マネージド HSM のユーザー割り当てマネージド ID を有効にします。 ID リソース ID のスペース区切りの一覧を受け入れます。

--name -n

コンテナーの名前。

--network-acls

Network ACLs. JSON ファイル名または JSON 文字列を受け入れます。 JSON 形式: {\"ip\":[<ip1>, <ip2>...],\"vnet\":[<vnet_name_1>/<subnet_name_1>,<subnet_id2>...]}。

プロパティ	値
Parameter group:	Network Rule Arguments

--network-acls-ips

ネットワーク ACL の IP 規則。 IP アドレスのスペース区切りの一覧。

プロパティ	値
Parameter group:	Network Rule Arguments

--network-acls-vnets

ネットワーク ACLS VNet 規則。 Vnet とサブネットのペアまたはサブネット リソース ID のスペース区切りの一覧。

プロパティ	値
Parameter group:	Network Rule Arguments

--no-self-perms

[コンテナーのみ]新しいコンテナーに現在のユーザー/サービス プリンシパルのアクセス許可を追加しないでください。

プロパティ	値
指定可能な値:	false, true

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ	値
規定値:	False

--public-network-access

プライベート エンドポイントが有効になっている間、パブリック ネットワークから送信されるデータ プレーン トラフィックのアクセス許可を制御します。

プロパティ	値
指定可能な値:	Disabled, Enabled

--retention-days

データの論理的な削除の保有日数。 >=7 と <=90 を受け入れます。 keyvault を作成する場合、既定値は 90 です。 MHSM の作成に必要です。

--sku

Required. SKU details. Vault で使用できる値: Premium、Standard。 Default: standard. HSM に使用できる値: Standard_B1、Custom_B32、Custom_B6、Custom_C42、Custom_C10。 Default: Standard_B1.

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

グローバル パラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	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 keyvault delete

コンテナーまたは HSM を削除します。

az keyvault delete [--hsm-name]
                   [--name]
                   [--no-wait]
                   [--resource-group]

例

キー コンテナーを削除します。 (autogenerated)

az keyvault delete --name MyKeyVault --resource-group MyResourceGroup

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--hsm-name

HSM の名前。 (--hsm-name と --name/-n は相互に排他的です。そのうちの 1 つだけを指定してください)。

--name -n

コンテナーの名前。

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ	値
規定値:	False

--resource-group -g

Key Vault が指定したリソース グループに属している場合にのみ続行します。

グローバル パラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	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 keyvault delete-policy

Key Vault のセキュリティ ポリシー設定を削除します。

az keyvault delete-policy --name
                          [--application-id]
                          [--no-wait]
                          [--object-id]
                          [--resource-group]
                          [--spn]
                          [--upn]

必須のパラメーター

--name -n

コンテナーの名前。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--application-id

プリンシパルに代わって要求を行うクライアントのアプリケーション ID。 代理認証フローを使用して複合 ID 用に公開されます。

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ	値
規定値:	False

--object-id

アクセス許可を受け取るプリンシパルを識別する GUID。

--resource-group -g

Key Vault が指定したリソース グループに属している場合にのみ続行します。

--spn

アクセス許可を受け取るサービス プリンシパルの名前。

--upn

アクセス許可を受け取るユーザー プリンシパルの名前。

グローバル パラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	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 keyvault list

コンテナーや HSM を一覧表示します。

az keyvault list [--resource-group]
                 [--resource-type]

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-group -g

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

--resource-type

--resource-type が存在しない場合、コマンドはすべてのコンテナーと HSM を一覧表示します。 --resource-type に指定できる値は、コンテナーと hsm です。

グローバル パラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	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 keyvault list-deleted

サブスクリプション内の削除されたコンテナーまたは HSM に関する情報を取得します。

az keyvault list-deleted [--resource-type]

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-type

--resource-type が存在しない場合、コマンドはすべての削除されたコンテナーと HSM を一覧表示します。 --resource-type に指定できる値は、コンテナーと hsm です。

グローバル パラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	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 keyvault purge

指定したコンテナーまたは HSM を完全に削除します。 Aka 削除されたコンテナーまたは HSM を消去します。

az keyvault purge [--hsm-name]
                  [--location]
                  [--name]
                  [--no-wait]

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--hsm-name

削除された HSM の名前。 (--hsm-name と --name/-n は相互に排他的です。そのうちの 1 つだけを指定してください)。

--location -l

削除されたコンテナーまたは HSM の場所。

--name -n

削除されたコンテナーの名前。

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ	値
規定値:	False

グローバル パラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	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 keyvault recover

コンテナーまたは HSM を復旧します。

論理的な削除が有効になっていた以前に削除されたコンテナーまたは HSM を復旧します。

az keyvault recover [--hsm-name]
                    [--location]
                    [--name]
                    [--no-wait]
                    [--resource-group]

例

キー コンテナーを回復します。 (autogenerated)

az keyvault recover --location westus2 --name MyKeyVault --resource-group MyResourceGroup

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--hsm-name

削除された HSM の名前。 (--hsm-name と --name/-n は相互に排他的です。そのうちの 1 つだけを指定してください)。

--location -l

削除されたコンテナーまたは HSM の場所。

--name -n

削除されたコンテナーの名前。

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ	値
規定値:	False

--resource-group -g

削除されたコンテナーまたは HSM のリソース グループ。

グローバル パラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	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 keyvault set-policy

Key Vault のセキュリティ ポリシー設定を更新します。

az keyvault set-policy --name
                       [--application-id]
                       [--certificate-permissions {all, backup, create, delete, deleteissuers, get, getissuers, import, list, listissuers, managecontacts, manageissuers, purge, recover, restore, setissuers, update}]
                       [--key-permissions {all, backup, create, decrypt, delete, encrypt, get, getrotationpolicy, import, list, purge, recover, release, restore, rotate, setrotationpolicy, sign, unwrapKey, update, verify, wrapKey}]
                       [--no-wait]
                       [--object-id]
                       [--resource-group]
                       [--secret-permissions {all, backup, delete, get, list, purge, recover, restore, set}]
                       [--spn]
                       [--storage-permissions {all, backup, delete, deletesas, get, getsas, list, listsas, purge, recover, regeneratekey, restore, set, setsas, update}]
                       [--upn]

例

キーのアクセス許可 'get'、'list'、'import' とシークレットのアクセス許可 'backup'、'restore' をオブジェクト ID に割り当てます。

az keyvault set-policy -n MyVault --key-permissions get list import --secret-permissions backup restore --object-id {GUID}

UPN (ユーザー プリンシパル名) にキーのアクセス許可 'get'、'list' を割り当てます。

az keyvault set-policy -n MyVault --key-permissions get list --upn {UPN}

キーのアクセス許可 'get'、'list' を SPN (サービス プリンシパル名) に割り当てます。

az keyvault set-policy -n MyVault --key-permissions get list --spn {SPN}

必須のパラメーター

--name -n

コンテナーの名前。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--application-id

プリンシパルに代わって要求を行うクライアントのアプリケーション ID。 代理認証フローを使用して複合 ID 用に公開されます。

--certificate-permissions

割り当てる証明書アクセス許可のスペース区切りの一覧。

プロパティ	値
Parameter group:	Permission Arguments
指定可能な値:	all, backup, create, delete, deleteissuers, get, getissuers, import, list, listissuers, managecontacts, manageissuers, purge, recover, restore, setissuers, update

--key-permissions

割り当てるキーアクセス許可のスペース区切りの一覧。

プロパティ	値
Parameter group:	Permission Arguments
指定可能な値:	all, backup, create, decrypt, delete, encrypt, get, getrotationpolicy, import, list, purge, recover, release, restore, rotate, setrotationpolicy, sign, unwrapKey, update, verify, wrapKey

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ	値
規定値:	False

--object-id

アクセス許可を受け取るプリンシパルを識別する GUID。

--resource-group -g

Key Vault が指定したリソース グループに属している場合にのみ続行します。

--secret-permissions

割り当てるシークレットアクセス許可のスペース区切りの一覧。

プロパティ	値
Parameter group:	Permission Arguments
指定可能な値:	all, backup, delete, get, list, purge, recover, restore, set

--spn

アクセス許可を受け取るサービス プリンシパルの名前。

--storage-permissions

割り当てるストレージアクセス許可のスペース区切りの一覧。

プロパティ	値
Parameter group:	Permission Arguments
指定可能な値:	all, backup, delete, deletesas, get, getsas, list, listsas, purge, recover, regeneratekey, restore, set, setsas, update

--upn

アクセス許可を受け取るユーザー プリンシパルの名前。

グローバル パラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	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 keyvault show

コンテナーまたは HSM の詳細を表示します。

az keyvault show [--hsm-name]
                 [--name]
                 [--resource-group]

例

キー コンテナーの詳細を表示します。 (autogenerated)

az keyvault show --name MyKeyVault

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--hsm-name

HSM の名前。 (--hsm-name と --name/-n は相互に排他的です。そのうちの 1 つだけを指定してください)。

--name -n

コンテナーの名前。

--resource-group -g

Key Vault が指定したリソース グループに属している場合にのみ続行します。

グローバル パラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	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 keyvault show-deleted

削除されたコンテナーまたは HSM の詳細を表示します。

az keyvault show-deleted [--hsm-name]
                         [--location]
                         [--name]

例

削除されたキー コンテナーの詳細を表示します。

az keyvault show-deleted --name MyKeyVault

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--hsm-name

削除された HSM の名前。 (--hsm-name と --name/-n は相互に排他的です。そのうちの 1 つだけを指定してください)。

--location -l

削除されたコンテナーまたは HSM の場所。

--name -n

削除されたコンテナーの名前。

グローバル パラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	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 keyvault update

コンテナーのプロパティを更新します。

az keyvault update --name
                   [--add]
                   [--bypass {AzureServices, None}]
                   [--default-action {Allow, Deny}]
                   [--enable-purge-protection {false, true}]
                   [--enable-rbac-authorization {false, true}]
                   [--enabled-for-deployment {false, true}]
                   [--enabled-for-disk-encryption {false, true}]
                   [--enabled-for-template-deployment {false, true}]
                   [--force-string]
                   [--no-wait]
                   [--public-network-access {Disabled, Enabled}]
                   [--remove]
                   [--resource-group]
                   [--retention-days]
                   [--set]

例

コンテナーのプロパティを更新します。 (autogenerated)

az keyvault update --enabled-for-disk-encryption true --name MyKeyVault --resource-group MyResourceGroup

必須のパラメーター

--name -n

コンテナーの名前。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value, string or JSON string>。

プロパティ	値
Parameter group:	Generic Update Arguments
規定値:	[]

--bypass

スペース区切りの使用のためにトラフィックをバイパスします。

プロパティ	値
Parameter group:	Network Rule Arguments
指定可能な値:	AzureServices, None

--default-action

ルールが一致しない場合に適用される既定のアクション。

プロパティ	値
Parameter group:	Network Rule Arguments
指定可能な値:	Allow, Deny

--enable-purge-protection

このコンテナー/マネージド HSM プールに対して消去に対する保護を有効にするかどうかを指定するプロパティ。 このプロパティを true に設定すると、このコンテナー/マネージド HSM プールとそのコンテンツの消去に対する保護がアクティブになります。回復不可能なハード削除を開始できるのは、Key Vault/Managed HSM サービスだけです。 この設定は、論理的な削除も有効になっている場合にのみ有効です。 この機能を有効にすることは元に戻すことはできません。

プロパティ	値
指定可能な値:	false, true

--enable-rbac-authorization

データ アクションの承認方法を制御するプロパティ。 true の場合、キー コンテナーはデータ アクションの承認にロール ベースのアクセス制御 (RBAC) を使用し、コンテナーのプロパティで指定されたアクセス ポリシーは無視されます。 false の場合、キー コンテナーはコンテナーのプロパティで指定されたアクセス ポリシーを使用し、Azure Resource Manager に格納されているポリシーはすべて無視されます。 null または指定されていない場合、既定値が true のコンテナーが作成されます。 管理アクションは常に RBAC で承認されることに注意してください。

プロパティ	値
指定可能な値:	false, true

--enabled-for-deployment

[コンテナーのみ]キー コンテナーからシークレットとして格納されている証明書を Azure Virtual Machines が取得できるかどうかを指定するプロパティ。

プロパティ	値
指定可能な値:	false, true

--enabled-for-disk-encryption

[コンテナーのみ]コンテナーからシークレットを取得してキーのラップを解除することを Azure Disk Encryption で許可するかどうかを指定するプロパティ。

プロパティ	値
指定可能な値:	false, true

--enabled-for-template-deployment

[コンテナーのみ]Azure Resource Manager がキー コンテナーからシークレットを取得できるかどうかを指定するプロパティ。

プロパティ	値
指定可能な値:	false, true

--force-string

'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。

プロパティ	値
Parameter group:	Generic Update Arguments
規定値:	False

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ	値
規定値:	False

--public-network-access

プライベート エンドポイントが有効になっている間、パブリック ネットワークから送信されるデータ プレーン トラフィックのアクセス許可を制御します。

プロパティ	値
指定可能な値:	Disabled, Enabled

--remove

リストからプロパティまたは要素を削除します。 例: --remove property.list <indexToRemove> OR --remove propertyToRemove。

プロパティ	値
Parameter group:	Generic Update Arguments
規定値:	[]

--resource-group -g

Key Vault が指定したリソース グループに属している場合にのみ続行します。

--retention-days

データの論理的な削除の保有日数。 >=7 と <=90 を受け入れます。

--set

設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=<value>。

プロパティ	値
Parameter group:	Generic Update Arguments
規定値:	[]

グローバル パラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	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 keyvault update-hsm

HSM のプロパティを更新します。

az keyvault update-hsm --hsm-name
                       [--add]
                       [--bypass {AzureServices, None}]
                       [--default-action {Allow, Deny}]
                       [--enable-purge-protection {false, true}]
                       [--force-string]
                       [--mi-user-assigned]
                       [--no-wait]
                       [--public-network-access {Disabled, Enabled}]
                       [--remove]
                       [--resource-group]
                       [--secondary-locations]
                       [--set]

例

HSM のプロパティを更新します。

az keyvault update-hsm --enable-purge-protection true --hsm-name MyHSM --resource-group MyResourceGroup

必須のパラメーター

--hsm-name

HSM の名前。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value, string or JSON string>。

プロパティ	値
Parameter group:	Generic Update Arguments
規定値:	[]

--bypass

スペース区切りの使用のためにトラフィックをバイパスします。

プロパティ	値
Parameter group:	Network Rule Arguments
指定可能な値:	AzureServices, None

--default-action

ルールが一致しない場合に適用される既定のアクション。

プロパティ	値
Parameter group:	Network Rule Arguments
指定可能な値:	Allow, Deny

--enable-purge-protection -e

このコンテナー/マネージド HSM プールに対して消去に対する保護を有効にするかどうかを指定するプロパティ。 このプロパティを true に設定すると、このコンテナー/マネージド HSM プールとそのコンテンツの消去に対する保護がアクティブになります。回復不可能なハード削除を開始できるのは、Key Vault/Managed HSM サービスだけです。 この設定は、論理的な削除も有効になっている場合にのみ有効です。 この機能を有効にすることは元に戻すことはできません。

プロパティ	値
指定可能な値:	false, true

--force-string

'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。

プロパティ	値
Parameter group:	Generic Update Arguments
規定値:	False

--mi-user-assigned

マネージド HSM のユーザー割り当てマネージド ID を有効にします。 ID リソース ID のスペース区切りの一覧を受け入れます。

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ	値
規定値:	False

--public-network-access

プライベート エンドポイントが有効になっている間、パブリック ネットワークから送信されるデータ プレーン トラフィックのアクセス許可を制御します。

プロパティ	値
指定可能な値:	Disabled, Enabled

--remove

リストからプロパティまたは要素を削除します。 例: --remove property.list <indexToRemove> OR --remove propertyToRemove。

プロパティ	値
Parameter group:	Generic Update Arguments
規定値:	[]

--resource-group -g

Key Vault が指定したリソース グループに属している場合にのみ続行します。

--secondary-locations

--secondary-locations は、HSM プールを一覧表示されているリージョンに拡張/コントラクトします。 リソースが最初に作成されたプライマリの場所は削除できません。

--set

設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=<value>。

プロパティ	値
Parameter group:	Generic Update Arguments
規定値:	[]

グローバル パラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	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 keyvault wait

コンテナーの条件が満たされるまで、CLI を待機状態にします。

az keyvault wait --name
                 [--created]
                 [--custom]
                 [--deleted]
                 [--exists]
                 [--interval]
                 [--resource-group]
                 [--timeout]
                 [--updated]

例

コンテナーが作成されるまで CLI を一時停止します。

az keyvault wait --name MyVault --created

必須のパラメーター

--name -n

コンテナーの名前。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

'provisioningState' が 'Succeeded' で作成されるまで待ちます。

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	False

--custom

条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。

プロパティ	値
Parameter group:	Wait Condition Arguments

--deleted

削除されるまで待ちます。

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	False

--exists

リソースが存在するまで待ちます。

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	False

--interval

ポーリング間隔 (秒単位)。

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	30

--resource-group -g

Key Vault が指定したリソース グループに属している場合にのみ続行します。

--timeout

最大待機時間 (秒単位)。

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	3600

--updated

provisioningState が 'Succeeded' で更新されるまで待ちます。

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	False

グローバル パラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	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 keyvault wait-hsm

HSM の条件が満たされるまで、CLI を待機状態にします。

az keyvault wait-hsm --hsm-name
                     [--created]
                     [--custom]
                     [--deleted]
                     [--exists]
                     [--interval]
                     [--resource-group]
                     [--timeout]
                     [--updated]

例

HSM が作成されるまで CLI を一時停止します。

az keyvault wait-hsm --hsm-name MyHSM --created

必須のパラメーター

--hsm-name

HSM の名前。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

'provisioningState' が 'Succeeded' で作成されるまで待ちます。

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	False

--custom

条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。

プロパティ	値
Parameter group:	Wait Condition Arguments

--deleted

削除されるまで待ちます。

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	False

--exists

リソースが存在するまで待ちます。

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	False

--interval

ポーリング間隔 (秒単位)。

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	30

--resource-group -g

HSM が指定されたリソース グループに属している場合にのみ続行します。

--timeout

最大待機時間 (秒単位)。

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	3600

--updated

provisioningState が 'Succeeded' で更新されるまで待ちます。

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	False

グローバル パラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	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