Dela via

KeyVaultBackupClient class

Paket:
@azure/keyvault-admin

KeyVaultBackupClient innehåller metoder för att generera säkerhetskopior och återställa säkerhetskopior av en viss Azure Key Vault-instans. Den här klienten stöder generering av fullständiga säkerhetskopior, selektiva återställningar av specifika nycklar och fullständiga återställningar av Key Vault-instanser.

Konstruktorer

KeyVaultBackupClient(string, TokenCredential, KeyVaultBackupClientOptions)

Skapar en instans av KeyVaultBackupClient.

Exempel på användning:

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

Egenskaper

vaultUrl

Bas-URL:en till valvet

Metoder

beginBackup(string, KeyVaultBeginBackupOptions)

Börjar generera en säkerhetskopia av ett Azure Key Vault på det angivna Lagringsblobkontot med hjälp av en användartilldelad hanterad identitet för att få åtkomst till lagringskontot.

Den här funktionen returnerar en poller för tidskrävande åtgärder som gör att du kan vänta på obestämd tid tills Key Vault-säkerhetskopieringen har genererats.

Exempel på användning:

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

Startar en fullständig säkerhetskopieringsåtgärd.
beginBackup(string, string, KeyVaultBeginBackupOptions)

Börjar generera en säkerhetskopia av ett Azure Key Vault på det angivna Storage Blob-kontot.

Den här funktionen returnerar en poller för tidskrävande åtgärder som gör att du kan vänta på obestämd tid tills Key Vault-säkerhetskopieringen har genererats.

Exempel på användning:

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

Startar en fullständig säkerhetskopieringsåtgärd.
beginPreBackup(string, KeyVaultBeginPreBackupOptions)

Startar en försäkerhetsåtgärd som kan användas för att kontrollera om kunden kan utföra en beginBackup- åtgärd med hjälp av Managed HSM:s konfigurerade användartilldelade hanterade identitet för att autentisera med Azure Storage.

Den här funktionen returnerar en poller för tidskrävande åtgärder som gör att du kan vänta på obestämd tid tills åtgärden har slutförts.

Exempel på användning:

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)

Startar en försäkerhetsåtgärd som kan användas för att kontrollera om kunden kan utföra en beginBackup- åtgärd med hjälp av den angivna SAS-token.

Den här funktionen returnerar en poller för tidskrävande åtgärder som gör att du kan vänta på obestämd tid tills åtgärden har slutförts.

Exempel på användning:

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)

Startar en föråterställningsåtgärd som kan användas för att kontrollera om kunden kan utföra en beginRestore- åtgärd med hjälp av den angivna SAS-token.

Den här funktionen returnerar en poller för tidskrävande åtgärder som gör att du kan vänta på obestämd tid tills åtgärden har slutförts.

Exempel på användning:

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)

Startar en föråterställningsåtgärd som kan användas för att kontrollera om kunden kan utföra en beginRestore- åtgärd med hjälp av den angivna SAS-token.

Den här funktionen returnerar en poller för tidskrävande åtgärder som gör att du kan vänta på obestämd tid tills åtgärden har slutförts.

Exempel på användning:

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)

Börjar återställa allt nyckelmaterial med hjälp av SAS-token som pekar på en tidigare lagrad Azure Blob Storage-säkerhetskopieringsmapp med hjälp av en användartilldelad hanterad identitet för att få åtkomst till lagringskontot.

Den här funktionen returnerar en poller för tidskrävande åtgärder som gör att du kan vänta på obestämd tid tills återställningsåtgärden för Key Vault har slutförts.

Exempel på användning:

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

Startar en fullständig återställningsåtgärd.
beginRestore(string, string, KeyVaultBeginRestoreOptions)

Börjar återställa allt nyckelmaterial med hjälp av SAS-token som pekar på en tidigare lagrad Azure Blob Storage-säkerhetskopieringsmapp.

Den här funktionen returnerar en poller för tidskrävande åtgärder som gör att du kan vänta på obestämd tid tills återställningsåtgärden för Key Vault har slutförts.

Exempel på användning:

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

Startar en fullständig återställningsåtgärd.
beginSelectiveKeyRestore(string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Börjar återställa alla nyckelversioner av en viss nyckel med hjälp av till en tidigare lagrad Azure Blob Storage-säkerhetskopieringsmapp. Säkerhetskopieringsmappen för Blob Storage kommer att nås med hjälp av användartilldelad hanterad identitet.

Den här funktionen returnerar en poller för tidskrävande åtgärder som gör att du kan vänta på obestämd tid tills den selektiva återställningen av Key Vault har slutförts.

Exempel på användning:

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

Skapar en ny rolltilldelning.
beginSelectiveKeyRestore(string, string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Börjar återställa alla nyckelversioner av en viss nyckel med hjälp av en sas-token som angetts av användaren och pekar på en tidigare lagrad azure bloblagringssäkerhetsmapp.

Den här funktionen returnerar en poller för tidskrävande åtgärder som gör att du kan vänta på obestämd tid tills den selektiva återställningen av Key Vault har slutförts.

Exempel på användning:

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

Skapar en ny rolltilldelning.

Konstruktorinformation

KeyVaultBackupClient(string, TokenCredential, KeyVaultBackupClientOptions)

Skapar en instans av KeyVaultBackupClient.

Exempel på användning:

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)

Parametrar

vaultUrl

string

URL:en för Key Vault. Den bör ha den här formen: https://${your-key-vault-name}.vault.azure.net. Du bör kontrollera att den här URL:en refererar till en giltig Key Vault- eller Managed HSM-resurs. Mer information finns i https://aka.ms/azsdk/blog/vault-uri.

credential
TokenCredential

Ett objekt som implementerar det TokenCredential gränssnitt som används för att autentisera begäranden till tjänsten. Använd @azure/identity-paketet för att skapa en autentiseringsuppgift som passar dina behov.

options
KeyVaultBackupClientOptions

alternativ som används för att konfigurera Key Vault API-begäranden.

Egenskapsinformation

vaultUrl

Bas-URL:en till valvet

vaultUrl: string

Egenskapsvärde

string

Metodinformation

beginBackup(string, KeyVaultBeginBackupOptions)

Börjar generera en säkerhetskopia av ett Azure Key Vault på det angivna Lagringsblobkontot med hjälp av en användartilldelad hanterad identitet för att få åtkomst till lagringskontot.

Den här funktionen returnerar en poller för tidskrävande åtgärder som gör att du kan vänta på obestämd tid tills Key Vault-säkerhetskopieringen har genererats.

Exempel på användning:

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

Startar en fullständig säkerhetskopieringsåtgärd.

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

Parametrar

blobStorageUri

string

URL:en för bloblagringsresursen, inklusive sökvägen till containern där säkerhetskopieringen lagras.

options
KeyVaultBeginBackupOptions

De valfria parametrarna.

Returer

Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

beginBackup(string, string, KeyVaultBeginBackupOptions)

Börjar generera en säkerhetskopia av ett Azure Key Vault på det angivna Storage Blob-kontot.

Den här funktionen returnerar en poller för tidskrävande åtgärder som gör att du kan vänta på obestämd tid tills Key Vault-säkerhetskopieringen har genererats.

Exempel på användning:

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

Startar en fullständig säkerhetskopieringsåtgärd.

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

Parametrar

blobStorageUri

string

URL:en för bloblagringsresursen, inklusive sökvägen till containern där säkerhetskopieringen lagras.

sasToken

string

DEN SAS-token som används för att komma åt bloblagringsresursen.

options
KeyVaultBeginBackupOptions

De valfria parametrarna.

Returer

Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

beginPreBackup(string, KeyVaultBeginPreBackupOptions)

Startar en försäkerhetsåtgärd som kan användas för att kontrollera om kunden kan utföra en beginBackup- åtgärd med hjälp av Managed HSM:s konfigurerade användartilldelade hanterade identitet för att autentisera med Azure Storage.

Den här funktionen returnerar en poller för tidskrävande åtgärder som gör att du kan vänta på obestämd tid tills åtgärden har slutförts.

Exempel på användning:

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

Parametrar

blobStorageUri

string

URL:en för bloblagringsresursen, inklusive sökvägen till containern där säkerhetskopieringen lagras.

options
KeyVaultBeginPreBackupOptions

De valfria parametrarna.

Returer

Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

beginPreBackup(string, string, KeyVaultBeginPreBackupOptions)

Startar en försäkerhetsåtgärd som kan användas för att kontrollera om kunden kan utföra en beginBackup- åtgärd med hjälp av den angivna SAS-token.

Den här funktionen returnerar en poller för tidskrävande åtgärder som gör att du kan vänta på obestämd tid tills åtgärden har slutförts.

Exempel på användning:

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

Parametrar

blobStorageUri

string

URL:en för bloblagringsresursen, inklusive sökvägen till containern där säkerhetskopieringen lagras.

sasToken

string

DEN SAS-token som används för att komma åt bloblagringsresursen.

options
KeyVaultBeginPreBackupOptions

De valfria parametrarna.

Returer

Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

beginPreRestore(string, KeyVaultBeginPreRestoreOptions)

Startar en föråterställningsåtgärd som kan användas för att kontrollera om kunden kan utföra en beginRestore- åtgärd med hjälp av den angivna SAS-token.

Den här funktionen returnerar en poller för tidskrävande åtgärder som gör att du kan vänta på obestämd tid tills åtgärden har slutförts.

Exempel på användning:

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

Parametrar

folderUri

string

URL:en för bloblagringsresursen där den tidigare lyckade fullständiga säkerhetskopieringen lagrades.

options
KeyVaultBeginPreRestoreOptions

De valfria parametrarna.

Returer

Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

beginPreRestore(string, string, KeyVaultBeginPreRestoreOptions)

Startar en föråterställningsåtgärd som kan användas för att kontrollera om kunden kan utföra en beginRestore- åtgärd med hjälp av den angivna SAS-token.

Den här funktionen returnerar en poller för tidskrävande åtgärder som gör att du kan vänta på obestämd tid tills åtgärden har slutförts.

Exempel på användning:

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

Parametrar

folderUri

string

URL:en för bloblagringsresursen där den tidigare lyckade fullständiga säkerhetskopieringen lagrades.

sasToken

string

SAS-token. Om ingen SAS-token tillhandahålls används användartilldelad hanterad identitet för att komma åt bloblagringsresursen.

options
KeyVaultBeginPreRestoreOptions

De valfria parametrarna.

Returer

Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

beginRestore(string, KeyVaultBeginRestoreOptions)

Börjar återställa allt nyckelmaterial med hjälp av SAS-token som pekar på en tidigare lagrad Azure Blob Storage-säkerhetskopieringsmapp med hjälp av en användartilldelad hanterad identitet för att få åtkomst till lagringskontot.

Den här funktionen returnerar en poller för tidskrävande åtgärder som gör att du kan vänta på obestämd tid tills återställningsåtgärden för Key Vault har slutförts.

Exempel på användning:

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

Startar en fullständig återställningsåtgärd.

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

Parametrar

folderUri

string

URL:en för bloblagringsresursen där den tidigare lyckade fullständiga säkerhetskopieringen lagrades.

options
KeyVaultBeginRestoreOptions

De valfria parametrarna.

Returer

Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

beginRestore(string, string, KeyVaultBeginRestoreOptions)

Börjar återställa allt nyckelmaterial med hjälp av SAS-token som pekar på en tidigare lagrad Azure Blob Storage-säkerhetskopieringsmapp.

Den här funktionen returnerar en poller för tidskrävande åtgärder som gör att du kan vänta på obestämd tid tills återställningsåtgärden för Key Vault har slutförts.

Exempel på användning:

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

Startar en fullständig återställningsåtgärd.

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

Parametrar

folderUri

string

URL:en för bloblagringsresursen där den tidigare lyckade fullständiga säkerhetskopieringen lagrades.

sasToken

string

SAS-token. Om ingen SAS-token tillhandahålls används användartilldelad hanterad identitet för att komma åt bloblagringsresursen.

options
KeyVaultBeginRestoreOptions

De valfria parametrarna.

Returer

Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

beginSelectiveKeyRestore(string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Börjar återställa alla nyckelversioner av en viss nyckel med hjälp av till en tidigare lagrad Azure Blob Storage-säkerhetskopieringsmapp. Säkerhetskopieringsmappen för Blob Storage kommer att nås med hjälp av användartilldelad hanterad identitet.

Den här funktionen returnerar en poller för tidskrävande åtgärder som gör att du kan vänta på obestämd tid tills den selektiva återställningen av Key Vault har slutförts.

Exempel på användning:

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

Skapar en ny rolltilldelning.

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

Parametrar

keyName

string

Namnet på nyckeln som vill återställas.

folderUri

string

URL:en för bloblagringsresursen med mappnamnet för bloben där den tidigare lyckade fullständiga säkerhetskopieringen lagrades.

options
KeyVaultBeginSelectiveKeyRestoreOptions

De valfria parametrarna.

Returer

Promise<PollerLike<KeyVaultSelectiveKeyRestoreOperationState, KeyVaultSelectiveKeyRestoreResult>>

beginSelectiveKeyRestore(string, string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Börjar återställa alla nyckelversioner av en viss nyckel med hjälp av en sas-token som angetts av användaren och pekar på en tidigare lagrad azure bloblagringssäkerhetsmapp.

Den här funktionen returnerar en poller för tidskrävande åtgärder som gör att du kan vänta på obestämd tid tills den selektiva återställningen av Key Vault har slutförts.

Exempel på användning:

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

Skapar en ny rolltilldelning.

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

Parametrar

keyName

string

Namnet på nyckeln som vill återställas.

folderUri

string

URL:en för bloblagringsresursen med mappnamnet för bloben där den tidigare lyckade fullständiga säkerhetskopieringen lagrades.

sasToken

string

SAS-token. Om ingen SAS-token tillhandahålls används användartilldelad hanterad identitet för att komma åt bloblagringsresursen.

options
KeyVaultBeginSelectiveKeyRestoreOptions

De valfria parametrarna.

Returer

Promise<PollerLike<KeyVaultSelectiveKeyRestoreOperationState, KeyVaultSelectiveKeyRestoreResult>>