MHSM Private Endpoint Connections - List By Resource

Referensi

Layanan:: Key Vault

Versi API:: 2022-07-01

Operasi Daftar mendapatkan informasi tentang koneksi titik akhir privat yang terkait dengan Kumpulan HSM terkelola.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
name	path	True	string	Nama Kumpulan HSM terkelola
resourceGroupName	path	True	string	Nama grup sumber daya yang berisi kumpulan HSM terkelola.
subscriptionId	path	True	string	Kredensial langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.
api-version	query	True	string	Versi Api Klien.

Respons

Nama	Jenis	Deskripsi
200 OK	MHSMPrivateEndpointConnectionsListResult	Dapatkan informasi tentang semua Kumpulan HSM terkelola dalam langganan yang ditentukan.
Other Status Codes	ManagedHsmError	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

List managed HSM Pools in a subscription

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

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

Respon sampel

Kode status:: 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
}

Definisi

Nama	Deskripsi
ActionsRequired	Pesan yang menunjukkan apakah perubahan pada penyedia layanan memerlukan pembaruan pada konsumen.
Error	Kesalahan server.
identityType	Jenis identitas yang membuat sumber daya brankas kunci.
ManagedHsmError	Pengecualian kesalahan.
ManagedHsmSku	Detail SKU
ManagedHsmSkuFamily	Keluarga SKU dari Kumpulan HSM terkelola
ManagedHsmSkuName	SKU kumpulan HSM terkelola
MHSMPrivateEndpoint	Properti objek titik akhir privat.
MHSMPrivateEndpointConnection	Sumber daya koneksi titik akhir privat.
MHSMPrivateEndpointConnectionsListResult	Daftar koneksi titik akhir privat yang terkait dengan Kumpulan HSM terkelola
MHSMPrivateLinkServiceConnectionState	Objek yang mewakili status persetujuan koneksi tautan privat.
PrivateEndpointConnectionProvisioningState	Status penyediaan koneksi titik akhir privat.
PrivateEndpointServiceConnectionStatus	Menunjukkan apakah koneksi telah disetujui, ditolak, atau dihapus oleh pemilik brankas kunci.
SystemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya brankas kunci.

ActionsRequired

Pesan yang menunjukkan apakah perubahan pada penyedia layanan memerlukan pembaruan pada konsumen.

Nama	Jenis	Deskripsi
None	string

Error

Kesalahan server.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan.
innererror	Error	Kesalahan dalam, berisi kode kesalahan yang lebih spesifik.
message	string	Pesan kesalahan.

identityType

Jenis identitas yang membuat sumber daya brankas kunci.

Nama	Jenis	Deskripsi
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsmError

Pengecualian kesalahan.

Nama	Jenis	Deskripsi
error	Error	Kesalahan server.

ManagedHsmSku

Detail SKU

Nama	Jenis	Deskripsi
family	ManagedHsmSkuFamily	Keluarga SKU dari Kumpulan HSM terkelola
name	ManagedHsmSkuName	SKU kumpulan HSM terkelola

ManagedHsmSkuFamily

Keluarga SKU dari Kumpulan HSM terkelola

Nama	Jenis	Deskripsi
B	string

ManagedHsmSkuName

SKU kumpulan HSM terkelola

Nama	Jenis	Deskripsi
Custom_B32	string
Custom_B6	string
Standard_B1	string