Compartilhar via

KeyClient class

  • Referência
Pacote:
@azure/keyvault-keys

O KeyClient fornece métodos para gerenciar KeyVaultKey no Azure Key Vault. O cliente dá suporte à criação, recuperação, atualização, exclusão, limpeza, backup, restauração e listagem de KeyVaultKeys. O cliente também dá suporte à listagem DeletedKey para um Azure Key Vault habilitado para exclusão reversível.

Construtores

KeyClient(string, TokenCredential, KeyClientOptions)

Cria uma instância do KeyClient.

Uso de exemplo:

import { KeyClient } from "@azure/keyvault-keys";
import { DefaultAzureCredential } from "@azure/identity";

let vaultUrl = `https://<MY KEYVAULT HERE>.vault.azure.net`;
let credentials = new DefaultAzureCredential();

let client = new KeyClient(vaultUrl, credentials);

Propriedades

vaultUrl

A URL base para o cofre

Métodos

backupKey(string, BackupKeyOptions)

Solicita que um backup da chave especificada seja baixado para o cliente. Todas as versões da chave serão baixadas. Essa operação requer a permissão de chaves/backup.

Uso de exemplo:

let client = new KeyClient(url, credentials);
let backupContents = await client.backupKey("MyKey");

Faz backup da chave especificada.
beginDeleteKey(string, BeginDeleteKeyOptions)

A operação de exclusão se aplica a qualquer chave armazenada no Azure Key Vault. Versões individuais de uma chave não podem ser excluídas, apenas todas as versões de uma determinada chave de uma só vez.

Essa função retorna um sondador de Operação de Execução Longa que permite que você aguarde indefinidamente até que a chave seja excluída.

Essa operação requer a permissão de chaves/exclusão.

Uso de exemplo:

const client = new KeyClient(url, credentials);
await client.createKey("MyKey", "EC");
const poller = await client.beginDeleteKey("MyKey");

// Serializing the poller
const serialized = poller.toString();
// A new poller can be created with:
// await client.beginDeleteKey("MyKey", { resumeFrom: serialized });

// Waiting until it's done
const deletedKey = await poller.pollUntilDone();
console.log(deletedKey);

Exclui uma chave de um cofre de chaves especificado.
beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

Recupera a chave excluída no cofre especificado. Essa operação só pode ser executada em um cofre habilitado para exclusão reversível.

Essa função retorna um sondador de Operação de Execução Longa que permite que você aguarde indefinidamente até que a chave excluída seja recuperada.

Essa operação requer a permissão de recuperação/chaves.

Uso de exemplo:

const client = new KeyClient(url, credentials);
await client.createKey("MyKey", "EC");
const deletePoller = await client.beginDeleteKey("MyKey");
await deletePoller.pollUntilDone();
const poller = await client.beginRecoverDeletedKey("MyKey");

// Serializing the poller
const serialized = poller.toString();
// A new poller can be created with:
// await client.beginRecoverDeletedKey("MyKey", { resumeFrom: serialized });

// Waiting until it's done
const key = await poller.pollUntilDone();
console.log(key);

Recupera a chave excluída para a versão mais recente.
createEcKey(string, CreateEcKeyOptions)

O método createEcKey cria uma nova chave de curva elíptica no Azure Key Vault. Se a chave nomeada já existir, o Azure Key Vault criará uma nova versão da chave. Ele requer a permissão de criação/chaves.

Uso de exemplo:

let client = new KeyClient(url, credentials);
let result = await client.createEcKey("MyKey", { curve: "P-256" });

Cria uma nova chave, armazena-a e, em seguida, retorna parâmetros de chave e propriedades para o cliente.
createKey(string, string, CreateKeyOptions)

A operação create key pode ser usada para criar qualquer tipo de chave no Azure Key Vault. Se a chave nomeada já existir, o Azure Key Vault criará uma nova versão da chave. Ele requer a permissão de criação/chaves.

Uso de exemplo:

let client = new KeyClient(url, credentials);
// Create an elliptic-curve key:
let result = await client.createKey("MyKey", "EC");

Cria uma nova chave, armazena-a e, em seguida, retorna parâmetros de chave e propriedades para o cliente.
createOctKey(string, CreateOctKeyOptions)

O método createOctKey cria uma nova chave OCT no Azure Key Vault. Se a chave nomeada já existir, o Azure Key Vault criará uma nova versão da chave. Ele requer a permissão de criação/chaves.

Uso de exemplo:

let client = new KeyClient(url, credentials);
let result = await client.createOctKey("MyKey", { hsm: true });

Cria uma nova chave, armazena-a e, em seguida, retorna parâmetros de chave e propriedades para o cliente.
createRsaKey(string, CreateRsaKeyOptions)

O método createRSAKey cria uma nova chave RSA no Azure Key Vault. Se a chave nomeada já existir, o Azure Key Vault criará uma nova versão da chave. Ele requer a permissão de criação/chaves.

Uso de exemplo:

let client = new KeyClient(url, credentials);
let result = await client.createRsaKey("MyKey", { keySize: 2048 });

Cria uma nova chave, armazena-a e, em seguida, retorna parâmetros de chave e propriedades para o cliente.
getCryptographyClient(string, GetCryptographyClientOptions)

Obtém um CryptographyClient para a chave fornecida.

Uso de exemplo:

let client = new KeyClient(url, credentials);
// get a cryptography client for a given key
let cryptographyClient = client.getCryptographyClient("MyKey");
getDeletedKey(string, GetDeletedKeyOptions)

O método getDeletedKey retorna a chave excluída especificada junto com suas propriedades. Essa operação requer a permissão de obtenção/chaves.

Uso de exemplo:

let client = new KeyClient(url, credentials);
let key = await client.getDeletedKey("MyDeletedKey");

Obtém a chave excluída especificada.
getKey(string, GetKeyOptions)

O método getKey obtém uma chave especificada e é aplicável a qualquer chave armazenada no Azure Key Vault. Essa operação requer a permissão de obtenção/chaves.

Uso de exemplo:

let client = new KeyClient(url, credentials);
let key = await client.getKey("MyKey");

Obtenha uma chave especificada de um determinado cofre de chaves.
getKeyRotationPolicy(string, GetKeyRotationPolicyOptions)

Obtém a política de rotação de uma chave do Key Vault. Por padrão, todas as chaves têm uma política que notificará 30 dias antes da expiração.

Essa operação requer a permissão de obtenção/chaves. Uso de exemplo:

let client = new KeyClient(vaultUrl, credentials);
let result = await client.getKeyRotationPolicy("myKey");
getRandomBytes(number, GetRandomBytesOptions)

Obtém o número solicitado de bytes que contêm valores aleatórios de um HSM gerenciado. Essa operação requer a permissão managedHsm/rng.

Uso de exemplo:

let client = new KeyClient(vaultUrl, credentials);
let { bytes } = await client.getRandomBytes(10);
importKey(string, JsonWebKey, ImportKeyOptions)

A operação de importação de chave pode ser usada para importar qualquer tipo de chave para um Azure Key Vault. Se a chave nomeada já existir, o Azure Key Vault criará uma nova versão da chave. Essa operação requer a permissão de importação/chaves.

Uso de exemplo:

let client = new KeyClient(url, credentials);
// Key contents in myKeyContents
let result = await client.importKey("MyKey", myKeyContents);

Importa uma chave criada externamente, armazena-a e retorna parâmetros de chave e propriedades para o cliente.
listDeletedKeys(ListDeletedKeysOptions)

Itera as chaves excluídas no cofre. O identificador de chave completo e as propriedades são fornecidos na resposta. Nenhum valor é retornado para as chaves. Essas operações exigem a permissão de chaves/lista.

Uso de exemplo:

let client = new KeyClient(url, credentials);
for await (const deletedKey of client.listDeletedKeys()) {
  console.log("deleted key: ", deletedKey);
}

Listar todas as chaves no cofre
listPropertiesOfKeys(ListPropertiesOfKeysOptions)

Itera a versão mais recente de todas as chaves no cofre. O identificador de chave completo e as propriedades são fornecidos na resposta. Nenhum valor é retornado para as chaves. Essas operações exigem a permissão de chaves/lista.

Uso de exemplo:

let client = new KeyClient(url, credentials);
for await (const keyProperties of client.listPropertiesOfKeys()) {
  const key = await client.getKey(keyProperties.name);
  console.log("key: ", key);
}

Listar todas as chaves no cofre
listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)

Itera todas as versões da chave fornecida no cofre. O identificador de chave completo, as propriedades e as marcas são fornecidos na resposta. Essa operação requer a permissão de chaves/lista.

Uso de exemplo:

let client = new KeyClient(url, credentials);
for await (const keyProperties of client.listPropertiesOfKeyVersions("MyKey")) {
  const key = await client.getKey(keyProperties.name);
  console.log("key version: ", key);
}
purgeDeletedKey(string, PurgeDeletedKeyOptions)

A operação de chave excluída de limpeza remove a chave permanentemente, sem a possibilidade de recuperação. Essa operação só pode ser habilitada em um cofre habilitado para exclusão reversível. Essa operação requer a permissão de limpeza/chaves.

Uso de exemplo:

const client = new KeyClient(url, credentials);
const deletePoller = await client.beginDeleteKey("MyKey")
await deletePoller.pollUntilDone();
await client.purgeDeletedKey("MyKey");

Exclui permanentemente a chave especificada.
releaseKey(string, string, ReleaseKeyOptions)

Libera uma chave de um HSM gerenciado.

A operação de chave de versão é aplicável a todos os tipos de chave. A operação requer que a chave seja marcada como exportável e a permissão de chave/liberação.

Uso de exemplo:

let client = new KeyClient(vaultUrl, credentials);
let result = await client.releaseKey("myKey", target)
restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions)

Restaura uma chave de backup e todas as suas versões em um cofre. Essa operação requer a permissão de restauração/chaves.

Uso de exemplo:

let client = new KeyClient(url, credentials);
let backupContents = await client.backupKey("MyKey");
// ...
let key = await client.restoreKeyBackup(backupContents);

Restaura uma chave de backup em um cofre.
rotateKey(string, RotateKeyOptions)

Gira a chave com base na política de chave gerando uma nova versão da chave. Essa operação requer a permissão de rotação/chaves.

Uso de exemplo:

let client = new KeyClient(vaultUrl, credentials);
let key = await client.rotateKey("MyKey");
updateKeyProperties(string, string, UpdateKeyPropertiesOptions)

O método updateKeyProperties altera as propriedades especificadas de uma chave armazenada existente. As propriedades que não são especificadas na solicitação são deixadas inalteradas. O valor de uma chave em si não pode ser alterado. Essa operação requer a permissão de conjunto/chaves.

Uso de exemplo:

let keyName = "MyKey";
let client = new KeyClient(vaultUrl, credentials);
let key = await client.getKey(keyName);
let result = await client.updateKeyProperties(keyName, key.properties.version, { enabled: false });

Atualiza as propriedades associadas a uma chave especificada em um determinado cofre de chaves.
updateKeyProperties(string, UpdateKeyPropertiesOptions)

O método updateKeyProperties altera as propriedades especificadas da versão mais recente de uma chave armazenada existente. As propriedades que não são especificadas na solicitação são deixadas inalteradas. O valor de uma chave em si não pode ser alterado. Essa operação requer a permissão de conjunto/chaves.

Uso de exemplo:

let keyName = "MyKey";
let client = new KeyClient(vaultUrl, credentials);
let key = await client.getKey(keyName);
let result = await client.updateKeyProperties(keyName, { enabled: false });

Atualiza as propriedades associadas a uma chave especificada em um determinado cofre de chaves.
updateKeyRotationPolicy(string, KeyRotationPolicyProperties, UpdateKeyRotationPolicyOptions)

Atualiza a política de rotação de uma chave do Key Vault. Essa operação requer a permissão de chaves/atualização.

Uso de exemplo:

let client = new KeyClient(vaultUrl, credentials);
const setPolicy = await client.updateKeyRotationPolicy("MyKey", myPolicy);

Detalhes do construtor

KeyClient(string, TokenCredential, KeyClientOptions)

Cria uma instância do KeyClient.

Uso de exemplo:

import { KeyClient } from "@azure/keyvault-keys";
import { DefaultAzureCredential } from "@azure/identity";

let vaultUrl = `https://<MY KEYVAULT HERE>.vault.azure.net`;
let credentials = new DefaultAzureCredential();

let client = new KeyClient(vaultUrl, credentials);

new KeyClient(vaultUrl: string, credential: TokenCredential, pipelineOptions?: KeyClientOptions)

Parâmetros

vaultUrl

string

a URL do Key Vault. Ele deve ter esta forma: https://${your-key-vault-name}.vault.azure.net. Você deve validar que essa URL faz referência a um cofre de chaves válido ou recurso HSM gerenciado. Consulte https://aka.ms/azsdk/blog/vault-uri para obter detalhes.

credential
TokenCredential

Um objeto que implementa a interface TokenCredential usada para autenticar solicitações no serviço. Use o pacote @azure/identity para criar uma credencial que atenda às suas necessidades.

pipelineOptions
KeyClientOptions

Opções de pipeline usadas para configurar solicitações de API do Key Vault. Omita esse parâmetro para usar a configuração de pipeline padrão.

Detalhes da propriedade

vaultUrl

A URL base para o cofre

vaultUrl: string

Valor da propriedade

string

Detalhes do método

backupKey(string, BackupKeyOptions)

Solicita que um backup da chave especificada seja baixado para o cliente. Todas as versões da chave serão baixadas. Essa operação requer a permissão de chaves/backup.

Uso de exemplo:

let client = new KeyClient(url, credentials);
let backupContents = await client.backupKey("MyKey");

Faz backup da chave especificada.

function backupKey(name: string, options?: BackupKeyOptions): Promise<undefined | Uint8Array>

Parâmetros

name

string

O nome da chave.

options
BackupKeyOptions

Os parâmetros opcionais.

Retornos

Promise<undefined | Uint8Array>

beginDeleteKey(string, BeginDeleteKeyOptions)

A operação de exclusão se aplica a qualquer chave armazenada no Azure Key Vault. Versões individuais de uma chave não podem ser excluídas, apenas todas as versões de uma determinada chave de uma só vez.

Essa função retorna um sondador de Operação de Execução Longa que permite que você aguarde indefinidamente até que a chave seja excluída.

Essa operação requer a permissão de chaves/exclusão.

Uso de exemplo:

const client = new KeyClient(url, credentials);
await client.createKey("MyKey", "EC");
const poller = await client.beginDeleteKey("MyKey");

// Serializing the poller
const serialized = poller.toString();
// A new poller can be created with:
// await client.beginDeleteKey("MyKey", { resumeFrom: serialized });

// Waiting until it's done
const deletedKey = await poller.pollUntilDone();
console.log(deletedKey);

Exclui uma chave de um cofre de chaves especificado.

function beginDeleteKey(name: string, options?: BeginDeleteKeyOptions): Promise<PollerLike<PollOperationState<DeletedKey>, DeletedKey>>

Parâmetros

name

string

O nome da chave.

options
BeginDeleteKeyOptions

Os parâmetros opcionais.

Retornos

Promise<PollerLike<PollOperationState<DeletedKey>, DeletedKey>>

beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

Recupera a chave excluída no cofre especificado. Essa operação só pode ser executada em um cofre habilitado para exclusão reversível.

Essa função retorna um sondador de Operação de Execução Longa que permite que você aguarde indefinidamente até que a chave excluída seja recuperada.

Essa operação requer a permissão de recuperação/chaves.

Uso de exemplo:

const client = new KeyClient(url, credentials);
await client.createKey("MyKey", "EC");
const deletePoller = await client.beginDeleteKey("MyKey");
await deletePoller.pollUntilDone();
const poller = await client.beginRecoverDeletedKey("MyKey");

// Serializing the poller
const serialized = poller.toString();
// A new poller can be created with:
// await client.beginRecoverDeletedKey("MyKey", { resumeFrom: serialized });

// Waiting until it's done
const key = await poller.pollUntilDone();
console.log(key);

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

function beginRecoverDeletedKey(name: string, options?: BeginRecoverDeletedKeyOptions): Promise<PollerLike<PollOperationState<DeletedKey>, DeletedKey>>

Parâmetros

name

string

O nome da chave excluída.

options
BeginRecoverDeletedKeyOptions

Os parâmetros opcionais.

Retornos

Promise<PollerLike<PollOperationState<DeletedKey>, DeletedKey>>

createEcKey(string, CreateEcKeyOptions)

O método createEcKey cria uma nova chave de curva elíptica no Azure Key Vault. Se a chave nomeada já existir, o Azure Key Vault criará uma nova versão da chave. Ele requer a permissão de criação/chaves.

Uso de exemplo:

let client = new KeyClient(url, credentials);
let result = await client.createEcKey("MyKey", { curve: "P-256" });

Cria uma nova chave, armazena-a e, em seguida, retorna parâmetros de chave e propriedades para o cliente.

function createEcKey(name: string, options?: CreateEcKeyOptions): Promise<KeyVaultKey>

Parâmetros

name

string

O nome da chave.

options
CreateEcKeyOptions

Os parâmetros opcionais.

Retornos

Promise<KeyVaultKey>

createKey(string, string, CreateKeyOptions)

A operação create key pode ser usada para criar qualquer tipo de chave no Azure Key Vault. Se a chave nomeada já existir, o Azure Key Vault criará uma nova versão da chave. Ele requer a permissão de criação/chaves.

Uso de exemplo:

let client = new KeyClient(url, credentials);
// Create an elliptic-curve key:
let result = await client.createKey("MyKey", "EC");

Cria uma nova chave, armazena-a e, em seguida, retorna parâmetros de chave e propriedades para o cliente.

function createKey(name: string, keyType: string, options?: CreateKeyOptions): Promise<KeyVaultKey>

Parâmetros

name

string

O nome da chave.

keyType

string

O tipo da chave. Um dos seguintes: 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct'.

options
CreateKeyOptions

Os parâmetros opcionais.

Retornos

Promise<KeyVaultKey>

createOctKey(string, CreateOctKeyOptions)

O método createOctKey cria uma nova chave OCT no Azure Key Vault. Se a chave nomeada já existir, o Azure Key Vault criará uma nova versão da chave. Ele requer a permissão de criação/chaves.

Uso de exemplo:

let client = new KeyClient(url, credentials);
let result = await client.createOctKey("MyKey", { hsm: true });

Cria uma nova chave, armazena-a e, em seguida, retorna parâmetros de chave e propriedades para o cliente.

function createOctKey(name: string, options?: CreateOctKeyOptions): Promise<KeyVaultKey>

Parâmetros

name

string

O nome da chave.

options
CreateOctKeyOptions

Os parâmetros opcionais.

Retornos

Promise<KeyVaultKey>

createRsaKey(string, CreateRsaKeyOptions)

O método createRSAKey cria uma nova chave RSA no Azure Key Vault. Se a chave nomeada já existir, o Azure Key Vault criará uma nova versão da chave. Ele requer a permissão de criação/chaves.

Uso de exemplo:

let client = new KeyClient(url, credentials);
let result = await client.createRsaKey("MyKey", { keySize: 2048 });

Cria uma nova chave, armazena-a e, em seguida, retorna parâmetros de chave e propriedades para o cliente.

function createRsaKey(name: string, options?: CreateRsaKeyOptions): Promise<KeyVaultKey>

Parâmetros

name

string

O nome da chave.

options
CreateRsaKeyOptions

Os parâmetros opcionais.

Retornos

Promise<KeyVaultKey>

getCryptographyClient(string, GetCryptographyClientOptions)

Obtém um CryptographyClient para a chave fornecida.

Uso de exemplo:

let client = new KeyClient(url, credentials);
// get a cryptography client for a given key
let cryptographyClient = client.getCryptographyClient("MyKey");

function getCryptographyClient(keyName: string, options?: GetCryptographyClientOptions): CryptographyClient

Parâmetros

keyName

string

options
GetCryptographyClientOptions

Retornos

CryptographyClient

getDeletedKey(string, GetDeletedKeyOptions)

O método getDeletedKey retorna a chave excluída especificada junto com suas propriedades. Essa operação requer a permissão de obtenção/chaves.

Uso de exemplo:

let client = new KeyClient(url, credentials);
let key = await client.getDeletedKey("MyDeletedKey");

Obtém a chave excluída especificada.

function getDeletedKey(name: string, options?: GetDeletedKeyOptions): Promise<DeletedKey>

Parâmetros

name

string

O nome da chave.

options
GetDeletedKeyOptions

Os parâmetros opcionais.

Retornos

Promise<DeletedKey>

getKey(string, GetKeyOptions)

O método getKey obtém uma chave especificada e é aplicável a qualquer chave armazenada no Azure Key Vault. Essa operação requer a permissão de obtenção/chaves.

Uso de exemplo:

let client = new KeyClient(url, credentials);
let key = await client.getKey("MyKey");

Obtenha uma chave especificada de um determinado cofre de chaves.

function getKey(name: string, options?: GetKeyOptions): Promise<KeyVaultKey>

Parâmetros

name

string

O nome da chave.

options
GetKeyOptions

Os parâmetros opcionais.

Retornos

Promise<KeyVaultKey>

getKeyRotationPolicy(string, GetKeyRotationPolicyOptions)

Obtém a política de rotação de uma chave do Key Vault. Por padrão, todas as chaves têm uma política que notificará 30 dias antes da expiração.

Essa operação requer a permissão de obtenção/chaves. Uso de exemplo:

let client = new KeyClient(vaultUrl, credentials);
let result = await client.getKeyRotationPolicy("myKey");

function getKeyRotationPolicy(keyName: string, options?: GetKeyRotationPolicyOptions): Promise<KeyRotationPolicy>

Parâmetros

keyName

string

O nome da chave.

options
GetKeyRotationPolicyOptions

Os parâmetros opcionais.

Retornos

Promise<KeyRotationPolicy>

getRandomBytes(number, GetRandomBytesOptions)

Obtém o número solicitado de bytes que contêm valores aleatórios de um HSM gerenciado. Essa operação requer a permissão managedHsm/rng.

Uso de exemplo:

let client = new KeyClient(vaultUrl, credentials);
let { bytes } = await client.getRandomBytes(10);

function getRandomBytes(count: number, options?: GetRandomBytesOptions): Promise<Uint8Array>

Parâmetros

count

number

O número de bytes a serem gerados entre 1 e 128 inclusive.

options
GetRandomBytesOptions

Os parâmetros opcionais.

Retornos

Promise<Uint8Array>

importKey(string, JsonWebKey, ImportKeyOptions)

A operação de importação de chave pode ser usada para importar qualquer tipo de chave para um Azure Key Vault. Se a chave nomeada já existir, o Azure Key Vault criará uma nova versão da chave. Essa operação requer a permissão de importação/chaves.

Uso de exemplo:

let client = new KeyClient(url, credentials);
// Key contents in myKeyContents
let result = await client.importKey("MyKey", myKeyContents);

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

function importKey(name: string, key: JsonWebKey, options?: ImportKeyOptions): Promise<KeyVaultKey>

Parâmetros

name

string

Nome da chave importada.

key
JsonWebKey

A chave da Web JSON.

options
ImportKeyOptions

Os parâmetros opcionais.

Retornos

Promise<KeyVaultKey>

listDeletedKeys(ListDeletedKeysOptions)

Itera as chaves excluídas no cofre. O identificador de chave completo e as propriedades são fornecidos na resposta. Nenhum valor é retornado para as chaves. Essas operações exigem a permissão de chaves/lista.

Uso de exemplo:

let client = new KeyClient(url, credentials);
for await (const deletedKey of client.listDeletedKeys()) {
  console.log("deleted key: ", deletedKey);
}

Listar todas as chaves no cofre

function listDeletedKeys(options?: ListDeletedKeysOptions): PagedAsyncIterableIterator<DeletedKey, DeletedKey[], PageSettings>

Parâmetros

options
ListDeletedKeysOptions

Os parâmetros opcionais.

Retornos

PagedAsyncIterableIterator<DeletedKey, DeletedKey[], PageSettings>

listPropertiesOfKeys(ListPropertiesOfKeysOptions)

Itera a versão mais recente de todas as chaves no cofre. O identificador de chave completo e as propriedades são fornecidos na resposta. Nenhum valor é retornado para as chaves. Essas operações exigem a permissão de chaves/lista.

Uso de exemplo:

let client = new KeyClient(url, credentials);
for await (const keyProperties of client.listPropertiesOfKeys()) {
  const key = await client.getKey(keyProperties.name);
  console.log("key: ", key);
}

Listar todas as chaves no cofre

function listPropertiesOfKeys(options?: ListPropertiesOfKeysOptions): PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

Parâmetros

options
ListPropertiesOfKeysOptions

Os parâmetros opcionais.

Retornos

PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)

Itera todas as versões da chave fornecida no cofre. O identificador de chave completo, as propriedades e as marcas são fornecidos na resposta. Essa operação requer a permissão de chaves/lista.

Uso de exemplo:

let client = new KeyClient(url, credentials);
for await (const keyProperties of client.listPropertiesOfKeyVersions("MyKey")) {
  const key = await client.getKey(keyProperties.name);
  console.log("key version: ", key);
}

function listPropertiesOfKeyVersions(name: string, options?: ListPropertiesOfKeyVersionsOptions): PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

Parâmetros

name

string

Nome da chave para buscar versões para

options
ListPropertiesOfKeyVersionsOptions

Os parâmetros opcionais.

Retornos

PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

purgeDeletedKey(string, PurgeDeletedKeyOptions)

A operação de chave excluída de limpeza remove a chave permanentemente, sem a possibilidade de recuperação. Essa operação só pode ser habilitada em um cofre habilitado para exclusão reversível. Essa operação requer a permissão de limpeza/chaves.

Uso de exemplo:

const client = new KeyClient(url, credentials);
const deletePoller = await client.beginDeleteKey("MyKey")
await deletePoller.pollUntilDone();
await client.purgeDeletedKey("MyKey");

Exclui permanentemente a chave especificada.

function purgeDeletedKey(name: string, options?: PurgeDeletedKeyOptions): Promise<void>

Parâmetros

name

string

O nome da chave.

options
PurgeDeletedKeyOptions

Os parâmetros opcionais.

Retornos

Promise<void>

releaseKey(string, string, ReleaseKeyOptions)

Libera uma chave de um HSM gerenciado.

A operação de chave de versão é aplicável a todos os tipos de chave. A operação requer que a chave seja marcada como exportável e a permissão de chave/liberação.

Uso de exemplo:

let client = new KeyClient(vaultUrl, credentials);
let result = await client.releaseKey("myKey", target)

function releaseKey(name: string, targetAttestationToken: string, options?: ReleaseKeyOptions): Promise<ReleaseKeyResult>

Parâmetros

name

string

O nome da chave.

targetAttestationToken

string

A asserção de atestado para o destino da versão da chave.

options
ReleaseKeyOptions

Os parâmetros opcionais.

Retornos

Promise<ReleaseKeyResult>

restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions)

Restaura uma chave de backup e todas as suas versões em um cofre. Essa operação requer a permissão de restauração/chaves.

Uso de exemplo:

let client = new KeyClient(url, credentials);
let backupContents = await client.backupKey("MyKey");
// ...
let key = await client.restoreKeyBackup(backupContents);

Restaura uma chave de backup em um cofre.

function restoreKeyBackup(backup: Uint8Array, options?: RestoreKeyBackupOptions): Promise<KeyVaultKey>

Parâmetros

backup

Uint8Array

O blob de backup associado a um pacote de chaves.

options
RestoreKeyBackupOptions

Os parâmetros opcionais.

Retornos

Promise<KeyVaultKey>

rotateKey(string, RotateKeyOptions)

Gira a chave com base na política de chave gerando uma nova versão da chave. Essa operação requer a permissão de rotação/chaves.

Uso de exemplo:

let client = new KeyClient(vaultUrl, credentials);
let key = await client.rotateKey("MyKey");

function rotateKey(name: string, options?: RotateKeyOptions): Promise<KeyVaultKey>

Parâmetros

name

string

O nome da chave a ser girada.

options
RotateKeyOptions

Os parâmetros opcionais.

Retornos

Promise<KeyVaultKey>

updateKeyProperties(string, string, UpdateKeyPropertiesOptions)

O método updateKeyProperties altera as propriedades especificadas de uma chave armazenada existente. As propriedades que não são especificadas na solicitação são deixadas inalteradas. O valor de uma chave em si não pode ser alterado. Essa operação requer a permissão de conjunto/chaves.

Uso de exemplo:

let keyName = "MyKey";
let client = new KeyClient(vaultUrl, credentials);
let key = await client.getKey(keyName);
let result = await client.updateKeyProperties(keyName, key.properties.version, { enabled: false });

Atualiza as propriedades associadas a uma chave especificada em um determinado cofre de chaves.

function updateKeyProperties(name: string, keyVersion: string, options?: UpdateKeyPropertiesOptions): Promise<KeyVaultKey>

Parâmetros

name

string

O nome da chave.

keyVersion

string

A versão da chave.

options
UpdateKeyPropertiesOptions

Os parâmetros opcionais.

Retornos

Promise<KeyVaultKey>

updateKeyProperties(string, UpdateKeyPropertiesOptions)

O método updateKeyProperties altera as propriedades especificadas da versão mais recente de uma chave armazenada existente. As propriedades que não são especificadas na solicitação são deixadas inalteradas. O valor de uma chave em si não pode ser alterado. Essa operação requer a permissão de conjunto/chaves.

Uso de exemplo:

let keyName = "MyKey";
let client = new KeyClient(vaultUrl, credentials);
let key = await client.getKey(keyName);
let result = await client.updateKeyProperties(keyName, { enabled: false });

Atualiza as propriedades associadas a uma chave especificada em um determinado cofre de chaves.

function updateKeyProperties(name: string, options?: UpdateKeyPropertiesOptions): Promise<KeyVaultKey>

Parâmetros

name

string

O nome da chave.

options
UpdateKeyPropertiesOptions

Os parâmetros opcionais.

Retornos

Promise<KeyVaultKey>

updateKeyRotationPolicy(string, KeyRotationPolicyProperties, UpdateKeyRotationPolicyOptions)

Atualiza a política de rotação de uma chave do Key Vault. Essa operação requer a permissão de chaves/atualização.

Uso de exemplo:

let client = new KeyClient(vaultUrl, credentials);
const setPolicy = await client.updateKeyRotationPolicy("MyKey", myPolicy);

function updateKeyRotationPolicy(keyName: string, policy: KeyRotationPolicyProperties, options?: UpdateKeyRotationPolicyOptions): Promise<KeyRotationPolicy>

Parâmetros

keyName

string

O nome da chave.

policy
KeyRotationPolicyProperties
options
UpdateKeyRotationPolicyOptions

Os parâmetros opcionais.

Retornos

Promise<KeyRotationPolicy>