Private Endpoint Connections - List By Resource

Referentie

Service:: Key Vault

API Version:: 2022-07-01

Met de bewerking List wordt informatie opgehaald over de privé-eindpuntverbindingen die zijn gekoppeld aan de kluis.

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

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string	Naam van de resourcegroep die de sleutelkluis bevat.
subscriptionId	path	True	string	Abonnementsreferenties waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke service-aanroep.
vaultName	path	True	string	De naam van de sleutelkluis. Regex pattern: `^[a-zA-Z0-9-]{3,24}$`
api-version	query	True	string	Client-API-versie.

Antwoorden

Name	Type	Description
200 OK	PrivateEndpointConnectionListResult	Informatie ophalen over alle privé-eindpuntverbindingen in de opgegeven resourcegroep.
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Voorbeelden

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
}

Definities

Name	Description
ActionsRequired	Een bericht waarin wordt aangegeven of wijzigingen in de serviceprovider updates van de consument vereisen.
CloudError	Een foutreactie van Key Vault resourceprovider
CloudErrorBody	Een foutreactie van Key Vault resourceprovider
PrivateEndpoint	Eigenschappen van privé-eindpuntobjecten.
PrivateEndpointConnection	Privé-eindpuntverbindingsresource.
PrivateEndpointConnectionListResult	Lijst met privé-eindpuntverbindingen.
PrivateEndpointConnectionProvisioningState	De huidige inrichtingsstatus.
PrivateEndpointServiceConnectionStatus	De verbindingsstatus van het privé-eindpunt.
PrivateLinkServiceConnectionState	Een object dat de goedkeuringsstatus van de private link-verbinding vertegenwoordigt.

ActionsRequired

Een bericht waarin wordt aangegeven of wijzigingen in de serviceprovider updates van de consument vereisen.

Name	Type	Description
None	string

CloudError

Een foutreactie van Key Vault resourceprovider

Name	Type	Description
error	CloudErrorBody	Een foutreactie van Key Vault resourceprovider

CloudErrorBody

Een foutreactie van Key Vault resourceprovider

Name	Type	Description
code	string	Foutcode. Dit is een ezelsbruggetje dat programmatisch kan worden gebruikt.
message	string	Gebruiksvriendelijk foutbericht. Het bericht is doorgaans gelokaliseerd en kan per serviceversie verschillen.

PrivateEndpoint

Eigenschappen van privé-eindpuntobjecten.

Name	Type	Description
id	string	Volledige id van de privé-eindpuntresource.

PrivateEndpointConnection

Privé-eindpuntverbindingsresource.

Name	Type	Description
etag	string	Gewijzigd wanneer er een wijziging is in de status van de privé-eindpuntverbinding.
id	string	Volledig gekwalificeerde id van de sleutelkluisresource.
location	string	Azure-locatie van de sleutelkluisresource.
name	string	Naam van de sleutelkluisresource.
properties.privateEndpoint	PrivateEndpoint	Eigenschappen van het privé-eindpuntobject.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Goedkeuringsstatus van de private link-verbinding.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Inrichtingsstatus van de privé-eindpuntverbinding.
tags	object	Tags die zijn toegewezen aan de sleutelkluisresource.
type	string	Resourcetype van de sleutelkluisresource.

PrivateEndpointConnectionListResult

Lijst met privé-eindpuntverbindingen.

Name	Type	Description
nextLink	string	De URL voor het ophalen van de volgende set privé-eindpuntverbindingen.
value	PrivateEndpointConnection[]	De lijst met privé-eindpuntverbindingen.

PrivateEndpointConnectionProvisioningState

De huidige inrichtingsstatus.

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

PrivateEndpointServiceConnectionStatus

De verbindingsstatus van het privé-eindpunt.

Name	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Een object dat de goedkeuringsstatus van de private link-verbinding vertegenwoordigt.

Name	Type	Description
actionsRequired	ActionsRequired	Een bericht waarin wordt aangegeven of wijzigingen in de serviceprovider updates van de consument vereisen.
description	string	De reden voor goedkeuring of afwijzing.
status	PrivateEndpointServiceConnectionStatus	Geeft aan of de verbinding is goedgekeurd, geweigerd of verwijderd door de eigenaar van de sleutelkluis.