Private Endpoint Connections - List By Resource

Referência

Service:: Key Vault

API Version:: 2022-07-01

A operação Lista obtém informações sobre as ligações de ponto final privado associadas ao cofre.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	Nome do grupo de recursos que contém o cofre de chaves.
subscriptionId	path	True	string	Credenciais de subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.
vaultName	path	True	string	O nome do cofre de chaves. Regex pattern: `^[a-zA-Z0-9-]{3,24}$`
api-version	query	True	string	Versão da API de Cliente.

Respostas

Name	Tipo	Description
200 OK	PrivateEndpointConnectionListResult	Obtenha informações sobre todas as ligações de ponto final privado no grupo de recursos especificado.
Other Status Codes	CloudError	Resposta de erro que descreve a razão pela qual a operação falhou.

Exemplos

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
}

Definições

Name	Description
ActionsRequired	Uma mensagem a indicar se as alterações no fornecedor de serviços necessitam de atualizações no consumidor.
CloudError	Uma resposta de erro do fornecedor de recursos Key Vault
CloudErrorBody	Uma resposta de erro do fornecedor de recursos Key Vault
PrivateEndpoint	Propriedades do objeto de ponto final privado.
PrivateEndpointConnection	Recurso de ligação de ponto final privado.
PrivateEndpointConnectionListResult	Lista de ligações de pontos finais privados.
PrivateEndpointConnectionProvisioningState	O estado de aprovisionamento atual.
PrivateEndpointServiceConnectionStatus	O estado da ligação do ponto final privado.
PrivateLinkServiceConnectionState	Um objeto que representa o estado de aprovação da ligação de ligação privada.

ActionsRequired

Uma mensagem a indicar se as alterações no fornecedor de serviços necessitam de atualizações no consumidor.

Name	Tipo	Description
None	string

CloudError

Uma resposta de erro do fornecedor de recursos Key Vault

Name	Tipo	Description
error	CloudErrorBody	Uma resposta de erro do fornecedor de recursos Key Vault

CloudErrorBody

Uma resposta de erro do fornecedor de recursos Key Vault

Name	Tipo	Description
code	string	Código de erro. Este é um mnemónico que pode ser consumido programaticamente.
message	string	Mensagem de erro amigável do utilizador. Normalmente, a mensagem é localizada e pode variar consoante a versão do serviço.

PrivateEndpoint

Propriedades do objeto de ponto final privado.

Name	Tipo	Description
id	string	Identificador completo do recurso de ponto final privado.

PrivateEndpointConnection

Recurso de ligação de ponto final privado.

Name	Tipo	Description
etag	string	Modificado sempre que existir uma alteração no estado da ligação de ponto final privado.
id	string	Identificador completamente qualificado do recurso do cofre de chaves.
location	string	Localização do Azure do recurso do cofre de chaves.
name	string	Nome do recurso do cofre de chaves.
properties.privateEndpoint	PrivateEndpoint	Propriedades do objeto de ponto final privado.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Estado de aprovação da ligação de ligação privada.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Estado de aprovisionamento da ligação de ponto final privado.
tags	object	Etiquetas atribuídas ao recurso do cofre de chaves.
type	string	Tipo de recurso do recurso do cofre de chaves.

PrivateEndpointConnectionListResult

Lista de ligações de pontos finais privados.

Name	Tipo	Description
nextLink	string	O URL para obter o próximo conjunto de ligações de ponto final privado.
value	PrivateEndpointConnection[]	A lista de ligações de pontos finais privados.

PrivateEndpointConnectionProvisioningState

O estado de aprovisionamento atual.

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

PrivateEndpointServiceConnectionStatus

O estado da ligação do ponto final privado.

Name	Tipo	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Um objeto que representa o estado de aprovação da ligação de ligação privada.

Name	Tipo	Description
actionsRequired	ActionsRequired	Uma mensagem a indicar se as alterações no fornecedor de serviços necessitam de atualizações no consumidor.
description	string	O motivo da aprovação ou rejeição.
status	PrivateEndpointServiceConnectionStatus	Indica se a ligação foi aprovada, rejeitada ou removida pelo proprietário do cofre de chaves.