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 conexões de ponto de extremidade 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 de URI

Nome	Em	Obrigató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 assinatura que identificam exclusivamente a assinatura do Microsoft Azure. A ID da assinatura 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 do cliente.

Respostas

Nome	Tipo	Description
200 OK	PrivateEndpointConnectionListResult	Obtenha informações sobre todas as conexões de ponto de extremidade privado no grupo de recursos especificado.
Other Status Codes	CloudError	Resposta de erro que descreve por que 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

Nome	Description
ActionsRequired	Uma mensagem que indica se as alterações no provedor de serviços exigem atualizações no consumidor.
CloudError	Uma resposta de erro do provedor de recursos Key Vault
CloudErrorBody	Uma resposta de erro do provedor de recursos Key Vault
PrivateEndpoint	Propriedades do objeto de ponto de extremidade privado.
PrivateEndpointConnection	Recurso de conexão de ponto de extremidade privado.
PrivateEndpointConnectionListResult	Lista de conexões de ponto de extremidade privado.
PrivateEndpointConnectionProvisioningState	O estado de provisionamento atual.
PrivateEndpointServiceConnectionStatus	A conexão do ponto de extremidade privado status.
PrivateLinkServiceConnectionState	Um objeto que representa o estado de aprovação da conexão de link privado.

ActionsRequired

Uma mensagem que indica se as alterações no provedor de serviços exigem atualizações no consumidor.

Nome	Tipo	Description
None	string

CloudError

Uma resposta de erro do provedor de recursos Key Vault

Nome	Tipo	Description
error	CloudErrorBody	Uma resposta de erro do provedor de recursos Key Vault

CloudErrorBody

Uma resposta de erro do provedor de recursos Key Vault

Nome	Tipo	Description
code	string	Código do erro. Este é um mnemônico que pode ser consumido programaticamente.
message	string	Mensagem de erro amigável. A mensagem normalmente é localizada e pode variar com a versão do serviço.

PrivateEndpoint

Propriedades do objeto de ponto de extremidade privado.

Nome	Tipo	Description
id	string	Identificador completo do recurso de ponto de extremidade privado.

PrivateEndpointConnection

Recurso de conexão de ponto de extremidade privado.

Nome	Tipo	Description
etag	string	Modificado sempre que há uma alteração no estado da conexão de ponto de extremidade privado.
id	string	Identificador totalmente qualificado do recurso do cofre de chaves.
location	string	Local 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 de extremidade privado.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Estado de aprovação da conexão de link privado.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Estado de provisionamento da conexão de ponto de extremidade privado.
tags	object	Marcas atribuídas ao recurso do cofre de chaves.
type	string	Tipo de recurso do recurso do cofre de chaves.

PrivateEndpointConnectionListResult

Lista de conexões de ponto de extremidade privado.

Nome	Tipo	Description
nextLink	string	A URL para obter o próximo conjunto de conexões de ponto de extremidade privado.
value	PrivateEndpointConnection[]	A lista de conexões de ponto de extremidade privado.

PrivateEndpointConnectionProvisioningState

O estado de provisionamento atual.

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

PrivateEndpointServiceConnectionStatus

A conexão do ponto de extremidade privado status.

Nome	Tipo	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Um objeto que representa o estado de aprovação da conexão de link privado.

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