SecretClient class

  • Ссылка
Пакет:
@azure/keyvault-secrets

SecretClient предоставляет методы для управления KeyVaultSecret в Key Vault Azure. Клиент поддерживает создание, извлечение, обновление, удаление, очистку, резервное копирование, восстановление и перечисление KeyVaultSecrets. Клиент также поддерживает перечисление DeletedSecret для Key Vault Azure с поддержкой обратимого удаления.

Конструкторы

SecretClient(string, TokenCredential, SecretClientOptions)

Создает экземпляр 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);

Свойства

vaultUrl

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

Методы

backupSecret(string, BackupSecretOptions)

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

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

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

Резервное копирование указанного секрета.
beginDeleteSecret(string, BeginDeleteSecretOptions)

Удаляет секрет, хранящийся в 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);

Удаляет секрет из указанного хранилища ключей.
beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)

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

Для этой операции требуется разрешение 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);

Восстанавливает удаленный секрет до последней версии.
getDeletedSecret(string, GetDeletedSecretOptions)

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

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

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

Возвращает указанный удаленный секрет.
getSecret(string, GetSecretOptions)

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

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

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

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

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

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

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

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

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

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

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

Вывод списка всех секретов в хранилище.
listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions)

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

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

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);
}
purgeDeletedSecret(string, PurgeDeletedSecretOptions)

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

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

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

Безвозвратно удаляет указанный секрет.
restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions)

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

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

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

Восстанавливает резервную копию секрета в хранилище.
setSecret(string, string, SetSecretOptions)

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

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

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

Добавляет секрет в указанное хранилище ключей.
updateSecretProperties(string, string, UpdateSecretPropertiesOptions)

Метод 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 });

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

Сведения о конструкторе

SecretClient(string, TokenCredential, SecretClientOptions)

Создает экземпляр 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)

Параметры

vaultUrl

string

Базовый URL-адрес хранилища. Убедитесь, что этот URL-адрес ссылается на допустимый ресурс Key Vault. Дополнительные сведения см. в разделе https://aka.ms/azsdk/blog/vault-uri.

credential
TokenCredential

Объект , реализующий интерфейс, используемый TokenCredential для проверки подлинности запросов к службе. @azure/identity Используйте пакет для создания учетных данных, которые соответствуют вашим потребностям.

pipelineOptions
SecretClientOptions

Параметры конвейера, используемые для настройки Key Vault запросов API. Пропустите этот параметр, чтобы использовать конфигурацию конвейера по умолчанию.

Сведения о свойстве

vaultUrl

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

vaultUrl: string

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

string

Сведения о методе

backupSecret(string, BackupSecretOptions)

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

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

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

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

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

Параметры

secretName

string

Имя секрета.

options
BackupSecretOptions

Необязательные параметры.

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

Promise<undefined | Uint8Array>

beginDeleteSecret(string, BeginDeleteSecretOptions)

Удаляет секрет, хранящийся в 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>>

Параметры

name

string

options
BeginDeleteSecretOptions

Необязательные параметры.

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

Promise<PollerLike<PollOperationState<DeletedSecret>, DeletedSecret>>

beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)

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

Для этой операции требуется разрешение 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>>

Параметры

name

string

options
BeginRecoverDeletedSecretOptions

Необязательные параметры.

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

Promise<PollerLike<PollOperationState<SecretProperties>, SecretProperties>>

getDeletedSecret(string, GetDeletedSecretOptions)

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

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

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

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

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

Параметры

secretName

string

Имя секрета.

options
GetDeletedSecretOptions

Необязательные параметры.

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

Promise<DeletedSecret>

getSecret(string, GetSecretOptions)

Метод 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>

Параметры

secretName

string

Имя секрета.

options
GetSecretOptions

Необязательные параметры.

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

Promise<KeyVaultSecret>

listDeletedSecrets(ListDeletedSecretsOptions)

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

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

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>

Параметры

options
ListDeletedSecretsOptions

Необязательные параметры.

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

PagedAsyncIterableIterator<DeletedSecret, DeletedSecret[], PageSettings>

listPropertiesOfSecrets(ListPropertiesOfSecretsOptions)

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

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

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>

Параметры

options
ListPropertiesOfSecretsOptions

Необязательные параметры.

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

PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions)

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

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

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>

Параметры

secretName

string

Имя секрета для получения версий.

options
ListPropertiesOfSecretVersionsOptions

Необязательные параметры.

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

PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

purgeDeletedSecret(string, PurgeDeletedSecretOptions)

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

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

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>

Параметры

secretName

string

Имя секрета.

options
PurgeDeletedSecretOptions

Необязательные параметры.

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

Promise<void>

restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions)

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

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

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

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

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

Параметры

secretBundleBackup

Uint8Array

Резервный BLOB-объект, связанный с секретным пакетом.

options
RestoreSecretBackupOptions

Необязательные параметры.

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

Promise<SecretProperties>

setSecret(string, string, SetSecretOptions)

Метод 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>

Параметры

secretName

string

Имя секрета.

value

string

Значение секрета.

options
SetSecretOptions

Необязательные параметры.

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

Promise<KeyVaultSecret>

updateSecretProperties(string, string, UpdateSecretPropertiesOptions)

Метод 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>

Параметры

secretName

string

Имя секрета.

secretVersion

string

Версия секрета.

options
UpdateSecretPropertiesOptions

Необязательные параметры.

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

Promise<SecretProperties>