SecretClient class

Создает экземпляр SecretClient.

Пример использования:

import { SecretClient } from "@azure/keyvault-secrets";
import { DefaultAzureCredential } from "@azure/identity";

let vaultUrl = `https://<MY KEYVAULT HERE>.vault.azure.net`;
let credentials = new DefaultAzureCredential();

let client = new SecretClient(vaultUrl, credentials);

new SecretClient(vaultUrl: string, credential: TokenCredential, pipelineOptions?: SecretClientOptions)

Параметры

Базовый URL-адрес хранилища

vaultUrl: string

Значение свойства

Запрашивает скачивание на клиент резервной копии указанного секрета. Будут загружены все версии секрета. Для этой операции требуется разрешение секретов или резервного копирования.

Пример использования:

let client = new SecretClient(url, credentials);
let backupResult = await client.backupSecret("MySecretName");

Резервное копирование указанного секрета.

function backupSecret(secretName: string, options?: BackupSecretOptions): Promise<undefined | Uint8Array>

Параметры

Возвращаемое значение

Удаляет секрет, хранящийся в azure Key Vault. Эта функция возвращает опрашиватель длительных операций, который позволяет бесконечно ждать удаления секрета.

Для этой операции требуется разрешение на удаление секретов.

Пример использования:

const client = new SecretClient(url, credentials);
await client.setSecret("MySecretName", "ABC123");

const deletePoller = await client.beginDeleteSecret("MySecretName");

// Serializing the poller
const serialized = deletePoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginDeleteSecret("MySecretName", { resumeFrom: serialized });

// Waiting until it's done
const deletedSecret = await deletePoller.pollUntilDone();
console.log(deletedSecret);

Удаляет секрет из указанного хранилища ключей.

function beginDeleteSecret(name: string, options?: BeginDeleteSecretOptions): Promise<PollerLike<PollOperationState<DeletedSecret>, DeletedSecret>>

Параметры

Возвращаемое значение

Восстанавливает удаленный секрет в указанном хранилище. Эта функция возвращает средство опроса длительных операций, которое позволяет бесконечно ждать, пока секрет не будет восстановлен.

Для этой операции требуется разрешение secrets/recover.

Пример использования:

const client = new SecretClient(url, credentials);
await client.setSecret("MySecretName", "ABC123");

const deletePoller = await client.beginDeleteSecret("MySecretName");
await deletePoller.pollUntilDone();

const recoverPoller = await client.beginRecoverDeletedSecret("MySecretName");

// Serializing the poller
const serialized = recoverPoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginRecoverDeletedSecret("MySecretName", { resumeFrom: serialized });

// Waiting until it's done
const deletedSecret = await recoverPoller.pollUntilDone();
console.log(deletedSecret);

Восстанавливает удаленный секрет до последней версии.

function beginRecoverDeletedSecret(name: string, options?: BeginRecoverDeletedSecretOptions): Promise<PollerLike<PollOperationState<SecretProperties>, SecretProperties>>

Параметры

Возвращаемое значение

Метод getDeletedSecret возвращает указанный удаленный секрет вместе с его атрибутами. Для этой операции требуется разрешение secrets/get.

Пример использования:

let client = new SecretClient(url, credentials);
await client.getDeletedSecret("MyDeletedSecret");

Возвращает указанный удаленный секрет.

function getDeletedSecret(secretName: string, options?: GetDeletedSecretOptions): Promise<DeletedSecret>

Параметры

Возвращаемое значение

Метод getSecret применим к любому секрету, хранящейся в azure Key Vault. Для этой операции требуется разрешение secrets/get.

Пример использования:

let client = new SecretClient(url, credentials);
let secret = await client.getSecret("MySecretName");

Получение указанного секрета из заданного хранилища ключей.

function getSecret(secretName: string, options?: GetSecretOptions): Promise<KeyVaultSecret>

Параметры

Возвращаемое значение

Выполняет итерацию удаленных секретов в хранилище. В ответе предоставляется полный идентификатор и атрибуты секрета. Значения для секретов не возвращаются. Для этой операции требуется разрешение секретов и списка.

Пример использования:

let client = new SecretClient(url, credentials);
for await (const deletedSecret of client.listDeletedSecrets()) {
  console.log("deleted secret: ", deletedSecret);
}

Вывод списка всех секретов в хранилище.

function listDeletedSecrets(options?: ListDeletedSecretsOptions): PagedAsyncIterableIterator<DeletedSecret, DeletedSecret[], PageSettings>

Параметры

Возвращаемое значение

Выполняет итерацию последней версии всех секретов в хранилище. В ответе предоставляется полный идентификатор и атрибуты секрета. Значения для секретов не возвращаются. Для этой операции требуется разрешение секретов и списка.

Пример использования:

let client = new SecretClient(url, credentials);
for await (const secretProperties of client.listPropertiesOfSecrets()) {
  const secret = await client.getSecret(secretProperties.name);
  console.log("secret: ", secret);
}

Вывод списка всех секретов в хранилище.

function listPropertiesOfSecrets(options?: ListPropertiesOfSecretsOptions): PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

Параметры

Возвращаемое значение

Выполняет итерацию всех версий заданного секрета в хранилище. В ответе предоставляется полный идентификатор и атрибуты секрета. Значения для секретов не возвращаются. Для этой операции требуется разрешение секретов и списка.

Пример использования:

let client = new SecretClient(url, credentials);
for await (const secretProperties of client.listPropertiesOfSecretVersions("MySecretName")) {
  const secret = await client.getSecret(secretProperties.name);
  console.log("secret version: ", secret);
}

function listPropertiesOfSecretVersions(secretName: string, options?: ListPropertiesOfSecretVersionsOptions): PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

Параметры

Возвращаемое значение

Операция очистки удаленного секрета удаляет секрет без возможности восстановления. Эту операцию можно включить только в хранилище с поддержкой обратимого удаления. Для этой операции требуется разрешение секретов и очистки.

Пример использования:

const client = new SecretClient(url, credentials);
const deletePoller = await client.beginDeleteSecret("MySecretName");
await deletePoller.pollUntilDone();
await client.purgeDeletedSecret("MySecretName");

Безвозвратно удаляет указанный секрет.

function purgeDeletedSecret(secretName: string, options?: PurgeDeletedSecretOptions): Promise<void>

Параметры

Возвращаемое значение

Восстанавливает архивный секрет и все его версии в хранилище. Для этой операции требуется разрешение на восстановление секретов.

Пример использования:

let client = new SecretClient(url, credentials);
let mySecretBundle = await client.backupSecret("MySecretName");
// ...
await client.restoreSecretBackup(mySecretBundle);

Восстанавливает резервную копию секрета в хранилище.

function restoreSecretBackup(secretBundleBackup: Uint8Array, options?: RestoreSecretBackupOptions): Promise<SecretProperties>

Параметры

Возвращаемое значение

Метод setSecret добавляет секрет или версию секрета в Key Vault Azure. Если именованный секрет уже существует, хранилище ключей Azure создает новую версию этого секрета. Для этой операции требуется разрешение на секреты или набор.

Пример использования:

let client = new SecretClient(url, credentials);
await client.setSecret("MySecretName", "ABC123");

Добавляет секрет в указанное хранилище ключей.

function setSecret(secretName: string, value: string, options?: SetSecretOptions): Promise<KeyVaultSecret>

Параметры

Возвращаемое значение

Метод updateSecret изменяет указанные атрибуты существующего хранимого секрета. Свойства, не указанные в запросе, остаются без изменений. Значение самого секрета не может быть изменено. Для этой операции требуется разрешение на секреты или набор.

Пример использования:

let secretName = "MySecretName";
let client = new SecretClient(url, credentials);
let secret = await client.getSecret(secretName);
await client.updateSecretProperties(secretName, secret.properties.version, { enabled: false });

Обновления атрибуты, связанные с указанным секретом в данном хранилище ключей.

function updateSecretProperties(secretName: string, secretVersion: string, options?: UpdateSecretPropertiesOptions): Promise<SecretProperties>

Параметры

Возвращаемое значение