Private Endpoint Connections - List By Resource

Referencia

Service:: Key Vault

API Version:: 2022-07-01

La operación List obtiene información sobre las conexiones de punto de conexión privado asociadas al almacén.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string	Nombre del grupo de recursos que contiene el almacén de claves.
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI para cada llamada al servicio.
vaultName	path	True	string	Nombre del almacén de claves. Regex pattern: `^[a-zA-Z0-9-]{3,24}$`
api-version	query	True	string	Versión de api de cliente.

Respuestas

Nombre	Tipo	Description
200 OK	PrivateEndpointConnectionListResult	Obtenga información sobre todas las conexiones de punto de conexión privado del grupo de recursos especificado.
Other Status Codes	CloudError	Respuesta de error que describe el motivo del error de la operación.

Ejemplos

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
}

Definiciones

Nombre	Description
ActionsRequired	Mensaje que indica si los cambios en el proveedor de servicios requieren actualizaciones en el consumidor.
CloudError	Respuesta de error del proveedor de recursos de Key Vault
CloudErrorBody	Respuesta de error del proveedor de recursos de Key Vault
PrivateEndpoint	Propiedades del objeto de punto de conexión privado.
PrivateEndpointConnection	Recurso de conexión de punto de conexión privado.
PrivateEndpointConnectionListResult	Lista de conexiones de punto de conexión privado.
PrivateEndpointConnectionProvisioningState	Estado de aprovisionamiento actual.
PrivateEndpointServiceConnectionStatus	Estado de conexión del punto de conexión privado.
PrivateLinkServiceConnectionState	Objeto que representa el estado de aprobación de la conexión de vínculo privado.

ActionsRequired

Mensaje que indica si los cambios en el proveedor de servicios requieren actualizaciones en el consumidor.

Nombre	Tipo	Description
None	string

CloudError

Respuesta de error del proveedor de recursos de Key Vault

Nombre	Tipo	Description
error	CloudErrorBody	Respuesta de error del proveedor de recursos de Key Vault

CloudErrorBody

Respuesta de error del proveedor de recursos de Key Vault

Nombre	Tipo	Description
code	string	Código de error. Se trata de una mnemónica que se puede consumir mediante programación.
message	string	Mensaje de error descriptivo. El mensaje suele localizarse y puede variar con la versión del servicio.

PrivateEndpoint

Propiedades del objeto de punto de conexión privado.

Nombre	Tipo	Description
id	string	Identificador completo del recurso de punto de conexión privado.

PrivateEndpointConnection

Recurso de conexión de punto de conexión privado.

Nombre	Tipo	Description
etag	string	Se modifica cada vez que se produce un cambio en el estado de la conexión de punto de conexión privado.
id	string	Identificador completo del recurso del almacén de claves.
location	string	Ubicación de Azure del recurso del almacén de claves.
name	string	Nombre del recurso del almacén de claves.
properties.privateEndpoint	PrivateEndpoint	Propiedades del objeto de punto de conexión privado.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Estado de aprobación de la conexión de vínculo privado.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Estado de aprovisionamiento de la conexión de punto de conexión privado.
tags	object	Etiquetas asignadas al recurso del almacén de claves.
type	string	Tipo de recurso del recurso del almacén de claves.

PrivateEndpointConnectionListResult

Lista de conexiones de punto de conexión privado.

Nombre	Tipo	Description
nextLink	string	Dirección URL para obtener el siguiente conjunto de conexiones de punto de conexión privado.
value	PrivateEndpointConnection[]	Lista de conexiones de punto de conexión privado.

PrivateEndpointConnectionProvisioningState

Estado de aprovisionamiento actual.

Nombre	Tipo	Description
Creating	string
Deleting	string
Disconnected	string
Failed	string
Succeeded	string
Updating	string

PrivateEndpointServiceConnectionStatus

Estado de conexión del punto de conexión privado.

Nombre	Tipo	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Objeto que representa el estado de aprobación de la conexión de vínculo privado.

Nombre	Tipo	Description
actionsRequired	ActionsRequired	Mensaje que indica si los cambios en el proveedor de servicios requieren actualizaciones en el consumidor.
description	string	Motivo de aprobación o rechazo.
status	PrivateEndpointServiceConnectionStatus	Indica si el propietario del almacén de claves ha aprobado, rechazado o quitado la conexión.