MHSM Private Endpoint Connections - Get

Referenz

Dienst:: Key Vault

API-Version:: 2022-07-01

Ruft die angegebene private Endpunktverbindung ab, die dem verwalteten HSM-Pool zugeordnet ist.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
name	path	True	string	Name des verwalteten HSM-Pools
privateEndpointConnectionName	path	True	string	Name der privaten Endpunktverbindung, die dem verwalteten HSM-Pool zugeordnet ist.
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	MHSMPrivateEndpointConnection	Die private Endpunktverbindung wurde erfolgreich zurückgegeben.
Other Status Codes	ManagedHsmError	Die Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

ManagedHsmGetPrivateEndpointConnection

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedHSMs/sample-mhsm/privateEndpointConnections/sample-pec?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_get_private_endpoint_connection.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.get(
        resource_group_name="sample-group",
        name="sample-mhsm",
        private_endpoint_connection_name="sample-pec",
    )
    print(response)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/ManagedHsm_getPrivateEndpointConnection.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

Beispiel für eine Antwort

Statuscode:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedhsms/sample-mhsm/privateEndpointConnections/sample-pec",
  "name": "sample-pec",
  "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-pe"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "This was automatically approved by user1234@contoso.com",
      "actionsRequired": "None"
    }
  }
}

Definitionen

Name	Beschreibung
ActionsRequired	Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Verbraucher erfordern.
Error	Der Serverfehler.
identityType	Der Identitätstyp, der die Schlüsseltresorressource erstellt hat.
ManagedHsmError	Die Fehler ausnahme.
ManagedHsmSku	SKU-Details
ManagedHsmSkuFamily	SKU-Familie des verwalteten HSM-Pools
ManagedHsmSkuName	SKU des verwalteten HSM-Pools
MHSMPrivateEndpoint	Eigenschaften des privaten Endpunktobjekts.
MHSMPrivateEndpointConnection	Private Endpunktverbindungsressource.
MHSMPrivateLinkServiceConnectionState	Ein Objekt, das den Genehmigungsstatus der privaten Verknüpfungsverbindung darstellt.
PrivateEndpointConnectionProvisioningState	Bereitstellungsstatus der privaten Endpunktverbindung.
PrivateEndpointServiceConnectionStatus	Gibt an, ob die Verbindung vom Schlüsseltresorbesitzer genehmigt, abgelehnt oder entfernt wurde.
SystemData	Metadaten zur Erstellung und letzten Änderung der Schlüsseltresorressource.

ActionsRequired

Enumeration

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

Wert	Beschreibung
None

Error

Objekt

Der Serverfehler.

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

identityType

Enumeration

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

Wert	Beschreibung
Application
Key
ManagedIdentity
User

ManagedHsmError

Objekt

Die Fehler ausnahme.

Name	Typ	Beschreibung
error	Error	Der Serverfehler.

ManagedHsmSku

Objekt

SKU-Details

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

ManagedHsmSkuFamily

Enumeration

SKU-Familie des verwalteten HSM-Pools

Wert	Beschreibung
B

ManagedHsmSkuName

Enumeration

SKU des verwalteten HSM-Pools

Wert	Beschreibung
Custom_B32
Custom_B6
Standard_B1