MHSM Private Endpoint Connections - List By Resource

サービス:

Key Vault

API バージョン:

2022-07-01

List 操作は、マネージド HSM プールに関連付けられているプライベート エンドポイント接続に関する情報を取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/managedHSMs/{name}/privateEndpointConnections?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	MHSMPrivateEndpointConnectionsListResult	指定したサブスクリプション内のすべてのマネージド HSM プールに関する情報を取得します。
Other Status Codes	ManagedHsmError	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

List managed HSM Pools in a subscription

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedHSMs/sample-mhsm/privateEndpointConnections?api-version=2022-07-01

Python

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_endpoint_connections_by_resource.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_endpoint_connections.list_by_resource(
        resource_group_name="sample-group",
        name="sample-mhsm",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/ManagedHsm_ListPrivateEndpointConnectionsByResource.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/managedhsms/sample-mhsm/privateEndpointConnections/sample-pec1",
      "name": "sample-pec1",
      "type": "Microsoft.KeyVault/managedhsms/privateEndpointConnections",
      "etag": "",
      "properties": {
        "provisioningState": "Succeeded",
        "privateEndpoint": {
          "id": "/subscriptions/00000000-0000-0000-1234-000000000000/resourceGroups/sample-group/providers/Microsoft.Network/privateEndpoints/sample-pe1"
        },
        "privateLinkServiceConnectionState": {
          "status": "Approved",
          "description": "This was automatically approved by user1234@contoso.com",
          "actionsRequired": "None"
        }
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedhsms/sample-mhsm/privateEndpointConnections/sample-pec2",
      "name": "sample-pec2",
      "type": "Microsoft.KeyVault/managedhsms/privateEndpointConnections",
      "etag": "",
      "properties": {
        "provisioningState": "Succeeded",
        "privateEndpoint": {
          "id": "/subscriptions/00000000-0000-0000-1234-000000000000/resourceGroups/sample-group/providers/Microsoft.Network/privateEndpoints/sample-pe2"
        },
        "privateLinkServiceConnectionState": {
          "status": "Approved",
          "description": "This was automatically approved by user1234@contoso.com",
          "actionsRequired": "None"
        }
      }
    }
  ],
  "nextLink": null
}

定義

名前	説明
ActionsRequired	サービス プロバイダーの変更にコンシューマーの更新が必要かどうかを示すメッセージ。
Error	サーバー エラー。
identityType	キー コンテナー リソースを作成した ID の種類。
ManagedHsmError	エラー例外。
ManagedHsmSku	SKU の詳細
ManagedHsmSkuFamily	マネージド HSM プールの SKU ファミリ
ManagedHsmSkuName	マネージド HSM プールの SKU
MHSMPrivateEndpoint	プライベート エンドポイント オブジェクトのプロパティ。
MHSMPrivateEndpointConnection	プライベート エンドポイント接続リソース。
MHSMPrivateEndpointConnectionsListResult	マネージド HSM プールに関連付けられているプライベート エンドポイント接続の一覧
MHSMPrivateLinkServiceConnectionState	プライベート リンク接続の承認状態を表すオブジェクト。
PrivateEndpointConnectionProvisioningState	プライベート エンドポイント接続のプロビジョニング状態。
PrivateEndpointServiceConnectionStatus	キー コンテナーの所有者によって接続が承認、拒否、または削除されたかどうかを示します。
SystemData	キー コンテナー リソースの作成と最後の変更に関連するメタデータ。

ActionsRequired

列挙

サービス プロバイダーの変更にコンシューマーの更新が必要かどうかを示すメッセージ。

値	説明
None

Error

Object

サーバー エラー。

名前	型	説明
code	string	エラー コード。
innererror	Error	内部エラーには、より具体的なエラー コードが含まれています。
message	string	エラー メッセージ。

identityType

列挙

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

値	説明
Application
Key
ManagedIdentity
User

ManagedHsmError

Object

エラー例外。

名前	型	説明
error	Error	サーバー エラー。

ManagedHsmSku

Object

SKU の詳細

名前	型	説明
family	ManagedHsmSkuFamily	マネージド HSM プールの SKU ファミリ
name	ManagedHsmSkuName	マネージド HSM プールの SKU

ManagedHsmSkuFamily

列挙

マネージド HSM プールの SKU ファミリ

値	説明
B

ManagedHsmSkuName

列挙

マネージド HSM プールの SKU

値	説明
Custom_B32
Custom_B6
Standard_B1

MHSMPrivateEndpoint

Object

プライベート エンドポイント オブジェクトのプロパティ。

名前	型	説明
id	string	プライベート エンドポイント リソースの完全な識別子。

MHSMPrivateEndpointConnection

Object

プライベート エンドポイント接続リソース。

名前	型	説明
etag	string	プライベート エンドポイント接続の状態が変更されるたびに変更されます。
id	string	マネージド HSM プールの Azure Resource Manager リソース ID。
location	string	マネージド HSM プールを作成する必要がある、サポートされている Azure の場所。
name	string	マネージド HSM プールの名前。
properties.privateEndpoint	MHSMPrivateEndpoint	プライベート エンドポイント オブジェクトのプロパティ。
properties.privateLinkServiceConnectionState	MHSMPrivateLinkServiceConnectionState	プライベート リンク接続の承認状態。
properties.provisioningState	PrivateEndpointConnectionProvisioningState	プライベート エンドポイント接続のプロビジョニング状態。
sku	ManagedHsmSku	SKU の詳細
systemData	SystemData	キー コンテナー リソースの作成と最後の変更に関連するメタデータ。
tags	object	リソース タグ
type	string	マネージド HSM プールのリソースの種類。

MHSMPrivateEndpointConnectionsListResult

Object

マネージド HSM プールに関連付けられているプライベート エンドポイント接続の一覧

名前	型	説明
nextLink	string	マネージド HSM プールの次のセットを取得する URL。
value	MHSMPrivateEndpointConnection[]	マネージド HSM プールに関連付けられているプライベート エンドポイント接続。

MHSMPrivateLinkServiceConnectionState

Object

プライベート リンク接続の承認状態を表すオブジェクト。

名前	型	説明
actionsRequired	ActionsRequired	サービス プロバイダーの変更にコンシューマーの更新が必要かどうかを示すメッセージ。
description	string	承認または拒否の理由。
status	PrivateEndpointServiceConnectionStatus	キー コンテナーの所有者によって接続が承認、拒否、または削除されたかどうかを示します。

PrivateEndpointConnectionProvisioningState

列挙

プライベート エンドポイント接続のプロビジョニング状態。

値	説明
Creating
Deleting
Disconnected
Failed
Succeeded
Updating

PrivateEndpointServiceConnectionStatus

列挙

キー コンテナーの所有者によって接続が承認、拒否、または削除されたかどうかを示します。

値	説明
Approved
Disconnected
Pending
Rejected

SystemData

Object

キー コンテナー リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	キー コンテナー リソースの作成 (UTC) のタイムスタンプ。
createdBy	string	キー コンテナー リソースを作成した ID。
createdByType	identityType	キー コンテナー リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	キー コンテナー リソースの最終変更 (UTC) のタイムスタンプ。
lastModifiedBy	string	キー コンテナー リソースを最後に変更した ID。
lastModifiedByType	identityType	キー コンテナー リソースを最後に変更した ID の種類。