@azure/keyvault-secrets package

Классы

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

Интерфейсы

BackupSecretOptions	Параметры <xref:backupSecretOptions>.
BeginDeleteSecretOptions	Интерфейс, представляющий необязательные параметры, которые можно передать в beginDeleteSecret(string, BeginDeleteSecretOptions)
BeginRecoverDeletedSecretOptions	Интерфейс, представляющий необязательные параметры, которые можно передать в beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)
DeletedSecret	Интерфейс, представляющий удаленный секрет KeyVault.
GetDeletedSecretOptions	Параметры getDeletedSecret(string, GetDeletedSecretOptions).
GetSecretOptions	Параметры getSecret(string, GetSecretOptions).
KeyVaultSecret	Интерфейс, представляющий секрет KeyVault, с его именем, значением и SecretProperties.
KeyVaultSecretIdentifier	Представляет сегменты, составляющие идентификатор секрета Key Vault.
ListDeletedSecretsOptions	Параметры listDeletedSecrets(ListDeletedSecretsOptions).
ListPropertiesOfSecretVersionsOptions	Параметры listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions).
ListPropertiesOfSecretsOptions	Параметры listPropertiesOfSecrets(ListPropertiesOfSecretsOptions).
PageSettings	Интерфейс, отслеживающий параметры для итерации страниц
PagedAsyncIterableIterator	Интерфейс, позволяющий асинхронно итерации выполнять итерацию как по страницам, так и по страницам.
PollOperationState	PollOperationState содержит список с мнением наименьшего набора свойств, необходимых для определения любого длительного опроса операций. Хотя класс Poller работает в качестве локального механизма управления для запуска, ожидания и потенциальной отмены длительной операции, pollOperationState документирует состояние удаленной длительной операции. Он должен обновляться по крайней мере после запуска операции, когда она завершится и когда она отменена. Хотя реализации могут иметь любое другое количество свойств, которые могут быть обновлены другими причинами.
PollerLike	Абстрактное представление опроса, предназначенное для предоставления только минимального API, с которым должен работать пользователь.
PurgeDeletedSecretOptions	Параметры purgeDeletedSecret(string, PurgeDeletedSecretOptions).
RestoreSecretBackupOptions	Параметры restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions).
SecretClientOptions	Необязательные параметры, принятые keyVault KeyClient
SecretPollerOptions	Интерфейс, представляющий необязательные параметры, которые можно передать в beginDeleteSecret(string, BeginDeleteSecretOptions) и <xref:beginRecoverDeletedKey>.
SecretProperties	Интерфейс, представляющий свойства KeyVaultSecret.
SetSecretOptions	Параметры setSecret(string, string, SetSecretOptions).
UpdateSecretPropertiesOptions	Параметры updateSecretProperties(string, string, UpdateSecretPropertiesOptions).

Псевдонимы типа

DeletionRecoveryLevel

Отражает уровень восстановления удаления, который в настоящее время действует для секретов в текущем хранилище. Если он содержит "Purgeable", секрет может быть окончательно удален привилегированным пользователем; в противном случае только система может очистить секрет в конце интервала хранения.
KnownDeletionRecoveryLevel можно использовать взаимозаменяемо с удалениемRecoveryLevel, в этом перечислении содержатся известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

очистка: обозначает состояние хранилища, в котором удаление является необратимой операцией без возможности восстановления. Этот уровень не соответствует защите от операции delete; данные безвозвратно теряются при принятии операции удаления на уровне сущности или выше (хранилище, группа ресурсов, подписка и т. д.).
Восстановление и очистка: обозначает состояние хранилища, в котором можно восстановить, а также разрешает немедленное и постоянное удаление (т. е. очистка). Этот уровень гарантирует возможность восстановления удаленной сущности в течение интервала хранения (90 дней), если операция очистки не запрашивается или подписка отменена. Система будет окончательно удалять ее через 90 дней, если не восстановлена
можно восстановить: обозначает состояние хранилища, в котором удаление можно восстановить без возможности немедленного и постоянного удаления (т. е. очистки). Этот уровень гарантирует возможность восстановления удаленной сущности в течение интервала хранения (90 дней) и пока подписка по-прежнему доступна. Система будет окончательно удалять ее через 90 дней, если не восстановлена
recoveryable+ProtectedSubscription: обозначает хранилище и состояние подписки, в котором удаление можно восстановить в течение интервала хранения (90 дней), немедленное и постоянное удаление (т. е. очистка) не допускается, и при этом сама подписка не может быть окончательно отменена. Система будет окончательно удалять ее через 90 дней, если не восстановлена
Настраиваемыйrecoverable+Purgeable: обозначает состояние хранилища, в котором можно восстановить удаление, а также разрешает немедленное и постоянное удаление (т. е. очистка при 7 <= SoftDeleteRetentionInDays < 90). Этот уровень гарантирует возможность восстановления удаленной сущности во время интервала хранения, если не запрашивается операция очистки или подписка отменена.
Настраиваемый: обозначает состояние хранилища, в котором удаление можно восстановить без возможности немедленного и постоянного удаления (т. е. очистка при 7 <= SoftDeleteRetentionInDays < 90). Этот уровень гарантирует возможность восстановления удаленной сущности во время периода хранения и пока подписка по-прежнему доступна.
Настраиваемыйrecoverable+ProtectedSubscription: обозначает состояние хранилища и подписки, в котором удаление можно восстановить, немедленное и постоянное удаление (т. е. очистка) не разрешено, и при этом сама подписка не может быть окончательно отменена, когда 7 <= SoftDeleteRetentionInDays < 90. Этот уровень гарантирует возможность восстановления удаленной сущности во время интервала хранения, а также отражает тот факт, что сама подписка не может быть отменена.

Перечисления

KnownDeletionRecoveryLevel

Функции

parseKeyVaultSecretIdentifier(string)

Анализирует указанный идентификатор секрета Key Vault. Пример:

https://< имя-ключа.vault.azure.net/secrets/>< имя-секрета>/<уникальный-идентификатор версии>

При анализе приведенного выше идентификатора эта функция возвращает следующее:

  {
     sourceId: "https://<keyvault-name>.vault.azure.net/secrets/<secret-name>/<unique-version-id>",
     vaultUrl: "https://<keyvault-name>.vault.azure.net",
     version: "<unique-version-id>",
     name: "<secret-name>"
  }

Сведения о функции

parseKeyVaultSecretIdentifier(string)

Анализирует указанный идентификатор секрета Key Vault. Пример:

https://< имя-ключа.vault.azure.net/secrets/>< имя-секрета>/<уникальный-идентификатор версии>

При анализе приведенного выше идентификатора эта функция возвращает следующее:

  {
     sourceId: "https://<keyvault-name>.vault.azure.net/secrets/<secret-name>/<unique-version-id>",
     vaultUrl: "https://<keyvault-name>.vault.azure.net",
     version: "<unique-version-id>",
     name: "<secret-name>"
  }

function parseKeyVaultSecretIdentifier(id: string): KeyVaultSecretIdentifier

Параметры

id: string

Идентификатор секрета Key Vault.

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

KeyVaultSecretIdentifier

Поделиться через

@azure/keyvault-secrets package

Классы

Интерфейсы

Псевдонимы типа

Известные значения, поддерживаемые службой

Перечисления

Функции

Сведения о функции

parseKeyVaultSecretIdentifier(string)

Параметры

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