Private Link Resources - List By Cluster

Service:

HDInsight

API Version:

2021-06-01

Lists the private link resources in a HDInsight cluster.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/privateLinkResources?api-version=2021-06-01

URI Parameters

Name	In	Required	Type	Description
clusterName	path	True	string	The name of the cluster.
resourceGroupName	path	True	string	The name of the resource group.
subscriptionId	path	True	string	The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	The HDInsight client API Version.

Responses

Name	Type	Description
200 OK	PrivateLinkResourceListResult	OK response definition.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Get all private link resources in a specific HDInsight cluster.

Sample request

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/privateLinkResources?api-version=2021-06-01

Sample response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/privateLinkResources/gateway",
      "name": "gateway",
      "type": "Microsoft.HDInsight/clusters/privateLinkResources",
      "properties": {
        "groupId": "gateway",
        "requiredMembers": [
          "gateway"
        ],
        "requiredZoneNames": [
          "privatelink.azurehdinsight.net"
        ]
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/privateLinkResources/headnode",
      "name": "headnode",
      "type": "Microsoft.HDInsight/clusters/privateLinkResources",
      "properties": {
        "groupId": "headnode",
        "requiredMembers": [
          "headnode"
        ],
        "requiredZoneNames": [
          "privatelink.azurehdinsight.net"
        ]
      }
    }
  ]
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
ErrorResponse	Describes the format of Error response.
PrivateLinkResource	A private link resource
PrivateLinkResourceListResult	A list of private link resources
systemData	Metadata pertaining to creation and last modification of the resource.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorResponse

Object

Describes the format of Error response.

Name	Type	Description
code	string	Error code
message	string	Error message indicating why the operation failed.

PrivateLinkResource

Object

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.groupId	string	The private link resource group id.
properties.requiredMembers	string[]	The private link resource required member names.
properties.requiredZoneNames	string[]	The private link resource Private link DNS zone name.
systemData	systemData	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

PrivateLinkResourceListResult

Object

A list of private link resources

Name	Type	Description
value	PrivateLinkResource[]	Array of private link resources

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.