-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Key Vault Admin] Convenience layer - KeyVaultBackupClient (#11009)
* [Key Vault Admin] The Backup client source code * Updates based on feedback, specially docs * Apply suggestions from code review Co-authored-by: Christopher Scott <chriscott@hotmail.com> * Param feedback and comments * api review update * small update I did on lro/backup/operation, now on lro/restore/operation * Comment improvement, I think * comment fix * moving the internal properties to an options bag * no need for requestParameters * no need for requestParameters, and some cleanup on the pollers * Addressed #11009 (comment) Co-authored-by: Christopher Scott <chriscott@hotmail.com>
- Loading branch information
1 parent
5801548
commit 3c5a739
Showing
11 changed files
with
1,431 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,294 @@ | ||
| // Copyright (c) Microsoft Corporation. | ||
| // Licensed under the MIT license. | ||
|
|
||
| import { | ||
| createPipelineFromOptions, | ||
| isTokenCredential, | ||
| signingPolicy, | ||
| TokenCredential | ||
| } from "@azure/core-http"; | ||
| import { PollerLike } from "@azure/core-lro"; | ||
|
|
||
| import { challengeBasedAuthenticationPolicy } from "../../keyvault-common"; | ||
| import { KeyVaultClient } from "./generated/keyVaultClient"; | ||
| import { BackupClientOptions, BeginBackupOptions, BeginRestoreOptions } from "./backupClientModels"; | ||
| import { LATEST_API_VERSION, SDK_VERSION } from "./constants"; | ||
| import { logger } from "./log"; | ||
| import { BackupPoller } from "./lro/backup/poller"; | ||
| import { RestorePoller } from "./lro/restore/poller"; | ||
| import { SelectiveRestorePoller } from "./lro/selectiveRestore/poller"; | ||
| import { BackupOperationState } from "./lro/backup/operation"; | ||
| import { RestoreOperationState } from "./lro/restore/operation"; | ||
| import { SelectiveRestoreOperationState } from "./lro/selectiveRestore/operation"; | ||
|
|
||
| export { BackupOperationState, RestoreOperationState, SelectiveRestoreOperationState }; | ||
|
|
||
| /** | ||
| * The KeyVaultBackupClient provides methods to generate backups | ||
| * and restore backups of any given Azure Key Vault instance. | ||
| * This client supports generating full backups, selective restores of specific keys | ||
| * and full restores of Key Vault instances. | ||
| */ | ||
| export class KeyVaultBackupClient { | ||
| /** | ||
| * The base URL to the vault | ||
| */ | ||
| public readonly vaultUrl: string; | ||
|
|
||
| /** | ||
| * @internal | ||
| * @ignore | ||
| * A reference to the auto-generated Key Vault HTTP client. | ||
| */ | ||
| private readonly client: KeyVaultClient; | ||
|
|
||
| /** | ||
| * Creates an instance of the KeyVaultBackupClient. | ||
| * | ||
| * Example usage: | ||
| * ```ts | ||
| * 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); | ||
| * ``` | ||
| * @param vaultUrl the URL of the Key Vault. It should have this shape: https://${your-key-vault-name}.vault.azure.net | ||
| * @param credential An object that implements the `TokenCredential` interface used to authenticate requests to the service. Use the @azure/identity package to create a credential that suits your needs. | ||
| * @param [pipelineOptions] Pipeline options used to configure Key Vault API requests. Omit this parameter to use the default pipeline configuration. | ||
| */ | ||
| constructor( | ||
| vaultUrl: string, | ||
| credential: TokenCredential, | ||
| pipelineOptions: BackupClientOptions = {} | ||
| ) { | ||
| this.vaultUrl = vaultUrl; | ||
|
|
||
| const libInfo = `azsdk-js-keyvault-admin/${SDK_VERSION}`; | ||
|
|
||
| const userAgentOptions = pipelineOptions.userAgentOptions; | ||
|
|
||
| pipelineOptions.userAgentOptions = { | ||
| ...pipelineOptions.userAgentOptions, | ||
| userAgentPrefix: | ||
| userAgentOptions && userAgentOptions.userAgentPrefix | ||
| ? `${userAgentOptions.userAgentPrefix} ${libInfo}` | ||
| : libInfo | ||
| }; | ||
|
|
||
| const authPolicy = isTokenCredential(credential) | ||
| ? challengeBasedAuthenticationPolicy(credential) | ||
| : signingPolicy(credential); | ||
|
|
||
| const internalPipelineOptions = { | ||
| ...pipelineOptions, | ||
| ...{ | ||
| loggingOptions: { | ||
| logger: logger.info, | ||
| logPolicyOptions: { | ||
| allowedHeaderNames: [ | ||
| "x-ms-keyvault-region", | ||
| "x-ms-keyvault-network-info", | ||
| "x-ms-keyvault-service-version" | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| }; | ||
|
|
||
| const pipeline = createPipelineFromOptions(internalPipelineOptions, authPolicy); | ||
| this.client = new KeyVaultClient({ | ||
| apiVersion: pipelineOptions.serviceVersion || LATEST_API_VERSION, | ||
| ...pipeline | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * Starts generating a backup of an Azure Key Vault on the specified Storage Blob account. | ||
| * | ||
| * This function returns a Long Running Operation poller that allows you to wait indefinitely until the Key Vault backup is generated. | ||
| * | ||
| * Example usage: | ||
| * ```ts | ||
| * 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); | ||
| * ``` | ||
| * @summary Starts a full backup operation. | ||
| * @param blobStorageUri The URL of the blob storage resource, including the path to the container where the backup will end up being stored. | ||
| * @param sasToken The SAS token. | ||
| * @param [options] The optional parameters. | ||
| */ | ||
| public async beginBackup( | ||
| blobStorageUri: string, | ||
| sasToken: string, | ||
| options: BeginBackupOptions = {} | ||
| ): Promise<PollerLike<BackupOperationState, string>> { | ||
| if (!(blobStorageUri && sasToken)) { | ||
| throw new Error( | ||
| "beginBackup requires non-empty strings for the parameters: blobStorageUri and sasToken." | ||
| ); | ||
| } | ||
|
|
||
| const poller = new BackupPoller({ | ||
| blobStorageUri, | ||
| sasToken, | ||
| client: this.client, | ||
| vaultUrl: this.vaultUrl, | ||
| intervalInMs: options.intervalInMs, | ||
| resumeFrom: options.resumeFrom, | ||
| requestOptions: options | ||
| }); | ||
|
|
||
| // This will initialize the poller's operation (the generation of the backup). | ||
| await poller.poll(); | ||
|
|
||
| return poller; | ||
| } | ||
|
|
||
| /** | ||
| * Starts restoring all key materials using the SAS token pointing to a previously stored Azure Blob storage | ||
| * backup folder. | ||
| * | ||
| * This function returns a Long Running Operation poller that allows you to wait indefinitely until the Key Vault restore operation is complete. | ||
| * | ||
| * Example usage: | ||
| * ```ts | ||
| * const client = new KeyVaultBackupClient(url, credentials); | ||
| * | ||
| * const blobStorageUri = "<blob-storage-uri>"; // <Blob storage URL>/<folder name> | ||
| * const sasToken = "<sas-token>"; | ||
| * const folderName = "<folder-name>"; | ||
| * const poller = await client.beginRestore(blobStorageUri, sasToken, folderName); | ||
| * | ||
| * // The poller can be serialized with: | ||
| * // | ||
| * // const serialized = poller.toString(); | ||
| * // | ||
| * // A new poller can be created with: | ||
| * // | ||
| * // await client.beginRestore(blobStorageUri, sasToken, folderName, { resumeFrom: serialized }); | ||
| * // | ||
| * | ||
| * // Waiting until it's done | ||
| * const backupUri = await poller.pollUntilDone(); | ||
| * console.log(backupUri); | ||
| * ``` | ||
| * @summary Starts a full restore operation. | ||
| * @param blobStorageUri The URL of the blob storage resource where the previous successful full backup was stored. | ||
| * @param sasToken The SAS token. | ||
| * @param folderName The folder name of the blob where the previous successful full backup was stored. | ||
| * @param [options] The optional parameters. | ||
| */ | ||
| public async beginRestore( | ||
| blobStorageUri: string, | ||
| sasToken: string, | ||
| folderName: string, | ||
| options: BeginRestoreOptions = {} | ||
| ): Promise<PollerLike<RestoreOperationState, undefined>> { | ||
| if (!(blobStorageUri && sasToken && folderName)) { | ||
| throw new Error( | ||
| "beginRestore requires non-empty strings for the parameters: blobStorageUri, sasToken and folderName." | ||
| ); | ||
| } | ||
|
|
||
| const poller = new RestorePoller({ | ||
| blobStorageUri, | ||
| sasToken, | ||
| folderName, | ||
| client: this.client, | ||
| vaultUrl: this.vaultUrl, | ||
| intervalInMs: options.intervalInMs, | ||
| resumeFrom: options.resumeFrom, | ||
| requestOptions: options | ||
| }); | ||
|
|
||
| // This will initialize the poller's operation (the generation of the backup). | ||
| await poller.poll(); | ||
|
|
||
| return poller; | ||
| } | ||
|
|
||
| /** | ||
| * Starts restoring all key versions of a given key using user supplied SAS token pointing to a previously | ||
| * stored Azure Blob storage backup folder. | ||
| * | ||
| * This function returns a Long Running Operation poller that allows you to wait indefinitely until the Key Vault selective restore is complete. | ||
| * | ||
| * Example usage: | ||
| * ```ts | ||
| * const client = new KeyVaultBackupClient(url, credentials); | ||
| * | ||
| * const blobStorageUri = "<blob-storage-uri>"; | ||
| * const sasToken = "<sas-token>"; | ||
| * const folderName = "<folder-name>"; | ||
| * const keyName = "<key-name>"; | ||
| * const poller = await client.beginSelectiveRestore(blobStorageUri, sasToken, folderName, keyName); | ||
| * | ||
| * // Serializing the poller | ||
| * // | ||
| * // const serialized = poller.toString(); | ||
| * // | ||
| * // A new poller can be created with: | ||
| * // | ||
| * // await client.beginSelectiveRestore(blobStorageUri, sasToken, folderName, keyName, { resumeFrom: serialized }); | ||
| * // | ||
| * | ||
| * // Waiting until it's done | ||
| * await poller.pollUntilDone(); | ||
| * ``` | ||
| * @summary Creates a new role assignment. | ||
| * @param blobStorageUri The URL of the blob storage resource, with the folder name of the blob where the previous successful full backup was stored. | ||
| * @param sasToken The SAS token. | ||
| * @param folderName The Folder name of the blob where the previous successful full backup was stored. | ||
| * @param keyName The name of the key that wants to be restored. | ||
| * @param [options] The optional parameters. | ||
| */ | ||
| public async beginSelectiveRestore( | ||
| blobStorageUri: string, | ||
| sasToken: string, | ||
| folderName: string, | ||
| keyName: string, | ||
| options: BeginBackupOptions = {} | ||
| ): Promise<PollerLike<SelectiveRestoreOperationState, undefined>> { | ||
| if (!(keyName && blobStorageUri && sasToken && folderName)) { | ||
| throw new Error( | ||
| "beginSelectiveRestore requires non-empty strings for the parameters: keyName, blobStorageUri, sasToken and folderName." | ||
| ); | ||
| } | ||
|
|
||
| const poller = new SelectiveRestorePoller({ | ||
| keyName, | ||
| blobStorageUri, | ||
| sasToken, | ||
| folderName, | ||
| client: this.client, | ||
| vaultUrl: this.vaultUrl, | ||
| intervalInMs: options.intervalInMs, | ||
| resumeFrom: options.resumeFrom, | ||
| requestOptions: options | ||
| }); | ||
|
|
||
| // This will initialize the poller's operation (the generation of the backup). | ||
| await poller.poll(); | ||
|
|
||
| return poller; | ||
| } | ||
| } |
Oops, something went wrong.