KeyVaultClient Class
Provides the client class to perform cryptographic key operations and vault operations against the Key Vault service.
Namespace: Microsoft.Azure.KeyVault
Assembly: Microsoft.Azure.KeyVault (in Microsoft.Azure.KeyVault.dll)
Inheritance Hierarchy
System.Object
Microsoft.Azure.KeyVault.KeyVaultClient
Syntax
public class KeyVaultClient
public ref class KeyVaultClient
type KeyVaultClient = class end
Public Class KeyVaultClient
Constructors
Name | Description | |
---|---|---|
KeyVaultClient(KeyVaultClient.AuthenticationCallback) | Initializes a new instance of the KeyVaultClient class. |
|
KeyVaultClient(KeyVaultClient.AuthenticationCallback, HttpClient) | Initializes a new instance of the KeyVaultClient class. |
Methods
Name | Description | |
---|---|---|
BackupKeyAsync(String, String, CancellationToken) | Asynchronously requests that a backup of the specified key be downloaded to the client. |
|
CreateKeyAsync(String, String, String, Nullable<Int32>, String[], KeyAttributes, Dictionary<String, String>, CancellationToken) | Asynchronously creates a new, named, key in the specified vault. |
|
DecryptAsync(String, String, Byte[], CancellationToken) | Asynchronously decrypts a single block of encrypted data. |
|
DeleteKeyAsync(String, String, CancellationToken) | Asynchronously deletes the specified key. |
|
DeleteSecretAsync(String, String, CancellationToken) | Asynchronously deletes a secret from the specified vault. |
|
Do<T>(Func<Task<T>>) | Processes the asynchronous operation. |
|
EncryptAsync(String, String, Byte[], CancellationToken) | Asynchronously encrypts a single block of data. The amount of data that may be encrypted is determined by the target key type and the encryption algorithm. |
|
EncryptAsync(String, String, String, String, Byte[], CancellationToken) | Asynchronously encrypts a single block of data. The amount of data that may be encrypted is determined by the target key type and the encryption algorithm. |
|
Equals(Object) | (Inherited from Object.) |
|
Finalize() | (Inherited from Object.) |
|
GetHashCode() | (Inherited from Object.) |
|
GetKeyAsync(String, CancellationToken) | Asynchronously retrieves the public portion of a key plus its attributes. |
|
GetKeyAsync(String, String, String, CancellationToken) | Asynchronously retrieves the public portion of a key plus its attributes. |
|
GetKeysAsync(String, Nullable<Int32>, CancellationToken) | Asynchronously list keys in the specified vault. |
|
GetKeysNextAsync(String, CancellationToken) | Asynchronously list the next page of keys. |
|
GetKeyVersionsAsync(String, String, Nullable<Int32>, CancellationToken) | Asynchronously list the versions of the specified key. |
|
GetKeyVersionsNextAsync(String, CancellationToken) | Asynchronously list the next page of key versions. |
|
GetSecretAsync(String, CancellationToken) | Asynchronously gets a secret. |
|
GetSecretAsync(String, String, String, CancellationToken) | Asynchronously gets a secret. |
|
GetSecretsAsync(String, Nullable<Int32>, CancellationToken) | Asynchronously list secrets in the specified vault. |
|
GetSecretsNextAsync(String, CancellationToken) | Asynchronously list the next page of secrets. |
|
GetSecretVersionsAsync(String, String, Nullable<Int32>, CancellationToken) | Asynchronously list the versions of a secret. |
|
GetSecretVersionsNextAsync(String, CancellationToken) | Asynchronously list the next page of versions of a secret. |
|
GetType() | (Inherited from Object.) |
|
ImportKeyAsync(String, String, KeyBundle, Nullable<Boolean>, CancellationToken) | Asynchronously imports a key into the specified vault. |
|
MemberwiseClone() | (Inherited from Object.) |
|
RestoreKeyAsync(String, Byte[], CancellationToken) | Asynchronously restores the backup key in to a vault. |
|
SetSecretAsync(String, String, String, Dictionary<String, String>, String, SecretAttributes, CancellationToken) | Asynchronously sets a secret in the specified vault. |
|
SignAsync(String, String, Byte[], CancellationToken) | Asynchronously creates a signature from a digest using the specified key in the vault. |
|
SignAsync(String, String, String, String, Byte[], CancellationToken) | Asynchronously creates a signature from a digest using the specified key in the vault. |
|
ToString() | (Inherited from Object.) |
|
UnwrapKeyAsync(String, String, Byte[], CancellationToken) | Asynchronously unwraps a symmetric key using the specified key in the vault that has initially been used for wrapping the key. |
|
UpdateKeyAsync(String, String, String[], KeyAttributes, Dictionary<String, String>, CancellationToken) | Asynchronously updates the Key Attributes associated with the specified key. |
|
UpdateKeyAsync(String, String[], KeyAttributes, Dictionary<String, String>, CancellationToken) | Asynchronously updates the Key Attributes associated with the specified key. |
|
UpdateSecretAsync(String, String, SecretAttributes, Dictionary<String, String>, CancellationToken) | Asynchronously updates the attributes associated with the specified secret. |
|
UpdateSecretAsync(String, String, String, SecretAttributes, Dictionary<String, String>, CancellationToken) | Asynchronously updates the attributes associated with the specified secret. |
|
VerifyAsync(String, String, Byte[], Byte[], CancellationToken) | Asynchronously verifies a signature using the specified key. |
|
WrapKeyAsync(String, String, Byte[], CancellationToken) | Asynchronously wraps a symmetric key using the specified key. |
|
WrapKeyAsync(String, String, String, String, Byte[], CancellationToken) | Asynchronously wraps a symmetric key using the specified key. |
Extension Methods
Name | Description | |
---|---|---|
DecryptDataAsync(JsonWebKey, String, Byte[]) | Overloaded. Asynchronously decrypts a single block of encrypted data.(Defined by KeyVaultClientExtensions.) |
|
DecryptDataAsync(KeyBundle, String, Byte[]) | Overloaded. Asynchronously decrypts a single block of encrypted data.(Defined by KeyVaultClientExtensions.) |
|
EncryptDataAsync(JsonWebKey, String, Byte[]) | Overloaded. Asynchronously encrypts a single block of data. The amount of data that may be encrypted is determined by the target key type and the encryption algorithm.(Defined by KeyVaultClientExtensions.) |
|
EncryptDataAsync(KeyBundle, String, Byte[]) | Overloaded. Asynchronously encrypts a single block of data. The amount of data that may be encrypted is determined by the target key type and the encryption algorithm.(Defined by KeyVaultClientExtensions.) |
|
SignAsync(JsonWebKey, String, Byte[]) | Overloaded. Asynchronously creates a signature from a digest using the specified key in the vault.(Defined by KeyVaultClientExtensions.) |
|
SignAsync(KeyBundle, String, Byte[]) | Overloaded. Asynchronously creates a signature from a digest using the specified key in the vault.(Defined by KeyVaultClientExtensions.) |
|
UnwrapKeyAsync(JsonWebKey, Byte[], String) | Overloaded. Asynchronously unwraps a symmetric key using the specified wrapping key and algorithm.(Defined by KeyVaultClientExtensions.) |
|
UnwrapKeyAsync(KeyBundle, Byte[], String) | Overloaded. Asynchronously unwraps a symmetric key using the specified wrapping key and algorithm.(Defined by KeyVaultClientExtensions.) |
|
VerifyAsync(JsonWebKey, String, Byte[], Byte[]) | Overloaded. Indicates a value whether the verification is successful.(Defined by KeyVaultClientExtensions.) |
|
VerifyAsync(KeyBundle, String, Byte[], Byte[]) | Overloaded. Indicates a value whether the verification is successful.(Defined by KeyVaultClientExtensions.) |
|
WrapKeyAsync(JsonWebKey, Byte[], String) | Overloaded. Asynchronously wraps a symmetric key using the specified wrapping key and algorithm.(Defined by KeyVaultClientExtensions.) |
|
WrapKeyAsync(KeyBundle, Byte[], String) | Overloaded. Asynchronously wraps a symmetric key using the specified wrapping key and algorithm.(Defined by KeyVaultClientExtensions.) |
Thread Safety
This class is thread-safe.
See Also
Microsoft.Azure.KeyVault Namespace
Return to top