通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

@azure/keyvault-secrets package

  • 参考

类

SecretClient

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

接口

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

表示组成密钥保管库机密 ID 的段。
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

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

表示 KeyVaultSecret 的属性的接口。
SetSecretOptions

的选项 setSecret(string, string, SetSecretOptions)。
UpdateSecretPropertiesOptions

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

类型别名

DeletionRecoveryLevel

定义 DeletionRecoveryLevel 的值。
KnownDeletionRecoveryLevel 可与 DeletionRecoveryLevel 互换使用，此枚举包含服务支持的已知值。

服务支持的已知值

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

枚举

KnownDeletionRecoveryLevel

服务接受的 DeletionRecoveryLevel 的已知值。

函数

parseKeyVaultSecretIdentifier(string)

分析给定密钥保管库机密 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>"
  }

函数详细信息

parseKeyVaultSecretIdentifier(string)

分析给定密钥保管库机密 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>"
  }

function parseKeyVaultSecretIdentifier(id: string): KeyVaultSecretIdentifier

参数

id

string

密钥保管库机密的 ID。

返回

KeyVaultSecretIdentifier