private_endpoint_connections

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

Overview

Name	private_endpoint_connections
Type	Resource
Id	azure.hdinsight.private_endpoint_connections

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	The private endpoint connection 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	The private endpoint connection 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, privateEndpointConnectionName		Gets the specific private endpoint connection.
list_by_cluster	select	subscriptionId, resourceGroupName, clusterName		Lists the private endpoint connections for a HDInsight cluster.
create_or_update	insert	subscriptionId, resourceGroupName, clusterName, privateEndpointConnectionName, data__properties		Approve or reject a private endpoint connection manually.
delete	delete	subscriptionId, resourceGroupName, clusterName, privateEndpointConnectionName		Deletes the specific private endpoint connection.

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.
privateEndpointConnectionName	string	The name of the private endpoint connection.
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 endpoint connection.

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

list_by_cluster

Lists the private endpoint connections for a HDInsight cluster.

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

INSERT examples

create_or_update

Approve or reject a private endpoint connection manually.

INSERT INTO azure.hdinsight.private_endpoint_connections (
data__properties,
subscriptionId,
resourceGroupName,
clusterName,
privateEndpointConnectionName
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ clusterName }}',
'{{ privateEndpointConnectionName }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: private_endpoint_connections
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the private_endpoint_connections resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the private_endpoint_connections resource.
    - name: clusterName
      value: string
      description: Required parameter for the private_endpoint_connections resource.
    - name: privateEndpointConnectionName
      value: string
      description: Required parameter for the private_endpoint_connections resource.
    - name: properties
      value: object
      description: |
        The private endpoint connection properties.

DELETE examples

delete

Deletes the specific private endpoint connection.

DELETE FROM azure.hdinsight.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' --required
;