Share via

Managed Instance Private Link Resources - Get

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

Gets a private link resource for SQL server.

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

URI Parameters

Name In Required Type Description
groupName
 path True

string

The name of the private link resource.
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

ManagedInstancePrivateLink

Successfully retrieved private link resources.
Other Status Codes

*** Error Responses: ***

  • 404 OperationIdNotFound - The operation with Id does not exist.

  • 404 OperationIdNotFound - The operation with Id does not exist.

  • 409 OperationCancelled - The operation has been cancelled by user.

  • 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.

  • 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.

  • 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.

  • 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.

  • 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.

Examples

Sample request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/test-cl/privateLinkResources/plr?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/privateLinkResources/plr",
  "name": "plr",
  "type": "Microsoft.Sql/managedInstances/privateLinkResources",
  "properties": {
    "groupId": "managedInstance",
    "requiredMembers": [
      "managedInstance"
    ]
  }
}

Definitions

Name Description
ManagedInstancePrivateLink

A private link resource
ManagedInstancePrivateLinkProperties

Properties of a private link resource.

A private link resource

Name Type Description
id

string

Resource ID.
name

string

Resource name.
properties

ManagedInstancePrivateLinkProperties

The private link resource group id.
type

string

Resource type.

ManagedInstancePrivateLinkProperties

Properties of a private link resource.

Name Type Description
groupId

string

The private link resource group id.
requiredMembers

string[]

The private link resource required member names.
requiredZoneNames

string[]

The private link resource required zone names.