Private Endpoint Connections - List By Resource

Odwołanie

Usługa:: Key Vault

Wersja interfejsu API:: 2022-07-01

Operacja Lista pobiera informacje o połączeniach prywatnego punktu końcowego skojarzonych z magazynem.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string	Nazwa grupy zasobów zawierającej magazyn kluczy.
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.
vaultName	path	True	string	Nazwa magazynu kluczy. Wzorzec wyrażenia regularnego: `^[a-zA-Z0-9-]{3,24}$`
api-version	query	True	string	Wersja interfejsu API klienta.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	PrivateEndpointConnectionListResult	Uzyskaj informacje o wszystkich połączeniach prywatnego punktu końcowego w określonej grupie zasobów.
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Przykłady

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

Przykładowa odpowiedź

Kod stanu:: 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
}

Definicje

Nazwa	Opis
ActionsRequired	Komunikat wskazujący, czy zmiany dostawcy usług wymagają aktualizacji dla konsumenta.
CloudError	Odpowiedź na błąd dostawcy zasobów Key Vault
CloudErrorBody	Odpowiedź na błąd dostawcy zasobów Key Vault
PrivateEndpoint	Właściwości obiektu prywatnego punktu końcowego.
PrivateEndpointConnection	Zasób połączenia prywatnego punktu końcowego.
PrivateEndpointConnectionListResult	Lista połączeń prywatnego punktu końcowego.
PrivateEndpointConnectionProvisioningState	Bieżący stan aprowizacji.
PrivateEndpointServiceConnectionStatus	Stan połączenia prywatnego punktu końcowego.
PrivateLinkServiceConnectionState	Obiekt reprezentujący stan zatwierdzenia połączenia łącza prywatnego.

ActionsRequired

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

Nazwa	Typ	Opis
None	string

CloudError

Odpowiedź na błąd dostawcy zasobów Key Vault

Nazwa	Typ	Opis
error	CloudErrorBody	Odpowiedź na błąd dostawcy zasobów Key Vault

CloudErrorBody

Odpowiedź na błąd dostawcy zasobów Key Vault

Nazwa	Typ	Opis
code	string	Kod błędu. Jest to mnemonic, który może być używany programowo.
message	string	Przyjazny dla użytkownika komunikat o błędzie. Komunikat jest zazwyczaj zlokalizowany i może się różnić w zależności od wersji usługi.

PrivateEndpoint

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

Nazwa	Typ	Opis
id	string	Pełny identyfikator zasobu prywatnego punktu końcowego.

PrivateEndpointConnection

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	W pełni kwalifikowany identyfikator zasobu magazynu kluczy.
location	string	Lokalizacja platformy Azure zasobu magazynu kluczy.
name	string	Nazwa zasobu magazynu kluczy.
properties.privateEndpoint	PrivateEndpoint	Właściwości obiektu prywatnego punktu końcowego.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Stan zatwierdzenia połączenia z łączem prywatnym.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Stan aprowizacji połączenia prywatnego punktu końcowego.
tags	object	Tagi przypisane do zasobu magazynu kluczy.
type	string	Typ zasobu magazynu kluczy.

PrivateEndpointConnectionListResult

Lista połączeń prywatnego punktu końcowego.

Nazwa	Typ	Opis
nextLink	string	Adres URL umożliwiający pobranie następnego zestawu połączeń prywatnych punktów końcowych.
value	PrivateEndpointConnection[]	Lista połączeń prywatnego punktu końcowego.

PrivateEndpointConnectionProvisioningState

Bieżący stan aprowizacji.

Nazwa	Typ	Opis
Creating	string
Deleting	string
Disconnected	string
Failed	string
Succeeded	string
Updating	string

PrivateEndpointServiceConnectionStatus

Stan połączenia prywatnego punktu końcowego.

Nazwa	Typ	Opis
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

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.

Udostępnij za pośrednictwem