Partilhar via


KeyClient Classe

Definição

O KeyClient fornece métodos síncronos e assíncronos para gerenciar KeyVaultKey no Key Vault do Azure. O cliente dá suporte à criação, recuperação, atualização, exclusão, limpeza, backup, restauração e listagem do KeyVaultKey. O cliente também dá suporte à listagem DeletedKey para uma Key Vault do Azure habilitada para exclusão reversível.

public class KeyClient
type KeyClient = class
Public Class KeyClient
Herança
KeyClient

Construtores

KeyClient()

Inicializa uma nova instância da KeyClient classe para zombar.

KeyClient(Uri, TokenCredential)

Inicializa uma nova instância da KeyClient classe para o cofre especificado.

KeyClient(Uri, TokenCredential, KeyClientOptions)

Inicializa uma nova instância da KeyClient classe para o cofre especificado.

Propriedades

VaultUri

Obtém o Uri do cofre usado para criar essa instância do KeyClient.

Métodos

BackupKey(String, CancellationToken)

Solicita que um backup da chave especificada seja baixado para o cliente.

BackupKeyAsync(String, CancellationToken)

Solicita que um backup da chave especificada seja baixado para o cliente.

CreateEcKey(CreateEcKeyOptions, CancellationToken)

Cria e armazena uma nova chave curva elíptica em Key Vault. Se a chave denominada já existir, o Cofre de Chaves do Azure criará uma nova versão da chave. Essa operação requer a permissão de criação/chaves.

CreateEcKeyAsync(CreateEcKeyOptions, CancellationToken)

Cria e armazena uma nova chave curva elíptica em Key Vault. Se a chave denominada já existir, o Cofre de Chaves do Azure criará uma nova versão da chave. Essa operação requer a permissão de criação/chaves.

CreateKey(String, KeyType, CreateKeyOptions, CancellationToken)

Cria e armazena uma nova chave em Key Vault. A operação criar chave pode ser usada para criar qualquer tipo de chave no Key Vault do Azure. Se a chave denominada já existir, o Cofre de Chaves do Azure criará uma nova versão da chave. Essa operação requer a permissão de criação/chaves.

CreateKeyAsync(String, KeyType, CreateKeyOptions, CancellationToken)

Cria e armazena uma nova chave em Key Vault. A operação criar chave pode ser usada para criar qualquer tipo de chave no Key Vault do Azure. Se a chave denominada já existir, o Cofre de Chaves do Azure criará uma nova versão da chave. Essa operação requer a permissão de criação/chaves.

CreateOctKey(CreateOctKeyOptions, CancellationToken)

Cria e armazena uma nova chave AES em Key Vault. Se a chave denominada já existir, o Cofre de Chaves do Azure criará uma nova versão da chave. Essa operação requer a permissão de criação/chaves.

CreateOctKeyAsync(CreateOctKeyOptions, CancellationToken)

Cria e armazena uma nova chave AES em Key Vault. Se a chave denominada já existir, o Cofre de Chaves do Azure criará uma nova versão da chave. Essa operação requer a permissão de criação/chaves.

CreateRsaKey(CreateRsaKeyOptions, CancellationToken)

Cria e armazena uma nova chave RSA em Key Vault. Se a chave denominada já existir, o Cofre de Chaves do Azure criará uma nova versão da chave. Essa operação requer a permissão de criação/chaves.

CreateRsaKeyAsync(CreateRsaKeyOptions, CancellationToken)

Cria e armazena uma nova chave RSA em Key Vault. Se a chave denominada já existir, o Cofre de Chaves do Azure criará uma nova versão da chave. Essa operação requer a permissão de criação/chaves.

GetCryptographyClient(String, String)

Obtenha um CryptographyClient para a chave fornecida.

GetDeletedKey(String, CancellationToken)

Obtém a parte pública de uma chave excluída.

GetDeletedKeyAsync(String, CancellationToken)

Obtém a parte pública de uma chave excluída.

GetDeletedKeys(CancellationToken)

Lista as chaves excluídas no cofre especificado.

GetDeletedKeysAsync(CancellationToken)

Lista as chaves excluídas no cofre especificado.

GetKey(String, String, CancellationToken)

Obtém a parte pública de uma chave armazenada.

GetKeyAsync(String, String, CancellationToken)

Obtém a parte pública de uma chave armazenada.

GetKeyRotationPolicy(String, CancellationToken)

Obtém o KeyRotationPolicy para a chave especificada em Key Vault.

GetKeyRotationPolicyAsync(String, CancellationToken)

Obtém o KeyRotationPolicy para a chave especificada em Key Vault.

GetPropertiesOfKeys(CancellationToken)

Lista as propriedades de todas as chaves habilitadas e desabilitadas no cofre especificado. Você pode usar o retornado Name em chamadas subsequentes para GetKey(String, String, CancellationToken).

GetPropertiesOfKeysAsync(CancellationToken)

Lista as propriedades de todas as chaves habilitadas e desabilitadas no cofre especificado. Você pode usar o retornado Name em chamadas subsequentes para GetKeyAsync(String, String, CancellationToken).

GetPropertiesOfKeyVersions(String, CancellationToken)

Lista as propriedades de todas as versões habilitadas e desabilitadas da chave especificada. Você pode usar o retornado Name e Version em chamadas subsequentes para GetKey(String, String, CancellationToken).

GetPropertiesOfKeyVersionsAsync(String, CancellationToken)

Lista as propriedades de todas as versões habilitadas e desabilitadas da chave especificada. Você pode usar o retornado Name e Version em chamadas subsequentes para GetKeyAsync(String, String, CancellationToken).

GetRandomBytes(Int32, CancellationToken)

Obtenha o número solicitado de bytes que contêm valores aleatórios de um HSM (módulo de segurança de hardware) gerenciado.

GetRandomBytesAsync(Int32, CancellationToken)

Obtenha o número solicitado de bytes que contêm valores aleatórios de um HSM (módulo de segurança de hardware) gerenciado.

ImportKey(ImportKeyOptions, CancellationToken)

Importa uma chave criada externamente, armazena-a e retorna os parâmetros de chaves e atributos para o cliente.

ImportKey(String, JsonWebKey, CancellationToken)

Importa uma chave criada externamente, armazena-a e retorna os parâmetros de chaves e atributos para o cliente.

ImportKeyAsync(ImportKeyOptions, CancellationToken)

Importa uma chave criada externamente, armazena-a e retorna os parâmetros de chaves e atributos para o cliente.

ImportKeyAsync(String, JsonWebKey, CancellationToken)

Importa uma chave criada externamente, armazena-a e retorna os parâmetros de chaves e atributos para o cliente.

PurgeDeletedKey(String, CancellationToken)

Exclui permanentemente a chave especificada.

PurgeDeletedKeyAsync(String, CancellationToken)

Exclui permanentemente a chave especificada.

ReleaseKey(ReleaseKeyOptions, CancellationToken)

Libera uma chave.

ReleaseKey(String, String, CancellationToken)

Libera a versão mais recente de uma chave.

ReleaseKeyAsync(ReleaseKeyOptions, CancellationToken)

Libera uma chave.

ReleaseKeyAsync(String, String, CancellationToken)

Libera a versão mais recente de uma chave.

RestoreKeyBackup(Byte[], CancellationToken)

Restaura uma chave de backup em um cofre.

RestoreKeyBackupAsync(Byte[], CancellationToken)

Restaura uma chave de backup em um cofre.

RotateKey(String, CancellationToken)

Cria uma nova versão de chave no Key Vault, armazena-a e retorna o novo KeyVaultKey.

RotateKeyAsync(String, CancellationToken)

Cria uma nova versão de chave no Key Vault, armazena-a e retorna o novo KeyVaultKey.

StartDeleteKey(String, CancellationToken)

Exclui uma chave de qualquer tipo do armazenamento no Azure Key Vault.

StartDeleteKeyAsync(String, CancellationToken)

Exclui uma chave de qualquer tipo do armazenamento no Azure Key Vault.

StartRecoverDeletedKey(String, CancellationToken)

Recupera a chave excluída para sua versão mais recente.

StartRecoverDeletedKeyAsync(String, CancellationToken)

Recupera a chave excluída para sua versão mais recente.

UpdateKeyProperties(KeyProperties, IEnumerable<KeyOperation>, CancellationToken)

A operação de chave de atualização altera os atributos especificados de uma chave armazenada e pode ser aplicada a qualquer tipo de chave e versão de chave armazenada no Azure Key Vault.

UpdateKeyPropertiesAsync(KeyProperties, IEnumerable<KeyOperation>, CancellationToken)

A operação de chave de atualização altera os atributos especificados de uma chave armazenada e pode ser aplicada a qualquer tipo de chave e versão de chave armazenada no Azure Key Vault.

UpdateKeyRotationPolicy(String, KeyRotationPolicy, CancellationToken)

Atualizações para KeyRotationPolicy a chave especificada em Key Vault. A nova política será usada para a próxima versão da chave quando girada.

UpdateKeyRotationPolicyAsync(String, KeyRotationPolicy, CancellationToken)

Atualizações para KeyRotationPolicy a chave especificada em Key Vault. A nova política será usada para a próxima versão da chave quando girada.

Aplica-se a