Share via

Managed Instance Private Endpoint Connections - Get

  • Reference
Service:
SQL Database
API Version:
2021-11-01

Gets a private endpoint connection.

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

URI Parameters

Name In Required Type Description
managedInstanceName
 path True

string

The name of the managed instance.
privateEndpointConnectionName
 path True

string

The name of the private endpoint connection.
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

ManagedInstancePrivateEndpointConnection

Successfully retrieved a specified private endpoint connection.
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 private endpoint connection.

Sample request

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

Sample response

Status code:
200 
{
  "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"
    }
  }
}

Definitions

Name Description
ManagedInstancePrivateEndpointConnection

A private endpoint connection
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.

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.