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

MHSM Private Link Resources - List By MHSM Resource

参考

服务:: Key Vault

API 版本:: 2022-07-01

获取托管 hsm 池支持的专用链接资源。

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

URI 参数

名称	在	必需	类型	说明
name	path	True	string	托管 HSM 池的名称
resourceGroupName	path	True	string	包含托管 HSM 池的资源组的名称。
subscriptionId	path	True	string	唯一标识 Microsoft Azure 订阅的订阅凭据。此订阅 ID 是每个服务调用的 URI 的一部分。
api-version	query	True	string	客户端 API 版本。

响应

名称	类型	说明
200 OK	MHSMPrivateLinkResourceListResult	已成功检索专用链接资源。
Other Status Codes	CloudError	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

KeyVaultListPrivateLinkResources

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedHSMs/sample-mhsm/privateLinkResources?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 managed_hsm_list_private_link_resources.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.mhsm_private_link_resources.list_by_mhsm_resource(
        resource_group_name="sample-group",
        name="sample-mhsm",
    )
    print(response)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/ManagedHsm_listPrivateLinkResources.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-resource-group/providers/Microsoft.KeyVault/managedhsms/sample-mhsm/privateLinkResources/managedhsm",
      "name": "managedhsm",
      "type": "Microsoft.KeyVault/managedhsms/privateLinkResources",
      "properties": {
        "groupId": "managedhsms",
        "requiredMembers": [
          "default"
        ],
        "requiredZoneNames": [
          "privatelink.managedhsm.azure.net"
        ]
      }
    }
  ]
}

定义

名称	说明
CloudError	密钥保管库资源提供程序的错误响应
CloudErrorBody	密钥保管库资源提供程序的错误响应
identityType	创建密钥保管库资源的标识类型。
ManagedHsmSku	SKU 详细信息
ManagedHsmSkuFamily	托管 HSM 池的 SKU 系列
ManagedHsmSkuName	托管 HSM 池的 SKU
MHSMPrivateLinkResource	专用链接资源
MHSMPrivateLinkResourceListResult	专用链接资源列表
SystemData	与密钥保管库资源的创建和上次修改相关的元数据。

CloudError

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

名称	类型	说明
error	CloudErrorBody	密钥保管库资源提供程序的错误响应

CloudErrorBody

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

名称	类型	说明
code	string	错误代码。这是可以编程方式使用的助记键。
message	string	用户友好的错误消息。消息通常是本地化的，可能因服务版本而异。

identityType

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

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsmSku

SKU 详细信息

名称	类型	说明
family	ManagedHsmSkuFamily	托管 HSM 池的 SKU 系列
name	ManagedHsmSkuName	托管 HSM 池的 SKU

ManagedHsmSkuFamily

托管 HSM 池的 SKU 系列

名称	类型	说明
B	string

ManagedHsmSkuName

托管 HSM 池的 SKU

名称	类型	说明
Custom_B32	string
Custom_B6	string
Standard_B1	string

MHSMPrivateLinkResource

专用链接资源

名称	类型	说明
id	string	托管 HSM 池的 Azure 资源管理器资源 ID。
location	string	应在其中创建托管 HSM 池的受支持 Azure 位置。
name	string	托管 HSM 池的名称。
properties.groupId	string	专用链接资源的组标识符。
properties.requiredMembers	string[]	专用链接资源的必需成员名称。
properties.requiredZoneNames	string[]	专用链接资源的所需 DNS 区域名称。
sku	ManagedHsmSku	SKU 详细信息
systemData	SystemData	与密钥保管库资源的创建和上次修改相关的元数据。
tags	object	资源标记
type	string	托管 HSM 池的资源类型。

MHSMPrivateLinkResourceListResult

专用链接资源列表

名称	类型	说明
value	MHSMPrivateLinkResource[]	专用链接资源的数组

SystemData

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

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

通过