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

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.
linkIdentifier	string	The link identifier.
privateEndpoint	object	The private endpoint of the private endpoint connection.
privateLinkServiceConnectionState	object	The private link service connection state. Required.
provisioningState	string	The provisioning state, which only appears in the response. Known values are: "InProgress", "Updating", "Failed", "Succeeded", "Canceled", and "Deleting". (InProgress, Updating, Failed, Succeeded, Canceled, Deleting)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_cluster

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.
linkIdentifier	string	The link identifier.
privateEndpoint	object	The private endpoint of the private endpoint connection.
privateLinkServiceConnectionState	object	The private link service connection state. Required.
provisioningState	string	The provisioning state, which only appears in the response. Known values are: "InProgress", "Updating", "Failed", "Succeeded", "Canceled", and "Deleting". (InProgress, Updating, Failed, Succeeded, Canceled, Deleting)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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	resource_group_name, cluster_name, private_endpoint_connection_name, subscription_id		Gets the specific private endpoint connection.
list_by_cluster	select	resource_group_name, cluster_name, subscription_id		Lists the private endpoint connections for a HDInsight cluster.
create_or_update	insert	resource_group_name, cluster_name, private_endpoint_connection_name, subscription_id, properties		Approve or reject a private endpoint connection manually.
create_or_update	replace	resource_group_name, cluster_name, private_endpoint_connection_name, subscription_id, properties		Approve or reject a private endpoint connection manually.
delete	delete	resource_group_name, cluster_name, private_endpoint_connection_name, subscription_id		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
cluster_name	string	The name of the cluster. Required.
private_endpoint_connection_name	string	The name of the private endpoint connection. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets the specific private endpoint connection.

SELECT
id,
name,
linkIdentifier,
privateEndpoint,
privateLinkServiceConnectionState,
provisioningState,
systemData,
type
FROM azure.hdinsight.private_endpoint_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_cluster

Lists the private endpoint connections for a HDInsight cluster.

SELECT
id,
name,
linkIdentifier,
privateEndpoint,
privateLinkServiceConnectionState,
provisioningState,
systemData,
type
FROM azure.hdinsight.private_endpoint_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Approve or reject a private endpoint connection manually.

INSERT INTO azure.hdinsight.private_endpoint_connections (
properties,
resource_group_name,
cluster_name,
private_endpoint_connection_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ cluster_name }}',
'{{ private_endpoint_connection_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: private_endpoint_connections
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the private_endpoint_connections resource.
  - name: cluster_name
    value: "{{ cluster_name }}"
    description: Required parameter for the private_endpoint_connections resource.
  - name: private_endpoint_connection_name
    value: "{{ private_endpoint_connection_name }}"
    description: Required parameter for the private_endpoint_connections resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the private_endpoint_connections resource.
  - name: properties
    description: |
      The private endpoint connection properties. Required.
    value:
      privateEndpoint:
        id: "{{ id }}"
      privateLinkServiceConnectionState:
        status: "{{ status }}"
        description: "{{ description }}"
        actionsRequired: "{{ actionsRequired }}"
      linkIdentifier: "{{ linkIdentifier }}"
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

Approve or reject a private endpoint connection manually.

REPLACE azure.hdinsight.private_endpoint_connections
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes the specific private endpoint connection.

DELETE FROM azure.hdinsight.private_endpoint_connections
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;