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

Get Keys - Get Keys

  • 参考
Service:
Key Vault
API Version:
7.4

列出指定保管库中的密钥。
检索密钥保管库中密钥的列表，密钥保管库充当包含存储密钥公共部分的 JSON Web 密钥结构。 LIST 操作适用于所有密钥类型，但响应中仅提供基键标识符、属性和标记。 响应中未列出各个版本的密钥。 此操作需要密钥/列表权限。

GET {vaultBaseUrl}/keys?api-version=7.4
With optional parameters: 
GET {vaultBaseUrl}/keys?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

KeyListResult

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

KeyVaultError

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

示例

GetKeys

Sample Request

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

Sample Response

Status code:
200 
{
  "value": [
    {
      "kid": "https://myvault.vault.azure.net/keys/sdktestkey",
      "attributes": {
        "enabled": true,
        "created": 1493937656,
        "updated": 1493937656,
        "recoveryLevel": "Recoverable+Purgeable"
      }
    }
  ],
  "nextLink": "https://myvault.vault.azure.net:443/keys?api-version=7.2&$skiptoken=eyJOZXh0TWFya2VyIjoiMiE5NiFNREF3TURJM0lXdGxlUzlWVUVSQlZFVkxSVmxCVkZSU1NVSlZWRVZUVkVWVFZDRXdNREF3TWpnaE1qQXhOeTB3TlMwd05GUXdNVG94TVRveE5pNDNNekE0TnpReVdpRS0iLCJUYXJnZXRMb2NhdGlvbiI6MH0&maxresults=1"
}

定义

名称 说明
DeletionRecoveryLevel

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

密钥保管库服务器错误。
KeyAttributes

密钥保管库服务管理的密钥的属性。
KeyItem

包含密钥元数据的键项。
KeyListResult

键列表结果。
KeyVaultError

密钥保管库错误异常。

DeletionRecoveryLevel

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

名称 类型 说明
CustomizedRecoverable

string

表示可恢复删除的保管库状态，无法立即和永久删除 (即在 7<= SoftDeleteRetentionInDays < 90) 时清除删除。此级别保证已删除实体在保留间隔期间和订阅仍然可用时可恢复。
CustomizedRecoverable+ProtectedSubscription

string

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

string

表示可恢复删除的保管库状态，还允许立即和永久删除 (即当 7<= SoftDeleteRetentionInDays < 90) 时清除。 此级别保证已删除实体在保留时间间隔内可恢复，除非请求清除操作或取消订阅。
Purgeable

string

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

Recoverable

string

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

string

表示保管库和订阅状态，在该状态中，删除可在保留间隔 (90 天) 恢复，即时和永久删除 (即不允许清除) ，并且订阅本身无法永久取消。 系统将在 90 天后永久删除它（如果未恢复）
Recoverable+Purgeable

string

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

Error

密钥保管库服务器错误。

名称 类型 说明
code

string

错误代码。
innererror

Error

密钥保管库服务器错误。
message

string

错误消息。

KeyAttributes

密钥保管库服务管理的密钥的属性。

名称 类型 说明
created

integer

创建时间（UTC）。
enabled

boolean

确定是否启用对象。
exp

integer

到期日期（UTC）。
exportable

boolean

指示是否可以导出私钥。 创建可导出密钥的第一个版本时，必须提供发布策略。
nbf

integer

不早于 UTC 日期。
recoverableDays

integer

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

DeletionRecoveryLevel

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

integer

上次更新时间（UTC）。

KeyItem

包含密钥元数据的键项。

名称 类型 说明
attributes

KeyAttributes

密钥管理属性。
kid

string

密钥标识符。
managed

boolean

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

object

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

KeyListResult

键列表结果。

名称 类型 说明
nextLink

string

用于获取下一组密钥的 URL。
value

KeyItem[]

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

KeyVaultError

密钥保管库错误异常。

名称 类型 说明
error

Error

密钥保管库服务器错误。