Private Endpoint Connections - List By Resource

Referens

Service:: Key Vault

API Version:: 2022-07-01

Liståtgärden hämtar information om de privata slutpunktsanslutningar som är associerade med valvet.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string	Namnet på resursgruppen som innehåller nyckelvalvet.
subscriptionId	path	True	string	Autentiseringsuppgifter för prenumeration som unikt identifierar Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
vaultName	path	True	string	Namnet på nyckelvalvet. Regex pattern: `^[a-zA-Z0-9-]{3,24}$`
api-version	query	True	string	Klient-API-version.

Svar

Name	Typ	Description
200 OK	PrivateEndpointConnectionListResult	Hämta information om alla privata slutpunktsanslutningar i den angivna resursgruppen.
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Exempel

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
}

Definitioner

Name	Description
ActionsRequired	Ett meddelande som anger om ändringar i tjänstleverantören kräver uppdateringar på konsumenten.
CloudError	Ett felsvar från Key Vault resursprovider
CloudErrorBody	Ett felsvar från Key Vault resursprovider
PrivateEndpoint	Egenskaper för privat slutpunktsobjekt.
PrivateEndpointConnection	Anslutningsresurs för privat slutpunkt.
PrivateEndpointConnectionListResult	Lista över privata slutpunktsanslutningar.
PrivateEndpointConnectionProvisioningState	Det aktuella etableringstillståndet.
PrivateEndpointServiceConnectionStatus	Anslutningsstatus för privat slutpunkt.
PrivateLinkServiceConnectionState	Ett objekt som representerar godkännandetillståndet för den privata länkanslutningen.

ActionsRequired

Ett meddelande som anger om ändringar i tjänstleverantören kräver uppdateringar på konsumenten.

Name	Typ	Description
None	string

CloudError

Ett felsvar från Key Vault resursprovider

Name	Typ	Description
error	CloudErrorBody	Ett felsvar från Key Vault resursprovider

CloudErrorBody

Ett felsvar från Key Vault resursprovider

Name	Typ	Description
code	string	Felkod. Detta är en mnemonic som kan konsumeras programmatiskt.
message	string	Användarvänligt felmeddelande. Meddelandet är vanligtvis lokaliserat och kan variera beroende på tjänstversion.

PrivateEndpoint

Egenskaper för privat slutpunktsobjekt.

Name	Typ	Description
id	string	Fullständig identifierare för den privata slutpunktsresursen.

PrivateEndpointConnection

Anslutningsresurs för privat slutpunkt.

Name	Typ	Description
etag	string	Ändras när det sker en ändring i tillståndet för den privata slutpunktsanslutningen.
id	string	Fullständigt kvalificerad identifierare för nyckelvalvsresursen.
location	string	Azure-platsen för nyckelvalvsresursen.
name	string	Namnet på nyckelvalvsresursen.
properties.privateEndpoint	PrivateEndpoint	Egenskaper för det privata slutpunktsobjektet.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Godkännandetillstånd för den privata länkanslutningen.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Etableringstillstånd för den privata slutpunktsanslutningen.
tags	object	Taggar som tilldelats till nyckelvalvsresursen.
type	string	Resurstyp för nyckelvalvsresursen.

PrivateEndpointConnectionListResult

Lista över privata slutpunktsanslutningar.

Name	Typ	Description
nextLink	string	URL:en för att hämta nästa uppsättning privata slutpunktsanslutningar.
value	PrivateEndpointConnection[]	Listan över privata slutpunktsanslutningar.

PrivateEndpointConnectionProvisioningState

Det aktuella etableringstillståndet.

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

PrivateEndpointServiceConnectionStatus

Anslutningsstatus för privat slutpunkt.

Name	Typ	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Ett objekt som representerar godkännandetillståndet för den privata länkanslutningen.

Name	Typ	Description
actionsRequired	ActionsRequired	Ett meddelande som anger om ändringar i tjänstleverantören kräver uppdateringar på konsumenten.
description	string	Anledningen till godkännande eller avvisande.
status	PrivateEndpointServiceConnectionStatus	Anger om anslutningen har godkänts, avvisats eller tagits bort av nyckelvalvets ägare.