Private Link Resources - Get

Service:: SQL Database

API Version:: 2023-08-01

Gets a private link resource for SQL server.

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

URI Parameters

Name	In	Required	Type	Description
groupName	path	True	string	The name of the private link resource.
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	PrivateLinkResource	Successfully retrieved private link resources.
Other Status Codes	ErrorResponse	* Error Responses: * 400 InvalidServerName - Invalid server name specified. 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character. 400 TokenTooLong - The provided token is too long. 404 OperationIdNotFound - The operation with Id does not exist. 404 OperationIdNotFound - The operation with Id does not exist. 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled. 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.

Name

Type

Description

200 OK

PrivateLinkResource

Successfully retrieved private link resources.

Other Status Codes

ErrorResponse

*** Error Responses: ***

400 InvalidServerName - Invalid server name specified.
400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.
400 TokenTooLong - The provided token is too long.
404 OperationIdNotFound - The operation with Id does not exist.
404 OperationIdNotFound - The operation with Id does not exist.
409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.
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 a private link resource for SQL.

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/PrivateLinkResourcesGet.json
// this example is just showing the usage of "PrivateLinkResources_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlPrivateLinkResource created on azure
// for more information of creating SqlPrivateLinkResource, please refer to the document of SqlPrivateLinkResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default";
string serverName = "test-svr";
string groupName = "plr";
ResourceIdentifier sqlPrivateLinkResourceId = SqlPrivateLinkResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, groupName);
SqlPrivateLinkResource sqlPrivateLinkResource = client.GetSqlPrivateLinkResource(sqlPrivateLinkResourceId);

// invoke the operation
SqlPrivateLinkResource result = await sqlPrivateLinkResource.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SqlPrivateLinkResourceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

{
  "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
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
PrivateLinkResource	A private link resource
PrivateLinkResourceProperties	Properties of a private link resource.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

PrivateLinkResource

Object

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.

PrivateLinkResourceProperties

Object

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.

Share via

Private Link Resources - Get

URI Parameters

Responses

Examples

Gets a private link resource for SQL.

Sample request

Sample response

Definitions

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PrivateLinkResource

PrivateLinkResourceProperties