Partilhar via

KeyVaultBackupClient class

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

O KeyVaultBackupClient fornece métodos para gerar cópias de segurança e restaurar cópias de segurança de qualquer instância do Azure Key Vault. Este cliente suporta a geração de cópias de segurança completas, restauros seletivos de chaves específicas e restauros completos de instâncias Key Vault.

Construtores

KeyVaultBackupClient(string, TokenCredential, KeyVaultBackupClientOptions)

Cria uma instância do KeyVaultBackupClient.

Utilização de exemplo: 

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 uma cópia de segurança de uma Key Vault do Azure na conta de Blob de Armazenamento especificada, utilizando uma Identidade Gerida atribuída pelo utilizador para aceder à conta de Armazenamento.

Esta função devolve um poller de Operação de Execução Prolongada que lhe permite aguardar indefinidamente até que a cópia de segurança Key Vault seja gerada.

Utilização de exemplo: 

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 cópia de segurança completa.
beginBackup(string, string, KeyVaultBeginBackupOptions)

Começa a gerar uma cópia de segurança de uma Key Vault do Azure na conta de Blob de Armazenamento especificada.

Esta função devolve um poller de Operação de Execução Prolongada que lhe permite aguardar indefinidamente até que a cópia de segurança Key Vault seja gerada.

Utilização de exemplo: 

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 cópia de segurança completa.
beginRestore(string, KeyVaultBeginRestoreOptions)

Começa a restaurar todos os materiais principais com o token de SAS que aponta para uma pasta de cópia de segurança do Armazenamento de Blobs do Azure armazenada anteriormente, utilizando uma Identidade Gerida atribuída pelo utilizador para aceder à conta de armazenamento.

Esta função devolve um poller de Operação de Execução Prolongada que lhe permite aguardar indefinidamente até que a operação de restauro do Key Vault esteja concluída.

Utilização de exemplo: 

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 restauro completa.
beginRestore(string, string, KeyVaultBeginRestoreOptions)

Começa a restaurar todos os materiais-chave com o token de SAS que aponta para uma pasta de cópia de segurança do Armazenamento de Blobs do Azure armazenada anteriormente.

Esta função devolve um poller de Operação de Execução Prolongada que lhe permite aguardar indefinidamente até que a operação de restauro do Key Vault esteja concluída.

Utilização de exemplo: 

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 restauro completa.
beginSelectiveKeyRestore(string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Começa a restaurar todas as versões principais de uma determinada chave com uma pasta de cópia de segurança do Armazenamento de Blobs do Azure armazenada anteriormente. A pasta de cópia de segurança do Armazenamento de blobs será acedida com a Identidade Gerida atribuída pelo utilizador.

Esta função devolve um poller de Operação de Execução Prolongada que lhe permite aguardar indefinidamente até que o Key Vault restauro seletivo esteja concluído.

Utilização de exemplo: 

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)

Começa a restaurar todas as versões principais de uma determinada chave com o token SAS fornecido pelo utilizador que aponta para uma pasta de cópia de segurança do Armazenamento de Blobs do Azure armazenada anteriormente.

Esta função devolve um poller de Operação de Execução Prolongada que lhe permite aguardar indefinidamente até que o Key Vault restauro seletivo esteja concluído.

Utilização de exemplo: 

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.

Utilização de exemplo: 

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

options
KeyVaultBackupClientOptions

opções utilizadas para configurar Key Vault pedidos de API.

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 uma cópia de segurança de uma Key Vault do Azure na conta de Blob de Armazenamento especificada, utilizando uma Identidade Gerida atribuída pelo utilizador para aceder à conta de Armazenamento.

Esta função devolve um poller de Operação de Execução Prolongada que lhe permite aguardar indefinidamente até que a cópia de segurança Key Vault seja gerada.

Utilização de exemplo: 

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

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

Parâmetros

blobStorageUri

string

O URL do recurso de armazenamento de blobs, incluindo o caminho para o contentor onde a cópia de segurança vai acabar por ser armazenada.

options
KeyVaultBeginBackupOptions

Os parâmetros opcionais.

Devoluções

Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

beginBackup(string, string, KeyVaultBeginBackupOptions)

Começa a gerar uma cópia de segurança de uma Key Vault do Azure na conta de Blob de Armazenamento especificada.

Esta função devolve um poller de Operação de Execução Prolongada que lhe permite aguardar indefinidamente até que a cópia de segurança Key Vault seja gerada.

Utilização de exemplo: 

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

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

Parâmetros

blobStorageUri

string

O URL do recurso de armazenamento de blobs, incluindo o caminho para o contentor onde a cópia de segurança vai acabar por ser armazenada.

sasToken

string

O token de SAS utilizado para aceder ao recurso de armazenamento de blobs.

options
KeyVaultBeginBackupOptions

Os parâmetros opcionais.

Devoluções

Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

beginRestore(string, KeyVaultBeginRestoreOptions)

Começa a restaurar todos os materiais principais com o token de SAS que aponta para uma pasta de cópia de segurança do Armazenamento de Blobs do Azure armazenada anteriormente, utilizando uma Identidade Gerida atribuída pelo utilizador para aceder à conta de armazenamento.

Esta função devolve um poller de Operação de Execução Prolongada que lhe permite aguardar indefinidamente até que a operação de restauro do Key Vault esteja concluída.

Utilização de exemplo: 

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 restauro completa.

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

Parâmetros

folderUri

string

O URL do recurso de armazenamento de blobs onde a cópia de segurança completa com êxito anterior foi armazenada.

options
KeyVaultBeginRestoreOptions

Os parâmetros opcionais.

Devoluções

Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

beginRestore(string, string, KeyVaultBeginRestoreOptions)

Começa a restaurar todos os materiais-chave com o token de SAS que aponta para uma pasta de cópia de segurança do Armazenamento de Blobs do Azure armazenada anteriormente.

Esta função devolve um poller de Operação de Execução Prolongada que lhe permite aguardar indefinidamente até que a operação de restauro do Key Vault esteja concluída.

Utilização de exemplo: 

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 restauro completa.

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

Parâmetros

folderUri

string

O URL do recurso de armazenamento de blobs onde a cópia de segurança completa com êxito anterior foi armazenada.

sasToken

string

O token de SAS. Se não for fornecido nenhum token de SAS, a Identidade Gerida atribuída pelo utilizador será utilizada para aceder ao recurso de armazenamento de blobs.

options
KeyVaultBeginRestoreOptions

Os parâmetros opcionais.

Devoluções

Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

beginSelectiveKeyRestore(string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Começa a restaurar todas as versões principais de uma determinada chave com uma pasta de cópia de segurança do Armazenamento de Blobs do Azure armazenada anteriormente. A pasta de cópia de segurança do Armazenamento de blobs será acedida com a Identidade Gerida atribuída pelo utilizador.

Esta função devolve um poller de Operação de Execução Prolongada que lhe permite aguardar indefinidamente até que o Key Vault restauro seletivo esteja concluído.

Utilização de exemplo: 

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 quer ser restaurada.

folderUri

string

O URL do recurso de armazenamento de blobs, com o nome da pasta do blob onde a cópia de segurança completa com êxito anterior foi armazenada.

options
KeyVaultBeginSelectiveKeyRestoreOptions

Os parâmetros opcionais.

Devoluções

Promise<PollerLike<KeyVaultSelectiveKeyRestoreOperationState, KeyVaultSelectiveKeyRestoreResult>>

beginSelectiveKeyRestore(string, string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Começa a restaurar todas as versões principais de uma determinada chave com o token SAS fornecido pelo utilizador que aponta para uma pasta de cópia de segurança do Armazenamento de Blobs do Azure armazenada anteriormente.

Esta função devolve um poller de Operação de Execução Prolongada que lhe permite aguardar indefinidamente até que o Key Vault restauro seletivo esteja concluído.

Utilização de exemplo: 

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 quer ser restaurada.

folderUri

string

O URL do recurso de armazenamento de blobs, com o nome da pasta do blob onde a cópia de segurança completa com êxito anterior foi armazenada.

sasToken

string

O token de SAS. Se não for fornecido nenhum token de SAS, a Identidade Gerida atribuída pelo utilizador será utilizada para aceder ao recurso de armazenamento de blobs.

options
KeyVaultBeginSelectiveKeyRestoreOptions

Os parâmetros opcionais.

Devoluções

Promise<PollerLike<KeyVaultSelectiveKeyRestoreOperationState, KeyVaultSelectiveKeyRestoreResult>>