az keyvault key

Manage keys.

コマンド

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

編集

指定したキーのバックアップをクライアントにダウンロードするように要求します。

キーバックアップ操作では、保護された形式でコンテナーまたは HSM からキーをエクスポートします。この操作では、コンテナーまたは HSM システムの外部で使用できる形式のキーマテリアルは返されません。返されるキーマテリアルは、HSM またはコンテナー自体に対して保護されます。この操作の目的は、クライアントが 1 つのコンテナーまたは HSM インスタンスでキーを生成し、キーをバックアップしてから、別のコンテナーまたは HSM インスタンスに復元できるようにすることです。 BACKUP 操作は、コンテナーまたは HSM から任意のキーの種類を保護された形式でエクスポートするために使用できます。キーの個々のバージョンをバックアップすることはできません。 BACKUP / RESTOREは地理的境界内でのみ実行できます。は、ある地理的領域の BACKUP を別の地理的領域に復元できないことを意味します。たとえば、米国の地理的領域からのバックアップを EU の地理的領域に復元することはできません。この操作には、キー/バックアップのアクセス許可が必要です。

az keyvault key backup --file
                       [--hsm-name]
                       [--id]
                       [--name]
                       [--vault-name]

必須のパラメーター

--file -f

キーバックアップを格納するローカルファイルパス。

省略可能のパラメーター

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 と --vault-name は相互に排他的です。そのうちの 1 つだけを指定してください)。

プロパティ	値
Parameter group:	Id Arguments

--id

キーの ID。他のすべての 'Id' 引数を指定する場合は省略する必要があります。

プロパティ	値
Parameter group:	Id Arguments

--name -n

キーの名前。 --id が指定されていない場合は必須です。

プロパティ	値
Parameter group:	Id Arguments

--vault-name

コンテナーの名前。

プロパティ	値
Parameter group:	Id 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 key create

編集

新しいキーを作成して格納し、キーパラメーターと属性をクライアントに返します。

キーの作成操作を使用して、任意の種類のキーをコンテナーまたは HSM に作成できます。名前付きキーが既に存在する場合は、コンテナーまたは HSM によって新しいバージョンのキーが作成されます。これには、キー/作成アクセス許可が必要です。

az keyvault key create [--curve {P-256, P-256K, P-384, P-521}]
                       [--default-cvm-policy]
                       [--disabled {false, true}]
                       [--expires]
                       [--exportable {false, true}]
                       [--hsm-name]
                       [--id]
                       [--immutable {false, true}]
                       [--kty {EC, EC-HSM, RSA, RSA-HSM, oct, oct-HSM}]
                       [--name]
                       [--not-before]
                       [--ops {decrypt, encrypt, export, import, sign, unwrapKey, verify, wrapKey}]
                       [--policy]
                       [--protection {hsm, software}]
                       [--size]
                       [--tags]
                       [--vault-name]

例

指定した名前の指定した Key Vault にキーを作成します。 (autogenerated)

az keyvault key create --vault-name envault -n enkey

省略可能のパラメーター

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

--curve

楕円曲線の名前。有効な値については、https://learn.microsoft.com/rest/api/keyvault/keys/create-key/create-key#jsonwebkeycurvenameを参照してください。

プロパティ	値
指定可能な値:	P-256, P-256K, P-384, P-521

--default-cvm-policy

CVM ディスク暗号化のためにキーをエクスポートできる既定のポリシーを使用します。

プロパティ	値
規定値:	False

--disabled

無効な状態でキーを作成します。

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

--expires

有効期限 UTC 日時 (Y-m-d'T'H:M:S'Z')。

--exportable

秘密キーをエクスポートできるかどうか。リリースポリシーを使用してキーを作成するには、"exportable" が true で、呼び出し元に "エクスポート" アクセス許可が必要です。

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

--hsm-name

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

プロパティ	値
Parameter group:	Id Arguments

--id

キーの ID。他のすべての 'Id' 引数を指定する場合は省略する必要があります。

プロパティ	値
Parameter group:	Id Arguments

--immutable

リリースポリシーを変更不可としてマークします。変更できないリリースポリシーは、変更不可としてマークされた後は変更または更新できません。リリースポリシーは既定で変更可能です。

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

--kty

作成するキーの種類。有効な値については、https://learn.microsoft.com/rest/api/keyvault/keys/create-key/create-key#jsonwebkeytypeを参照してください。

プロパティ	値
指定可能な値:	EC, EC-HSM, RSA, RSA-HSM, oct, oct-HSM

--name -n

キーの名前。 --id が指定されていない場合は必須です。

プロパティ	値
Parameter group:	Id Arguments

--not-before

指定された UTC 日時 (Y-m-d'T'H:M:S'Z') の前にはキーを使用できません。

--ops

許可される JSON Web キー操作のスペース区切りの一覧。

プロパティ	値
指定可能な値:	decrypt, encrypt, export, import, sign, unwrapKey, verify, wrapKey

--policy

キーをエクスポートできるポリシールール。 JSON としてのポリシー定義、または JSON ポリシー定義を含むファイルへのパス。

--protection -p

キー保護の種類を指定します。

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

--size

キーサイズ (ビット単位)。たとえば、RSA の場合は 2048、3072、4096 などです。 10 月の場合は 128、192、または 256。

--tags

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

--vault-name

コンテナーの名前。

プロパティ	値
Parameter group:	Id 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 key decrypt

編集

プレビュー

このコマンドはプレビュー段階であり、開発中です。参照レベルとサポートレベル: https://aka.ms/CLI_refstatus

暗号化されたデータの 1 つのブロックを復号化します。

DECRYPT 操作は、ターゲット暗号化キーと指定されたアルゴリズムを使用して、整形式の暗号テキストブロックを復号化します。この操作は ENCRYPT 操作の逆です。暗号化を解除できるのは 1 つのデータブロックだけです。このブロックのサイズは、使用するターゲットキーとアルゴリズムに依存します。 DECRYPT 操作は、キーの秘密部分を使用するため、コンテナーまたは HSM に格納されている非対称キーと対称キーに適用されます。この操作には、キー/復号化アクセス許可が必要です。

az keyvault key decrypt --algorithm {A128CBC, A128CBCPAD, A128GCM, A192CBC, A192CBCPAD, A192GCM, A256CBC, A256CBCPAD, A256GCM, CKM_AES_KEY_WRAP, CKM_AES_KEY_WRAP_PAD, RSA-OAEP, RSA-OAEP-256, RSA1_5}
                        --value
                        [--aad]
                        [--data-type {base64, plaintext}]
                        [--hsm-name]
                        [--id]
                        [--iv]
                        [--name]
                        [--tag]
                        [--vault-name]
                        [--version]

例

RSA-OAEP を使用してコンテナーのキーを使用して value (encrypt コマンドによって返される Base64 でエンコードされた文字列) を復号化し、結果を base64 エンコードとして取得します。

az keyvault key decrypt --name mykey --vault-name myvault --algorithm RSA-OAEP --data-type base64 --value "CbFcCxHG7WTU+nbpFRrHoqSduwlPy8xpWxf1JxZ2y12BY/qFJirMSYq1i4SO9rvSmvmEMxFV5kw5s9Tc+YoKmv8X6oe+xXx+JytYV8obA5l3OQD9epuuQHWW0kir/mp88lzhcYWxYuF7mKDpPKDV4if+wnAZqQ4woB6t2JEZU5MVK3s+3E/EU4ehb5XrVxAl6xpYy8VYbyF33uJ5s+aUsYIrsVtXgrW99HQ3ic7tJtIOGuWqKhPCdQRezRkOcyxkJcmnDHOLjWA/9strzzx/dyg/t884gT7qrkmIHh8if9SFal/vi1h4XhoDqUleMTnKev2IFHyDNcYVYG3pftJiuA=="

AES-GCM を使用して MHSM のキーを使用して value (encrypt コマンドによって返される Base64 でエンコードされた文字列) を復号化し、結果をプレーンテキストとして取得します。

az keyvault key decrypt --name mykey --hsm-name myhsm --algorithm A256GCM --value "N5w02jS77xg536Ddzv/xPWQ=" --data-type plaintext
--aad "101112131415161718191a1b1c1d1e1f" --iv "727b26f78e55cf4cd8d34216" --tag "f7207d02cead35a77a1c7e5f8af959e9"

必須のパラメーター

--algorithm -a

Algorithm identifier.

プロパティ	値
指定可能な値:	A128CBC, A128CBCPAD, A128GCM, A192CBC, A192CBCPAD, A192GCM, A256CBC, A256CBCPAD, A256GCM, CKM_AES_KEY_WRAP, CKM_AES_KEY_WRAP_PAD, RSA-OAEP, RSA-OAEP-256, RSA1_5

--value

復号化する値。これは "az keyvault encrypt" の結果である必要があります。

省略可能のパラメーター

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

--aad

認証されているが暗号化されていないオプションのデータ。 AES-GCM 復号化で使用します。

--data-type

元のデータの型。

プロパティ	値
規定値:	base64
指定可能な値:	base64, plaintext

--hsm-name

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

プロパティ	値
Parameter group:	Id Arguments

--id

キーの ID。他のすべての 'Id' 引数を指定する場合は省略する必要があります。

プロパティ	値
Parameter group:	Id Arguments

--iv

暗号化中に使用される初期化ベクトル。 AES 復号化に必要です。

--name -n

キーの名前。 --id が指定されていない場合は必須です。

プロパティ	値
Parameter group:	Id Arguments

--tag

暗号化中に生成される認証タグ。 AES-GCM 復号化にのみ必要です。

--vault-name

コンテナーの名前。

プロパティ	値
Parameter group:	Id Arguments

--version -v

キーのバージョン。省略した場合は、最新バージョンを使用します。

プロパティ	値
Parameter group:	Id 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 key delete

編集

コンテナーまたは HSM のストレージから任意の種類のキーを削除します。

キーの削除操作を使用して、キーの個々のバージョンを削除することはできません。この操作により、キーに関連付けられている暗号化マテリアルが削除されます。つまり、キーは署名/検証、ラップ/ラップ解除、暗号化/復号化の操作には使用できません。この操作には、キー/削除アクセス許可が必要です。

az keyvault key delete [--hsm-name]
                       [--id]
                       [--name]
                       [--vault-name]

省略可能のパラメーター

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 と --vault-name は相互に排他的です。そのうちの 1 つだけを指定してください)。

プロパティ	値
Parameter group:	Id Arguments

--id

キーの ID。他のすべての 'Id' 引数を指定する場合は省略する必要があります。

プロパティ	値
Parameter group:	Id Arguments

--name -n

キーの名前。 --id が指定されていない場合は必須です。

プロパティ	値
Parameter group:	Id Arguments

--vault-name

コンテナーの名前。

プロパティ	値
Parameter group:	Id 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 key download

編集

保存されているキーの公開部分をダウンロードします。

az keyvault key download --file
                         [--encoding {DER, PEM}]
                         [--hsm-name]
                         [--id]
                         [--name]
                         [--vault-name]
                         [--version]

例

PEM エンコードを使用してキーを保存します。

az keyvault key download --vault-name MyKeyVault -n MyKey -e PEM -f mykey.pem

DER エンコードを使用してキーを保存します。

az keyvault key download --vault-name MyKeyVault -n MyKey -e DER -f mykey.der

必須のパラメーター

--file -f

キーの内容を受け取るファイル。

省略可能のパラメーター

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

--encoding -e

キーのエンコード。既定値: PEM。

プロパティ	値
規定値:	PEM
指定可能な値:	DER, PEM

--hsm-name

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

プロパティ	値
Parameter group:	Id Arguments

--id

キーの ID。他のすべての 'Id' 引数を指定する場合は省略する必要があります。

プロパティ	値
Parameter group:	Id Arguments

--name -n

キーの名前。 --id が指定されていない場合は必須です。

プロパティ	値
Parameter group:	Id Arguments

--vault-name

コンテナーの名前。

プロパティ	値
Parameter group:	Id Arguments

--version -v

キーのバージョン。省略した場合は、最新バージョンを使用します。

プロパティ	値
Parameter group:	Id 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 key encrypt

編集

プレビュー

このコマンドはプレビュー段階であり、開発中です。参照レベルとサポートレベル: https://aka.ms/CLI_refstatus

コンテナーまたは HSM に格納されている暗号化キーを使用して、任意のバイトシーケンスを暗号化します。

ENCRYPT 操作では、Vault または HSM に格納されている暗号化キーを使用して任意のバイトシーケンスを暗号化します。 ENCRYPT 操作では、1 つのデータブロックのみがサポートされることに注意してください。そのサイズは、使用するターゲットキーと暗号化アルゴリズムに依存します。暗号化操作は、キーの公開部分を使用して非対称キーによる保護を実行できるため、Vault pr HSM に格納されている対称キーに対してのみ厳密に必要です。この操作は、キー参照があるが公開キーマテリアルにアクセスできない呼び出し元にとって便利な方法として、非対称キーに対してサポートされます。この操作には、キー/暗号化アクセス許可が必要です。

az keyvault key encrypt --algorithm {A128CBC, A128CBCPAD, A128GCM, A192CBC, A192CBCPAD, A192GCM, A256CBC, A256CBCPAD, A256GCM, CKM_AES_KEY_WRAP, CKM_AES_KEY_WRAP_PAD, RSA-OAEP, RSA-OAEP-256, RSA1_5}
                        --value
                        [--aad]
                        [--data-type {base64, plaintext}]
                        [--hsm-name]
                        [--id]
                        [--iv]
                        [--name]
                        [--vault-name]
                        [--version]

例

RSA-OAEP を使用して、コンテナーのキーを使用して value(Base64 でエンコードされた文字列) を暗号化します。

az keyvault key encrypt --name mykey --vault-name myvault --algorithm RSA-OAEP --value "YWJjZGVm" --data-type base64

AES-GCM を使用して、MHSM のキーで値 (プレーンテキスト) を暗号化します。

az keyvault key encrypt --name mykey --hsm-name myhsm --algorithm A256GCM --value "this is plaintext" --data-type plaintext --aad "101112131415161718191a1b1c1d1e1f"

必須のパラメーター

--algorithm -a

Algorithm identifier.

プロパティ	値
指定可能な値:	A128CBC, A128CBCPAD, A128GCM, A192CBC, A192CBCPAD, A192GCM, A256CBC, A256CBCPAD, A256GCM, CKM_AES_KEY_WRAP, CKM_AES_KEY_WRAP_PAD, RSA-OAEP, RSA-OAEP-256, RSA1_5

--value

暗号化する値。既定のデータ型は、Base64 でエンコードされた文字列です。

省略可能のパラメーター

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

--aad

認証されているが暗号化されていないオプションのデータ。 AES-GCM 暗号化で使用します。

--data-type

元のデータの型。

プロパティ	値
規定値:	base64
指定可能な値:	base64, plaintext

--hsm-name

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

プロパティ	値
Parameter group:	Id Arguments

--id

キーの ID。他のすべての 'Id' 引数を指定する場合は省略する必要があります。

プロパティ	値
Parameter group:	Id Arguments

--iv

Initialization vector. AES-CBC(PAD) 暗号化にのみ必要です。

--name -n

キーの名前。 --id が指定されていない場合は必須です。

プロパティ	値
Parameter group:	Id Arguments

--vault-name

コンテナーの名前。

プロパティ	値
Parameter group:	Id Arguments

--version -v

キーのバージョン。省略した場合は、最新バージョンを使用します。

プロパティ	値
Parameter group:	Id 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 key get-attestation

編集

キーの構成証明 BLOB を取得します。

このコマンドは、Azure Key Vault Managed HSM に格納されているすべてのキーに適用されます。この操作には、キー/取得アクセス許可が必要です。

az keyvault key get-attestation [--file]
                                [--hsm-name]
                                [--id]
                                [--name]
                                [--version]

例

キーの構成証明を取得します。

az keyvault key get-attestation --hsm-name myhsm -n mykey

キーの構成証明をローカルファイルに保存します。

az keyvault key get-attestation --hsm-name myhsm -n mykey -f mykeyattestation.json

省略可能のパラメーター

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

--file -f

キーの構成証明を受け取るファイル (保存する場合)。

--hsm-name

HSM の名前。 --id が指定されていない場合は必須です。

プロパティ	値
Parameter group:	Id Arguments

--id

キーの ID。他のすべての 'Id' 引数を指定する場合は省略する必要があります。

プロパティ	値
Parameter group:	Id Arguments

--name -n

キーの名前。 --id が指定されていない場合は必須です。

プロパティ	値
Parameter group:	Id Arguments

--version -v

キーのバージョン。省略した場合は、最新バージョンを使用します。

プロパティ	値
Parameter group:	Id 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 key get-policy-template

編集

プレビュー

このコマンドはプレビュー段階であり、開発中です。参照レベルとサポートレベル: https://aka.ms/CLI_refstatus

ポリシーテンプレートを JSON でエンコードされたポリシー定義として返します。

az keyvault key get-policy-template

グローバルパラメーター

--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 key import

編集

秘密キーをインポートします。

PEM ファイルまたは文字列からの base64 でエンコードされた秘密キーのインポートをサポートします。 Premium キーコンテナーの HSM への BYOK キーのインポートをサポートします。

az keyvault key import [--byok-file]
                       [--byok-string]
                       [--curve {P-256, P-256K, P-384, P-521}]
                       [--default-cvm-policy]
                       [--disabled {false, true}]
                       [--expires]
                       [--exportable {false, true}]
                       [--hsm-name]
                       [--id]
                       [--immutable {false, true}]
                       [--kty {EC, RSA, oct}]
                       [--name]
                       [--not-before]
                       [--ops {decrypt, encrypt, export, import, sign, unwrapKey, verify, wrapKey}]
                       [--pem-file]
                       [--pem-password]
                       [--pem-string]
                       [--policy]
                       [--protection {hsm, software}]
                       [--tags]
                       [--vault-name]

省略可能のパラメーター

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

--byok-file

インポートするキーを含む BYOK ファイル。パスワードで保護しないでください。

プロパティ	値
Parameter group:	Key Source Arguments

--byok-string

インポートするキーを含む BYOK 文字列。パスワードで保護しないでください。

プロパティ	値
Parameter group:	Key Source Arguments

--curve

インポートするキーの曲線名 (BYOK の場合のみ)。

プロパティ	値
指定可能な値:	P-256, P-256K, P-384, P-521

--default-cvm-policy

CVM ディスク暗号化のためにキーをエクスポートできる既定のポリシーを使用します。

プロパティ	値
規定値:	False

--disabled

無効な状態でキーを作成します。

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

--expires

有効期限 UTC 日時 (Y-m-d'T'H:M:S'Z')。

--exportable

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

--hsm-name

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

プロパティ	値
Parameter group:	Id Arguments

--id

キーの ID。他のすべての 'Id' 引数を指定する場合は省略する必要があります。

プロパティ	値
Parameter group:	Id Arguments

--immutable

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

--kty

インポートするキーの種類 (BYOK の場合のみ)。

プロパティ	値
規定値:	RSA
指定可能な値:	EC, RSA, oct

--name -n

キーの名前。 --id が指定されていない場合は必須です。

プロパティ	値
Parameter group:	Id Arguments

--not-before

指定された UTC 日時 (Y-m-d'T'H:M:S'Z') の前にはキーを使用できません。

--ops

許可される JSON Web キー操作のスペース区切りの一覧。

プロパティ	値
指定可能な値:	decrypt, encrypt, export, import, sign, unwrapKey, verify, wrapKey

--pem-file

インポートするキーを含む PEM ファイル。

プロパティ	値
Parameter group:	Key Source Arguments

--pem-password

PEM ファイルのパスワード。

プロパティ	値
Parameter group:	Key Source Arguments

--pem-string

インポートするキーを含む PEM 文字列。

プロパティ	値
Parameter group:	Key Source Arguments

--policy

キーをエクスポートできるポリシールール。 JSON としてのポリシー定義、または JSON ポリシー定義を含むファイルへのパス。

--protection -p

キー保護の種類を指定します。

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

--tags

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

--vault-name

コンテナーの名前。

プロパティ	値
Parameter group:	Id 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 key list

編集

指定したコンテナーまたは HSM のキーを一覧表示します。

格納されているキーの公開部分を含む JSON Web キー構造として、コンテナーまたは HSM 内のキーの一覧を取得します。 LIST 操作はすべてのキーの種類に適用できますが、応答では基本キー識別子、属性、タグのみが提供されます。個々のバージョンのキーは応答に一覧表示されません。この操作には、キー/リストのアクセス許可が必要です。

az keyvault key list [--hsm-name]
                     [--id]
                     [--include-managed {false, true}]
                     [--maxresults]
                     [--vault-name]

省略可能のパラメーター

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 の名前。 --id が指定されている場合は省略できます。

プロパティ	値
Parameter group:	Id Arguments

--id

コンテナーまたは HSM の完全な URI。他のすべての 'Id' 引数を指定する場合は省略する必要があります。

プロパティ	値
Parameter group:	Id Arguments

--include-managed

マネージドキーを含めます。

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

--maxresults

返される結果の最大数。

--vault-name

コンテナーの名前。

プロパティ	値
Parameter group:	Id 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 key list-deleted

編集

指定したコンテナーまたは HSM で削除されたキーを一覧表示します。

コンテナーまたは HSM 内のキーの一覧を、削除されたキーの公開部分を含む JSON Web キー構造として取得します。この操作には、削除固有の情報が含まれます。削除済みキーの取得操作は、論理的な削除が有効なコンテナーに適用されます。操作は任意のコンテナーまたは HSM で呼び出すことができますが、論理的な削除が有効になっていないコンテナーまたは HSM で呼び出されるとエラーが返されます。この操作には、キー/リストのアクセス許可が必要です。

az keyvault key list-deleted [--hsm-name]
                             [--id]
                             [--maxresults]
                             [--vault-name]

省略可能のパラメーター

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 の名前。 --id が指定されている場合は省略できます。

プロパティ	値
Parameter group:	Id Arguments

--id

コンテナーまたは HSM の完全な URI。他のすべての 'Id' 引数を指定する場合は省略する必要があります。

プロパティ	値
Parameter group:	Id Arguments

--maxresults

返される結果の最大数。

--vault-name

コンテナーの名前。

プロパティ	値
Parameter group:	Id 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 key list-versions

編集

キーのバージョンの識別子とプロパティを一覧表示します。

キー/リストのアクセス許可が必要です。

az keyvault key list-versions [--hsm-name]
                              [--id]
                              [--maxresults]
                              [--name]
                              [--vault-name]

省略可能のパラメーター

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 と --vault-name は相互に排他的です。そのうちの 1 つだけを指定してください)。

プロパティ	値
Parameter group:	Id Arguments

--id

キーの ID。他のすべての 'Id' 引数を指定する場合は省略する必要があります。

プロパティ	値
Parameter group:	Id Arguments

--maxresults

返される結果の最大数。

--name -n

キーの名前。 --id が指定されていない場合は必須です。

プロパティ	値
Parameter group:	Id Arguments

--vault-name

コンテナーの名前。

プロパティ	値
Parameter group:	Id 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 key purge

編集

指定したキーを完全に削除します。

削除されたキーの消去操作は、論理的な削除が有効なコンテナーまたは HSM に適用されます。操作は任意のコンテナーまたは HSM で呼び出すことができますが、論理的な削除が有効になっていないコンテナーまたは HSM で呼び出されるとエラーが返されます。この操作には、キー/消去アクセス許可が必要です。

az keyvault key purge [--hsm-name]
                      [--id]
                      [--name]
                      [--vault-name]

省略可能のパラメーター

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 と --vault-name は相互に排他的です。そのうちの 1 つだけを指定してください)。

プロパティ	値
Parameter group:	Id Arguments

--id

キーの回復 ID。他のすべての 'Id' 引数を指定する場合は省略する必要があります。

プロパティ	値
Parameter group:	Id Arguments

--name -n

キーの名前。 --id が指定されていない場合は必須です。

プロパティ	値
Parameter group:	Id Arguments

--vault-name

コンテナーの名前。

プロパティ	値
Parameter group:	Id 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 key random

編集

マネージド HSM から要求されたランダムバイト数を取得します。

az keyvault key random --count
                       [--hsm-name]
                       [--id]

必須のパラメーター

--count

要求されたランダムバイト数。

省略可能のパラメーター

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 の名前。

プロパティ	値
Parameter group:	Id Arguments

--id

HSM の完全な URI。

プロパティ	値
Parameter group:	Id 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 key recover

編集

削除したキーを最新バージョンに回復します。

削除されたキーの回復操作は、論理的な削除が有効なコンテナーまたは HSM の削除されたキーに適用されます。削除されたキーは、/keys の下の最新バージョンに回復されます。削除されていないキーを回復しようとすると、エラーが返されます。これは、論理的な削除が有効なコンテナーまたは HSM での削除操作の逆と考えてください。この操作には、キー/回復アクセス許可が必要です。

az keyvault key recover [--hsm-name]
                        [--id]
                        [--name]
                        [--vault-name]

省略可能のパラメーター

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 と --vault-name は相互に排他的です。そのうちの 1 つだけを指定してください)。

プロパティ	値
Parameter group:	Id Arguments

--id

キーの回復 ID。他のすべての 'Id' 引数を指定する場合は省略する必要があります。

プロパティ	値
Parameter group:	Id Arguments

--name -n

キーの名前。 --id が指定されていない場合は必須です。

プロパティ	値
Parameter group:	Id Arguments

--vault-name

コンテナーの名前。

プロパティ	値
Parameter group:	Id 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 key restore

編集

バックアップされたキーをコンテナーまたは HSM に復元します。

以前にバックアップしたキーをコンテナーまたは HSM にインポートし、キー、そのキー識別子、属性、アクセス制御ポリシーを復元します。 RESTORE 操作を使用して、以前にバックアップしたキーをインポートできます。キーの個々のバージョンを復元することはできません。キーは、バックアップ時と同じキー名で完全に復元されます。ターゲット Key Vault でキー名を使用できない場合、RESTORE 操作は拒否されます。復元中にキー名が保持されている間、キーが別のコンテナーまたは HSM に復元されると、最終的なキー識別子が変更されます。復元では、すべてのバージョンが復元され、バージョン識別子が保持されます。 RESTORE 操作は、セキュリティ上の制約の対象となります。ターゲットコンテナーまたは HSM は、ソースコンテナーまたは HSM と同じ Microsoft Azure サブスクリプションによって所有されている必要があります。ユーザーは、ターゲットコンテナーまたは HSM で RESTORE アクセス許可を持っている必要があります。この操作には、キー/復元アクセス許可が必要です。

az keyvault key restore [--backup-folder]
                        [--blob-container-name]
                        [--file]
                        [--hsm-name]
                        [--id]
                        [--name]
                        [--no-wait]
                        [--storage-account-name]
                        [--storage-container-SAS-token]
                        [--storage-resource-uri]
                        [--vault-name]

省略可能のパラメーター

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

--backup-folder

バックアップを含む BLOB コンテナーの名前。

プロパティ	値
Parameter group:	Restoring keys from storage account Arguments

--blob-container-name

BLOB コンテナーの名前。

プロパティ	値
Parameter group:	Storage Id Arguments

--file -f

キーの復元元のローカルキーバックアップ。

--hsm-name

HSM の名前。 --id が指定されている場合は省略できます。

プロパティ	値
Parameter group:	Id Arguments

--id

コンテナーまたは HSM の完全な URI。他のすべての 'Id' 引数を指定する場合は省略する必要があります。

プロパティ	値
Parameter group:	Id Arguments

--name -n

キーの名前。 (ストレージアカウントから復元する場合のみ)。

プロパティ	値
Parameter group:	Restoring keys from storage account Arguments

--no-wait

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

プロパティ	値
規定値:	False

--storage-account-name

Azure ストレージアカウントの名前。

プロパティ	値
Parameter group:	Storage Id Arguments

--storage-container-SAS-token -t

Azure Blob Storage コンテナーを指す SAS トークン。

プロパティ	値
Parameter group:	Restoring keys from storage account Arguments

--storage-resource-uri -u

Azure Blob Storage コンテナー URI。指定した場合は、他のすべての 'Storage Id' 引数を省略する必要があります。

プロパティ	値
Parameter group:	Storage Id Arguments

--vault-name

コンテナーの名前。

プロパティ	値
Parameter group:	Id 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 key rotate

編集

キーの新しいバージョンを生成して、キーポリシーに基づいてキーをローテーションします。

az keyvault key rotate [--hsm-name]
                       [--id]
                       [--name]
                       [--vault-name]

省略可能のパラメーター

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 と --vault-name は相互に排他的です。そのうちの 1 つだけを指定してください)。

プロパティ	値
Parameter group:	Id Arguments

--id

キーの ID。他のすべての 'Id' 引数を指定する場合は省略する必要があります。

プロパティ	値
Parameter group:	Id Arguments

--name -n

キーの名前。 --id が指定されていない場合は必須です。

プロパティ	値
Parameter group:	Id Arguments

--vault-name

コンテナーの名前。

プロパティ	値
Parameter group:	Id 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 key set-attributes

編集

更新キー操作では、格納されているキーの指定された属性が変更され、コンテナーまたは HSM に格納されている任意のキーの種類とキーバージョンに適用できます。

この操作を実行するには、キーがコンテナーまたは HSM に既に存在している必要があります。キー自体の暗号化マテリアルは変更できません。この操作には、キー/更新アクセス許可が必要です。

az keyvault key set-attributes [--enabled {false, true}]
                               [--expires]
                               [--hsm-name]
                               [--id]
                               [--immutable {false, true}]
                               [--name]
                               [--not-before]
                               [--ops {decrypt, encrypt, export, import, sign, unwrapKey, verify, wrapKey}]
                               [--policy]
                               [--tags]
                               [--vault-name]
                               [--version]

省略可能のパラメーター

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

--enabled

キーを有効にします。

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

--expires

有効期限 UTC 日時 (Y-m-d'T'H:M:S'Z')。

--hsm-name

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

プロパティ	値
Parameter group:	Id Arguments

--id

キーの ID。他のすべての 'Id' 引数を指定する場合は省略する必要があります。

プロパティ	値
Parameter group:	Id Arguments

--immutable

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

--name -n

キーの名前。 --id が指定されていない場合は必須です。

プロパティ	値
Parameter group:	Id Arguments

--not-before

指定された UTC 日時 (Y-m-d'T'H:M:S'Z') の前にはキーを使用できません。

--ops

許可される JSON Web キー操作のスペース区切りの一覧。

プロパティ	値
指定可能な値:	decrypt, encrypt, export, import, sign, unwrapKey, verify, wrapKey

--policy

キーをエクスポートできるポリシールール。 JSON としてのポリシー定義、または JSON ポリシー定義を含むファイルへのパス。

--tags

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

--vault-name

コンテナーの名前。

プロパティ	値
Parameter group:	Id Arguments

--version -v

キーのバージョン。省略した場合は、最新バージョンを使用します。

プロパティ	値
Parameter group:	Id 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 key show

編集

キーの属性を取得し、非対称キーの場合は公開資料を取得します。

キー/取得アクセス許可が必要です。

az keyvault key show [--hsm-name]
                     [--id]
                     [--name]
                     [--vault-name]
                     [--version]

省略可能のパラメーター

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 と --vault-name は相互に排他的です。そのうちの 1 つだけを指定してください)。

プロパティ	値
Parameter group:	Id Arguments

--id

キーの ID。他のすべての 'Id' 引数を指定する場合は省略する必要があります。

プロパティ	値
Parameter group:	Id Arguments

--name -n

キーの名前。 --id が指定されていない場合は必須です。

プロパティ	値
Parameter group:	Id Arguments

--vault-name

コンテナーの名前。

プロパティ	値
Parameter group:	Id Arguments

--version -v

キーのバージョン。省略した場合は、最新バージョンを使用します。

プロパティ	値
Parameter group:	Id 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 key show-deleted

編集

削除されたキーの公開部分を取得します。

削除されたキーの取得操作は、論理的な削除が有効なコンテナーまたは HSM に適用されます。操作は任意のコンテナーまたは HSM で呼び出すことができますが、論理的な削除が有効になっていないコンテナーまたは HSM で呼び出されるとエラーが返されます。この操作には、キー/取得アクセス許可が必要です。

az keyvault key show-deleted [--hsm-name]
                             [--id]
                             [--name]
                             [--vault-name]

省略可能のパラメーター

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 と --vault-name は相互に排他的です。そのうちの 1 つだけを指定してください)。

プロパティ	値
Parameter group:	Id Arguments

--id

キーの ID。他のすべての 'Id' 引数を指定する場合は省略する必要があります。

プロパティ	値
Parameter group:	Id Arguments

--name -n

キーの名前。 --id が指定されていない場合は必須です。

プロパティ	値
Parameter group:	Id Arguments

--vault-name

コンテナーの名前。

プロパティ	値
Parameter group:	Id 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 key sign

編集

コンテナーまたは HSM に格納されているキーを使用して、ダイジェストから署名を作成します。

az keyvault key sign --algorithm {ES256, ES256K, ES384, ES512, HS256, HS384, HS512, PS256, PS384, PS512, RS256, RS384, RS512}
                     --digest
                     [--hsm-name]
                     [--id]
                     [--name]
                     [--vault-name]
                     [--version]

例

keyvault のキーを使用してダイジェストから署名を作成します。

az keyvault key sign --name mykey --vault-name myvault --algorithm RS256 --digest "12345678901234567890123456789012"

必須のパラメーター

--algorithm -a

Algorithm identifier.

プロパティ	値
指定可能な値:	ES256, ES256K, ES384, ES512, HS256, HS384, HS512, PS256, PS384, PS512, RS256, RS384, RS512

--digest

署名する値。

省略可能のパラメーター

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 と --vault-name は相互に排他的です。そのうちの 1 つだけを指定してください)。

プロパティ	値
Parameter group:	Id Arguments

--id

キーの ID。他のすべての 'Id' 引数を指定する場合は省略する必要があります。

プロパティ	値
Parameter group:	Id Arguments

--name -n

キーの名前。 --id が指定されていない場合は必須です。

プロパティ	値
Parameter group:	Id Arguments

--vault-name

コンテナーの名前。

プロパティ	値
Parameter group:	Id Arguments

--version -v

キーのバージョン。省略した場合は、最新バージョンを使用します。

プロパティ	値
Parameter group:	Id 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 key verify

編集

コンテナーまたは HSM に格納されているキーを使用して署名を確認します。

az keyvault key verify --algorithm {ES256, ES256K, ES384, ES512, HS256, HS384, HS512, PS256, PS384, PS512, RS256, RS384, RS512}
                       --digest
                       --signature
                       [--hsm-name]
                       [--id]
                       [--name]
                       [--vault-name]
                       [--version]

例

keyvault のキーを使用して署名を確認します。

az keyvault key verify --name mykey --vault-name myvault --algorithm RS256 --digest "12345678901234567890123456789012" --signature XXXYYYZZZ

必須のパラメーター

--algorithm -a

Algorithm identifier.

プロパティ	値
指定可能な値:	ES256, ES256K, ES384, ES512, HS256, HS384, HS512, PS256, PS384, PS512, RS256, RS384, RS512

--digest

署名する値。

--signature

検証する署名。

省略可能のパラメーター

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 と --vault-name は相互に排他的です。そのうちの 1 つだけを指定してください)。

プロパティ	値
Parameter group:	Id Arguments

--id

キーの ID。他のすべての 'Id' 引数を指定する場合は省略する必要があります。

プロパティ	値
Parameter group:	Id Arguments

--name -n

キーの名前。 --id が指定されていない場合は必須です。

プロパティ	値
Parameter group:	Id Arguments

--vault-name

コンテナーの名前。

プロパティ	値
Parameter group:	Id Arguments

--version -v

キーのバージョン。省略した場合は、最新バージョンを使用します。

プロパティ	値
Parameter group:	Id 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 key

コマンド

az keyvault key backup

必須のパラメーター

省略可能のパラメーター

az keyvault key create

例

省略可能のパラメーター

az keyvault key decrypt

例

必須のパラメーター

省略可能のパラメーター

az keyvault key delete

省略可能のパラメーター

az keyvault key download

例

必須のパラメーター

省略可能のパラメーター

az keyvault key encrypt

例

必須のパラメーター

省略可能のパラメーター

az keyvault key get-attestation

例

省略可能のパラメーター

az keyvault key get-policy-template

az keyvault key import

省略可能のパラメーター

az keyvault key list

省略可能のパラメーター

az keyvault key list-deleted

省略可能のパラメーター

az keyvault key list-versions

省略可能のパラメーター

az keyvault key purge

省略可能のパラメーター

az keyvault key random

必須のパラメーター

省略可能のパラメーター

az keyvault key recover

省略可能のパラメーター

az keyvault key restore

省略可能のパラメーター

az keyvault key rotate

省略可能のパラメーター

az keyvault key set-attributes

省略可能のパラメーター

az keyvault key show

省略可能のパラメーター

az keyvault key show-deleted

省略可能のパラメーター

az keyvault key sign

例

必須のパラメーター

省略可能のパラメーター

az keyvault key verify

例

必須のパラメーター

省略可能のパラメーター

フィードバック