次の方法で共有

az keyvault secret

  • リファレンス

シークレットを管理します。

コマンド

名前 説明 型 状態
az keyvault secret backup

指定したシークレットをバックアップします。

 コア ジョージア 州
az keyvault secret delete

シークレットのすべてのバージョンを削除します。

 コア 廃止
az keyvault secret download

KeyVault からシークレットをダウンロードします。

 コア ジョージア 州
az keyvault secret list

指定したキー コンテナー内のシークレットを一覧表示します。

 コア ジョージア 州
az keyvault secret list-deleted

指定したコンテナーの削除されたシークレットを一覧表示します。

 コア ジョージア 州
az keyvault secret list-versions

指定したシークレットのすべてのバージョンを一覧表示します。

 コア ジョージア 州
az keyvault secret purge

指定したシークレットを完全に削除します。

 コア ジョージア 州
az keyvault secret recover

削除されたシークレットを最新バージョンに回復します。

 コア ジョージア 州
az keyvault secret restore

バックアップされたシークレットをコンテナーに復元します。

 コア ジョージア 州
az keyvault secret set

シークレット (存在しない場合) を作成するか、KeyVault でシークレットを更新します。

 コア ジョージア 州
az keyvault secret set-attributes

特定のキー コンテナー内の指定されたシークレットに関連付けられている属性を更新します。

 コア ジョージア 州
az keyvault secret show

特定のキー コンテナーから指定されたシークレットを取得します。

 コア ジョージア 州
az keyvault secret show-deleted

指定した削除されたシークレットを取得します。

 コア ジョージア 州

az keyvault secret backup

編集

指定したシークレットをバックアップします。

指定したシークレットのバックアップをクライアントにダウンロードするように要求します。 シークレットのすべてのバージョンがダウンロードされます。 この操作には、シークレット/バックアップアクセス許可が必要です。

az keyvault secret backup --file
                          [--id]
                          [--name]
                          [--vault-name]

必須のパラメーター

--file -f

シークレットの内容を受け取るファイル。

省略可能のパラメーター

--id

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

--name -n

シークレットの名前。 --id が指定されていない場合は必須です。

--vault-name

Key Vault の名前。 --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 を使用します。

az keyvault secret delete

編集
非推奨

警告！ このキー コンテナーで論理的な削除保護が有効になっている場合、このシークレットは論理的に削除された状態に移動されます。 シークレットが論理的に削除された状態から消去されるまで、このキー コンテナー内に同じ名前のシークレットを作成することはできません。 追加のガイダンスについては、次のドキュメントを参照してください。 https://zcusa.951200.xyz/azure/key-vault/general/soft-delete-overview

シークレットのすべてのバージョンを削除します。

シークレット/削除アクセス許可が必要です。 このメソッドが返されると、Key Vault はシークレットの削除を開始しました。 論理的な削除が有効になっているコンテナーでは、削除に数秒かかる場合があります。 したがって、このメソッドは、削除が完了するまで待機できるポーリングャーを返します。

az keyvault secret delete [--id]
                          [--name]
                          [--vault-name]

省略可能のパラメーター

--id

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

--name -n

シークレットの名前。 --id が指定されていない場合は必須です。

--vault-name

Key Vault の名前。 --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 を使用します。

az keyvault secret download

編集

KeyVault からシークレットをダウンロードします。

az keyvault secret download --file
                            [--encoding {ascii, base64, hex, utf-16be, utf-16le, utf-8}]
                            [--id]
                            [--name]
                            [--vault-name]
                            [--version]

必須のパラメーター

--file -f

シークレットの内容を受け取るファイル。

省略可能のパラメーター

--encoding -e

シークレットのエンコード。 既定では、シークレットの 'file-encoding' タグが検索されます。 それ以外の場合は、'utf-8' と見なされます。

指定可能な値: ascii, base64, hex, utf-16be, utf-16le, utf-8
--id

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

--name -n

シークレットの名前。 --id が指定されていない場合は必須です。

--vault-name

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

--version -v

シークレットのバージョン。 省略した場合は、最新バージョンを使用します。

グローバル パラメーター
--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 keyvault secret list

編集

指定したキー コンテナー内のシークレットを一覧表示します。

シークレットの取得操作は、コンテナー全体に適用できます。 ただし、応答ではベース シークレット識別子とその属性のみが提供されます。 個々のシークレット バージョンは応答に一覧表示されません。 この操作には、シークレット/リストのアクセス許可が必要です。

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

省略可能のパラメーター

--id

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

--include-managed

マネージド シークレットを含めます。 既定値: false。

指定可能な値: false, true
規定値: False
--maxresults

ページに返される結果の最大数。 指定しない場合、サービスは最大 25 件の結果を返します。

--vault-name

Key Vault の名前。 --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 を使用します。

az keyvault secret list-deleted

編集

指定したコンテナーの削除されたシークレットを一覧表示します。

削除されたシークレットの取得操作は、論理的な削除が有効になっているコンテナーに対して削除されたシークレットを返します。 この操作には、シークレット/リストのアクセス許可が必要です。

az keyvault secret list-deleted [--id]
                                [--maxresults]
                                [--vault-name]

省略可能のパラメーター

--id

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

--maxresults

ページに返される結果の最大数。 指定しない場合、サービスは最大 25 件の結果を返します。

--vault-name

Key Vault の名前。 --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 を使用します。

az keyvault secret list-versions

編集

指定したシークレットのすべてのバージョンを一覧表示します。

完全なシークレット識別子と属性が応答で提供されます。 シークレットの値は返されません。 この操作には、シークレット/リストのアクセス許可が必要です。

az keyvault secret list-versions [--id]
                                 [--maxresults]
                                 [--name]
                                 [--vault-name]

省略可能のパラメーター

--id

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

--maxresults

ページに返される結果の最大数。 指定しない場合、サービスは最大 25 件の結果を返します。

--name -n

シークレットの名前。 --id が指定されていない場合は必須です。

--vault-name

Key Vault の名前。 --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 を使用します。

az keyvault secret purge

編集

指定したシークレットを完全に削除します。

削除されたシークレットの消去操作では、回復の可能性なしに、シークレットが完全に削除されます。 この操作は、論理的な削除が有効なコンテナーでのみ有効にすることができます。 この操作には、シークレット/消去アクセス許可が必要です。

az keyvault secret purge [--id]
                         [--name]
                         [--vault-name]

省略可能のパラメーター

--id

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

--name -n

シークレットの名前。 --id が指定されていない場合は必須です。

--vault-name

コンテナーの名前。 --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 を使用します。

az keyvault secret recover

編集

削除されたシークレットを最新バージョンに回復します。

指定したコンテナー内の削除されたシークレットを回復します。 この操作は、論理的な削除が有効なコンテナーでのみ実行できます。 この操作には、シークレット/回復アクセス許可が必要です。

az keyvault secret recover [--id]
                           [--name]
                           [--vault-name]

省略可能のパラメーター

--id

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

--name -n

シークレットの名前。 --id が指定されていない場合は必須です。

--vault-name

コンテナーの名前。 --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 を使用します。

az keyvault secret restore

編集

バックアップされたシークレットをコンテナーに復元します。

バックアップされたシークレットとそのすべてのバージョンをコンテナーに復元します。 この操作には、シークレット/復元アクセス許可が必要です。

az keyvault secret restore --file
                           --vault-name

必須のパラメーター

--file -f

シークレットの内容を受け取るファイル。

--vault-name

コンテナーの名前。

グローバル パラメーター
--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 keyvault secret set

編集

シークレット (存在しない場合) を作成するか、KeyVault でシークレットを更新します。

az keyvault secret set --name
                       --vault-name
                       [--content-type]
                       [--disabled {false, true}]
                       [--encoding {ascii, base64, hex, utf-16be, utf-16le, utf-8}]
                       [--expires]
                       [--file]
                       [--not-before]
                       [--tags]
                       [--value]

例

シークレット (存在しない場合) を作成するか、KeyVault でシークレットを更新します。

az keyvault secret set --name MySecretName --vault-name MyKeyVault --value MyVault

シークレット (存在しない場合) を作成するか、ファイルを使用して KeyVault 内のシークレットを更新します。

az keyvault secret set --name MySecretName --vault-name MyKeyVault --file /path/to/file --encoding MyEncoding

必須のパラメーター

--name -n

シークレットの名前。

--vault-name

コンテナーの名前。

省略可能のパラメーター

--content-type --description

シークレットの内容の説明 (パスワード、接続文字列など)。

--disabled

無効な状態でシークレットを作成します。

指定可能な値: false, true
--encoding -e

ソース ファイルのエンコード。 値はタグ (file-encoding=<val>) として保存され、ダウンロード中に結果のファイルを自動的にエンコードするために使用されます。

指定可能な値: ascii, base64, hex, utf-16be, utf-16le, utf-8
規定値: utf-8
--expires

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

--file -f

シークレットのソース ファイル。 '--encoding' と組み合わせて使用します。

--not-before

指定された UTC 日時 (Y-m-d'T'H:M:S'Z') より前のシークレットは使用できません。

--tags

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

--value

プレーン テキスト シークレット値。 '--file' または '--encoding' では使用できません。

グローバル パラメーター
--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 keyvault secret set-attributes

編集

特定のキー コンテナー内の指定されたシークレットに関連付けられている属性を更新します。

UPDATE 操作は、既存の格納されているシークレットの指定された属性を変更します。 要求で指定されていない属性は変更されません。 シークレット自体の値は変更できません。 この操作には、シークレット/設定アクセス許可が必要です。

az keyvault secret set-attributes [--content-type]
                                  [--enabled {false, true}]
                                  [--expires]
                                  [--id]
                                  [--name]
                                  [--not-before]
                                  [--tags]
                                  [--vault-name]
                                  [--version]

省略可能のパラメーター

--content-type

パスワードなどのシークレット値の種類。

--enabled

シークレットを有効にします。

指定可能な値: false, true
--expires

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

--id

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

--name -n

シークレットの名前。 --id が指定されていない場合は必須です。

--not-before

指定された UTC 日時 (Y-m-d'T'H:M:S'Z') より前のシークレットは使用できません。

--tags

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

--vault-name

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

--version -v

シークレットのバージョン。 省略した場合は、最新バージョンを使用します。

グローバル パラメーター
--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 keyvault secret show

編集

特定のキー コンテナーから指定されたシークレットを取得します。

GET 操作は、Azure Key Vault に格納されているすべてのシークレットに適用されます。 この操作には、シークレット/取得アクセス許可が必要です。

az keyvault secret show [--id]
                        [--name]
                        [--vault-name]
                        [--version]

省略可能のパラメーター

--id

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

--name -n

シークレットの名前。 --id が指定されていない場合は必須です。

--vault-name

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

--version -v

シークレットのバージョン。 省略した場合は、最新バージョンを使用します。

グローバル パラメーター
--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 keyvault secret show-deleted

編集

指定した削除されたシークレットを取得します。

削除されたシークレットの取得操作は、指定された削除されたシークレットとその属性を返します。 この操作には、シークレット/取得アクセス許可が必要です。

az keyvault secret show-deleted [--id]
                                [--name]
                                [--vault-name]

省略可能のパラメーター

--id

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

--name -n

シークレットの名前。 --id が指定されていない場合は必須です。

--vault-name

コンテナーの名前。 --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 を使用します。