Private Endpoint Connections - List By Server

Serviço:

SQL Database

Versão da API:

2021-11-01

Obtém todas as ligações de ponto final privado num servidor.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/privateEndpointConnections?api-version=2021-11-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Pode obter este valor a partir da API do Azure Resource Manager ou do portal.
serverName	path	True	string	O nome do servidor.
subscriptionId	path	True	string	O ID da subscrição que identifica uma subscrição do Azure.
api-version	query	True	string	A versão da API a utilizar para o pedido.

Respostas

Name	Tipo	Description
200 OK	PrivateEndpointConnectionListResult	Ligações de ponto final privado obtidas com êxito.
Other Status Codes		Respostas de Erro: *** 400 PrivateEndpointConnectionDoesNotExist – A Ligação de Ponto Final Privado não existe 400 PrivateEndpointConnectionStatusNotPending – O Estado da Ligação do Ponto Final Privado não está Pendente 400 NullRemotePrivateLinkServiceConnectionState - Remote Private Link Service Connection State is Null 400 NullPrivateEndpointConnectionProperties - Private Endpoint Connection Properties is Null 400 NullRemotePrivateLinkServiceConnectionStateStatus - Remote Private Link Service Connection State Status is Null 400 IncorrectPrivateLinkServiceConnectionStateStatus - Private Link Estado do Estado da Ligação do Serviço tem de ser "Aprovado" ou "Rejeitado" 404 ResourceNotFound – o recurso pedido não foi encontrado.

Exemplos

Gets list of private endpoint connections on a server.

Pedido de amostra

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/test-svr/privateEndpointConnections?api-version=2021-11-01

Java

/**
 * Samples for PrivateEndpointConnections ListByServer.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/PrivateEndpointConnectionList.json
     */
    /**
     * Sample code: Gets list of private endpoint connections on a server.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        getsListOfPrivateEndpointConnectionsOnAServer(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getPrivateEndpointConnections().listByServer("Default", "test-svr",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta da amostra

Código de estado:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/test-svr/privateEndpointConnections/private-endpoint-connection-name-2",
      "name": "private-endpoint-connection-name",
      "type": "Microsoft.Sql/servers/privateEndpointConnections",
      "properties": {
        "provisioningState": "Ready",
        "privateEndpoint": {
          "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name"
        },
        "privateLinkServiceConnectionState": {
          "status": "Approved",
          "description": "Auto-approved",
          "actionsRequired": "None"
        }
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/test-svr/privateEndpointConnections/private-endpoint-connection-name-2",
      "name": "private-endpoint-connection-name-2",
      "type": "Microsoft.Sql/servers/privateEndpointConnections",
      "properties": {
        "provisioningState": "Ready",
        "privateEndpoint": {
          "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name-2"
        },
        "privateLinkServiceConnectionState": {
          "status": "Approved",
          "description": "Auto-approved",
          "actionsRequired": "None"
        }
      }
    }
  ]
}

Definições

Name	Description
PrivateEndpointConnection	Uma ligação de ponto final privado
PrivateEndpointConnectionListResult	Uma lista de ligações de ponto final privado.
PrivateEndpointProperty
PrivateEndpointProvisioningState	Estado da ligação de ponto final privado.
PrivateLinkServiceConnectionStateActionsRequire	As ações necessárias para a ligação do serviço de ligação privada.
PrivateLinkServiceConnectionStateProperty
PrivateLinkServiceConnectionStateStatus	O estado da ligação do serviço de ligação privada.

PrivateEndpointConnection

Object

Uma ligação de ponto final privado

Name	Tipo	Description
id	string	ID do Recurso.
name	string	Nome do recurso.
properties.groupIds	string[]	IDs de grupo.
properties.privateEndpoint	PrivateEndpointProperty	Ponto final privado ao qual pertence a ligação.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Estado de ligação da ligação do ponto final privado.
properties.provisioningState	PrivateEndpointProvisioningState	Estado da ligação de ponto final privado.
type	string	Tipo de recurso.

PrivateEndpointConnectionListResult

Object

Uma lista de ligações de ponto final privado.

Name	Tipo	Description
nextLink	string	Ligação para obter a página seguinte dos resultados.
value	PrivateEndpointConnection[]	Matriz de resultados.

PrivateEndpointProperty

Object

Name	Tipo	Description
id	string	ID do recurso do ponto final privado.

PrivateEndpointProvisioningState

Enumeration

Estado da ligação de ponto final privado.

Valor	Description
Approving
Dropping
Failed
Ready
Rejecting

PrivateLinkServiceConnectionStateActionsRequire

Enumeration

As ações necessárias para a ligação do serviço de ligação privada.

Valor	Description
None

PrivateLinkServiceConnectionStateProperty

Object

Name	Tipo	Description
actionsRequired	PrivateLinkServiceConnectionStateActionsRequire	As ações necessárias para a ligação do serviço de ligação privada.
description	string	A descrição da ligação do serviço de ligação privada.
status	PrivateLinkServiceConnectionStateStatus	O estado da ligação do serviço de ligação privada.

PrivateLinkServiceConnectionStateStatus

Enumeration

O estado da ligação do serviço de ligação privada.

Valor	Description
Approved
Disconnected
Pending
Rejected