KeyVaultClientExtensions Class

Definition

Extension methods for KeyVaultClient.

public static class KeyVaultClientExtensions
type KeyVaultClientExtensions = class
Public Module KeyVaultClientExtensions
Inheritance
KeyVaultClientExtensions

Methods

BackupCertificateAsync(IKeyVaultClient, String, String, CancellationToken)

Backs up the specified certificate.

BackupKeyAsync(IKeyVaultClient, String, String, CancellationToken)

Requests that a backup of the specified key be downloaded to the client.

BackupSecretAsync(IKeyVaultClient, String, String, CancellationToken)

Backs up the specified secret.

BackupStorageAccountAsync(IKeyVaultClient, String, String, CancellationToken)

Backs up the specified storage account.

CreateCertificateAsync(IKeyVaultClient, String, String, CertificatePolicy, CertificateAttributes, IDictionary<String,String>, CancellationToken)

Creates a new certificate.

CreateKeyAsync(IKeyVaultClient, String, String, NewKeyParameters, CancellationToken)
CreateKeyAsync(IKeyVaultClient, String, String, String, Nullable<Int32>, IList<String>, KeyAttributes, IDictionary<String,String>, String, CancellationToken)

Creates a new key, stores it, then returns key parameters and attributes to the client.

DecryptAsync(IKeyVaultClient, String, String, Byte[], CancellationToken)

Decrypts a single block of encrypted data

DecryptAsync(IKeyVaultClient, String, String, String, String, Byte[], CancellationToken)

Decrypts a single block of encrypted data.

DeleteCertificateAsync(IKeyVaultClient, String, String, CancellationToken)

Deletes a certificate from a specified key vault.

DeleteCertificateContactsAsync(IKeyVaultClient, String, CancellationToken)

Deletes the certificate contacts for a specified key vault.

DeleteCertificateIssuerAsync(IKeyVaultClient, String, String, CancellationToken)

Deletes the specified certificate issuer.

DeleteCertificateOperationAsync(IKeyVaultClient, String, String, CancellationToken)

Deletes the creation operation for a specific certificate.

DeleteKeyAsync(IKeyVaultClient, String, String, CancellationToken)

Deletes a key of any type from storage in Azure Key Vault.

DeleteSasDefinitionAsync(IKeyVaultClient, String, String, String, CancellationToken)

Deletes a SAS definition from a specified storage account. This operation requires the storage/deletesas permission.

DeleteSecretAsync(IKeyVaultClient, String, String, CancellationToken)

Deletes a secret from a specified key vault.

DeleteStorageAccountAsync(IKeyVaultClient, String, String, CancellationToken)

Deletes a storage account. This operation requires the storage/delete permission.

EncryptAsync(IKeyVaultClient, String, String, Byte[], CancellationToken)

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(IKeyVaultClient, String, String, String, String, Byte[], CancellationToken)

Encrypts an arbitrary sequence of bytes using an encryption key that is stored in a key vault.

GetCertificateAsync(IKeyVaultClient, String, CancellationToken)

Gets a certificate.

GetCertificateAsync(IKeyVaultClient, String, String, CancellationToken)

Gets a certificate.

GetCertificateAsync(IKeyVaultClient, String, String, String, CancellationToken)

Gets information about a certificate.

GetCertificateContactsAsync(IKeyVaultClient, String, CancellationToken)

Lists the certificate contacts for a specified key vault.

GetCertificateIssuerAsync(IKeyVaultClient, String, String, CancellationToken)

Lists the specified certificate issuer.

GetCertificateIssuersAsync(IKeyVaultClient, String, Nullable<Int32>, CancellationToken)

List certificate issuers for a specified key vault.

GetCertificateIssuersNextAsync(IKeyVaultClient, String, CancellationToken)

List certificate issuers for a specified key vault.

GetCertificateOperationAsync(IKeyVaultClient, String, String, CancellationToken)

Gets the creation operation of a certificate.

GetCertificatePolicyAsync(IKeyVaultClient, String, String, CancellationToken)

Lists the policy for a certificate.

GetCertificatesAsync(IKeyVaultClient, String, Nullable<Int32>, Nullable<Boolean>, CancellationToken)

List certificates in a specified key vault

GetCertificatesNextAsync(IKeyVaultClient, String, CancellationToken)

List certificates in a specified key vault

GetCertificateVersionsAsync(IKeyVaultClient, String, String, Nullable<Int32>, CancellationToken)

List the versions of a certificate.

GetCertificateVersionsNextAsync(IKeyVaultClient, String, CancellationToken)

List the versions of a certificate.

GetDeletedCertificateAsync(IKeyVaultClient, String, String, CancellationToken)

Retrieves information about the specified deleted certificate.

GetDeletedCertificatesAsync(IKeyVaultClient, String, Nullable<Int32>, Nullable<Boolean>, CancellationToken)

Lists the deleted certificates in the specified vault currently available for recovery.

GetDeletedCertificatesNextAsync(IKeyVaultClient, String, CancellationToken)

Lists the deleted certificates in the specified vault currently available for recovery.

GetDeletedKeyAsync(IKeyVaultClient, String, String, CancellationToken)

Gets the public part of a deleted key.

GetDeletedKeysAsync(IKeyVaultClient, String, Nullable<Int32>, CancellationToken)

Lists the deleted keys in the specified vault.

GetDeletedKeysNextAsync(IKeyVaultClient, String, CancellationToken)

Lists the deleted keys in the specified vault.

GetDeletedSasDefinitionAsync(IKeyVaultClient, String, String, String, CancellationToken)

Gets the specified deleted sas definition.

GetDeletedSasDefinitionsAsync(IKeyVaultClient, String, String, Nullable<Int32>, CancellationToken)

Lists deleted SAS definitions for the specified vault and storage account.

GetDeletedSasDefinitionsNextAsync(IKeyVaultClient, String, CancellationToken)

Lists deleted SAS definitions for the specified vault and storage account.

GetDeletedSecretAsync(IKeyVaultClient, String, String, CancellationToken)

Gets the specified deleted secret.

GetDeletedSecretsAsync(IKeyVaultClient, String, Nullable<Int32>, CancellationToken)

Lists deleted secrets for the specified vault.

GetDeletedSecretsNextAsync(IKeyVaultClient, String, CancellationToken)

Lists deleted secrets for the specified vault.

GetDeletedStorageAccountAsync(IKeyVaultClient, String, String, CancellationToken)

Gets the specified deleted storage account.

GetDeletedStorageAccountsAsync(IKeyVaultClient, String, Nullable<Int32>, CancellationToken)

Lists deleted storage accounts for the specified vault.

GetDeletedStorageAccountsNextAsync(IKeyVaultClient, String, CancellationToken)

Lists deleted storage accounts for the specified vault.

GetKeyAsync(IKeyVaultClient, String, CancellationToken)

Retrieves the public portion of a key plus its attributes

GetKeyAsync(IKeyVaultClient, String, String, CancellationToken)

Retrieves the public portion of a key plus its attributes

GetKeyAsync(IKeyVaultClient, String, String, String, CancellationToken)

Gets the public part of a stored key.

GetKeysAsync(IKeyVaultClient, String, Nullable<Int32>, CancellationToken)

List keys in the specified vault.

GetKeysNextAsync(IKeyVaultClient, String, CancellationToken)

List keys in the specified vault.

GetKeyVersionsAsync(IKeyVaultClient, String, String, Nullable<Int32>, CancellationToken)

Retrieves a list of individual key versions with the same key name.

GetKeyVersionsNextAsync(IKeyVaultClient, String, CancellationToken)

Retrieves a list of individual key versions with the same key name.

GetPendingCertificateSigningRequestAsync(IKeyVaultClient, String, String, CancellationToken)

Gets the Base64 pending certificate signing request (PKCS-10)

GetSasDefinitionAsync(IKeyVaultClient, String, String, String, CancellationToken)

Gets information about a SAS definition for the specified storage account. This operation requires the storage/getsas permission.

GetSasDefinitionsAsync(IKeyVaultClient, String, String, Nullable<Int32>, CancellationToken)

List storage SAS definitions for the given storage account. This operation requires the storage/listsas permission.

GetSasDefinitionsNextAsync(IKeyVaultClient, String, CancellationToken)

List storage SAS definitions for the given storage account. This operation requires the storage/listsas permission.

GetSecretAsync(IKeyVaultClient, String, CancellationToken)

Gets a secret.

GetSecretAsync(IKeyVaultClient, String, String, CancellationToken)

Gets a secret.

GetSecretAsync(IKeyVaultClient, String, String, String, CancellationToken)

Get a specified secret from a given key vault.

GetSecretsAsync(IKeyVaultClient, String, Nullable<Int32>, CancellationToken)

List secrets in a specified key vault.

GetSecretsNextAsync(IKeyVaultClient, String, CancellationToken)

List secrets in a specified key vault.

GetSecretVersionsAsync(IKeyVaultClient, String, String, Nullable<Int32>, CancellationToken)

List all versions of the specified secret.

GetSecretVersionsNextAsync(IKeyVaultClient, String, CancellationToken)

List all versions of the specified secret.

GetStorageAccountAsync(IKeyVaultClient, String, String, CancellationToken)

Gets information about a specified storage account. This operation requires the storage/get permission.

GetStorageAccountsAsync(IKeyVaultClient, String, Nullable<Int32>, CancellationToken)

List storage accounts managed by the specified key vault. This operation requires the storage/list permission.

GetStorageAccountsNextAsync(IKeyVaultClient, String, CancellationToken)

List storage accounts managed by the specified key vault. This operation requires the storage/list permission.

ImportCertificateAsync(IKeyVaultClient, String, String, String, String, CertificatePolicy, CertificateAttributes, IDictionary<String,String>, CancellationToken)

Imports a certificate into a specified key vault.

ImportCertificateAsync(IKeyVaultClient, String, String, X509Certificate2Collection, CertificatePolicy, CertificateAttributes, IDictionary<String,String>, CancellationToken)

Imports a new certificate version. If this is the first version, the certificate resource is created.

ImportKeyAsync(IKeyVaultClient, String, String, JsonWebKey, Nullable<Boolean>, KeyAttributes, IDictionary<String,String>, CancellationToken)

Imports an externally created key, stores it, and returns key parameters and attributes to the client.

ImportKeyAsync(IKeyVaultClient, String, String, KeyBundle, Nullable<Boolean>, CancellationToken)

Imports a key into the specified vault

MergeCertificateAsync(IKeyVaultClient, String, String, IList<Byte[]>, CertificateAttributes, IDictionary<String,String>, CancellationToken)

Merges a certificate or a certificate chain with a key pair existing on the server.

MergeCertificateAsync(IKeyVaultClient, String, String, X509Certificate2Collection, CertificateAttributes, IDictionary<String,String>, CancellationToken)

Merges a certificate or a certificate chain with a key pair existing on the server.

PurgeDeletedCertificateAsync(IKeyVaultClient, String, CancellationToken)

Purges the deleted certificate with immediate effect.

PurgeDeletedCertificateAsync(IKeyVaultClient, String, String, CancellationToken)

Permanently deletes the specified deleted certificate.

PurgeDeletedKeyAsync(IKeyVaultClient, String, CancellationToken)

Purges the deleted key immediately.

PurgeDeletedKeyAsync(IKeyVaultClient, String, String, CancellationToken)

Permanently deletes the specified key.

PurgeDeletedSecretAsync(IKeyVaultClient, String, CancellationToken)

Purges the deleted secret immediately.

PurgeDeletedSecretAsync(IKeyVaultClient, String, String, CancellationToken)

Permanently deletes the specified secret.

PurgeDeletedStorageAccountAsync(IKeyVaultClient, String, String, CancellationToken)

Permanently deletes the specified storage account.

RecoverDeletedCertificateAsync(IKeyVaultClient, String, CancellationToken)

Recovers the deleted certificate.

RecoverDeletedCertificateAsync(IKeyVaultClient, String, String, CancellationToken)

Recovers the deleted certificate back to its current version under /certificates.

RecoverDeletedKeyAsync(IKeyVaultClient, String, CancellationToken)

Recovers the deleted key.

RecoverDeletedKeyAsync(IKeyVaultClient, String, String, CancellationToken)

Recovers the deleted key to its latest version.

RecoverDeletedSasDefinitionAsync(IKeyVaultClient, String, String, String, CancellationToken)

Recovers the deleted SAS definition.

RecoverDeletedSecretAsync(IKeyVaultClient, String, CancellationToken)

Recovers the deleted secret.

RecoverDeletedSecretAsync(IKeyVaultClient, String, String, CancellationToken)

Recovers the deleted secret to the latest version.

RecoverDeletedStorageAccountAsync(IKeyVaultClient, String, String, CancellationToken)

Recovers the deleted storage account.

RegenerateStorageAccountKeyAsync(IKeyVaultClient, String, String, String, CancellationToken)

Regenerates the specified key value for the given storage account. This operation requires the storage/regeneratekey permission.

RestoreCertificateAsync(IKeyVaultClient, String, Byte[], CancellationToken)

Restores a backed up certificate to a vault.

RestoreKeyAsync(IKeyVaultClient, String, Byte[], CancellationToken)

Restores a backed up key to a vault.

RestoreSecretAsync(IKeyVaultClient, String, Byte[], CancellationToken)

Restores a backed up secret to a vault.

RestoreStorageAccountAsync(IKeyVaultClient, String, Byte[], CancellationToken)

Restores a backed up storage account to a vault.

SetCertificateContactsAsync(IKeyVaultClient, String, Contacts, CancellationToken)

Sets the certificate contacts for the specified key vault.

SetCertificateIssuerAsync(IKeyVaultClient, String, String, String, IssuerCredentials, OrganizationDetails, IssuerAttributes, CancellationToken)

Sets the specified certificate issuer.

SetSasDefinitionAsync(IKeyVaultClient, String, String, String, String, String, String, SasDefinitionAttributes, IDictionary<String,String>, CancellationToken)

Creates or updates a new SAS definition for the specified storage account. This operation requires the storage/setsas permission.

SetSecretAsync(IKeyVaultClient, String, String, String, IDictionary<String,String>, String, SecretAttributes, CancellationToken)

Sets a secret in a specified key vault.

SetStorageAccountAsync(IKeyVaultClient, String, String, String, String, Boolean, String, StorageAccountAttributes, IDictionary<String,String>, CancellationToken)

Creates or updates a new storage account. This operation requires the storage/set permission.

SignAsync(IKeyVaultClient, String, String, Byte[], CancellationToken)

Creates a signature from a digest using the specified key in the vault

SignAsync(IKeyVaultClient, String, String, String, String, Byte[], CancellationToken)

Creates a signature from a digest using the specified key.

UnwrapKeyAsync(IKeyVaultClient, String, String, Byte[], CancellationToken)

Unwraps a symmetric key using the specified key in the vault that has initially been used for wrapping the key.

UnwrapKeyAsync(IKeyVaultClient, String, String, String, String, Byte[], CancellationToken)

Unwraps a symmetric key using the specified key that was initially used for wrapping that key.

UpdateCertificateAsync(IKeyVaultClient, String, CertificatePolicy, CertificateAttributes, IDictionary<String,String>, CancellationToken)

Updates a certificate version.

UpdateCertificateAsync(IKeyVaultClient, String, String, String, CertificatePolicy, CertificateAttributes, IDictionary<String,String>, CancellationToken)

Updates the specified attributes associated with the given certificate.

UpdateCertificateIssuerAsync(IKeyVaultClient, String, String, String, IssuerCredentials, OrganizationDetails, IssuerAttributes, CancellationToken)

Updates the specified certificate issuer.

UpdateCertificateOperationAsync(IKeyVaultClient, String, String, Boolean, CancellationToken)

Updates a certificate operation.

UpdateCertificatePolicyAsync(IKeyVaultClient, String, String, CertificatePolicy, CancellationToken)

Updates the policy for a certificate.

UpdateKeyAsync(IKeyVaultClient, String, String, String, IList<String>, KeyAttributes, IDictionary<String,String>, CancellationToken)

The update key operation changes specified attributes of a stored key and can be applied to any key type and key version stored in Azure Key Vault.

UpdateKeyAsync(IKeyVaultClient, String, String, String[], KeyAttributes, Dictionary<String,String>, CancellationToken)

Updates the Key Attributes associated with the specified key

UpdateKeyAsync(IKeyVaultClient, String, String[], KeyAttributes, Dictionary<String,String>, CancellationToken)

Updates the Key Attributes associated with the specified key

UpdateSasDefinitionAsync(IKeyVaultClient, String, String, String, String, String, String, SasDefinitionAttributes, IDictionary<String,String>, CancellationToken)

Updates the specified attributes associated with the given SAS definition. This operation requires the storage/setsas permission.

UpdateSecretAsync(IKeyVaultClient, String, String, SecretAttributes, Dictionary<String,String>, CancellationToken)

Updates the attributes associated with the specified secret

UpdateSecretAsync(IKeyVaultClient, String, String, String, String, SecretAttributes, IDictionary<String,String>, CancellationToken)

Updates the attributes associated with a specified secret in a given key vault.

UpdateStorageAccountAsync(IKeyVaultClient, String, String, String, Nullable<Boolean>, String, StorageAccountAttributes, IDictionary<String,String>, CancellationToken)

Updates the specified attributes associated with the given storage account. This operation requires the storage/set/update permission.

VerifyAsync(IKeyVaultClient, String, String, Byte[], Byte[], CancellationToken)

Verifies a signature using the specified key

VerifyAsync(IKeyVaultClient, String, String, String, String, Byte[], Byte[], CancellationToken)

Verifies a signature using a specified key.

WrapKeyAsync(IKeyVaultClient, String, String, Byte[], CancellationToken)

Wraps a symmetric key using the specified key

WrapKeyAsync(IKeyVaultClient, String, String, String, String, Byte[], CancellationToken)

Wraps a symmetric key using a specified key.

Applies to