Compartilhar via

KeyVaultBackupClient class

Pacote:
@azure/keyvault-admin

O KeyVaultBackupClient fornece métodos para gerar backups e restaurar backups de qualquer determinada instância do Azure Key Vault. Esse cliente dá suporte à geração de backups completos, restaurações seletivas de chaves específicas e restaurações completas de instâncias do Key Vault.

Construtores

KeyVaultBackupClient(string, TokenCredential, KeyVaultBackupClientOptions)

Cria uma instância do KeyVaultBackupClient.

Uso de exemplo:

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

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

Propriedades

vaultUrl

A URL base para o cofre

Métodos

beginBackup(string, KeyVaultBeginBackupOptions)

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

Essa função retorna um sondador de Operação de Execução Longa que permite que você aguarde indefinidamente até que o backup do Key Vault seja gerado.

Uso de exemplo:

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

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

const blobStorageUri = "<blob-storage-uri>"; // <Blob storage URL>/<folder name>
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 completa.
beginBackup(string, string, KeyVaultBeginBackupOptions)

Começa a gerar um backup de um Azure Key Vault na conta de Blob de Armazenamento especificada.

Essa função retorna um sondador de Operação de Execução Longa que permite que você aguarde indefinidamente até que o backup do Key Vault seja gerado.

Uso de exemplo:

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

const vaultUrl = `https://<MY KEY VAULT HERE>.vault.azure.net`;
const credentials = new DefaultAzureCredential();
const client = new KeyVaultBackupClient(vaultUrl, 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 completa.
beginPreBackup(string, KeyVaultBeginPreBackupOptions)

Inicia uma operação de pré-backup que pode ser usada para verificar se o cliente pode executar uma operação de beginBackup usando a identidade gerenciada atribuída pelo usuário configurada pelo HSM gerenciado para autenticar com o Armazenamento do Azure.

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

Uso de exemplo:

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

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

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

// Serializing the poller
const serialized = poller.toString();

// A new poller can be created with:
await client.beginPreBackup(blobStorageUri, { resumeFrom: serialized });

// Waiting until it's done
const result = await poller.pollUntilDone();
console.log(result);
beginPreBackup(string, string, KeyVaultBeginPreBackupOptions)

Inicia uma operação de pré-backup que pode ser usada para verificar se o cliente pode executar uma operação de beginBackup usando o token SAS fornecido.

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

Uso de exemplo:

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

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

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

// Serializing the poller
const serialized = poller.toString();

// A new poller can be created with:
await client.beginPreBackup(blobStorageUri, sasToken, { resumeFrom: serialized });

// Waiting until it's done
const result = await poller.pollUntilDone();
console.log(result);
beginPreRestore(string, KeyVaultBeginPreRestoreOptions)

Inicia uma operação de pré-restauração que pode ser usada para verificar se o cliente pode executar uma operação de beginRestore usando o token SAS fornecido.

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

Uso de exemplo:

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

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

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

// The poller can be serialized with:
const serialized = poller.toString();

// A new poller can be created with:
await client.beginPreRestore(blobStorageUri, sasToken, { resumeFrom: serialized });

// Waiting until it's done
await poller.pollUntilDone();
beginPreRestore(string, string, KeyVaultBeginPreRestoreOptions)

Inicia uma operação de pré-restauração que pode ser usada para verificar se o cliente pode executar uma operação de beginRestore usando o token SAS fornecido.

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

Uso de exemplo:

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

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

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

// The poller can be serialized with:
const serialized = poller.toString();

// A new poller can be created with:
await client.beginPreRestore(blobStorageUri, sasToken, { resumeFrom: serialized });

// Waiting until it's done
await poller.pollUntilDone();
beginRestore(string, KeyVaultBeginRestoreOptions)

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

Essa função retorna um sondador de Operação de Execução Longa que permite que você aguarde indefinidamente até que a operação de restauração do Key Vault seja concluída.

Uso de exemplo:

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

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

const blobStorageUri = "<blob-storage-uri>"; // <Blob storage URL>/<folder name>
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
await poller.pollUntilDone();

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 Blobs do Azure armazenada anteriormente.

Essa função retorna um sondador de Operação de Execução Longa que permite que você aguarde indefinidamente até que a operação de restauração do Key Vault seja concluída.

Uso de exemplo:

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

const vaultUrl = `https://<MY KEY VAULT HERE>.vault.azure.net`;
const credentials = new DefaultAzureCredential();
const client = new KeyVaultBackupClient(vaultUrl, 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 principais versões de uma determinada chave usando uma pasta de backup de armazenamento de Blobs do Azure armazenada anteriormente. A pasta de backup do Armazenamento de Blobs será acessada usando a Identidade Gerenciada atribuída pelo usuário.

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

Uso de exemplo:

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

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

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

// Serializing the poller
const serialized = poller.toString();

// A new poller can be created with:
await client.beginSelectiveKeyRestore(keyName, blobStorageUri, { 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 principais versões de uma determinada chave usando o token SAS fornecido pelo usuário apontando para uma pasta de backup de armazenamento de Blobs do Azure armazenada anteriormente.

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

Uso de exemplo:

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

const vaultUrl = `https://<MY KEY VAULT HERE>.vault.azure.net`;
const credentials = new DefaultAzureCredential();
const client = new KeyVaultBackupClient(vaultUrl, 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.

Uso de exemplo:

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

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

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

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.

options
KeyVaultBackupClientOptions

opções usadas para configurar solicitações de API do Key Vault.

Detalhes da propriedade

vaultUrl

A URL base para o cofre

vaultUrl: string

Valor da propriedade

string

Detalhes do método

beginBackup(string, KeyVaultBeginBackupOptions)

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

Essa função retorna um sondador de Operação de Execução Longa que permite que você aguarde indefinidamente até que o backup do Key Vault seja gerado.

Uso de exemplo:

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

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

const blobStorageUri = "<blob-storage-uri>"; // <Blob storage URL>/<folder name>
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 completa.

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

Parâmetros

blobStorageUri

string

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

options
KeyVaultBeginBackupOptions

Os parâmetros opcionais.

Retornos

Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

beginBackup(string, string, KeyVaultBeginBackupOptions)

Começa a gerar um backup de um Azure Key Vault na conta de Blob de Armazenamento especificada.

Essa função retorna um sondador de Operação de Execução Longa que permite que você aguarde indefinidamente até que o backup do Key Vault seja gerado.

Uso de exemplo:

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

const vaultUrl = `https://<MY KEY VAULT HERE>.vault.azure.net`;
const credentials = new DefaultAzureCredential();
const client = new KeyVaultBackupClient(vaultUrl, 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 completa.

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

Parâmetros

blobStorageUri

string

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

sasToken

string

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

options
KeyVaultBeginBackupOptions

Os parâmetros opcionais.

Retornos

Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

beginPreBackup(string, KeyVaultBeginPreBackupOptions)

Inicia uma operação de pré-backup que pode ser usada para verificar se o cliente pode executar uma operação de beginBackup usando a identidade gerenciada atribuída pelo usuário configurada pelo HSM gerenciado para autenticar com o Armazenamento do Azure.

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

Uso de exemplo:

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

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

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

// Serializing the poller
const serialized = poller.toString();

// A new poller can be created with:
await client.beginPreBackup(blobStorageUri, { resumeFrom: serialized });

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

function beginPreBackup(blobStorageUri: string, options?: KeyVaultBeginPreBackupOptions): Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

Parâmetros

blobStorageUri

string

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

options
KeyVaultBeginPreBackupOptions

Os parâmetros opcionais.

Retornos

Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

beginPreBackup(string, string, KeyVaultBeginPreBackupOptions)

Inicia uma operação de pré-backup que pode ser usada para verificar se o cliente pode executar uma operação de beginBackup usando o token SAS fornecido.

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

Uso de exemplo:

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

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

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

// Serializing the poller
const serialized = poller.toString();

// A new poller can be created with:
await client.beginPreBackup(blobStorageUri, sasToken, { resumeFrom: serialized });

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

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

Parâmetros

blobStorageUri

string

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

sasToken

string

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

options
KeyVaultBeginPreBackupOptions

Os parâmetros opcionais.

Retornos

Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

beginPreRestore(string, KeyVaultBeginPreRestoreOptions)

Inicia uma operação de pré-restauração que pode ser usada para verificar se o cliente pode executar uma operação de beginRestore usando o token SAS fornecido.

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

Uso de exemplo:

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

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

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

// The poller can be serialized with:
const serialized = poller.toString();

// A new poller can be created with:
await client.beginPreRestore(blobStorageUri, sasToken, { resumeFrom: serialized });

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

function beginPreRestore(folderUri: string, options?: KeyVaultBeginPreRestoreOptions): Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

Parâmetros

folderUri

string

A URL do recurso de armazenamento de blobs em que o backup completo com êxito anterior foi armazenado.

options
KeyVaultBeginPreRestoreOptions

Os parâmetros opcionais.

Retornos

Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

beginPreRestore(string, string, KeyVaultBeginPreRestoreOptions)

Inicia uma operação de pré-restauração que pode ser usada para verificar se o cliente pode executar uma operação de beginRestore usando o token SAS fornecido.

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

Uso de exemplo:

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

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

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

// The poller can be serialized with:
const serialized = poller.toString();

// A new poller can be created with:
await client.beginPreRestore(blobStorageUri, sasToken, { resumeFrom: serialized });

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

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

Parâmetros

folderUri

string

A URL do recurso de armazenamento de blobs em que o backup completo com êxito 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 blobs.

options
KeyVaultBeginPreRestoreOptions

Os parâmetros opcionais.

Retornos

Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

beginRestore(string, KeyVaultBeginRestoreOptions)

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

Essa função retorna um sondador de Operação de Execução Longa que permite que você aguarde indefinidamente até que a operação de restauração do Key Vault seja concluída.

Uso de exemplo:

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

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

const blobStorageUri = "<blob-storage-uri>"; // <Blob storage URL>/<folder name>
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
await poller.pollUntilDone();

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 blobs em que o backup completo com êxito anterior foi armazenado.

options
KeyVaultBeginRestoreOptions

Os parâmetros opcionais.

Retornos

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 Blobs do Azure armazenada anteriormente.

Essa função retorna um sondador de Operação de Execução Longa que permite que você aguarde indefinidamente até que a operação de restauração do Key Vault seja concluída.

Uso de exemplo:

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

const vaultUrl = `https://<MY KEY VAULT HERE>.vault.azure.net`;
const credentials = new DefaultAzureCredential();
const client = new KeyVaultBackupClient(vaultUrl, 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 blobs em que o backup completo com êxito 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 blobs.

options
KeyVaultBeginRestoreOptions

Os parâmetros opcionais.

Retornos

Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

beginSelectiveKeyRestore(string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

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

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

Uso de exemplo:

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

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

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

// Serializing the poller
const serialized = poller.toString();

// A new poller can be created with:
await client.beginSelectiveKeyRestore(keyName, blobStorageUri, { 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 blobs, com o nome da pasta do blob em que o backup completo bem-sucedido anterior foi armazenado.

options
KeyVaultBeginSelectiveKeyRestoreOptions

Os parâmetros opcionais.

Retornos

Promise<PollerLike<KeyVaultSelectiveKeyRestoreOperationState, KeyVaultSelectiveKeyRestoreResult>>

beginSelectiveKeyRestore(string, string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Começa a restaurar todas as principais versões de uma determinada chave usando o token SAS fornecido pelo usuário apontando para uma pasta de backup de armazenamento de Blobs do Azure armazenada anteriormente.

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

Uso de exemplo:

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

const vaultUrl = `https://<MY KEY VAULT HERE>.vault.azure.net`;
const credentials = new DefaultAzureCredential();
const client = new KeyVaultBackupClient(vaultUrl, 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 blobs, com o nome da pasta do blob em que 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 blobs.

options
KeyVaultBeginSelectiveKeyRestoreOptions

Os parâmetros opcionais.

Retornos

Promise<PollerLike<KeyVaultSelectiveKeyRestoreOperationState, KeyVaultSelectiveKeyRestoreResult>>