@azure/keyvault-secrets package

SecretClient 提供了在 Azure Key Vault 中管理 KeyVaultSecret 的方法。 客户端支持创建、检索、更新、删除、清除、备份、还原和列出 KeyVaultSecrets。 客户端还支持列出已启用软删除的 Azure Key Vault DeletedSecret。

用于 <xref:backupSecretOptions>的选项。

表示可传递给 beginDeleteSecret(string, BeginDeleteSecretOptions) 的可选参数的接口

表示可传递给 beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions) 的可选参数的接口

表示已删除的 KeyVault 机密的接口。

用于 getDeletedSecret(string, GetDeletedSecretOptions)的选项。

用于 getSecret(string, GetSecretOptions)的选项。

表示 KeyVault 机密的接口，其名称、值和 SecretProperties。

表示构成 Key Vault 机密 ID 的段。

用于 listDeletedSecrets(ListDeletedSecretsOptions)的选项。

用于 listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions)的选项。

用于 listPropertiesOfSecrets(ListPropertiesOfSecretsOptions)的选项。

跟踪分页迭代设置的接口

允许异步迭代到完成和逐页迭代的接口。

PollOperationState 包含定义任何长时间运行的作轮询器所需的最小属性集的有意见列表。

虽然 Poller 类充当本地控制机制来开始触发、等待并可能取消长时间运行的作，但 PollOperationState 记录远程长时间运行作的状态。

它至少应在作启动时、作完成后以及取消时更新。 不过，实现可以具有其他原因可以更新的任何其他数量的属性。

投票器抽象表示形式，旨在仅公开用户需要使用的最小 API。

用于 purgeDeletedSecret(string, PurgeDeletedSecretOptions)的选项。

用于 restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions)的选项。

KeyVault 的 KeyClient 接受的可选参数

一个接口，表示可传递给 beginDeleteSecret(string, BeginDeleteSecretOptions) 和 <xref:beginRecoverDeletedKey>的可选参数。

一个接口，表示 KeyVaultSecret的属性。

用于 setSecret(string, string, SetSecretOptions)的选项。

用于 updateSecretProperties(string, string, UpdateSecretPropertiesOptions)的选项。

反映当前保管库中机密当前有效的删除恢复级别。 如果它包含“可清除”，则特权用户可永久删除机密;否则，只有系统才能在保留间隔结束时清除机密。
KnownDeletionRecoveryLevel 可与 DeletionRecoveryLevel 互换使用，此枚举包含服务支持的已知值。

服务支持的已知值

可清除：表示删除是不可逆作的保管库状态，而无法进行恢复。 此级别对应于不可用于删除作的保护;在接受实体级别或更高级别的删除作（保管库、资源组、订阅等）时，数据将不可挽回地丢失。
可恢复+可清除：表示可恢复删除的保管库状态，以及允许立即和永久删除（即清除）。 此级别保证在保留间隔（90 天）期间删除的实体的可恢复性，除非请求清除作或取消订阅。 系统在 90 天后永久删除它（如果未恢复）
可恢复：表示可以恢复删除的保管库状态，而无需立即和永久删除（即清除）。 此级别保证在保留间隔（90 天）期间以及订阅仍可用期间已删除实体的可恢复性。 系统在 90 天后永久删除它（如果未恢复）
可恢复+ProtectedSubscription：表示不允许在保留时间间隔（90 天）、立即和永久删除（即清除）内恢复的保管库和订阅状态，并且不允许永久取消订阅本身。 系统在 90 天后永久删除它（如果未恢复）
CustomizedRecoverable+Purgeable：表示可恢复删除的保管库状态，还允许立即和永久删除（即在 7 <= SoftDeleteRetentionInDays < 90 时清除）。 此级别保证在保留间隔期间删除的实体的可恢复性，除非请求清除作或取消订阅。
CustomizedRecoverable：表示可以恢复删除的保管库状态，而无需立即和永久删除（即在 7 <= SoftDeleteRetentionInDays < 90 时清除）。此级别保证在保留时间间隔内以及订阅仍可用期间已删除实体的可恢复性。
CustomizedRecoverable+ProtectedSubscription：表示不允许在其中恢复删除的保管库和订阅状态（即清除），并且当 7 <= SoftDeleteRetentionInDays < 90 时，订阅本身将无法永久取消。 此级别保证在保留时间间隔内删除实体的可恢复性，还反映了无法取消订阅本身的事实。

反映当前保管库中机密当前有效的删除恢复级别。 如果它包含“可清除”，则特权用户可永久删除机密;否则，只有系统才能在保留间隔结束时清除机密。

分析给定的 Key Vault 机密 ID。例如：

https://.vault.azure.net/secrets//

在分析上述 ID 时，此函数返回：

  {
     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>"
  }