Udostępnij za pośrednictwem

KeyVaultBackupClient class

  • Odwołanie
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ń Key Vault.

Konstruktory

KeyVaultBackupClient(string, TokenCredential, KeyVaultBackupClientOptions)

Tworzy wystąpienie klasy KeyVaultBackupClient.

Przykład użycia: 

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

Właściwości

vaultUrl

Podstawowy adres URL magazynu

Metody

beginBackup(string, KeyVaultBeginBackupOptions)

Rozpoczyna generowanie kopii zapasowej Key Vault platformy Azure 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 usługi Storage.

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

Przykład użycia: 

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

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

Rozpoczyna generowanie kopii zapasowej Key Vault platformy Azure 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 momentu wygenerowania kopii zapasowej Key Vault.

Przykład użycia: 

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

Uruchamia pełną operację tworzenia kopii zapasowej.
beginRestore(string, KeyVaultBeginRestoreOptions)

Rozpoczyna przywracanie wszystkich kluczowych materiałów przy użyciu tokenu SYGNATURy dostępu współdzielonego 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 ukończenia operacji przywracania Key Vault.

Przykład użycia: 

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

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 ukończenia operacji przywracania Key Vault.

Przykład użycia: 

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

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

Rozpoczyna przywracanie wszystkich kluczowych wersji danego klucza przy użyciu do 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 Key Vault.

Przykład użycia: 

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

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

Rozpoczyna przywracanie wszystkich wersji klucza 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 Key Vault.

Przykład użycia: 

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

Tworzy nowe przypisanie roli.

Szczegóły konstruktora

KeyVaultBackupClient(string, TokenCredential, KeyVaultBackupClientOptions)

Tworzy wystąpienie klasy KeyVaultBackupClient.

Przykład użycia: 

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)

Parametry

vaultUrl

string

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

credential
TokenCredential

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

options
KeyVaultBackupClientOptions

opcje używane do konfigurowania żądań interfejsu API 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 Key Vault platformy Azure 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 usługi Storage.

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

Przykład użycia: 

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

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 będzie przechowywana kopia zapasowa.

options
KeyVaultBeginBackupOptions

Parametry opcjonalne.

Zwraca

Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

beginBackup(string, string, KeyVaultBeginBackupOptions)

Rozpoczyna generowanie kopii zapasowej Key Vault platformy Azure 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 momentu wygenerowania kopii zapasowej Key Vault.

Przykład użycia: 

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

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 będzie przechowywana 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>>

beginRestore(string, KeyVaultBeginRestoreOptions)

Rozpoczyna przywracanie wszystkich kluczowych materiałów przy użyciu tokenu SYGNATURy dostępu współdzielonego 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 ukończenia operacji przywracania Key Vault.

Przykład użycia: 

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

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, pod 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 ukończenia operacji przywracania Key Vault.

Przykład użycia: 

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

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, pod którym przechowywano poprzednią pełną kopię zapasową.

sasToken

string

Token SAS. Jeśli token SAS nie zostanie podany, 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 do 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 Key Vault.

Przykład użycia: 

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

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 wersji klucza 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 Key Vault.

Przykład użycia: 

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

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 token SAS nie zostanie podany, 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>>