MHSM Private Link Resources - List By MHSM Resource

リファレンス

Service:: Key Vault

API Version:: 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 フロー

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前	説明
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

Sample Response

Status code:: 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	リソースプロバイダーからのエラー応答Key Vault
CloudErrorBody	リソースプロバイダーからのエラー応答Key Vault
identityType	キーコンテナーリソースを作成した ID の種類。
ManagedHsmSku	SKU の詳細
ManagedHsmSkuFamily	マネージド HSM プールの SKU ファミリ
ManagedHsmSkuName	マネージド HSM プールの SKU
MHSMPrivateLinkResource	プライベートリンクリソース
MHSMPrivateLinkResourceListResult	プライベートリンクリソースの一覧
SystemData	キーコンテナーリソースの作成と最後の変更に関連するメタデータ。

CloudError

リソースプロバイダーからのエラー応答Key Vault

名前	型	説明
error	CloudErrorBody	リソースプロバイダーからのエラー応答Key Vault

CloudErrorBody

リソースプロバイダーからのエラー応答Key Vault

名前	型	説明
code	string	エラーコード。これは、プログラムで使用できるニーモニックです。
message	string	ユーザーフレンドリなエラーメッセージ。通常、メッセージはローカライズされ、サービスのバージョンによって異なる場合があります。

identityType

キーコンテナーリソースを作成した ID の種類。

名前	型	説明
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 Resource Manager リソース 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	キーコンテナーリソースを作成した ID。
createdByType	identityType	キーコンテナーリソースを作成した ID の種類。
lastModifiedAt	string	キーコンテナーリソースの最終変更 (UTC) のタイムスタンプ。
lastModifiedBy	string	キーコンテナーリソースを最後に変更した ID。
lastModifiedByType	identityType	キーコンテナーリソースを最後に変更した ID の種類。