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

Vaults - List By Resource Group

参考

服务:: Key Vault

API 版本:: 2022-07-01

列表作获取与订阅和指定资源组中关联的保管库的相关信息。

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

具有可选参数:

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

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string	保管库所属的资源组的名称。
subscriptionId	path	True	string	唯一标识 azure 订阅Microsoft的订阅凭据。订阅 ID 构成了每个服务调用的 URI 的一部分。
api-version	query	True	string	客户端 API 版本。
$top	query		integer (int32)	要返回的最大结果数。

响应

名称	类型	说明
200 OK	VaultListResult	获取有关指定资源组中所有密钥保管库的信息。
Other Status Codes	CloudError	描述操作失败的原因的错误响应。

示例

List vaults in the specified resource group

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

from azure.identity import DefaultAzureCredential
from azure.mgmt.keyvault import KeyVaultManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-keyvault
# USAGE
    python list_vault_by_resource_group.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = KeyVaultManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.vaults.list_by_resource_group(
        resource_group_name="sample-group",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/listVaultByResourceGroup.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 200

{
  "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/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults?api-version=2022-07-01&$skiptoken=dmF1bHQtcGVza3ktanVyeS03MzA3Ng=="
}

定义

名称	说明
AccessPolicyEntry	有权访问密钥保管库的标识。数组中的所有标识都必须使用与密钥保管库租户 ID 相同的租户 ID。
ActionsRequired	一条消息，指示服务提供商上的更改是否需要对使用者进行任何更新。
CertificatePermissions	证书权限
CloudError	Key Vault 资源提供程序的错误响应
CloudErrorBody	Key Vault 资源提供程序的错误响应
CreateMode	保管库的创建模式，用于指示是否需要恢复保管库。
identityType	创建密钥保管库资源的标识类型。
IPRule	一个规则，用于控制从特定 IP 地址或 ip 范围访问保管库的可访问性。
KeyPermissions	密钥权限
NetworkRuleAction	当没有来自 ipRules 和 virtualNetworkRules 的规则匹配时，默认作。仅当评估绕过属性后，才使用此属性。
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

Object

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

名称	类型	说明
applicationId	string (uuid)	代表主体发出请求的客户端的应用程序 ID
objectId	string	保管库的 Azure Active Directory 租户中用户、服务主体或安全组的对象 ID。对象 ID 对于访问策略列表必须是唯一的。
permissions	Permissions	标识对密钥、机密和证书的权限。
tenantId	string (uuid)	应用于对密钥保管库的请求进行身份验证的 Azure Active Directory 租户 ID。

ActionsRequired

枚举

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

值	说明
None

CertificatePermissions

枚举

证书权限

值	说明
all
backup
create
delete
deleteissuers
get
getissuers
import
list
listissuers
managecontacts
manageissuers
purge
recover
restore
setissuers
update

CloudError

Object

Key Vault 资源提供程序的错误响应

名称	类型	说明
error	CloudErrorBody	Key Vault 资源提供程序的错误响应

CloudErrorBody

Object

Key Vault 资源提供程序的错误响应

名称	类型	说明
code	string	错误代码。这是一种助记法，可通过编程方式使用。
message	string	用户友好的错误消息。消息通常已本地化，服务版本可能会有所不同。

CreateMode

枚举

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

值	说明
default
recover

identityType

枚举

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

值	说明
Application
Key
ManagedIdentity
User

IPRule

Object

一个规则，用于控制从特定 IP 地址或 ip 范围访问保管库的可访问性。

名称	类型	说明
value	string	CIDR 表示法中的 IPv4 地址范围，例如“124.56.78.91”（简单 IP 地址）或“124.56.78.0/24”（以 124.56.78 开头的所有地址）。

KeyPermissions

枚举

密钥权限

值	说明
all
backup
create
decrypt
delete
encrypt
get
getrotationpolicy
import
list
purge
recover
release
restore
rotate
setrotationpolicy
sign
unwrapKey
update
verify
wrapKey

NetworkRuleAction

枚举

当没有来自 ipRules 和 virtualNetworkRules 的规则匹配时，默认作。仅当评估绕过属性后，才使用此属性。

值	说明
Allow
Deny

NetworkRuleBypassOptions

枚举

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

值	说明
AzureServices
None

NetworkRuleSet

Object

一组规则，用于控制保管库的网络可访问性。

名称	类型	说明
bypass	NetworkRuleBypassOptions	告知哪些流量可以绕过网络规则。这可以是“AzureServices”或“None”。如果未指定默认值，则为“AzureServices”。
defaultAction	NetworkRuleAction	当没有来自 ipRules 和 virtualNetworkRules 的规则匹配时，默认作。仅当评估绕过属性后，才使用此属性。
ipRules	IPRule[]	IP 地址规则的列表。
virtualNetworkRules	VirtualNetworkRule[]	虚拟网络规则的列表。

Permissions

Object

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

名称	类型	说明
certificates	CertificatePermissions[]	证书权限
keys	KeyPermissions[]	密钥权限
secrets	SecretPermissions[]	对机密的权限
storage	StoragePermissions[]	对存储帐户的权限

PrivateEndpoint

Object

专用终结点对象属性。

名称	类型	说明
id	string	专用终结点资源的完整标识符。

PrivateEndpointConnectionItem

Object

专用终结点连接项。

名称	类型	说明
etag	string	每当专用终结点连接状态发生更改时修改。
id	string	专用终结点连接的 ID。
properties.privateEndpoint	PrivateEndpoint	专用终结点对象的属性。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	专用链接连接的审批状态。
properties.provisioningState	PrivateEndpointConnectionProvisioningState	专用终结点连接的预配状态。

PrivateEndpointConnectionProvisioningState

枚举

当前预配状态。

值	说明
Creating
Deleting
Disconnected
Failed
Succeeded
Updating

PrivateEndpointServiceConnectionStatus

枚举

专用终结点连接状态。

值	说明
Approved
Disconnected
Pending
Rejected

PrivateLinkServiceConnectionState

Object

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

名称	类型	说明
actionsRequired	ActionsRequired	一条消息，指示服务提供商上的更改是否需要对使用者进行任何更新。
description	string	批准或拒绝的原因。
status	PrivateEndpointServiceConnectionStatus	指示密钥保管库所有者是否已批准、拒绝或删除连接。

SecretPermissions

枚举

对机密的权限

值	说明
all
backup
delete
get
list
purge
recover
restore
set

Sku

Object

SKU 详细信息

名称	类型	说明
family	SkuFamily	SKU 系列名称
name	SkuName	用于指定密钥保管库是标准保管库还是高级保管库的 SKU 名称。

SkuFamily

枚举

SKU 系列名称

值	说明
A

SkuName

枚举

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

值	说明
premium
standard

StoragePermissions

枚举

对存储帐户的权限

值	说明
all
backup
delete
deletesas
get
getsas
list
listsas
purge
recover
regeneratekey
restore
set
setsas
update

SystemData

Object

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

名称	类型	说明
createdAt	string (date-time)	密钥保管库资源创建（UTC）的时间戳。
createdBy	string	创建密钥保管库资源的标识。
createdByType	identityType	创建密钥保管库资源的标识类型。
lastModifiedAt	string (date-time)	Key Vault 资源上次修改的时间戳（UTC）。
lastModifiedBy	string	上次修改密钥保管库资源的标识。
lastModifiedByType	identityType	上次修改密钥保管库资源的标识类型。

Vault

Object

具有扩展详细信息的资源信息。

名称	类型	说明
id	string	密钥保管库资源的完全限定标识符。
location	string	密钥保管库资源的 Azure 位置。
name	string	密钥保管库资源的名称。
properties	VaultProperties	保管库的属性
systemData	SystemData	密钥保管库的系统元数据。
tags	object	分配给密钥保管库资源的标记。
type	string	密钥保管库资源的资源类型。

VaultListResult

Object

保管库列表

名称	类型	说明
nextLink	string	用于获取下一组保管库的 URL。
value	Vault[]	保管库列表。

VaultProperties

Object

保管库的属性

名称	类型	默认值	说明
accessPolicies	AccessPolicyEntry[]		有权访问密钥保管库的 0 到 1024 标识的数组。数组中的所有标识都必须使用与密钥保管库租户 ID 相同的租户 ID。当 `createMode` 设置为 `recover`时，不需要访问策略。否则，需要访问策略。
createMode	CreateMode		保管库的创建模式，用于指示是否需要恢复保管库。
enablePurgeProtection	boolean		指定是否为此保管库启用了针对清除的保护的属性。将此属性设置为 true 可激活针对此保管库及其内容的清除保护 - 只有 Key Vault 服务可能会启动难以、不可恢复的删除。仅当启用软删除时，此设置才有效。启用此功能不可逆 - 也就是说，属性不接受 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 (int32)	90	softDelete 数据保留天数。它接受 >=7，<=90。
tenantId	string (uuid)		应用于对密钥保管库的请求进行身份验证的 Azure Active Directory 租户 ID。
vaultUri	string		用于对密钥和机密执行作的保管库的 URI。

VaultProvisioningState

枚举

保管库的预配状态。

值	说明
RegisteringDns
Succeeded

VirtualNetworkRule

Object

一个规则，用于控制来自特定虚拟网络的保管库的可访问性。

名称	类型	说明
id	string	vnet 子网的完整资源 ID，例如“/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1”。
ignoreMissingVnetServiceEndpoint	boolean	用于指定 NRP 是否将忽略检查父子网是否配置 serviceEndpoints 的属性。

通过

Vaults - List By Resource Group

URI 参数

响应

示例

List vaults in the specified resource group

示例请求

示例响应

定义

AccessPolicyEntry

ActionsRequired

CertificatePermissions

CloudError

CloudErrorBody

CreateMode

identityType

IPRule

KeyPermissions

NetworkRuleAction

NetworkRuleBypassOptions

NetworkRuleSet

Permissions

PrivateEndpoint

PrivateEndpointConnectionItem

PrivateEndpointConnectionProvisioningState

PrivateEndpointServiceConnectionStatus

PrivateLinkServiceConnectionState

SecretPermissions

Sku

SkuFamily

SkuName

StoragePermissions

SystemData

Vault

VaultListResult

VaultProperties

VaultProvisioningState

VirtualNetworkRule

其他资源