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

Vaults - List By Subscription

List 操作获取与订阅关联的保管库的相关信息。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/vaults?api-version=2022-07-01
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/vaults?$top={$top}&api-version=2022-07-01

URI 参数

名称 必需 类型 说明
subscriptionId
path True

string

唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。

api-version
query True

string

客户端 API 版本。

$top
query

integer

int32

要返回的结果数上限。

响应

名称 类型 说明
200 OK

VaultListResult

获取有关指定订阅中所有密钥保管库的信息。

Other Status Codes

CloudError

描述操作失败原因的错误响应。

示例

List vaults in the specified subscription

示例请求

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/vaults?$top=1&api-version=2022-07-01

示例响应

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault",
      "name": "sample-vault",
      "type": "Microsoft.KeyVault/vaults",
      "location": "westus",
      "tags": {},
      "systemData": {
        "createdBy": "keyVaultUser1",
        "createdByType": "User",
        "createdAt": "2020-01-01T12:00:00.0000000Z",
        "lastModifiedBy": "keyVaultUser2",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2020-01-01T12:00:00.0000000Z"
      },
      "properties": {
        "sku": {
          "family": "A",
          "name": "premium"
        },
        "tenantId": "00000000-0000-0000-0000-000000000000",
        "accessPolicies": [
          {
            "tenantId": "00000000-0000-0000-0000-000000000000",
            "objectId": "00000000-0000-0000-0000-000000000000",
            "permissions": {
              "keys": [
                "encrypt",
                "decrypt",
                "wrapKey",
                "unwrapKey",
                "sign",
                "verify",
                "get",
                "list",
                "create",
                "update",
                "import",
                "delete",
                "backup",
                "restore",
                "recover",
                "purge"
              ],
              "secrets": [
                "get",
                "list",
                "set",
                "delete",
                "backup",
                "restore",
                "recover",
                "purge"
              ],
              "certificates": [
                "get",
                "list",
                "delete",
                "create",
                "import",
                "update",
                "managecontacts",
                "getissuers",
                "listissuers",
                "setissuers",
                "deleteissuers",
                "manageissuers",
                "recover",
                "purge"
              ]
            }
          }
        ],
        "enabledForDeployment": true,
        "enabledForDiskEncryption": true,
        "enabledForTemplateDeployment": true,
        "enableSoftDelete": true,
        "hsmPoolResourceId": "00000000-0000-0000-0000-000000000000",
        "vaultUri": "https://sample-vault.vault.azure.net/",
        "provisioningState": "Succeeded"
      }
    }
  ],
  "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resources?api-version=22022-07-01&$skiptoken=dmF1bHQtcGVza3ktanVyeS03MzA3Ng=="
}

定义

名称 说明
AccessPolicyEntry

有权访问密钥保管库的标识。 数组中的所有标识都必须使用与密钥保管库的租户 ID 相同的租户 ID。

ActionsRequired

一条消息,指示服务提供商的更改是否需要对使用者进行任何更新。

CertificatePermissions

对证书的权限

CloudError

密钥保管库资源提供程序的错误响应

CloudErrorBody

密钥保管库资源提供程序的错误响应

CreateMode

保管库的创建模式,用于指示是否需要恢复保管库。

identityType

创建密钥保管库资源的标识类型。

IPRule

一个规则,用于管理特定 IP 地址或 IP 范围内的保管库的可访问性。

KeyPermissions

密钥权限

NetworkRuleAction

ipRules 和 virtualNetworkRules 中没有规则匹配时的默认操作。 这仅在评估 bypass 属性后使用。

NetworkRuleBypassOptions

告知哪些流量可以绕过网络规则。 这可以是“AzureServices”或“None”。 如果未指定,则默认值为“AzureServices”。

NetworkRuleSet

管理保管库的网络可访问性的一组规则。

Permissions

标识对密钥、机密、证书和存储拥有的权限。

PrivateEndpoint

专用终结点对象属性。

PrivateEndpointConnectionItem

专用终结点连接项。

PrivateEndpointConnectionProvisioningState

当前预配状态。

PrivateEndpointServiceConnectionStatus

专用终结点连接状态。

PrivateLinkServiceConnectionState

一个 对象,表示专用链接连接的审批状态。

SecretPermissions

对机密的权限

Sku

SKU 详细信息

SkuFamily

SKU 系列名称

SkuName

用于指定密钥保管库是标准保管库还是高级保管库的 SKU 名称。

StoragePermissions

存储帐户的权限

SystemData

与密钥保管库资源的创建和上次修改相关的元数据。

Vault

包含扩展详细信息的资源信息。

VaultListResult

保管库列表

VaultProperties

保管库的属性

VaultProvisioningState

保管库的预配状态。

VirtualNetworkRule

管理特定虚拟网络中保管库的可访问性的规则。

AccessPolicyEntry

有权访问密钥保管库的标识。 数组中的所有标识都必须使用与密钥保管库的租户 ID 相同的租户 ID。

名称 类型 说明
applicationId

string

代表主体发出请求的客户端的应用程序 ID

objectId

string

保管库的 Azure Active Directory 租户中用户、服务主体或安全组的对象 ID。 对于访问策略列表,对象 ID 必须是唯一的。

permissions

Permissions

标识对密钥、机密和证书拥有的权限。

tenantId

string

应用于对密钥保管库的请求进行身份验证的 Azure Active Directory 租户 ID。

ActionsRequired

一条消息,指示服务提供商的更改是否需要对使用者进行任何更新。

名称 类型 说明
None

string

CertificatePermissions

对证书的权限

名称 类型 说明
all

string

backup

string

create

string

delete

string

deleteissuers

string

get

string

getissuers

string

import

string

list

string

listissuers

string

managecontacts

string

manageissuers

string

purge

string

recover

string

restore

string

setissuers

string

update

string

CloudError

密钥保管库资源提供程序的错误响应

名称 类型 说明
error

CloudErrorBody

密钥保管库资源提供程序的错误响应

CloudErrorBody

密钥保管库资源提供程序的错误响应

名称 类型 说明
code

string

错误代码。 这是可以编程方式使用的助记键。

message

string

用户友好的错误消息。 消息通常是本地化的,可能因服务版本而异。

CreateMode

保管库的创建模式,用于指示是否需要恢复保管库。

名称 类型 说明
default

string

recover

string

identityType

创建密钥保管库资源的标识类型。

名称 类型 说明
Application

string

Key

string

ManagedIdentity

string

User

string

IPRule

一个规则,用于管理特定 IP 地址或 IP 范围内的保管库的可访问性。

名称 类型 说明
value

string

以 CIDR 表示法表示的 IPv4 地址范围,例如“124.56.78.91” (简单 IP 地址) 或“124.56.78.0/24” (以 124.56.78) 开头的所有地址。

KeyPermissions

密钥权限

名称 类型 说明
all

string

backup

string

create

string

decrypt

string

delete

string

encrypt

string

get

string

getrotationpolicy

string

import

string

list

string

purge

string

recover

string

release

string

restore

string

rotate

string

setrotationpolicy

string

sign

string

unwrapKey

string

update

string

verify

string

wrapKey

string

NetworkRuleAction

ipRules 和 virtualNetworkRules 中没有规则匹配时的默认操作。 这仅在评估 bypass 属性后使用。

名称 类型 说明
Allow

string

Deny

string

NetworkRuleBypassOptions

告知哪些流量可以绕过网络规则。 这可以是“AzureServices”或“None”。 如果未指定,则默认值为“AzureServices”。

名称 类型 说明
AzureServices

string

None

string

NetworkRuleSet

管理保管库的网络可访问性的一组规则。

名称 类型 说明
bypass

NetworkRuleBypassOptions

告知哪些流量可以绕过网络规则。 这可以是“AzureServices”或“None”。 如果未指定,则默认值为“AzureServices”。

defaultAction

NetworkRuleAction

ipRules 和 virtualNetworkRules 中没有规则匹配时的默认操作。 这仅在评估 bypass 属性后使用。

ipRules

IPRule[]

IP 地址规则的列表。

virtualNetworkRules

VirtualNetworkRule[]

虚拟网络规则的列表。

Permissions

标识对密钥、机密、证书和存储拥有的权限。

名称 类型 说明
certificates

CertificatePermissions[]

对证书的权限

keys

KeyPermissions[]

密钥权限

secrets

SecretPermissions[]

对机密的权限

storage

StoragePermissions[]

存储帐户的权限

PrivateEndpoint

专用终结点对象属性。

名称 类型 说明
id

string

专用终结点资源的完整标识符。

PrivateEndpointConnectionItem

专用终结点连接项。

名称 类型 说明
etag

string

每当专用终结点连接的状态发生更改时修改。

id

string

专用终结点连接的 ID。

properties.privateEndpoint

PrivateEndpoint

专用终结点对象的属性。

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

专用链接连接的审批状态。

properties.provisioningState

PrivateEndpointConnectionProvisioningState

专用终结点连接的预配状态。

PrivateEndpointConnectionProvisioningState

当前预配状态。

名称 类型 说明
Creating

string

Deleting

string

Disconnected

string

Failed

string

Succeeded

string

Updating

string

PrivateEndpointServiceConnectionStatus

专用终结点连接状态。

名称 类型 说明
Approved

string

Disconnected

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

一个 对象,表示专用链接连接的审批状态。

名称 类型 说明
actionsRequired

ActionsRequired

一条消息,指示服务提供商的更改是否需要对使用者进行任何更新。

description

string

批准或拒绝的原因。

status

PrivateEndpointServiceConnectionStatus

指示连接是否已由密钥保管库所有者批准、拒绝或删除。

SecretPermissions

对机密的权限

名称 类型 说明
all

string

backup

string

delete

string

get

string

list

string

purge

string

recover

string

restore

string

set

string

Sku

SKU 详细信息

名称 类型 说明
family

SkuFamily

SKU 系列名称

name

SkuName

用于指定密钥保管库是标准保管库还是高级保管库的 SKU 名称。

SkuFamily

SKU 系列名称

名称 类型 说明
A

string

SkuName

用于指定密钥保管库是标准保管库还是高级保管库的 SKU 名称。

名称 类型 说明
premium

string

standard

string

StoragePermissions

存储帐户的权限

名称 类型 说明
all

string

backup

string

delete

string

deletesas

string

get

string

getsas

string

list

string

listsas

string

purge

string

recover

string

regeneratekey

string

restore

string

set

string

setsas

string

update

string

SystemData

与密钥保管库资源的创建和上次修改相关的元数据。

名称 类型 说明
createdAt

string

密钥保管库资源创建的时间戳 (UTC) 。

createdBy

string

创建密钥保管库资源的标识。

createdByType

identityType

创建密钥保管库资源的标识类型。

lastModifiedAt

string

上次修改密钥保管库资源的时间戳 (UTC) 。

lastModifiedBy

string

上次修改密钥保管库资源的标识。

lastModifiedByType

identityType

上次修改密钥保管库资源的标识类型。

Vault

包含扩展详细信息的资源信息。

名称 类型 说明
id

string

密钥保管库资源的完全限定标识符。

location

string

密钥保管库资源的 Azure 位置。

name

string

密钥保管库资源的名称。

properties

VaultProperties

保管库的属性

systemData

SystemData

密钥保管库的系统元数据。

tags

object

分配给密钥保管库资源的标记。

type

string

密钥保管库资源的资源类型。

VaultListResult

保管库列表

名称 类型 说明
nextLink

string

用于获取下一组保管库的 URL。

value

Vault[]

保管库列表。

VaultProperties

保管库的属性

名称 类型 默认值 说明
accessPolicies

AccessPolicyEntry[]

0 到 1024 个标识的数组,这些标识有权访问密钥保管库。 数组中的所有标识都必须使用与密钥保管库的租户 ID 相同的租户 ID。 当 设置为 recovercreateMode,不需要访问策略。 否则,需要访问策略。

createMode

CreateMode

保管库的创建模式,用于指示是否需要恢复保管库。

enablePurgeProtection

boolean

指定是否为此保管库启用清除防护的属性。 将此属性设置为 true 可激活针对此保管库及其内容的清除保护 - 只有密钥保管库服务可能会启动不可恢复的硬删除。 仅当还启用了软删除时,此设置才有效。 启用此功能是不可逆的 - 也就是说,属性不接受 false 作为其值。

enableRbacAuthorization

boolean

False

控制如何授权数据操作的属性。 如果为 true,密钥保管库将使用基于角色访问控制 (RBAC) 来授权数据操作,并且将忽略保管库属性中指定的访问策略。 如果为 false,则密钥保管库将使用保管库属性中指定的访问策略,存储在 Azure 资源管理器 上的任何策略将被忽略。 如果为 null 或未指定,则会使用默认值 false 创建保管库。 请注意,管理操作始终使用 RBAC 授权。

enableSoftDelete

boolean

True

用于指定是否为此密钥保管库启用“软删除”功能的属性。 如果在创建新的密钥保管库时,它未设置为任何值 (true 或 false) ,则默认情况下,该值将设置为 true。 设置为 true 后,无法将其还原为 false。

enabledForDeployment

boolean

用于指定是否允许 Azure 虚拟机从密钥保管库检索存储为机密的证书的属性。

enabledForDiskEncryption

boolean

用于指定是否允许 Azure 磁盘加密从保管库检索机密和解包密钥的属性。

enabledForTemplateDeployment

boolean

用于指定是否允许 Azure 资源管理器 从密钥保管库检索机密的属性。

hsmPoolResourceId

string

HSM 池的资源 ID。

networkAcls

NetworkRuleSet

管理来自特定网络位置的密钥保管库可访问性的规则。

privateEndpointConnections

PrivateEndpointConnectionItem[]

与密钥保管库关联的专用终结点连接列表。

provisioningState

VaultProvisioningState

保管库的预配状态。

publicNetworkAccess

string

enabled

用于指定保管库是否接受来自公共 Internet 的流量的属性。 如果设置为“禁用”,则将阻止来自受信任服务的所有流量(专用终结点流量除外)。 这将替代设置的防火墙规则,这意味着即使存在防火墙规则,也不会遵守这些规则。

sku

Sku

SKU 详细信息

softDeleteRetentionInDays

integer

90

softDelete 数据保留天数。 它接受 >=7 和 <=90。

tenantId

string

应用于对密钥保管库的请求进行身份验证的 Azure Active Directory 租户 ID。

vaultUri

string

用于对密钥和机密执行操作的保管库的 URI。

VaultProvisioningState

保管库的预配状态。

名称 类型 说明
RegisteringDns

string

Succeeded

string

VirtualNetworkRule

管理特定虚拟网络中保管库的可访问性的规则。

名称 类型 说明
id

string

vnet 子网的完整资源 ID,例如“/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1”。

ignoreMissingVnetServiceEndpoint

boolean

属性,用于指定如果父子网配置了 serviceEndpoints,NRP 是否会忽略检查。