@azure/keyvault-secrets package

Классы

SecretClient

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

Интерфейсы

BackupSecretOptions	Параметры для <xref:backupSecretOptions>.
BeginDeleteSecretOptions	Интерфейс, представляющий необязательные параметры, которые можно передать в beginDeleteSecret(string, BeginDeleteSecretOptions)
BeginRecoverDeletedSecretOptions	Интерфейс, представляющий необязательные параметры, которые можно передать в beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)
DeletedSecret	Интерфейс, представляющий удаленный секрет Хранилища ключей.
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	Необязательные параметры, принимаемые KeyClient Хранилища ключей
SecretPollerOptions	Интерфейс, представляющий необязательные параметры, которые можно передать в beginDeleteSecret(string, BeginDeleteSecretOptions) и <xref:beginRecoverDeletedKey>.
SecretProperties	Интерфейс, представляющий свойства KeyVaultSecret.
SetSecretOptions	Параметры для setSecret(string, string, SetSecretOptions).
UpdateSecretPropertiesOptions	Параметры для updateSecretProperties(string, string, UpdateSecretPropertiesOptions).

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

DeletionRecoveryLevel

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

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

KnownDeletionRecoveryLevel

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

Функции

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