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 Tresor zugeordnet sind.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Der Name der Ressourcengruppe, die den Schlüsseltresor 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.
vaultName	path	True	string	Der Name des Schlüsseltresors. Regex pattern: `^[a-zA-Z0-9-]{3,24}$`
api-version	query	True	string	Client-API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	PrivateEndpointConnectionListResult	Rufen Sie Informationen zu allen verbindungen des privaten Endpunkts in der angegebenen Ressourcengruppe ab.
Other Status Codes	CloudError	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Beispiele

KeyVaultListPrivateEndpointConnection

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/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 list_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.private_endpoint_connections.list_by_resource(
        resource_group_name="sample-group",
        vault_name="sample-vault",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/listPrivateEndpointConnection.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/vaults/sample-vault/privateEndpointConnections/sample-pec",
      "name": "sample-pec",
      "type": "Microsoft.KeyVault/vaults/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"
        }
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/privateEndpointConnections/sample-pec",
      "name": "sample-pec",
      "type": "Microsoft.KeyVault/vaults/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"
        }
      }
    }
  ],
  "nextLink": null
}

Definitionen

Name	Beschreibung
ActionsRequired	Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Consumer erfordern.
CloudError	Eine Fehlerantwort von Key Vault Ressourcenanbieter
CloudErrorBody	Eine Fehlerantwort von Key Vault Ressourcenanbieter
PrivateEndpoint	Eigenschaften des privaten Endpunktobjekts.
PrivateEndpointConnection	Verbindungsressource für private Endpunkte.
PrivateEndpointConnectionListResult	Liste der Verbindungen mit privaten Endpunkten.
PrivateEndpointConnectionProvisioningState	Der aktuelle Bereitstellungsstatus.
PrivateEndpointServiceConnectionStatus	Die private Endpunktverbindung status.
PrivateLinkServiceConnectionState	Ein -Objekt, das den Genehmigungsstatus der Private Link-Verbindung darstellt.

ActionsRequired

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

Name	Typ	Beschreibung
None	string

CloudError

Eine Fehlerantwort von Key Vault Ressourcenanbieter

Name	Typ	Beschreibung
error	CloudErrorBody	Eine Fehlerantwort von Key Vault Ressourcenanbieter

CloudErrorBody

Eine Fehlerantwort von Key Vault Ressourcenanbieter

Name	Typ	Beschreibung
code	string	Fehlercode Dies ist ein mnemonisches, das programmgesteuert genutzt werden kann.
message	string	Benutzerfreundliche Fehlermeldung. Die Nachricht ist in der Regel lokalisiert und kann je nach Dienstversion variieren.

PrivateEndpoint

Eigenschaften des privaten Endpunktobjekts.

Name	Typ	Beschreibung
id	string	Vollständiger Bezeichner der privaten Endpunktressource.

PrivateEndpointConnection

Verbindungsressource für private Endpunkte.

Name	Typ	Beschreibung
etag	string	Wird immer dann geändert, wenn sich der Status der Verbindung mit privaten Endpunkten ändert.
id	string	Vollqualifizierter Bezeichner der Schlüsseltresorressource.
location	string	Azure-Speicherort der Schlüsseltresorressource.
name	string	Name der Schlüsseltresorressource.
properties.privateEndpoint	PrivateEndpoint	Eigenschaften des privaten Endpunktobjekts.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Genehmigungsstatus der Verbindung mit privatem Link.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Bereitstellungsstatus der privaten Endpunktverbindung.
tags	object	Tags, die der Schlüsseltresorressource zugewiesen sind.
type	string	Ressourcentyp der Schlüsseltresorressource.

PrivateEndpointConnectionListResult

Liste der Verbindungen mit privaten Endpunkten.

Name	Typ	Beschreibung
nextLink	string	Die URL, um den nächsten Satz privater Endpunktverbindungen abzurufen.
value	PrivateEndpointConnection[]	Die Liste der Verbindungen mit privaten Endpunkten.

PrivateEndpointConnectionProvisioningState

Der aktuelle Bereitstellungsstatus.

Name	Typ	Beschreibung
Creating	string
Deleting	string
Disconnected	string
Failed	string
Succeeded	string
Updating	string

PrivateEndpointServiceConnectionStatus

Die private Endpunktverbindung status.

Name	Typ	Beschreibung
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Ein -Objekt, das den Genehmigungsstatus der Private Link-Verbindung darstellt.

Name	Typ	Beschreibung
actionsRequired	ActionsRequired	Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Consumer erfordern.
description	string	Der Grund für die Genehmigung oder Ablehnung.
status	PrivateEndpointServiceConnectionStatus	Gibt an, ob die Verbindung vom Besitzer des Schlüsseltresors genehmigt, abgelehnt oder entfernt wurde.