MHSM Private Endpoint Connections - List By Resource

Referenz

Service:: Key Vault

API Version:: 2022-07-01

Der List-Vorgang ruft Informationen zu den privaten Endpunktverbindungen ab, die dem verwalteten HSM-Pool zugeordnet sind.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
name	path	True	string	Name des verwalteten HSM-Pools
resourceGroupName	path	True	string	Name der Ressourcengruppe, die den verwalteten HSM-Pool enthält.
subscriptionId	path	True	string	Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Client-API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	MHSMPrivateEndpointConnectionsListResult	Rufen Sie Informationen zu allen verwalteten HSM-Pools im angegebenen Abonnement ab.
Other Status Codes	ManagedHsmError	Die Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

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

Sample Response

Status code:: 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
}

Definitionen

Name	Beschreibung
ActionsRequired	Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Consumer erfordern.
Error	Der Serverfehler.
identityType	Der Identitätstyp, der die Schlüsseltresorressource erstellt hat.
ManagedHsmError	Die Fehlerausnahme.
ManagedHsmSku	SKU-Details
ManagedHsmSkuFamily	SKU-Familie des verwalteten HSM-Pools
ManagedHsmSkuName	SKU des verwalteten HSM-Pools
MHSMPrivateEndpoint	Eigenschaften des privaten Endpunktobjekts.
MHSMPrivateEndpointConnection	Verbindungsressource für private Endpunkte.
MHSMPrivateEndpointConnectionsListResult	Liste der privaten Endpunktverbindungen, die einem verwalteten HSM-Pool zugeordnet sind
MHSMPrivateLinkServiceConnectionState	Ein -Objekt, das den Genehmigungsstatus der Private Link-Verbindung darstellt.
PrivateEndpointConnectionProvisioningState	Bereitstellungsstatus der Verbindung mit dem privaten Endpunkt.
PrivateEndpointServiceConnectionStatus	Gibt an, ob die Verbindung vom Besitzer des Schlüsseltresors genehmigt, abgelehnt oder entfernt wurde.
SystemData	Metadaten zur Erstellung und letzten Änderung der Schlüsseltresorressource.

ActionsRequired

Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Consumer erfordern.

Name	Typ	Beschreibung
None	string

Error

Der Serverfehler.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
innererror	Error	Der innere Fehler enthält einen spezifischeren Fehlercode.
message	string	Die Fehlermeldung.

identityType

Der Identitätstyp, der die Schlüsseltresorressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsmError

Die Fehlerausnahme.

Name	Typ	Beschreibung
error	Error	Der Serverfehler.

ManagedHsmSku

SKU-Details

Name	Typ	Beschreibung
family	ManagedHsmSkuFamily	SKU-Familie des verwalteten HSM-Pools
name	ManagedHsmSkuName	SKU des verwalteten HSM-Pools

ManagedHsmSkuFamily

SKU-Familie des verwalteten HSM-Pools

Name	Typ	Beschreibung
B	string

ManagedHsmSkuName

SKU des verwalteten HSM-Pools

Name	Typ	Beschreibung
Custom_B32	string
Custom_B6	string
Standard_B1	string