Azure Key Vault REST API リファレンス

  • [アーティクル]

Key Vaultを使用して、クラウド アプリケーションとサービスで使用される暗号化キー、証明書、シークレットを保護および管理します。

Key Vault の操作

操作 説明
名前を使用できるかどうかを確認します。 コンテナー名が有効であり、まだ使用されていないことを確認します。
Create または Update 指定したサブスクリプションでキー コンテナーを作成または更新します。
アクセス ポリシーを更新する 指定したサブスクリプションのキー コンテナー内のアクセス ポリシーを更新します。
Get 指定した Azure キー コンテナーを取得します。
リスト List 操作は、サブスクリプションに関連付けられているコンテナーに関する情報を取得します。
List By Resource Group List 操作は、サブスクリプションに関連付けられているコンテナーと、指定されたリソース グループ内のコンテナーに関する情報を取得します。
List By Subscription List 操作は、サブスクリプションに関連付けられているコンテナーに関する情報を取得します。
アップデート 指定したサブスクリプションのキー コンテナーを更新します。
削除 指定した Azure キー コンテナーを削除します。
削除の取得 削除された Azure キー コンテナーを取得します。
削除済みリスト サブスクリプション内の削除されたコンテナーに関する情報を取得します。
消去 指定したコンテナーを完全に削除します。
操作 説明
コンテナー別の一覧表示 キー コンテナーでサポートされているプライベート リンク リソースを取得します。

プライベート エンドポイント接続操作

操作 説明
Get キー コンテナーに関連付けられている指定されたプライベート エンドポイント接続を取得します。
リソース別の一覧表示 List 操作は、コンテナーに関連付けられているプライベート エンドポイント接続に関する情報を取得します。
置く キー コンテナーに関連付けられている指定されたプライベート エンドポイント接続を更新します。
削除 キー コンテナーに関連付けられている指定されたプライベート エンドポイント接続を削除します。

マネージド HSM 操作

操作 説明
Create または Update 指定したサブスクリプションでマネージド HSM プールを作成または更新します。
Get 指定したマネージド HSM プールを取得します。
List By Resource Group List 操作は、サブスクリプションに関連付けられているマネージド HSM プールと、指定されたリソース グループ内に関する情報を取得します。
List By Subscription List 操作は、サブスクリプションに関連付けられているマネージド HSM プールに関する情報を取得します。
アップデート 指定したサブスクリプションのマネージド HSM プールを更新します。
削除の取得 指定した削除されたマネージド HSM を取得します。
削除済みリスト List 操作は、サブスクリプションに関連付けられている削除されたマネージド HSM に関する情報を取得します。
削除 指定したマネージド HSM プールを削除します。
削除済みの消去 指定したマネージド HSM を完全に削除します。
操作 説明
MHSM リソース別の一覧 マネージド HSM プールでサポートされているプライベート リンク リソースを取得します。

プライベート エンドポイント接続操作

操作 説明
Get マネージド HSM プールに関連付けられている指定されたプライベート エンドポイント接続を取得します。
リソース別の一覧表示 List 操作は、マネージド HSM プールに関連付けられているプライベート エンドポイント接続に関する情報を取得します。
置く マネージド HSM プールに関連付けられている指定されたプライベート エンドポイント接続を更新します。
削除 マネージド HSM プールに関連付けられている指定されたプライベート エンドポイント接続を削除します。

HSM セキュリティ ドメインの操作

操作 説明
ダウンロード マネージド HSM からセキュリティ ドメインを取得します。 このエンドポイントを呼び出すと、プロビジョニングされたマネージド HSM リソースをアクティブ化するために使用できます。
ダウンロード保留中 セキュリティ ドメインのダウンロード操作の状態を取得します。
アップロード 指定されたセキュリティ ドメインを復元します。
アップロード保留中 セキュリティ ドメインのアップロード操作の状態を取得します。

マネージド HSM 設定操作

操作 説明
設定の取得 指定されたアカウント設定オブジェクトを取得します。 指定した設定名の設定オブジェクトを取得します。
設定の取得 アカウント設定を一覧表示します。 構成できる使用可能なすべてのアカウント設定の一覧を取得します。
更新設定 キー コンテナー アカウントの設定更新保存し、設定の名前と値をクライアントに返します。 更新するプール設定の説明

ロールベースのアクセス制御操作

ロールの割り当て操作

操作 説明
Get 指定したロールの割り当てを取得します。
リスト スコープのロールの割り当てを取得します。
作成 ロールの割り当てを作成します。
削除 ロールの割り当てを削除します。

ロール定義操作

操作 説明
Get 指定したロール定義を取得します。
リスト スコープ以上で適用可能なすべてのロール定義を取得します。
Create または Update カスタム ロール定義を作成または更新します。
削除 カスタム ロール定義を削除します。

バックアップ/復元操作

操作 説明
完全バックアップ ユーザー指定の SAS トークンを使用して、Azure BLOB ストレージ コンテナーへの完全バックアップを作成します。 この操作は、Managed HSM サービスでのみサポートされます。
バックアップの状態 完全バックアップ操作の状態を返します。
完全復元 以前に格納された Azure Blob Storage バックアップ フォルダーを指す SAS トークンを使用して、すべてのキーマテリアルを復元します。
選択的復元 以前に格納された Azure Blob Storage バックアップ フォルダーを指すユーザー指定の SAS トークンを使用して、特定のキーのすべてのキー バージョンを復元します。
復元の状態 復元操作の状態を返します。

キー操作 (Key Vault/マネージド HSM)

操作 説明
キーの取得 格納されているキーの公開部分を取得します。
キーの取得 指定したコンテナー内のキーを一覧表示します。
キー バージョンを取得する 同じキー名を持つ個々のキー バージョンの一覧を取得します。
キーの作成 新しいキーを作成し、格納し、キー パラメーターと属性をクライアントに返します。
インポート キー 外部で作成されたキーをインポートし、格納し、キーのパラメーターと属性をクライアントに返します。
更新キー 更新キー操作は、格納されているキーの指定された属性を変更し、Azure Key Vaultに格納されている任意のキーの種類とキーのバージョンに適用できます。
キーの削除 Azure Key Vaultのストレージから任意の種類のキーを削除します。
削除されたキーを取得する 削除されたキーの公開部分を取得します。
削除されたキーを取得する 指定したコンテナー内の削除されたキーを一覧表示します。
削除されたキーを消去する 指定したキーを完全に削除します。
削除されたキーを回復する 削除されたキーを最新バージョンに回復します。
キーのバックアップ 指定したキーのバックアップをクライアントにダウンロードするように要求します。
キーの復元 バックアップされたキーをコンテナーに復元します。
リリース キー キーを解放します。 リリース キー操作は、すべてのキーの種類に適用できます。 ターゲット キーはエクスポート可能とマークする必要があります。 この操作には、キー/リリースのアクセス許可が必要です。
キーの回転 新しいキー バージョンを作成し、それを格納してから、キー パラメーター、属性、ポリシーをクライアントに返します。 操作では、キー ポリシーに基づいてキーがローテーションされます。 キー/ローテーションアクセス許可が必要です。
キー ローテーション ポリシーを取得する キーのポリシーを一覧表示します。 GetKeyRotationPolicy 操作は、指定されたキー コンテナー内の指定されたキー ポリシー リソースを返します。 この操作には、キー/取得アクセス許可が必要です。
キー ローテーション ポリシーを更新する キーのローテーション ポリシーを更新します。 キー ポリシーで指定されたメンバーを設定します。 他のユーザーは未定義のままにします。 この操作には、キー/更新アクセス許可が必要です。

キー操作 (Managed HSM のみ)

操作 説明
ランダム バイトの取得 マネージド HSM からランダムな値を含む要求されたバイト数を取得します。

暗号化操作 (Key Vault/マネージド HSM)

操作 説明
復号化 暗号化されたデータの 1 つのブロックを復号化します。
Encrypt キー コンテナーに格納されている暗号化キーを使用して、任意のバイト シーケンスを暗号化します。
折り返しキー 指定したキーを使用して対称キーをラップします。
キーのラップ解除 最初にそのキーをラップするために使用された指定されたキーを使用して、対称キーのラップを解除します。
[署名] 指定したキーを使用してダイジェストから署名を作成します。
確認 指定したキーを使用して署名を検証します。

シークレット操作 (Key Vaultのみ)

操作 説明
シークレットの取得 指定したキー コンテナーから指定されたシークレットを取得します。
シークレットを取得する 指定したキー コンテナー内のシークレットを一覧表示します。
シークレット バージョンを取得する 指定したシークレットのすべてのバージョンを一覧表示します。
シークレットの設定 指定したキー コンテナーにシークレットを設定します。
シークレットの更新 特定のキー コンテナー内の指定したシークレットに関連付けられている属性を更新します。
シークレットの削除 指定したキー コンテナーからシークレットを削除します。
削除されたシークレットを取得する 指定した削除されたシークレットを取得します。
削除されたシークレットを取得する 指定したコンテナーの削除されたシークレットを一覧表示します。
削除されたシークレットを消去する 指定したシークレットを完全に削除します。
削除されたシークレットを回復する 削除されたシークレットを最新バージョンに回復します。
シークレットのバックアップ 指定したシークレットをバックアップします。
[シークレットの復元] バックアップされたシークレットをコンテナーに復元します。

ストレージ アカウント キー管理操作 (Key Vaultのみ)

ストレージ アカウントの構成操作

操作 説明
ストレージ アカウントを取得する 指定したストレージ アカウントに関する情報を取得します。 この操作には、ストレージ/取得アクセス許可が必要です。
ストレージ アカウントを取得する 指定したキー コンテナーによって管理されているストレージ アカウントを一覧表示します。 この操作には、ストレージ/リストのアクセス許可が必要です。
ストレージ アカウントの更新 指定したストレージ アカウントに関連付けられている指定した属性を更新します。 この操作には、ストレージ/設定/更新のアクセス許可が必要です。
ストレージ アカウントの設定 新しいストレージ アカウントを作成または更新します。 この操作には、ストレージ/設定のアクセス許可が必要です。
Delete Storage Account ストレージ アカウントを削除します。 この操作には、ストレージ/削除のアクセス許可が必要です。
削除されたストレージ アカウントを取得する 指定した削除されたストレージ アカウントを取得します。
削除されたストレージ アカウントを取得する 指定したコンテナーの削除されたストレージ アカウントを一覧表示します。
削除されたストレージ アカウントを消去する 指定したストレージ アカウントを完全に削除します。
削除されたストレージ アカウントを復旧する 削除されたストレージ アカウントを回復します。
バックアップ ストレージ アカウント 指定したストレージ アカウントをバックアップします。
ストレージ アカウントの復元 バックアップされたストレージ アカウントをコンテナーに復元します。

ストレージ アカウント キーの操作

操作 説明
ストレージ アカウントのキーの再生成 指定されたストレージ アカウントの指定したキー値を再生成します。 この操作には、ストレージ/再生成キーのアクセス許可が必要です。

ストレージ アカウントの SAS 操作

操作 説明
Sas 定義を取得する 指定したストレージ アカウントの SAS 定義に関する情報を取得します。 この操作には、storage/getsas アクセス許可が必要です。
Sas 定義を取得する 特定のストレージ アカウントのストレージ SAS 定義を一覧表示します。 この操作には、ストレージ/リストのアクセス許可が必要です。
Sas 定義の設定 指定したストレージ アカウントの新しい SAS 定義を作成または更新します。 この操作には storage/setsas アクセス許可が必要です。
Sas 定義の更新 指定した SAS 定義に関連付けられている指定した属性を更新します。 この操作には storage/setsas アクセス許可が必要です。
Sas 定義の削除 指定したストレージ アカウントから SAS 定義を削除します。 この操作には、storage/deletesas アクセス許可が必要です。
削除された Sas 定義を取得する 指定した削除済み sas 定義を取得します。
削除された Sas 定義を取得する 指定したコンテナーとストレージ アカウントの削除された SAS 定義を一覧表示します。
削除された Sas 定義を回復する 削除された SAS 定義を回復します。

証明書の操作 (Key Vaultのみ)

操作 説明
証明書の取得 証明書に関する情報を取得します。
証明書を取得する 指定したキー コンテナー内の証明書を一覧表示する
証明書のバージョンを取得する 証明書のバージョンを一覧表示します。
証明書を作成する 新しい証明書を作成します。
証明書のインポート 指定したキー コンテナーに証明書をインポートします。
証明書のマージ 証明書または証明書チェーンを、サーバー上に存在するキー ペアとマージします。
証明書の取得操作 証明書の作成操作を取得します。
証明書の更新操作 証明書操作を更新します。
証明書の削除操作 特定の証明書の作成操作を削除します。
証明書の更新 特定の証明書に関連付けられている、指定された属性を更新します。
証明書を削除する 指定したキー コンテナーから証明書を削除します。
削除された証明書を取得する 指定した削除された証明書に関する情報を取得します。
削除された証明書を取得する 現在復旧に使用できる、指定されたコンテナー内の削除された証明書を一覧表示します。
削除された証明書を消去する 指定した削除された証明書を完全に削除します。
削除された証明書を回復する 削除された証明書を 、/certificates の下の現在のバージョンに回復します。
証明書のバックアップ 指定した証明書をバックアップします。
証明書の復元 バックアップされた証明書をコンテナーに復元します。

証明書ポリシーの操作

操作 説明
証明書ポリシーを取得する 証明書のポリシーを一覧表示します。
証明書ポリシーの更新 証明書のポリシーを更新します。

証明書の連絡先の操作

操作 説明
証明書の連絡先を取得する 指定したキー コンテナーの証明書の連絡先を一覧表示します。
証明書の連絡先を設定する 指定したキー コンテナーの証明書の連絡先を設定します。
証明書の連絡先を削除する 指定したキー コンテナーの証明書の連絡先を削除します。

証明書発行者の操作

操作 説明
証明書発行者を取得する 指定した証明書発行者を一覧表示します。
証明書発行者を取得する 指定したキー コンテナーの証明書発行者を一覧表示します。
証明書発行者の設定 指定した証明書発行者を設定します。
証明書発行者の更新 指定した証明書発行者を更新します。
証明書の発行者を削除します 指定した証明書発行者を削除します。

こちらもご覧ください