Private Link Resources - List By Server

Service:

SQL Database

API Version:

2021-11-01

Gets the private link resources for SQL server.

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

URI Parameters

Name	In	Required	Type	Description
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.
serverName	path	True	string	The name of the server.
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	PrivateLinkResourceListResult	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

Gets private link resources for SQL.

Sample request

HTTP

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

Java

/**
 * Samples for PrivateLinkResources ListByServer.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/PrivateLinkResourcesList.json
     */
    /**
     * Sample code: Gets private link resources for SQL.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getsPrivateLinkResourcesForSQL(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getPrivateLinkResources().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

Sample response

Status code:

200

{
  "value": [
    {
      "id": "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/test-svr/privateLinkResources/plr",
      "name": "plr",
      "type": "Microsoft.Sql/servers/privateLinkResources",
      "properties": {
        "groupId": "sqlServer",
        "requiredMembers": [
          "sqlServer"
        ]
      }
    }
  ]
}

Definitions

Name	Description
PrivateLinkResource	A private link resource
PrivateLinkResourceListResult	A list of private link resources
PrivateLinkResourceProperties	Properties of a private link resource.

PrivateLinkResource

A private link resource

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties	PrivateLinkResourceProperties	The private link resource group id.
type	string	Resource type.

PrivateLinkResourceListResult

A list of private link resources

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

PrivateLinkResourceProperties

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.