Udostępnij za pośrednictwem

KeyVaultBackupClient class

Pakiet:
@azure/keyvault-admin

Klasa KeyVaultBackupClient udostępnia metody generowania kopii zapasowych i przywracania kopii zapasowych dowolnego wystąpienia usługi Azure Key Vault. Ten klient obsługuje generowanie pełnych kopii zapasowych, selektywne przywracanie określonych kluczy i pełne przywracanie wystąpień usługi Key Vault.

Konstruktory

KeyVaultBackupClient(string, TokenCredential, KeyVaultBackupClientOptions)

Tworzy wystąpienie klasy KeyVaultBackupClient.

Przykładowe użycie:

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);

Właściwości

vaultUrl

Podstawowy adres URL magazynu

Metody

beginBackup(string, KeyVaultBeginBackupOptions)

Rozpoczyna generowanie kopii zapasowej usługi Azure Key Vault na określonym koncie obiektu blob usługi Storage przy użyciu przypisanej przez użytkownika tożsamości zarządzanej w celu uzyskania dostępu do konta magazynu.

Ta funkcja zwraca operację długotrwałą, która umożliwia oczekiwanie na czas nieokreślony do wygenerowania kopii zapasowej usługi Key Vault.

Przykładowe użycie:

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);

Uruchamia pełną operację tworzenia kopii zapasowej.
beginBackup(string, string, KeyVaultBeginBackupOptions)

Rozpoczyna generowanie kopii zapasowej usługi Azure Key Vault na określonym koncie obiektu blob usługi Storage.

Ta funkcja zwraca operację długotrwałą, która umożliwia oczekiwanie na czas nieokreślony do wygenerowania kopii zapasowej usługi Key Vault.

Przykładowe użycie:

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);

Uruchamia pełną operację tworzenia kopii zapasowej.
beginPreBackup(string, KeyVaultBeginPreBackupOptions)

Uruchamia operację przed utworzeniem kopii zapasowej, która może służyć do sprawdzania, czy klient może wykonać operację beginBackup przy użyciu skonfigurowanej tożsamości zarządzanej zarządzanej zarządzanego modułu HSM zarządzanego za pomocą usługi Azure Storage.

Ta funkcja zwraca operację długotrwałą, która umożliwia oczekiwanie na czas nieokreślony do zakończenia operacji.

Przykładowe użycie:

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)

Uruchamia operację przed utworzeniem kopii zapasowej, która może służyć do sprawdzenia, czy klient może wykonać operację beginBackup przy użyciu podanego tokenu SAS.

Ta funkcja zwraca operację długotrwałą, która umożliwia oczekiwanie na czas nieokreślony do zakończenia operacji.

Przykładowe użycie:

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)

Uruchamia operację przywracania wstępnego, która może służyć do sprawdzania, czy klient może wykonać operację beginRestore przy użyciu podanego tokenu SAS.

Ta funkcja zwraca operację długotrwałą, która umożliwia oczekiwanie na czas nieokreślony do zakończenia operacji.

Przykładowe użycie:

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)

Uruchamia operację przywracania wstępnego, która może służyć do sprawdzania, czy klient może wykonać operację beginRestore przy użyciu podanego tokenu SAS.

Ta funkcja zwraca operację długotrwałą, która umożliwia oczekiwanie na czas nieokreślony do zakończenia operacji.

Przykładowe użycie:

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)

Rozpoczyna przywracanie wszystkich kluczowych materiałów przy użyciu tokenu SAS wskazującego wcześniej przechowywany folder kopii zapasowej usługi Azure Blob Storage przy użyciu przypisanej przez użytkownika tożsamości zarządzanej w celu uzyskania dostępu do konta magazynu.

Ta funkcja zwraca operację długotrwałą, która umożliwia oczekiwanie na czas nieokreślony do zakończenia operacji przywracania usługi Key Vault.

Przykładowe użycie:

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();

Uruchamia pełną operację przywracania.
beginRestore(string, string, KeyVaultBeginRestoreOptions)

Rozpoczyna przywracanie wszystkich kluczowych materiałów przy użyciu tokenu SAS wskazującego wcześniej przechowywany folder kopii zapasowej usługi Azure Blob Storage.

Ta funkcja zwraca operację długotrwałą, która umożliwia oczekiwanie na czas nieokreślony do zakończenia operacji przywracania usługi Key Vault.

Przykładowe użycie:

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);

Uruchamia pełną operację przywracania.
beginSelectiveKeyRestore(string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Rozpoczyna przywracanie wszystkich kluczowych wersji danego klucza przy użyciu wcześniej przechowywanego folderu kopii zapasowej usługi Azure Blob Storage. Dostęp do folderu kopii zapasowej usługi Blob Storage będzie uzyskiwany przy użyciu przypisanej przez użytkownika tożsamości zarządzanej.

Ta funkcja zwraca operację długotrwałą, która umożliwia oczekiwanie na czas nieokreślony do zakończenia selektywnego przywracania usługi Key Vault.

Przykładowe użycie:

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();

Tworzy nowe przypisanie roli.
beginSelectiveKeyRestore(string, string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Rozpoczyna przywracanie wszystkich kluczowych wersji danego klucza przy użyciu tokenu SAS dostarczonego przez użytkownika wskazującego wcześniej przechowywany folder kopii zapasowej usługi Azure Blob Storage.

Ta funkcja zwraca operację długotrwałą, która umożliwia oczekiwanie na czas nieokreślony do zakończenia selektywnego przywracania usługi Key Vault.

Przykładowe użycie:

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();

Tworzy nowe przypisanie roli.

Szczegóły konstruktora

KeyVaultBackupClient(string, TokenCredential, KeyVaultBackupClientOptions)

Tworzy wystąpienie klasy KeyVaultBackupClient.

Przykładowe użycie:

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)

Parametry

vaultUrl

string

adres URL usługi Key Vault. Powinien mieć ten kształt: https://${your-key-vault-name}.vault.azure.net. Należy sprawdzić, czy ten adres URL odwołuje się do prawidłowego zasobu usługi Key Vault lub zarządzanego modułu HSM. Aby uzyskać szczegółowe informacje, zobacz https://aka.ms/azsdk/blog/vault-uri.

credential
TokenCredential

Obiekt, który implementuje interfejs TokenCredential używany do uwierzytelniania żądań w usłudze. Użyj pakietu @azure/identity, aby utworzyć poświadczenia odpowiadające Twoim potrzebom.

options
KeyVaultBackupClientOptions

opcje używane do konfigurowania żądań interfejsu API usługi Key Vault.

Szczegóły właściwości

vaultUrl

Podstawowy adres URL magazynu

vaultUrl: string

Wartość właściwości

string

Szczegóły metody

beginBackup(string, KeyVaultBeginBackupOptions)

Rozpoczyna generowanie kopii zapasowej usługi Azure Key Vault na określonym koncie obiektu blob usługi Storage przy użyciu przypisanej przez użytkownika tożsamości zarządzanej w celu uzyskania dostępu do konta magazynu.

Ta funkcja zwraca operację długotrwałą, która umożliwia oczekiwanie na czas nieokreślony do wygenerowania kopii zapasowej usługi Key Vault.

Przykładowe użycie:

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);

Uruchamia pełną operację tworzenia kopii zapasowej.

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

Parametry

blobStorageUri

string

Adres URL zasobu magazynu obiektów blob, w tym ścieżka do kontenera, w którym zostanie zapisana kopia zapasowa.

options
KeyVaultBeginBackupOptions

Parametry opcjonalne.

Zwraca

Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

beginBackup(string, string, KeyVaultBeginBackupOptions)

Rozpoczyna generowanie kopii zapasowej usługi Azure Key Vault na określonym koncie obiektu blob usługi Storage.

Ta funkcja zwraca operację długotrwałą, która umożliwia oczekiwanie na czas nieokreślony do wygenerowania kopii zapasowej usługi Key Vault.

Przykładowe użycie:

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);

Uruchamia pełną operację tworzenia kopii zapasowej.

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

Parametry

blobStorageUri

string

Adres URL zasobu magazynu obiektów blob, w tym ścieżka do kontenera, w którym zostanie zapisana kopia zapasowa.

sasToken

string

Token SAS używany do uzyskiwania dostępu do zasobu magazynu obiektów blob.

options
KeyVaultBeginBackupOptions

Parametry opcjonalne.

Zwraca

Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

beginPreBackup(string, KeyVaultBeginPreBackupOptions)

Uruchamia operację przed utworzeniem kopii zapasowej, która może służyć do sprawdzania, czy klient może wykonać operację beginBackup przy użyciu skonfigurowanej tożsamości zarządzanej zarządzanej zarządzanego modułu HSM zarządzanego za pomocą usługi Azure Storage.

Ta funkcja zwraca operację długotrwałą, która umożliwia oczekiwanie na czas nieokreślony do zakończenia operacji.

Przykładowe użycie:

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

Parametry

blobStorageUri

string

Adres URL zasobu magazynu obiektów blob, w tym ścieżka do kontenera, w którym zostanie zapisana kopia zapasowa.

options
KeyVaultBeginPreBackupOptions

Parametry opcjonalne.

Zwraca

Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

beginPreBackup(string, string, KeyVaultBeginPreBackupOptions)

Uruchamia operację przed utworzeniem kopii zapasowej, która może służyć do sprawdzenia, czy klient może wykonać operację beginBackup przy użyciu podanego tokenu SAS.

Ta funkcja zwraca operację długotrwałą, która umożliwia oczekiwanie na czas nieokreślony do zakończenia operacji.

Przykładowe użycie:

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

Parametry

blobStorageUri

string

Adres URL zasobu magazynu obiektów blob, w tym ścieżka do kontenera, w którym zostanie zapisana kopia zapasowa.

sasToken

string

Token SAS używany do uzyskiwania dostępu do zasobu magazynu obiektów blob.

options
KeyVaultBeginPreBackupOptions

Parametry opcjonalne.

Zwraca

Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

beginPreRestore(string, KeyVaultBeginPreRestoreOptions)

Uruchamia operację przywracania wstępnego, która może służyć do sprawdzania, czy klient może wykonać operację beginRestore przy użyciu podanego tokenu SAS.

Ta funkcja zwraca operację długotrwałą, która umożliwia oczekiwanie na czas nieokreślony do zakończenia operacji.

Przykładowe użycie:

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

Parametry

folderUri

string

Adres URL zasobu magazynu obiektów blob, w którym przechowywano poprzednią pełną kopię zapasową.

options
KeyVaultBeginPreRestoreOptions

Parametry opcjonalne.

Zwraca

Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

beginPreRestore(string, string, KeyVaultBeginPreRestoreOptions)

Uruchamia operację przywracania wstępnego, która może służyć do sprawdzania, czy klient może wykonać operację beginRestore przy użyciu podanego tokenu SAS.

Ta funkcja zwraca operację długotrwałą, która umożliwia oczekiwanie na czas nieokreślony do zakończenia operacji.

Przykładowe użycie:

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

Parametry

folderUri

string

Adres URL zasobu magazynu obiektów blob, w którym przechowywano poprzednią pełną kopię zapasową.

sasToken

string

Token SAS. Jeśli nie podano tokenu SAS, tożsamość zarządzana przypisana przez użytkownika będzie używana do uzyskiwania dostępu do zasobu magazynu obiektów blob.

options
KeyVaultBeginPreRestoreOptions

Parametry opcjonalne.

Zwraca

Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

beginRestore(string, KeyVaultBeginRestoreOptions)

Rozpoczyna przywracanie wszystkich kluczowych materiałów przy użyciu tokenu SAS wskazującego wcześniej przechowywany folder kopii zapasowej usługi Azure Blob Storage przy użyciu przypisanej przez użytkownika tożsamości zarządzanej w celu uzyskania dostępu do konta magazynu.

Ta funkcja zwraca operację długotrwałą, która umożliwia oczekiwanie na czas nieokreślony do zakończenia operacji przywracania usługi Key Vault.

Przykładowe użycie:

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();

Uruchamia pełną operację przywracania.

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

Parametry

folderUri

string

Adres URL zasobu magazynu obiektów blob, w którym przechowywano poprzednią pełną kopię zapasową.

options
KeyVaultBeginRestoreOptions

Parametry opcjonalne.

Zwraca

Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

beginRestore(string, string, KeyVaultBeginRestoreOptions)

Rozpoczyna przywracanie wszystkich kluczowych materiałów przy użyciu tokenu SAS wskazującego wcześniej przechowywany folder kopii zapasowej usługi Azure Blob Storage.

Ta funkcja zwraca operację długotrwałą, która umożliwia oczekiwanie na czas nieokreślony do zakończenia operacji przywracania usługi Key Vault.

Przykładowe użycie:

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);

Uruchamia pełną operację przywracania.

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

Parametry

folderUri

string

Adres URL zasobu magazynu obiektów blob, w którym przechowywano poprzednią pełną kopię zapasową.

sasToken

string

Token SAS. Jeśli nie podano tokenu SAS, tożsamość zarządzana przypisana przez użytkownika będzie używana do uzyskiwania dostępu do zasobu magazynu obiektów blob.

options
KeyVaultBeginRestoreOptions

Parametry opcjonalne.

Zwraca

Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

beginSelectiveKeyRestore(string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Rozpoczyna przywracanie wszystkich kluczowych wersji danego klucza przy użyciu wcześniej przechowywanego folderu kopii zapasowej usługi Azure Blob Storage. Dostęp do folderu kopii zapasowej usługi Blob Storage będzie uzyskiwany przy użyciu przypisanej przez użytkownika tożsamości zarządzanej.

Ta funkcja zwraca operację długotrwałą, która umożliwia oczekiwanie na czas nieokreślony do zakończenia selektywnego przywracania usługi Key Vault.

Przykładowe użycie:

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();

Tworzy nowe przypisanie roli.

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

Parametry

keyName

string

Nazwa klucza, który ma zostać przywrócony.

folderUri

string

Adres URL zasobu magazynu obiektów blob z nazwą folderu obiektu blob, w którym zapisano poprzednią pełną kopię zapasową.

options
KeyVaultBeginSelectiveKeyRestoreOptions

Parametry opcjonalne.

Zwraca

Promise<PollerLike<KeyVaultSelectiveKeyRestoreOperationState, KeyVaultSelectiveKeyRestoreResult>>

beginSelectiveKeyRestore(string, string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Rozpoczyna przywracanie wszystkich kluczowych wersji danego klucza przy użyciu tokenu SAS dostarczonego przez użytkownika wskazującego wcześniej przechowywany folder kopii zapasowej usługi Azure Blob Storage.

Ta funkcja zwraca operację długotrwałą, która umożliwia oczekiwanie na czas nieokreślony do zakończenia selektywnego przywracania usługi Key Vault.

Przykładowe użycie:

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();

Tworzy nowe przypisanie roli.

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

Parametry

keyName

string

Nazwa klucza, który ma zostać przywrócony.

folderUri

string

Adres URL zasobu magazynu obiektów blob z nazwą folderu obiektu blob, w którym zapisano poprzednią pełną kopię zapasową.

sasToken

string

Token SAS. Jeśli nie podano tokenu SAS, tożsamość zarządzana przypisana przez użytkownika będzie używana do uzyskiwania dostępu do zasobu magazynu obiektów blob.

options
KeyVaultBeginSelectiveKeyRestoreOptions

Parametry opcjonalne.

Zwraca

Promise<PollerLike<KeyVaultSelectiveKeyRestoreOperationState, KeyVaultSelectiveKeyRestoreResult>>