Private Endpoint Connections - List By Resource

Référence

Service:: Key Vault

API Version:: 2022-07-01

L’opération List obtient des informations sur les connexions de point de terminaison privé associées au coffre.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string	Nom du groupe de ressources qui contient le coffre de clés.
subscriptionId	path	True	string	Informations d’identification d’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.
vaultName	path	True	string	Nom du coffre de clés. Regex pattern: `^[a-zA-Z0-9-]{3,24}$`
api-version	query	True	string	Version de l’API cliente.

Réponses

Nom	Type	Description
200 OK	PrivateEndpointConnectionListResult	Obtenez des informations sur toutes les connexions de point de terminaison privé dans le groupe de ressources spécifié.
Other Status Codes	CloudError	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Exemples

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
}

Définitions

Nom	Description
ActionsRequired	Message indiquant si les modifications apportées au fournisseur de services nécessitent des mises à jour sur le consommateur.
CloudError	Réponse d’erreur de Key Vault fournisseur de ressources
CloudErrorBody	Réponse d’erreur de Key Vault fournisseur de ressources
PrivateEndpoint	Propriétés de l’objet de point de terminaison privé.
PrivateEndpointConnection	Ressource de connexion de point de terminaison privé.
PrivateEndpointConnectionListResult	Liste des connexions de point de terminaison privé.
PrivateEndpointConnectionProvisioningState	État d’approvisionnement actuel.
PrivateEndpointServiceConnectionStatus	La connexion de point de terminaison privé status.
PrivateLinkServiceConnectionState	Objet qui représente l’état d’approbation de la connexion de liaison privée.

ActionsRequired

Message indiquant si les modifications apportées au fournisseur de services nécessitent des mises à jour sur le consommateur.

Nom	Type	Description
None	string

CloudError

Réponse d’erreur de Key Vault fournisseur de ressources

Nom	Type	Description
error	CloudErrorBody	Réponse d’erreur de Key Vault fournisseur de ressources

CloudErrorBody

Réponse d’erreur de Key Vault fournisseur de ressources

Nom	Type	Description
code	string	Code d’erreur. Il s’agit d’un mnémonique qui peut être consommé par programmation.
message	string	Message d’erreur convivial. Le message est généralement localisé et peut varier en fonction de la version du service.

PrivateEndpoint

Propriétés de l’objet de point de terminaison privé.

Nom	Type	Description
id	string	Identificateur complet de la ressource de point de terminaison privé.

PrivateEndpointConnection

Ressource de connexion de point de terminaison privé.

Nom	Type	Description
etag	string	Modifié chaque fois qu’il y a un changement dans l’état de la connexion de point de terminaison privé.
id	string	Identificateur complet de la ressource de coffre de clés.
location	string	Emplacement Azure de la ressource de coffre de clés.
name	string	Nom de la ressource de coffre de clés.
properties.privateEndpoint	PrivateEndpoint	Propriétés de l’objet de point de terminaison privé.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	État d’approbation de la connexion de liaison privée.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	État d’approvisionnement de la connexion de point de terminaison privé.
tags	object	Étiquettes affectées à la ressource de coffre de clés.
type	string	Type de ressource de la ressource de coffre de clés.

PrivateEndpointConnectionListResult

Liste des connexions de point de terminaison privé.

Nom	Type	Description
nextLink	string	URL permettant d’obtenir l’ensemble suivant de connexions de point de terminaison privé.
value	PrivateEndpointConnection[]	Liste des connexions de point de terminaison privé.

PrivateEndpointConnectionProvisioningState

État d’approvisionnement actuel.

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

PrivateEndpointServiceConnectionStatus

La connexion de point de terminaison privé status.

Nom	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Objet qui représente l’état d’approbation de la connexion de liaison privée.

Nom	Type	Description
actionsRequired	ActionsRequired	Message indiquant si les modifications apportées au fournisseur de services nécessitent des mises à jour sur le consommateur.
description	string	Motif de l’approbation ou du rejet.
status	PrivateEndpointServiceConnectionStatus	Indique si la connexion a été approuvée, rejetée ou supprimée par le propriétaire du coffre de clés.

Share via