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

Get Secrets - Get Secrets

列出指定密钥保管库中的机密。
获取机密操作适用于整个保管库。 但是,响应中仅提供基本机密标识符及其属性。 不会在响应中列出单个机密版本。 此操作需要机密/列表权限。

GET {vaultBaseUrl}/secrets?api-version=7.4
GET {vaultBaseUrl}/secrets?maxresults={maxresults}&api-version=7.4

URI 参数

名称 必需 类型 说明
vaultBaseUrl
path True

string

保管库名称,例如 https://myvault.vault.azure.net

api-version
query True

string

客户端 API 版本。

maxresults
query

integer

int32

在一页中返回的最大结果数。 如果未指定,该服务将返回最多 25 个结果。

响应

名称 类型 说明
200 OK

SecretListResult

包含保管库中的机密列表以及指向下一页机密的链接的响应消息。

Other Status Codes

KeyVaultError

密钥保管库描述操作失败原因的错误响应。

示例

GetSecrets

示例请求

GET https://myvault.vault.azure.net//secrets?maxresults=1&api-version=7.4

示例响应

{
  "value": [
    {
      "contentType": "plainText",
      "id": "https://myvault.vault.azure.net/secrets/listsecrettest0",
      "attributes": {
        "enabled": true,
        "created": 1482189047,
        "updated": 1482189047
      }
    }
  ],
  "nextLink": "https://myvault.vault.azure.net:443/secrets?api-version=7.2&$skiptoken=eyJOZXh0TWFya2VyIjoiMiE4OCFNREF3TURJeUlYTmxZM0psZEM5TVNWTlVVMFZEVWtWVVZFVlRWREVoTURBd01ESTRJVEl3TVRZdE1USXRNVGxVTWpNNk1UQTZORFV1T0RneE9ERXhNRm9oIiwiVGFyZ2V0TG9jYXRpb24iOjB9&maxresults=1"
}

定义

名称 说明
DeletionRecoveryLevel

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

Error

密钥保管库服务器错误。

KeyVaultError

密钥保管库错误异常。

SecretAttributes

机密管理属性。

SecretItem

包含机密元数据的机密项。

SecretListResult

机密列表结果。

DeletionRecoveryLevel

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

名称 类型 说明
CustomizedRecoverable

string

表示可恢复删除的保管库状态, (即当 7<= SoftDeleteRetentionInDays < 90) 时进行清除,则无法立即和永久删除删除。此级别可保证已删除实体在保留间隔期间以及订阅仍可用时的可恢复性。

CustomizedRecoverable+ProtectedSubscription

string

表示保管库和订阅状态,其中删除是可恢复的,即时和永久删除 (即不允许清除) ,并且当 7<= SoftDeleteRetentionInDays < 90 时,订阅本身无法永久取消。 此级别可保证已删除实体在保留间隔期间的可恢复性,还反映了订阅本身无法取消这一事实。

CustomizedRecoverable+Purgeable

string

表示保管库状态,其中删除是可恢复的,并且还允许立即和永久删除 (即在 7<= SoftDeleteRetentionInDays <) 时清除。 除非请求清除操作或取消订阅,否则此级别可保证已删除实体在保留间隔期间的可恢复性。

Purgeable

string

表示保管库状态,其中删除操作不可逆,无法恢复。 此级别对应于对删除操作没有可用的保护;在实体级别或更高 (保管库、资源组、订阅等接受删除操作时,数据将不可挽回地丢失 )

Recoverable

string

表示可恢复删除的保管库状态,无法立即和永久删除 (即清除) 。 此级别保证在保留间隔 (90 天) 且订阅仍然可用期间,已删除实体的可恢复性。 系统将在 90 天后永久删除它(如果未恢复)

Recoverable+ProtectedSubscription

string

表示保管库和订阅状态,其中删除可在 90 天内恢复, (90 天的保留间隔) ,即时和永久删除 (即不允许清除) ,并且订阅本身不能永久取消。 系统将在 90 天后永久删除它(如果未恢复)

Recoverable+Purgeable

string

表示保管库状态,其中删除是可恢复的,还允许立即和永久删除 (即清除) 。 此级别保证删除实体在保留间隔 (90 天) 的可恢复性,除非请求清除操作或取消订阅。 系统将在 90 天后永久删除它(如果未恢复)

Error

密钥保管库服务器错误。

名称 类型 说明
code

string

错误代码。

innererror

Error

密钥保管库服务器错误。

message

string

错误消息。

KeyVaultError

密钥保管库错误异常。

名称 类型 说明
error

Error

密钥保管库服务器错误。

SecretAttributes

机密管理属性。

名称 类型 说明
created

integer

创建时间(UTC)。

enabled

boolean

确定是否启用对象。

exp

integer

到期日期(UTC)。

nbf

integer

不早于 UTC 日期。

recoverableDays

integer

softDelete 数据保留天数。 启用 softDelete 时,值应为 >=7 和 <=90,否则为 0。

recoveryLevel

DeletionRecoveryLevel

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

updated

integer

上次更新时间(UTC)。

SecretItem

包含机密元数据的机密项。

名称 类型 说明
attributes

SecretAttributes

机密管理属性。

contentType

string

机密值的类型,例如密码。

id

string

机密标识符。

managed

boolean

如此 如果机密的生存期由密钥保管库管理。 如果这是支持证书的密钥,则托管为 true。

tags

object

键/值对形式的应用程序特定元数据。

SecretListResult

机密列表结果。

名称 类型 说明
nextLink

string

用于获取下一组机密的 URL。

value

SecretItem[]

包含密钥保管库中的机密列表以及指向下一页机密的链接的响应消息。