KeyVaultBackupClient class

  • 참조
패키지:
@azure/keyvault-admin

KeyVaultBackupClient는 지정된 Azure Key Vault instance 백업을 생성하고 백업을 복원하는 메서드를 제공합니다. 이 클라이언트는 전체 백업 생성, 특정 키의 선택적 복원 및 Key Vault 인스턴스의 전체 복원을 지원합니다.

생성자

KeyVaultBackupClient(string, TokenCredential, KeyVaultBackupClientOptions)

KeyVaultBackupClient의 instance 만듭니다.

사용 예제:

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

속성

vaultUrl

자격 증명 모음의 기본 URL

메서드

beginBackup(string, KeyVaultBeginBackupOptions)

사용자가 할당한 관리 ID를 사용하여 지정된 Storage Blob 계정에서 Azure Key Vault 백업을 생성하기 시작합니다.

이 함수는 Key Vault 백업이 생성될 때까지 무기한 대기할 수 있는 장기 실행 작업 폴러를 반환합니다.

사용 예제:

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

전체 백업 작업을 시작합니다.
beginBackup(string, string, KeyVaultBeginBackupOptions)

지정된 Storage Blob 계정에서 Azure Key Vault 백업 생성을 시작합니다.

이 함수는 Key Vault 백업이 생성될 때까지 무기한 대기할 수 있는 장기 실행 작업 폴러를 반환합니다.

사용 예제:

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

전체 백업 작업을 시작합니다.
beginRestore(string, KeyVaultBeginRestoreOptions)

사용자가 할당한 관리 ID를 사용하여 이전에 저장된 Azure Blob Storage 백업 폴더를 가리키는 SAS 토큰을 사용하여 모든 주요 자료를 복원하기 시작합니다.

이 함수는 Key Vault 복원 작업이 완료될 때까지 무기한 대기할 수 있는 장기 실행 작업 폴러를 반환합니다.

사용 예제:

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

전체 복원 작업을 시작합니다.
beginRestore(string, string, KeyVaultBeginRestoreOptions)

이전에 저장된 Azure Blob Storage 백업 폴더를 가리키는 SAS 토큰을 사용하여 모든 주요 자료 복원을 시작합니다.

이 함수는 Key Vault 복원 작업이 완료될 때까지 무기한 대기할 수 있는 장기 실행 작업 폴러를 반환합니다.

사용 예제:

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

전체 복원 작업을 시작합니다.
beginSelectiveKeyRestore(string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

를 사용하여 지정된 키의 모든 키 버전을 이전에 저장된 Azure Blob Storage 백업 폴더로 복원하기 시작합니다. Blob Storage 백업 폴더는 사용자가 할당한 관리 ID를 사용하여 액세스합니다.

이 함수는 Key Vault 선택적 복원이 완료될 때까지 무기한 대기할 수 있는 장기 실행 작업 폴러를 반환합니다.

사용 예제:

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

새 역할 할당을 만듭니다.
beginSelectiveKeyRestore(string, string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

이전에 저장된 Azure Blob Storage 백업 폴더를 가리키는 사용자가 제공한 SAS 토큰을 사용하여 지정된 키의 모든 키 버전을 복원하기 시작합니다.

이 함수는 Key Vault 선택적 복원이 완료될 때까지 무기한 대기할 수 있는 장기 실행 작업 폴러를 반환합니다.

사용 예제:

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

새 역할 할당을 만듭니다.

생성자 세부 정보

KeyVaultBackupClient(string, TokenCredential, KeyVaultBackupClientOptions)

KeyVaultBackupClient의 instance 만듭니다.

사용 예제:

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)

매개 변수

vaultUrl

string

Key Vault URL입니다. 이 셰이프 https://${your-key-vault-name}.vault.azure.net가 있어야 합니다. 이 URL이 유효한 Key Vault 또는 관리형 HSM 리소스를 참조하는지 확인해야 합니다. 자세한 내용은 https://aka.ms/azsdk/blog/vault-uri를 참조하세요.

credential
TokenCredential

서비스에 대한 TokenCredential 요청을 인증하는 데 사용되는 인터페이스를 구현하는 개체입니다. @azure/identity 패키지를 사용하여 요구 사항에 맞는 자격 증명을 만듭니다.

options
KeyVaultBackupClientOptions

Key Vault API 요청을 구성하는 데 사용되는 옵션입니다.

속성 세부 정보

vaultUrl

자격 증명 모음의 기본 URL

vaultUrl: string

속성 값

string

메서드 세부 정보

beginBackup(string, KeyVaultBeginBackupOptions)

사용자가 할당한 관리 ID를 사용하여 지정된 Storage Blob 계정에서 Azure Key Vault 백업을 생성하기 시작합니다.

이 함수는 Key Vault 백업이 생성될 때까지 무기한 대기할 수 있는 장기 실행 작업 폴러를 반환합니다.

사용 예제:

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

전체 백업 작업을 시작합니다.

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

매개 변수

blobStorageUri

string

백업이 저장되는 컨테이너 경로를 포함하여 Blob Storage 리소스의 URL입니다.

options
KeyVaultBeginBackupOptions

선택적 매개 변수입니다.

반환

Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

beginBackup(string, string, KeyVaultBeginBackupOptions)

지정된 Storage Blob 계정에서 Azure Key Vault 백업 생성을 시작합니다.

이 함수는 Key Vault 백업이 생성될 때까지 무기한 대기할 수 있는 장기 실행 작업 폴러를 반환합니다.

사용 예제:

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

전체 백업 작업을 시작합니다.

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

매개 변수

blobStorageUri

string

백업이 저장되는 컨테이너 경로를 포함하여 Blob Storage 리소스의 URL입니다.

sasToken

string

Blob Storage 리소스에 액세스하는 데 사용되는 SAS 토큰입니다.

options
KeyVaultBeginBackupOptions

선택적 매개 변수입니다.

반환

Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

beginRestore(string, KeyVaultBeginRestoreOptions)

사용자가 할당한 관리 ID를 사용하여 이전에 저장된 Azure Blob Storage 백업 폴더를 가리키는 SAS 토큰을 사용하여 모든 주요 자료를 복원하기 시작합니다.

이 함수는 Key Vault 복원 작업이 완료될 때까지 무기한 대기할 수 있는 장기 실행 작업 폴러를 반환합니다.

사용 예제:

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

전체 복원 작업을 시작합니다.

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

매개 변수

folderUri

string

이전의 성공적인 전체 백업이 저장된 Blob Storage 리소스의 URL입니다.

options
KeyVaultBeginRestoreOptions

선택적 매개 변수입니다.

반환

Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

beginRestore(string, string, KeyVaultBeginRestoreOptions)

이전에 저장된 Azure Blob Storage 백업 폴더를 가리키는 SAS 토큰을 사용하여 모든 주요 자료 복원을 시작합니다.

이 함수는 Key Vault 복원 작업이 완료될 때까지 무기한 대기할 수 있는 장기 실행 작업 폴러를 반환합니다.

사용 예제:

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

전체 복원 작업을 시작합니다.

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

매개 변수

folderUri

string

이전의 성공적인 전체 백업이 저장된 Blob Storage 리소스의 URL입니다.

sasToken

string

SAS 토큰입니다. SAS 토큰이 제공되지 않으면 사용자가 할당한 관리 ID가 Blob Storage 리소스에 액세스하는 데 사용됩니다.

options
KeyVaultBeginRestoreOptions

선택적 매개 변수입니다.

반환

Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

beginSelectiveKeyRestore(string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

를 사용하여 지정된 키의 모든 키 버전을 이전에 저장된 Azure Blob Storage 백업 폴더로 복원하기 시작합니다. Blob Storage 백업 폴더는 사용자가 할당한 관리 ID를 사용하여 액세스합니다.

이 함수는 Key Vault 선택적 복원이 완료될 때까지 무기한 대기할 수 있는 장기 실행 작업 폴러를 반환합니다.

사용 예제:

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

새 역할 할당을 만듭니다.

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

매개 변수

keyName

string

복원하려는 키의 이름입니다.

folderUri

string

이전에 성공한 전체 백업이 저장된 Blob의 폴더 이름을 가진 Blob Storage 리소스의 URL입니다.

options
KeyVaultBeginSelectiveKeyRestoreOptions

선택적 매개 변수입니다.

반환

Promise<PollerLike<KeyVaultSelectiveKeyRestoreOperationState, KeyVaultSelectiveKeyRestoreResult>>

beginSelectiveKeyRestore(string, string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

이전에 저장된 Azure Blob Storage 백업 폴더를 가리키는 사용자가 제공한 SAS 토큰을 사용하여 지정된 키의 모든 키 버전을 복원하기 시작합니다.

이 함수는 Key Vault 선택적 복원이 완료될 때까지 무기한 대기할 수 있는 장기 실행 작업 폴러를 반환합니다.

사용 예제:

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

새 역할 할당을 만듭니다.

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

매개 변수

keyName

string

복원하려는 키의 이름입니다.

folderUri

string

이전에 성공한 전체 백업이 저장된 Blob의 폴더 이름을 가진 Blob Storage 리소스의 URL입니다.

sasToken

string

SAS 토큰입니다. SAS 토큰이 제공되지 않으면 사용자가 할당한 관리 ID가 Blob Storage 리소스에 액세스하는 데 사용됩니다.

options
KeyVaultBeginSelectiveKeyRestoreOptions

선택적 매개 변수입니다.

반환

Promise<PollerLike<KeyVaultSelectiveKeyRestoreOperationState, KeyVaultSelectiveKeyRestoreResult>>