Partilhar via

KeyVaultBackupClient class

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

O KeyVaultBackupClient fornece métodos para gerar backups e restaurar backups de qualquer instância do Azure Key Vault. Este cliente suporta a geração de backups completos, restaurações seletivas de chaves específicas e restaurações completas de instâncias do Cofre de Chaves.

Construtores

KeyVaultBackupClient(string, TokenCredential, KeyVaultBackupClientOptions)

Cria uma instância do KeyVaultBackupClient.

Exemplo de uso:

import { KeyVaultBackupClient } from "@azure/keyvault-admin";
import { DefaultAzureCredential } from "@azure/identity";

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

let client = new KeyVaultBackupClient(vaultUrl, credentials);

Propriedades

vaultUrl

O URL base para o cofre

Métodos

beginBackup(string, KeyVaultBeginBackupOptions)

Começa a gerar um backup de um Cofre de Chaves do Azure na conta de Blob de Armazenamento especificada, usando uma Identidade Gerenciada atribuída pelo usuário para acessar a conta de Armazenamento.

Esta função retorna um poller de Operação de Longa Execução que permite que você aguarde indefinidamente até que o backup do Cofre da Chave seja gerado.

Exemplo de uso:

const client = new KeyVaultBackupClient(url, credentials);

const blobStorageUri = "<blob-storage-uri>"; // <Blob storage URL>/<folder name>
const sasToken = "<sas-token>";
const poller = await client.beginBackup(blobStorageUri);

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

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

Inicia uma operação de backup completo.
beginBackup(string, string, KeyVaultBeginBackupOptions)

Começa a gerar um backup de um Cofre de Chaves do Azure na conta de Blob de Armazenamento especificada.

Esta função retorna um poller de Operação de Longa Execução que permite que você aguarde indefinidamente até que o backup do Cofre da Chave seja gerado.

Exemplo de uso:

const client = new KeyVaultBackupClient(url, credentials);

const blobStorageUri = "<blob-storage-uri>"; // <Blob storage URL>/<folder name>
const sasToken = "<sas-token>";
const poller = await client.beginBackup(blobStorageUri, sasToken);

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

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

Inicia uma operação de backup completo.
beginRestore(string, KeyVaultBeginRestoreOptions)

Inicia a restauração de todos os materiais de chave usando o token SAS apontando para uma pasta de backup de armazenamento de Blob do Azure armazenada anteriormente, usando uma Identidade Gerenciada atribuída pelo usuário para acessar a conta de armazenamento.

Esta função retorna um poller de Operação de Longa Execução que permite que você aguarde indefinidamente até que a operação de restauração do Cofre da Chave seja concluída.

Exemplo de uso:

const client = new KeyVaultBackupClient(url, credentials);

const blobStorageUri = "<blob-storage-uri>"; // <Blob storage URL>/<folder name>
const sasToken = "<sas-token>";
const poller = await client.beginRestore(blobStorageUri);

// The poller can be serialized with:
//
//   const serialized = poller.toString();
//
// A new poller can be created with:
//
//   await client.beginRestore(blobStorageUri, { resumeFrom: serialized });
//

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

Inicia uma operação de restauração completa.
beginRestore(string, string, KeyVaultBeginRestoreOptions)

Começa a restaurar todos os materiais de chave usando o token SAS apontando para uma pasta de backup de armazenamento de Blob do Azure armazenada anteriormente.

Esta função retorna um poller de Operação de Longa Execução que permite que você aguarde indefinidamente até que a operação de restauração do Cofre da Chave seja concluída.

Exemplo de uso:

const client = new KeyVaultBackupClient(url, credentials);

const blobStorageUri = "<blob-storage-uri>"; // <Blob storage URL>/<folder name>
const sasToken = "<sas-token>";
const poller = await client.beginRestore(blobStorageUri, sasToken);

// The poller can be serialized with:
//
//   const serialized = poller.toString();
//
// A new poller can be created with:
//
//   await client.beginRestore(blobStorageUri, sasToken, { resumeFrom: serialized });
//

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

Inicia uma operação de restauração completa.
beginSelectiveKeyRestore(string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Começa a restaurar todas as versões de chave de uma determinada chave usando uma pasta de backup de armazenamento de Blob do Azure armazenada anteriormente. A pasta de backup de armazenamento de Blob será acessada usando a Identidade Gerenciada atribuída pelo usuário.

Esta função retorna um poller de Operação de Longa Execução que permite que você aguarde indefinidamente até que a restauração seletiva do Cofre da Chave seja concluída.

Exemplo de uso:

const client = new KeyVaultBackupClient(url, credentials);

const blobStorageUri = "<blob-storage-uri>";
const sasToken = "<sas-token>";
const keyName = "<key-name>";
const poller = await client.beginSelectiveKeyRestore(keyName, blobStorageUri, sasToken);

// Serializing the poller
//
//   const serialized = poller.toString();
//
// A new poller can be created with:
//
//   await client.beginSelectiveKeyRestore(keyName, blobStorageUri, sasToken, { resumeFrom: serialized });
//

// Waiting until it's done
await poller.pollUntilDone();

Cria uma nova atribuição de função.
beginSelectiveKeyRestore(string, string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Inicia a restauração de todas as versões de chave de uma determinada chave usando o token SAS fornecido pelo usuário apontando para uma pasta de backup de armazenamento de Blob do Azure armazenada anteriormente.

Esta função retorna um poller de Operação de Longa Execução que permite que você aguarde indefinidamente até que a restauração seletiva do Cofre da Chave seja concluída.

Exemplo de uso:

const client = new KeyVaultBackupClient(url, credentials);

const blobStorageUri = "<blob-storage-uri>";
const sasToken = "<sas-token>";
const keyName = "<key-name>";
const poller = await client.beginSelectiveKeyRestore(keyName, blobStorageUri, sasToken);

// Serializing the poller
//
//   const serialized = poller.toString();
//
// A new poller can be created with:
//
//   await client.beginSelectiveKeyRestore(keyName, blobStorageUri, sasToken, { resumeFrom: serialized });
//

// Waiting until it's done
await poller.pollUntilDone();

Cria uma nova atribuição de função.

Detalhes do Construtor

KeyVaultBackupClient(string, TokenCredential, KeyVaultBackupClientOptions)

Cria uma instância do KeyVaultBackupClient.

Exemplo de uso:

import { KeyVaultBackupClient } from "@azure/keyvault-admin";
import { DefaultAzureCredential } from "@azure/identity";

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

let client = new KeyVaultBackupClient(vaultUrl, credentials);

new KeyVaultBackupClient(vaultUrl: string, credential: TokenCredential, options?: KeyVaultBackupClientOptions)

Parâmetros

vaultUrl

string

o URL do Cofre da Chave. Deve ter esta forma: https://${your-key-vault-name}.vault.azure.net. Você deve validar se essa URL faz referência a um recurso válido do Cofre da Chave ou do 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 para o serviço. Use o pacote @azure/identity para criar uma credencial que atenda às suas necessidades.

options
KeyVaultBackupClientOptions

opções usadas para configurar solicitações de API do Cofre de Chaves.

Detalhes de Propriedade

vaultUrl

O URL base para o cofre

vaultUrl: string

Valor de Propriedade

string

Detalhes de Método

beginBackup(string, KeyVaultBeginBackupOptions)

Começa a gerar um backup de um Cofre de Chaves do Azure na conta de Blob de Armazenamento especificada, usando uma Identidade Gerenciada atribuída pelo usuário para acessar a conta de Armazenamento.

Esta função retorna um poller de Operação de Longa Execução que permite que você aguarde indefinidamente até que o backup do Cofre da Chave seja gerado.

Exemplo de uso:

const client = new KeyVaultBackupClient(url, credentials);

const blobStorageUri = "<blob-storage-uri>"; // <Blob storage URL>/<folder name>
const sasToken = "<sas-token>";
const poller = await client.beginBackup(blobStorageUri);

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

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

Inicia uma operação de backup completo.

function beginBackup(blobStorageUri: string, options?: KeyVaultBeginBackupOptions): Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

Parâmetros

blobStorageUri

string

A URL do recurso de armazenamento de blob, incluindo o caminho para o contêiner onde o backup acabará sendo armazenado.

options
KeyVaultBeginBackupOptions

Os parâmetros opcionais.

Devoluções

Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

beginBackup(string, string, KeyVaultBeginBackupOptions)

Começa a gerar um backup de um Cofre de Chaves do Azure na conta de Blob de Armazenamento especificada.

Esta função retorna um poller de Operação de Longa Execução que permite que você aguarde indefinidamente até que o backup do Cofre da Chave seja gerado.

Exemplo de uso:

const client = new KeyVaultBackupClient(url, credentials);

const blobStorageUri = "<blob-storage-uri>"; // <Blob storage URL>/<folder name>
const sasToken = "<sas-token>";
const poller = await client.beginBackup(blobStorageUri, sasToken);

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

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

Inicia uma operação de backup completo.

function beginBackup(blobStorageUri: string, sasToken: string, options?: KeyVaultBeginBackupOptions): Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

Parâmetros

blobStorageUri

string

A URL do recurso de armazenamento de blob, incluindo o caminho para o contêiner onde o backup acabará sendo armazenado.

sasToken

string

O token SAS usado para acessar o recurso de armazenamento de blob.

options
KeyVaultBeginBackupOptions

Os parâmetros opcionais.

Devoluções

Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

beginRestore(string, KeyVaultBeginRestoreOptions)

Inicia a restauração de todos os materiais de chave usando o token SAS apontando para uma pasta de backup de armazenamento de Blob do Azure armazenada anteriormente, usando uma Identidade Gerenciada atribuída pelo usuário para acessar a conta de armazenamento.

Esta função retorna um poller de Operação de Longa Execução que permite que você aguarde indefinidamente até que a operação de restauração do Cofre da Chave seja concluída.

Exemplo de uso:

const client = new KeyVaultBackupClient(url, credentials);

const blobStorageUri = "<blob-storage-uri>"; // <Blob storage URL>/<folder name>
const sasToken = "<sas-token>";
const poller = await client.beginRestore(blobStorageUri);

// The poller can be serialized with:
//
//   const serialized = poller.toString();
//
// A new poller can be created with:
//
//   await client.beginRestore(blobStorageUri, { resumeFrom: serialized });
//

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

Inicia uma operação de restauração completa.

function beginRestore(folderUri: string, options?: KeyVaultBeginRestoreOptions): Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

Parâmetros

folderUri

string

A URL do recurso de armazenamento de blob onde o backup completo bem-sucedido anterior foi armazenado.

options
KeyVaultBeginRestoreOptions

Os parâmetros opcionais.

Devoluções

Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

beginRestore(string, string, KeyVaultBeginRestoreOptions)

Começa a restaurar todos os materiais de chave usando o token SAS apontando para uma pasta de backup de armazenamento de Blob do Azure armazenada anteriormente.

Esta função retorna um poller de Operação de Longa Execução que permite que você aguarde indefinidamente até que a operação de restauração do Cofre da Chave seja concluída.

Exemplo de uso:

const client = new KeyVaultBackupClient(url, credentials);

const blobStorageUri = "<blob-storage-uri>"; // <Blob storage URL>/<folder name>
const sasToken = "<sas-token>";
const poller = await client.beginRestore(blobStorageUri, sasToken);

// The poller can be serialized with:
//
//   const serialized = poller.toString();
//
// A new poller can be created with:
//
//   await client.beginRestore(blobStorageUri, sasToken, { resumeFrom: serialized });
//

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

Inicia uma operação de restauração completa.

function beginRestore(folderUri: string, sasToken: string, options?: KeyVaultBeginRestoreOptions): Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

Parâmetros

folderUri

string

A URL do recurso de armazenamento de blob onde o backup completo bem-sucedido anterior foi armazenado.

sasToken

string

O token SAS. Se nenhum token SAS for fornecido, a Identidade Gerenciada atribuída pelo usuário será usada para acessar o recurso de armazenamento de blob.

options
KeyVaultBeginRestoreOptions

Os parâmetros opcionais.

Devoluções

Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

beginSelectiveKeyRestore(string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Começa a restaurar todas as versões de chave de uma determinada chave usando uma pasta de backup de armazenamento de Blob do Azure armazenada anteriormente. A pasta de backup de armazenamento de Blob será acessada usando a Identidade Gerenciada atribuída pelo usuário.

Esta função retorna um poller de Operação de Longa Execução que permite que você aguarde indefinidamente até que a restauração seletiva do Cofre da Chave seja concluída.

Exemplo de uso:

const client = new KeyVaultBackupClient(url, credentials);

const blobStorageUri = "<blob-storage-uri>";
const sasToken = "<sas-token>";
const keyName = "<key-name>";
const poller = await client.beginSelectiveKeyRestore(keyName, blobStorageUri, sasToken);

// Serializing the poller
//
//   const serialized = poller.toString();
//
// A new poller can be created with:
//
//   await client.beginSelectiveKeyRestore(keyName, blobStorageUri, sasToken, { resumeFrom: serialized });
//

// Waiting until it's done
await poller.pollUntilDone();

Cria uma nova atribuição de função.

function beginSelectiveKeyRestore(keyName: string, folderUri: string, options?: KeyVaultBeginSelectiveKeyRestoreOptions): Promise<PollerLike<KeyVaultSelectiveKeyRestoreOperationState, KeyVaultSelectiveKeyRestoreResult>>

Parâmetros

keyName

string

O nome da chave que deseja ser restaurada.

folderUri

string

A URL do recurso de armazenamento de blob, com o nome da pasta do blob onde o backup completo bem-sucedido anterior foi armazenado.

options
KeyVaultBeginSelectiveKeyRestoreOptions

Os parâmetros opcionais.

Devoluções

Promise<PollerLike<KeyVaultSelectiveKeyRestoreOperationState, KeyVaultSelectiveKeyRestoreResult>>

beginSelectiveKeyRestore(string, string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Inicia a restauração de todas as versões de chave de uma determinada chave usando o token SAS fornecido pelo usuário apontando para uma pasta de backup de armazenamento de Blob do Azure armazenada anteriormente.

Esta função retorna um poller de Operação de Longa Execução que permite que você aguarde indefinidamente até que a restauração seletiva do Cofre da Chave seja concluída.

Exemplo de uso:

const client = new KeyVaultBackupClient(url, credentials);

const blobStorageUri = "<blob-storage-uri>";
const sasToken = "<sas-token>";
const keyName = "<key-name>";
const poller = await client.beginSelectiveKeyRestore(keyName, blobStorageUri, sasToken);

// Serializing the poller
//
//   const serialized = poller.toString();
//
// A new poller can be created with:
//
//   await client.beginSelectiveKeyRestore(keyName, blobStorageUri, sasToken, { resumeFrom: serialized });
//

// Waiting until it's done
await poller.pollUntilDone();

Cria uma nova atribuição de função.

function beginSelectiveKeyRestore(keyName: string, folderUri: string, sasToken: string, options?: KeyVaultBeginSelectiveKeyRestoreOptions): Promise<PollerLike<KeyVaultSelectiveKeyRestoreOperationState, KeyVaultSelectiveKeyRestoreResult>>

Parâmetros

keyName

string

O nome da chave que deseja ser restaurada.

folderUri

string

A URL do recurso de armazenamento de blob, com o nome da pasta do blob onde o backup completo bem-sucedido anterior foi armazenado.

sasToken

string

O token SAS. Se nenhum token SAS for fornecido, a Identidade Gerenciada atribuída pelo usuário será usada para acessar o recurso de armazenamento de blob.

options
KeyVaultBeginSelectiveKeyRestoreOptions

Os parâmetros opcionais.

Devoluções

Promise<PollerLike<KeyVaultSelectiveKeyRestoreOperationState, KeyVaultSelectiveKeyRestoreResult>>