Share via


Private Link Hub Private Link Resources - Get

Get Private Link Hub Private Link Resource
Get private link resource in private link hub

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/privateLinkHubs/{privateLinkHubName}/privateLinkResources/{privateLinkResourceName}?api-version=2021-06-01

URI Parameters

Name In Required Type Description
privateLinkHubName
path True

string

The name of the private link hub

privateLinkResourceName
path True

string

The name of the private link resource

resourceGroupName
path True

string

minLength: 1
maxLength: 90

The name of the resource group. The name is case insensitive.

subscriptionId
path True

string

minLength: 1

The ID of the target subscription.

api-version
query True

string

minLength: 1

The API version to use for this operation.

Responses

Name Type Description
200 OK

PrivateLinkResource

Private link resource details

Other Status Codes

ErrorResponse

Examples

Sample request

GET https://management.azure.com/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/privateLinkHubs/ExamplePrivateLinkHub/privateLinkResources/sql?api-version=2021-06-01

Sample response

{
  "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/privateLinkHubs/ExamplePrivateLinkHub/privateLinkResources/sql",
  "name": "sql",
  "type": "Microsoft.Synapse/privateLinkHubs/privateLinkResources",
  "properties": {
    "groupId": "sql",
    "requiredMembers": [
      "sql"
    ],
    "requiredZoneNames": [
      "privatelink.sql.azuresynapse.net"
    ]
  }
}

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

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

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

Error response

Name Type Description
error

ErrorDetail

The error object.

PrivateLinkResource

A private link resource

Name Type Description
id

string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

The name of the resource

properties

PrivateLinkResourceProperties

The private link resource properties.

type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

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[]

Required DNS zone names of the the private link resource.