KeyClient class

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

O KeyClient fornece métodos para gerir KeyVaultKey na Key Vault do Azure. O cliente suporta a criação, obtenção, atualização, eliminação, remoção, cópia de segurança, restauro e listagem de KeyVaultKeys. O cliente também suporta a listagem deleteKey para uma eliminação recuperável ativada do Azure Key Vault.

Construtores

KeyClient(string, TokenCredential, KeyClientOptions)

Cria uma instância do KeyClient.

Utilização 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

O URL base para o cofre

Métodos

backupKey(string, BackupKeyOptions)

Pede que seja transferida uma cópia de segurança da chave especificada para o cliente. Todas as versões da chave serão transferidas. Esta operação requer as chaves/permissão de cópia de segurança.

Utilização de exemplo: 

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

Cria uma cópia de segurança da chave especificada.
beginDeleteKey(string, BeginDeleteKeyOptions)

A operação de eliminação aplica-se a qualquer chave armazenada no Azure Key Vault. As versões individuais de uma chave não podem ser eliminadas, apenas todas as versões de uma determinada chave ao mesmo tempo.

Esta função devolve um poller de Operação de Execução Prolongada que lhe permite aguardar indefinidamente até que a chave seja eliminada.

Esta operação requer a permissão de chaves/eliminação.

Utilização 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);

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

Recupera a chave eliminada no cofre especificado. Esta operação só pode ser efetuada num cofre ativado para eliminação recuperável.

Esta função devolve um poller de Operação de Execução Prolongada que lhe permite aguardar indefinidamente até que a chave eliminada seja recuperada.

Esta operação requer as chaves/permissão de recuperação.

Utilização 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 eliminada 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 cria uma nova versão da chave. Requer as chaves/permissão de criação.

Utilização 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, devolve propriedades e parâmetros-chave ao cliente.
createKey(string, string, CreateKeyOptions)

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

Utilização 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, devolve propriedades e parâmetros-chave ao 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 cria uma nova versão da chave. Requer as chaves/permissão de criação.

Utilização 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, devolve propriedades e parâmetros-chave ao 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 cria uma nova versão da chave. Requer as chaves/permissão de criação.

Utilização 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, devolve propriedades e parâmetros-chave ao cliente.
getCryptographyClient(string, GetCryptographyClientOptions)

Obtém um CryptographyClient para a chave especificada.

Utilização 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 devolve a chave eliminada especificada juntamente com as respetivas propriedades. Esta operação requer as chaves/obter permissão.

Utilização de exemplo: 

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

Obtém a chave eliminada especificada.
getKey(string, GetKeyOptions)

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

Utilização de exemplo: 

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

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

Obtém a política de rotação de uma Chave de Key Vault. Por predefinição, todas as chaves têm uma política que notificará 30 dias antes de expirar.

Esta operação requer as chaves/obter permissão. Utilização de exemplo: 

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

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

Utilização de exemplo: 

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

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

Utilização 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 devolve os parâmetros e propriedades principais ao cliente.
listDeletedKeys(ListDeletedKeysOptions)

Itera as chaves eliminadas no cofre. O identificador de chave completo e as propriedades são fornecidos na resposta. Não são devolvidos valores para as chaves. Estas operações requerem a permissão de chaves/lista.

Utilização 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. Não são devolvidos valores para as chaves. Estas operações requerem a permissão de chaves/lista.

Utilização 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 especificada no cofre. O identificador de chave completo, propriedades e etiquetas são fornecidos na resposta. Esta operação requer a permissão de chaves/lista.

Utilização 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 remoção da chave eliminada remove permanentemente a chave, sem a possibilidade de recuperação. Esta operação só pode ser ativada num cofre com eliminação recuperável ativada. Esta operação requer as chaves/permissão de remoção.

Utilização de exemplo: 

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

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

Lança uma chave de um HSM gerido.

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

Utilização de exemplo: 

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

Restaura uma chave de cópia de segurança e todas as respetivas versões para um cofre. Esta operação requer as chaves/permissão de restauro.

Utilização de exemplo: 

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

Restaura uma chave de cópia de segurança para um cofre.
rotateKey(string, RotateKeyOptions)

Roda a chave com base na política de chave ao gerar uma nova versão da chave. Esta operação requer as chaves/permissão de rotação.

Utilização 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 no pedido permanecem inalteradas. O valor de uma chave em si não pode ser alterado. Esta operação requer as chaves/permissão definida.

Utilização 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ções as propriedades associadas a uma chave especificada num 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 no pedido permanecem inalteradas. O valor de uma chave em si não pode ser alterado. Esta operação requer as chaves/permissão definida.

Utilização 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ções as propriedades associadas a uma chave especificada num determinado cofre de chaves.
updateKeyRotationPolicy(string, KeyRotationPolicyProperties, UpdateKeyRotationPolicyOptions)

Atualizações a política de rotação de uma Chave de Key Vault. Esta operação requer as chaves/permissão de atualização.

Utilização 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.

Utilização 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

o URL do Key Vault. Deve ter esta forma: https://${your-key-vault-name}.vault.azure.net. Deve validar que este URL faz referência a um recurso de Key Vault ou HSM gerido válido. Veja https://aka.ms/azsdk/blog/vault-uri para obter detalhes.

credential
TokenCredential

Um objeto que implementa a TokenCredential interface utilizada para autenticar pedidos no serviço. Utilize o @azure/identity pacote para criar uma credencial que se adeque às suas necessidades.

pipelineOptions
KeyClientOptions

Opções de pipeline utilizadas para configurar pedidos de API Key Vault. Omita este parâmetro para utilizar a configuração de pipeline predefinida.

Detalhes de Propriedade

vaultUrl

O URL base para o cofre

vaultUrl: string

Valor de Propriedade

string

Detalhes de Método

backupKey(string, BackupKeyOptions)

Pede que seja transferida uma cópia de segurança da chave especificada para o cliente. Todas as versões da chave serão transferidas. Esta operação requer as chaves/permissão de cópia de segurança.

Utilização de exemplo: 

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

Cria uma cópia de segurança 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.

Devoluções

Promise<undefined | Uint8Array>

beginDeleteKey(string, BeginDeleteKeyOptions)

A operação de eliminação aplica-se a qualquer chave armazenada no Azure Key Vault. As versões individuais de uma chave não podem ser eliminadas, apenas todas as versões de uma determinada chave ao mesmo tempo.

Esta função devolve um poller de Operação de Execução Prolongada que lhe permite aguardar indefinidamente até que a chave seja eliminada.

Esta operação requer a permissão de chaves/eliminação.

Utilização 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);

Elimina 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.

Devoluções

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

beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

Recupera a chave eliminada no cofre especificado. Esta operação só pode ser efetuada num cofre ativado para eliminação recuperável.

Esta função devolve um poller de Operação de Execução Prolongada que lhe permite aguardar indefinidamente até que a chave eliminada seja recuperada.

Esta operação requer as chaves/permissão de recuperação.

Utilização 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 eliminada 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 eliminada.

options
BeginRecoverDeletedKeyOptions

Os parâmetros opcionais.

Devoluções

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 cria uma nova versão da chave. Requer as chaves/permissão de criação.

Utilização 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, devolve propriedades e parâmetros-chave ao cliente.

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

Parâmetros

name

string

O nome da chave.

options
CreateEcKeyOptions

Os parâmetros opcionais.

Devoluções

Promise<KeyVaultKey>

createKey(string, string, CreateKeyOptions)

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

Utilização 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, devolve propriedades e parâmetros-chave ao 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.

Devoluções

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 cria uma nova versão da chave. Requer as chaves/permissão de criação.

Utilização 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, devolve propriedades e parâmetros-chave ao cliente.

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

Parâmetros

name

string

O nome da chave.

options
CreateOctKeyOptions

Os parâmetros opcionais.

Devoluções

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 cria uma nova versão da chave. Requer as chaves/permissão de criação.

Utilização 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, devolve propriedades e parâmetros-chave ao cliente.

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

Parâmetros

name

string

O nome da chave.

options
CreateRsaKeyOptions

Os parâmetros opcionais.

Devoluções

Promise<KeyVaultKey>

getCryptographyClient(string, GetCryptographyClientOptions)

Obtém um CryptographyClient para a chave especificada.

Utilização 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

Devoluções

CryptographyClient

getDeletedKey(string, GetDeletedKeyOptions)

O método getDeletedKey devolve a chave eliminada especificada juntamente com as respetivas propriedades. Esta operação requer as chaves/obter permissão.

Utilização de exemplo: 

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

Obtém a chave eliminada especificada.

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

Parâmetros

name

string

O nome da chave.

options
GetDeletedKeyOptions

Os parâmetros opcionais.

Devoluções

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. Esta operação requer as chaves/obter permissão.

Utilização de exemplo: 

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

Obtenha uma chave especificada a partir 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.

Devoluções

Promise<KeyVaultKey>

getKeyRotationPolicy(string, GetKeyRotationPolicyOptions)

Obtém a política de rotação de uma Chave de Key Vault. Por predefinição, todas as chaves têm uma política que notificará 30 dias antes de expirar.

Esta operação requer as chaves/obter permissão. Utilização 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.

Devoluções

Promise<KeyRotationPolicy>

getRandomBytes(number, GetRandomBytesOptions)

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

Utilização 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 gerar entre 1 e 128 inclusive.

options
GetRandomBytesOptions

Os parâmetros opcionais.

Devoluções

Promise<Uint8Array>

importKey(string, JsonWebKey_2, ImportKeyOptions)

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

Utilização 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 devolve os parâmetros e propriedades principais ao cliente.

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

Parâmetros

name

string

Nome da chave importada.

key
JsonWebKey

A chave Web JSON.

options
ImportKeyOptions

Os parâmetros opcionais.

Devoluções

Promise<KeyVaultKey>

listDeletedKeys(ListDeletedKeysOptions)

Itera as chaves eliminadas no cofre. O identificador de chave completo e as propriedades são fornecidos na resposta. Não são devolvidos valores para as chaves. Estas operações requerem a permissão de chaves/lista.

Utilização 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.

Devoluções

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. Não são devolvidos valores para as chaves. Estas operações requerem a permissão de chaves/lista.

Utilização 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.

Devoluções

PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)

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

Utilização 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 obter versões para

options
ListPropertiesOfKeyVersionsOptions

Os parâmetros opcionais.

Devoluções

PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

purgeDeletedKey(string, PurgeDeletedKeyOptions)

A operação de remoção da chave eliminada remove permanentemente a chave, sem a possibilidade de recuperação. Esta operação só pode ser ativada num cofre com eliminação recuperável ativada. Esta operação requer as chaves/permissão de remoção.

Utilização de exemplo: 

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

Elimina 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.

Devoluções

Promise<void>

releaseKey(string, string, ReleaseKeyOptions)

Lança uma chave de um HSM gerido.

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

Utilização 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 do atestado para o destino da versão da chave.

options
ReleaseKeyOptions

Os parâmetros opcionais.

Devoluções

Promise<ReleaseKeyResult>

restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions)

Restaura uma chave de cópia de segurança e todas as respetivas versões para um cofre. Esta operação requer as chaves/permissão de restauro.

Utilização de exemplo: 

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

Restaura uma chave de cópia de segurança para um cofre.

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

Parâmetros

backup

Uint8Array

O blob de cópia de segurança associado a um pacote de chaves.

options
RestoreKeyBackupOptions

Os parâmetros opcionais.

Devoluções

Promise<KeyVaultKey>

rotateKey(string, RotateKeyOptions)

Roda a chave com base na política de chave ao gerar uma nova versão da chave. Esta operação requer as chaves/permissão de rotação.

Utilização 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 rodar.

options
RotateKeyOptions

Os parâmetros opcionais.

Devoluções

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 no pedido permanecem inalteradas. O valor de uma chave em si não pode ser alterado. Esta operação requer as chaves/permissão definida.

Utilização 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ções as propriedades associadas a uma chave especificada num 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.

Devoluções

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 no pedido permanecem inalteradas. O valor de uma chave em si não pode ser alterado. Esta operação requer as chaves/permissão definida.

Utilização 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ções as propriedades associadas a uma chave especificada num 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.

Devoluções

Promise<KeyVaultKey>

updateKeyRotationPolicy(string, KeyRotationPolicyProperties, UpdateKeyRotationPolicyOptions)

Atualizações a política de rotação de uma Chave de Key Vault. Esta operação requer as chaves/permissão de atualização.

Utilização 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.

Devoluções

Promise<KeyRotationPolicy>