KeyClient クラス

定義

KeyClient には、Azure Key Vaultで管理KeyVaultKeyするための同期メソッドと非同期メソッドが用意されています。 クライアントでは、 の作成、取得、更新、削除、消去、バックアップ、復元、一覧表示が KeyVaultKeyサポートされています。 クライアントでは、論理的な削除が有効な Azure Key Vaultの一覧DeletedKeyもサポートされています。

public class KeyClient
type KeyClient = class
Public Class KeyClient
継承
KeyClient

コンストラクター

KeyClient()

モック作成のために クラスの KeyClient 新しいインスタンスを初期化します。

KeyClient(Uri, TokenCredential)

指定したコンテナーの クラスの KeyClient 新しいインスタンスを初期化します。

KeyClient(Uri, TokenCredential, KeyClientOptions)

指定したコンテナーの クラスの KeyClient 新しいインスタンスを初期化します。

プロパティ

VaultUri

Uri このインスタンスの作成に使用されるコンテナーの を取得します KeyClient

メソッド

BackupKey(String, CancellationToken)

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

BackupKeyAsync(String, CancellationToken)

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

CreateEcKey(CreateEcKeyOptions, CancellationToken)

新しい楕円曲線キーを作成し、Key Vaultに格納します。 名前付きのキーが既に存在する場合は、Azure Key Vault によりキーの新しいバージョンが作成されます。 この操作には、キー/作成アクセス許可が必要です。

CreateEcKeyAsync(CreateEcKeyOptions, CancellationToken)

新しい楕円曲線キーを作成し、Key Vaultに格納します。 名前付きのキーが既に存在する場合は、Azure Key Vault によりキーの新しいバージョンが作成されます。 この操作には、キー/作成アクセス許可が必要です。

CreateKey(String, KeyType, CreateKeyOptions, CancellationToken)

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

CreateKeyAsync(String, KeyType, CreateKeyOptions, CancellationToken)

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

CreateOctKey(CreateOctKeyOptions, CancellationToken)

Key Vaultに新しい AES キーを作成して格納します。 名前付きのキーが既に存在する場合は、Azure Key Vault によりキーの新しいバージョンが作成されます。 この操作には、キー/作成アクセス許可が必要です。

CreateOctKeyAsync(CreateOctKeyOptions, CancellationToken)

Key Vaultに新しい AES キーを作成して格納します。 名前付きのキーが既に存在する場合は、Azure Key Vault によりキーの新しいバージョンが作成されます。 この操作には、キー/作成アクセス許可が必要です。

CreateRsaKey(CreateRsaKeyOptions, CancellationToken)

Key Vaultに新しい RSA キーを作成して格納します。 名前付きのキーが既に存在する場合は、Azure Key Vault によりキーの新しいバージョンが作成されます。 この操作には、キー/作成アクセス許可が必要です。

CreateRsaKeyAsync(CreateRsaKeyOptions, CancellationToken)

Key Vaultに新しい RSA キーを作成して格納します。 名前付きのキーが既に存在する場合は、Azure Key Vault によりキーの新しいバージョンが作成されます。 この操作には、キー/作成アクセス許可が必要です。

GetCryptographyClient(String, String)

指定された CryptographyClient キーの を取得します。

GetDeletedKey(String, CancellationToken)

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

GetDeletedKeyAsync(String, CancellationToken)

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

GetDeletedKeys(CancellationToken)

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

GetDeletedKeysAsync(CancellationToken)

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

GetKey(String, String, CancellationToken)

格納されているキーの公開部分を取得します。

GetKeyAsync(String, String, CancellationToken)

格納されているキーの公開部分を取得します。

GetKeyRotationPolicy(String, CancellationToken)

KeyRotationPolicy Key Vaultで指定したキーの を取得します。

GetKeyRotationPolicyAsync(String, CancellationToken)

KeyRotationPolicy Key Vaultで指定したキーの を取得します。

GetPropertiesOfKeys(CancellationToken)

指定したコンテナー内のすべての有効キーと無効キーのプロパティを一覧表示します。 に対する後続の呼び出しで返される NameGetKey(String, String, CancellationToken)使用できます。

GetPropertiesOfKeysAsync(CancellationToken)

指定したコンテナー内のすべての有効キーと無効キーのプロパティを一覧表示します。 に対する後続の呼び出しで返される NameGetKeyAsync(String, String, CancellationToken)使用できます。

GetPropertiesOfKeyVersions(String, CancellationToken)

指定したキーのすべての有効バージョンと無効バージョンのプロパティを一覧表示します。 に対する後続の呼び出しで、返された NameVersionGetKey(String, String, CancellationToken)使用できます。

GetPropertiesOfKeyVersionsAsync(String, CancellationToken)

指定したキーのすべての有効バージョンと無効バージョンのプロパティを一覧表示します。 に対する後続の呼び出しで、返された NameVersionGetKeyAsync(String, String, CancellationToken)使用できます。

GetRandomBytes(Int32, CancellationToken)

マネージド ハードウェア セキュリティ モジュール (HSM) からランダムな値を含む要求されたバイト数を取得します。

GetRandomBytesAsync(Int32, CancellationToken)

マネージド ハードウェア セキュリティ モジュール (HSM) からランダムな値を含む要求されたバイト数を取得します。

ImportKey(ImportKeyOptions, CancellationToken)

外部で作成されたキーをインポートし、格納し、キーのパラメーターと属性をクライアントに返します。

ImportKey(String, JsonWebKey, CancellationToken)

外部で作成されたキーをインポートし、格納し、キーのパラメーターと属性をクライアントに返します。

ImportKeyAsync(ImportKeyOptions, CancellationToken)

外部で作成されたキーをインポートし、格納し、キーのパラメーターと属性をクライアントに返します。

ImportKeyAsync(String, JsonWebKey, CancellationToken)

外部で作成されたキーをインポートし、格納し、キーのパラメーターと属性をクライアントに返します。

PurgeDeletedKey(String, CancellationToken)

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

PurgeDeletedKeyAsync(String, CancellationToken)

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

ReleaseKey(ReleaseKeyOptions, CancellationToken)

キーを解放します。

ReleaseKey(String, String, CancellationToken)

キーの最新バージョンをリリースします。

ReleaseKeyAsync(ReleaseKeyOptions, CancellationToken)

キーを解放します。

ReleaseKeyAsync(String, String, CancellationToken)

キーの最新バージョンをリリースします。

RestoreKeyBackup(Byte[], CancellationToken)

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

RestoreKeyBackupAsync(Byte[], CancellationToken)

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

RotateKey(String, CancellationToken)

Key Vaultに新しいキー バージョンを作成し、それを格納してから、新しい KeyVaultKeyを返します。

RotateKeyAsync(String, CancellationToken)

Key Vaultに新しいキー バージョンを作成し、それを格納してから、新しい KeyVaultKeyを返します。

StartDeleteKey(String, CancellationToken)

Azure Key Vault のストレージから任意の種類のキーを削除します。

StartDeleteKeyAsync(String, CancellationToken)

Azure Key Vault のストレージから任意の種類のキーを削除します。

StartRecoverDeletedKey(String, CancellationToken)

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

StartRecoverDeletedKeyAsync(String, CancellationToken)

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

UpdateKeyProperties(KeyProperties, IEnumerable<KeyOperation>, CancellationToken)

更新キー操作は、格納されているキーの指定された属性を変更し、Azure Key Vaultに格納されている任意のキーの種類とキー バージョンに適用できます。

UpdateKeyPropertiesAsync(KeyProperties, IEnumerable<KeyOperation>, CancellationToken)

更新キー操作は、格納されているキーの指定された属性を変更し、Azure Key Vaultに格納されている任意のキーの種類とキー バージョンに適用できます。

UpdateKeyRotationPolicy(String, KeyRotationPolicy, CancellationToken)

Key VaultでKeyRotationPolicy指定したキーの を更新します。 新しいポリシーは、ローテーション時に次のバージョンのキーに使用されます。

UpdateKeyRotationPolicyAsync(String, KeyRotationPolicy, CancellationToken)

Key VaultでKeyRotationPolicy指定したキーの を更新します。 新しいポリシーは、ローテーション時に次のバージョンのキーに使用されます。

適用対象