private_link_resources

Creates, updates, deletes, gets or lists a private_link_resources resource.

Overview

Name	private_link_resources
Type	Resource
Id	azure.hdinsight.private_link_resources

Fields

The following fields are returned by SELECT queries:

get

OK response definition.

Name	Datatype	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	object	Resource properties.
systemData	object	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"

list_by_cluster

OK response definition.

Name	Datatype	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	object	Resource properties.
systemData	object	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"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, clusterName, privateLinkResourceName		Gets the specific private link resource.
list_by_cluster	select	subscriptionId, resourceGroupName, clusterName		Lists the private link resources in a HDInsight cluster.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
clusterName	string	The name of the cluster.
privateLinkResourceName	string	The name of the private link resource.
resourceGroupName	string	The name of the resource group.
subscriptionId	string	The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

SELECT examples

get

Gets the specific private link resource.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.hdinsight.private_link_resources
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
AND privateLinkResourceName = '{{ privateLinkResourceName }}' -- required
;

list_by_cluster

Lists the private link resources in a HDInsight cluster.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.hdinsight.private_link_resources
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
;