Managed Instance Private Endpoint Connections - List By Managed Instance

Service:

SQL Database

API Version:

2021-11-01

Gets all private endpoint connections on a server.

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

URI Parameters

Name	In	Required	Type	Description
managedInstanceName	path	True	string	The name of the managed instance.
resourceGroupName	path	True	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
subscriptionId	path	True	string	The subscription ID that identifies an Azure subscription.
api-version	query	True	string	The API version to use for the request.

Responses

Name	Type	Description
200 OK	ManagedInstancePrivateEndpointConnectionListResult	Successfully retrieved private endpoint connections.
Other Status Codes		*** Error Responses: *** 400 PrivateEndpointConnectionDoesNotExist - Private Endpoint Connection does not exist 400 PrivateEndpointConnectionStatusNotPending - Private Endpoint Connection Status is not Pending 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 Service Connection State Status must be "Approved" or "Rejected" 404 ResourceNotFound - The requested resource was not found.

Examples

Gets list of private endpoint connections on a server.

Sample Request

HTTP

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

Java

import com.azure.core.util.Context;

/** Samples for ManagedInstancePrivateEndpointConnections ListByManagedInstance. */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/
     * ManagedInstancePrivateEndpointConnectionList.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().getManagedInstancePrivateEndpointConnections()
            .listByManagedInstance("Default", "test-cl", 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

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/test-cl/privateEndpointConnections/private-endpoint-connection-name",
      "name": "private-endpoint-connection-name",
      "type": "Microsoft.Sql/managedInstances/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/managedInstances/test-cl/privateEndpointConnections/private-endpoint-connection-name-2",
      "name": "private-endpoint-connection-name-2",
      "type": "Microsoft.Sql/managedInstances/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"
        }
      }
    }
  ]
}

Definitions

Name	Description
ManagedInstancePrivateEndpointConnection	A private endpoint connection
ManagedInstancePrivateEndpointConnectionListResult	A list of private endpoint connections.
ManagedInstancePrivateEndpointProperty
ManagedInstancePrivateLinkServiceConnectionStateProperty

ManagedInstancePrivateEndpointConnection

A private endpoint connection

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.privateEndpoint	ManagedInstancePrivateEndpointProperty	Private endpoint which the connection belongs to.
properties.privateLinkServiceConnectionState	ManagedInstancePrivateLinkServiceConnectionStateProperty	Connection State of the Private Endpoint Connection.
properties.provisioningState	string	State of the Private Endpoint Connection.
type	string	Resource type.

ManagedInstancePrivateEndpointConnectionListResult

A list of private endpoint connections.

Name	Type	Description
nextLink	string	Link to retrieve next page of results.
value	ManagedInstancePrivateEndpointConnection[]	Array of results.

ManagedInstancePrivateEndpointProperty

Name	Type	Description
id	string	Resource id of the private endpoint.

ManagedInstancePrivateLinkServiceConnectionStateProperty

Name	Type	Description
actionsRequired	string	The private link service connection description.
description	string	The private link service connection description.
status	string	The private link service connection status.