Private Endpoint Connections - List By Server

Service:

SQL Database

Version d'API:

2021-11-01

Obtient toutes les connexions de point de terminaison privé sur un serveur.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string	Nom du groupe de ressources qui contient la ressource. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.
serverName	path	True	string	Le nom du serveur
subscriptionId	path	True	string	L’ID d’abonnement d’un abonnement Azure.
api-version	query	True	string	Version de l’API à utiliser pour la requête.

Réponses

Nom	Type	Description
200 OK	PrivateEndpointConnectionListResult	Récupération réussie des connexions de point de terminaison privé.
Other Status Codes		Réponses d’erreur : *** 400 PrivateEndpointConnectionDoesNotExist - La connexion de point de terminaison privé n’existe pas 400 PrivateEndpointConnectionStatusNotPending - L’état de la connexion du point de terminaison privé n’est pas en attente 400 NullRemotePrivateLinkServiceConnectionState - Remote Private Link Service Connection State est Null 400 NullPrivateEndpointConnectionProperties - Propriétés de connexion de point de terminaison privé est Null 400 NullRemotePrivateLinkServiceConnectionStateStatus - Remote Private Link Service Connection State Status is Null 400 IncorrectPrivateLinkServiceConnectionStateStatus : Private Link état de la connexion de service doit être « Approuvé » ou « Rejeté » 404 ResourceNotFound : la ressource demandée est introuvable.

Exemples

Gets list of private endpoint connections on a server.

Exemple de requête

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

Exemple de réponse

Code d’état:

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"
        }
      }
    }
  ]
}

Définitions

Nom	Description
PrivateEndpointConnection	Une connexion de point de terminaison privé
PrivateEndpointConnectionListResult	Liste des connexions de point de terminaison privé.
PrivateEndpointProperty
PrivateEndpointProvisioningState	État de la connexion de point de terminaison privé.
PrivateLinkServiceConnectionStateActionsRequire	Actions requises pour la connexion au service private link.
PrivateLinkServiceConnectionStateProperty
PrivateLinkServiceConnectionStateStatus	La connexion au service de liaison privée status.

PrivateEndpointConnection

Object

Une connexion de point de terminaison privé

Nom	Type	Description
id	string	ID de la ressource
name	string	Nom de la ressource.
properties.groupIds	string[]	ID de groupe.
properties.privateEndpoint	PrivateEndpointProperty	Point de terminaison privé auquel appartient la connexion.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	État de la connexion de la connexion de point de terminaison privé.
properties.provisioningState	PrivateEndpointProvisioningState	État de la connexion de point de terminaison privé.
type	string	Type de ressource.

PrivateEndpointConnectionListResult

Object

Liste des connexions de point de terminaison privé.

Nom	Type	Description
nextLink	string	Lien pour récupérer la page de résultats suivante.
value	PrivateEndpointConnection[]	Tableau de résultats.

PrivateEndpointProperty

Object

Nom	Type	Description
id	string	ID de ressource du point de terminaison privé.

PrivateEndpointProvisioningState

Enumeration

État de la connexion de point de terminaison privé.

Valeur	Description
Approving
Dropping
Failed
Ready
Rejecting

PrivateLinkServiceConnectionStateActionsRequire

Enumeration

Actions requises pour la connexion au service private link.

Valeur	Description
None

PrivateLinkServiceConnectionStateProperty

Object

Nom	Type	Description
actionsRequired	PrivateLinkServiceConnectionStateActionsRequire	Actions requises pour la connexion au service private link.
description	string	Description de la connexion au service private link.
status	PrivateLinkServiceConnectionStateStatus	La connexion au service de liaison privée status.

PrivateLinkServiceConnectionStateStatus

Enumeration

La connexion au service de liaison privée status.

Valeur	Description
Approved
Disconnected
Pending
Rejected