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 參數

名稱	位於	必要	類型	Description
name	path	True	string	受控 HSM 集區的名稱
resourceGroupName	path	True	string	包含受控 HSM 集區的資源群組名稱。
subscriptionId	path	True	string	可唯一識別 Microsoft Azure 訂用帳戶的訂用帳戶認證。訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。
api-version	query	True	string	用戶端 API 版本。

回應

名稱	類型	Description
200 OK	MHSMPrivateLinkResourceListResult	已成功擷取私人鏈接資源。
Other Status Codes	CloudError	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
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"
        ]
      }
    }
  ]
}

定義

名稱	Description
CloudError	來自金鑰保存庫資源提供者的錯誤回應
CloudErrorBody	來自金鑰保存庫資源提供者的錯誤回應
identityType	建立金鑰保存庫資源的身分識別類型。
ManagedHsmSku	SKU 詳細資料
ManagedHsmSkuFamily	受控 HSM 集區的 SKU 系列
ManagedHsmSkuName	受控 HSM 集區的 SKU
MHSMPrivateLinkResource	私人鏈接資源
MHSMPrivateLinkResourceListResult	私人鏈接資源清單
SystemData	與金鑰保存庫資源建立和上次修改相關的元數據。

CloudError

來自金鑰保存庫資源提供者的錯誤回應

名稱	類型	Description
error	CloudErrorBody	來自金鑰保存庫資源提供者的錯誤回應

CloudErrorBody

來自金鑰保存庫資源提供者的錯誤回應

名稱	類型	Description
code	string	錯誤碼。這是可透過程序設計方式取用的助記鍵。
message	string	使用者易記的錯誤訊息。訊息通常會當地語系化，而且可能會隨服務版本而有所不同。

identityType

建立金鑰保存庫資源的身分識別類型。

名稱	類型	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsmSku

SKU 詳細資料

名稱	類型	Description
family	ManagedHsmSkuFamily	受控 HSM 集區的 SKU 系列
name	ManagedHsmSkuName	受控 HSM 集區的 SKU

ManagedHsmSkuFamily

受控 HSM 集區的 SKU 系列

名稱	類型	Description
B	string

ManagedHsmSkuName

受控 HSM 集區的 SKU

名稱	類型	Description
Custom_B32	string
Custom_B6	string
Standard_B1	string

MHSMPrivateLinkResource

私人鏈接資源

名稱	類型	Description
id	string	受控 HSM 集區的 Azure Resource Manager 資源識別碼。
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

私人鏈接資源清單

名稱	類型	Description
value	MHSMPrivateLinkResource[]	私人鏈接資源的陣列

SystemData

與金鑰保存庫資源建立和上次修改相關的元數據。

名稱	類型	Description
createdAt	string	金鑰保存庫資源建立 (UTC) 的時間戳。
createdBy	string	建立金鑰保存庫資源的身分識別。
createdByType	identityType	建立金鑰保存庫資源的身分識別類型。
lastModifiedAt	string	上次修改金鑰保存庫資源的時間戳 (UTC) 。
lastModifiedBy	string	上次修改金鑰保存庫資源的身分識別。
lastModifiedByType	identityType	上次修改金鑰保存庫資源的身分識別類型。

共用方式為