Udostępnij za pośrednictwem


MHSM Private Endpoint Connections - List By Resource

Operacja Lista pobiera informacje o połączeniach prywatnego punktu końcowego skojarzonych z zarządzaną pulą modułów HSM.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
name
path True

string

Nazwa zarządzanej puli modułów HSM

resourceGroupName
path True

string

Nazwa grupy zasobów zawierającej zarządzaną pulę modułów HSM.

subscriptionId
path True

string

Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.

api-version
query True

string

Wersja interfejsu API klienta.

Odpowiedzi

Nazwa Typ Opis
200 OK

MHSMPrivateEndpointConnectionsListResult

Uzyskaj informacje o wszystkich zarządzanych pulach modułów HSM w określonej subskrypcji.

Other Status Codes

ManagedHsmError

Odpowiedź o błędzie opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

List managed HSM Pools in a subscription

Przykładowe żądanie

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

Przykładowa odpowiedź

{
  "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
}

Definicje

Nazwa Opis
ActionsRequired

Komunikat wskazujący, czy zmiany dostawcy usług wymagają aktualizacji dla konsumenta.

Error

Błąd serwera.

identityType

Typ tożsamości, która utworzyła zasób magazynu kluczy.

ManagedHsmError

Wyjątek błędu.

ManagedHsmSku

Szczegóły jednostki SKU

ManagedHsmSkuFamily

Rodzina jednostek SKU zarządzanej puli modułów HSM

ManagedHsmSkuName

Jednostka SKU zarządzanej puli modułów HSM

MHSMPrivateEndpoint

Właściwości obiektu prywatnego punktu końcowego.

MHSMPrivateEndpointConnection

Zasób połączenia prywatnego punktu końcowego.

MHSMPrivateEndpointConnectionsListResult

Lista połączeń prywatnych punktów końcowych skojarzonych z zarządzanymi pulami modułów HSM

MHSMPrivateLinkServiceConnectionState

Obiekt reprezentujący stan zatwierdzenia połączenia łącza prywatnego.

PrivateEndpointConnectionProvisioningState

Stan aprowizacji połączenia prywatnego punktu końcowego.

PrivateEndpointServiceConnectionStatus

Wskazuje, czy połączenie zostało zatwierdzone, odrzucone lub usunięte przez właściciela magazynu kluczy.

SystemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu magazynu kluczy.

ActionsRequired

Komunikat wskazujący, czy zmiany dostawcy usług wymagają aktualizacji dla konsumenta.

Nazwa Typ Opis
None

string

Error

Błąd serwera.

Nazwa Typ Opis
code

string

Kod błędu.

innererror

Error

Wewnętrzny błąd zawiera bardziej szczegółowy kod błędu.

message

string

Komunikat o błędzie.

identityType

Typ tożsamości, która utworzyła zasób magazynu kluczy.

Nazwa Typ Opis
Application

string

Key

string

ManagedIdentity

string

User

string

ManagedHsmError

Wyjątek błędu.

Nazwa Typ Opis
error

Error

Błąd serwera.

ManagedHsmSku

Szczegóły jednostki SKU

Nazwa Typ Opis
family

ManagedHsmSkuFamily

Rodzina jednostek SKU zarządzanej puli modułów HSM

name

ManagedHsmSkuName

Jednostka SKU zarządzanej puli modułów HSM

ManagedHsmSkuFamily

Rodzina jednostek SKU zarządzanej puli modułów HSM

Nazwa Typ Opis
B

string

ManagedHsmSkuName

Jednostka SKU zarządzanej puli modułów HSM

Nazwa Typ Opis
Custom_B32

string

Custom_B6

string

Standard_B1

string

MHSMPrivateEndpoint

Właściwości obiektu prywatnego punktu końcowego.

Nazwa Typ Opis
id

string

Pełny identyfikator zasobu prywatnego punktu końcowego.

MHSMPrivateEndpointConnection

Zasób połączenia prywatnego punktu końcowego.

Nazwa Typ Opis
etag

string

Zmodyfikowane za każdym razem, gdy wystąpi zmiana stanu połączenia prywatnego punktu końcowego.

id

string

Identyfikator zasobu usługi Azure Resource Manager dla zarządzanej puli modułów HSM.

location

string

Obsługiwana lokalizacja platformy Azure, w której powinna zostać utworzona zarządzana pula modułów HSM.

name

string

Nazwa zarządzanej puli modułów HSM.

properties.privateEndpoint

MHSMPrivateEndpoint

Właściwości obiektu prywatnego punktu końcowego.

properties.privateLinkServiceConnectionState

MHSMPrivateLinkServiceConnectionState

Stan zatwierdzenia połączenia z łączem prywatnym.

properties.provisioningState

PrivateEndpointConnectionProvisioningState

Stan aprowizacji połączenia prywatnego punktu końcowego.

sku

ManagedHsmSku

Szczegóły jednostki SKU

systemData

SystemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu magazynu kluczy.

tags

object

Tagi zasobów

type

string

Typ zasobu zarządzanej puli modułów HSM.

MHSMPrivateEndpointConnectionsListResult

Lista połączeń prywatnych punktów końcowych skojarzonych z zarządzanymi pulami modułów HSM

Nazwa Typ Opis
nextLink

string

Adres URL umożliwiający pobranie następnego zestawu zarządzanych pul modułów HSM.

value

MHSMPrivateEndpointConnection[]

Połączenie prywatnego punktu końcowego skojarzone z zarządzanymi pulami modułów HSM.

MHSMPrivateLinkServiceConnectionState

Obiekt reprezentujący stan zatwierdzenia połączenia łącza prywatnego.

Nazwa Typ Opis
actionsRequired

ActionsRequired

Komunikat wskazujący, czy zmiany dostawcy usług wymagają aktualizacji dla konsumenta.

description

string

Przyczyna zatwierdzenia lub odrzucenia.

status

PrivateEndpointServiceConnectionStatus

Wskazuje, czy połączenie zostało zatwierdzone, odrzucone lub usunięte przez właściciela magazynu kluczy.

PrivateEndpointConnectionProvisioningState

Stan aprowizacji połączenia prywatnego punktu końcowego.

Nazwa Typ Opis
Creating

string

Deleting

string

Disconnected

string

Failed

string

Succeeded

string

Updating

string

PrivateEndpointServiceConnectionStatus

Wskazuje, czy połączenie zostało zatwierdzone, odrzucone lub usunięte przez właściciela magazynu kluczy.

Nazwa Typ Opis
Approved

string

Disconnected

string

Pending

string

Rejected

string

SystemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu magazynu kluczy.

Nazwa Typ Opis
createdAt

string

Sygnatura czasowa tworzenia zasobów magazynu kluczy (UTC).

createdBy

string

Tożsamość, która utworzyła zasób magazynu kluczy.

createdByType

identityType

Typ tożsamości, która utworzyła zasób magazynu kluczy.

lastModifiedAt

string

Sygnatura czasowa ostatniej modyfikacji zasobu magazynu kluczy (UTC).

lastModifiedBy

string

Tożsamość, która ostatnio zmodyfikowała zasób magazynu kluczy.

lastModifiedByType

identityType

Typ tożsamości, która ostatnio zmodyfikowała zasób magazynu kluczy.