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

vw_private_endpoint_connections

Name	Datatype	Description
id	text	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	text	The name of the resource
clusterName	text	field from the properties object
privateEndpointConnectionName	text	field from the properties object
private_endpoint	text	field from the properties object
private_link_service_connection_state	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object
type	text	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

private_endpoint_connections

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	Properties of the PrivateEndpointConnectProperties.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

Name	Accessible by	Required Params	Description
get	SELECT	clusterName, privateEndpointConnectionName, resourceGroupName, subscriptionId	Gets the specific private endpoint connection.
list_by_cluster	SELECT	clusterName, resourceGroupName, subscriptionId	Lists the private endpoint connections for a HDInsight cluster.
create_or_update	INSERT	clusterName, privateEndpointConnectionName, resourceGroupName, subscriptionId	Approve or reject a private endpoint connection manually.
delete	DELETE	clusterName, privateEndpointConnectionName, resourceGroupName, subscriptionId	Deletes the specific private endpoint connection.

SELECT examples

Lists the private endpoint connections for a HDInsight cluster.

vw_private_endpoint_connections

SELECT
id,
name,
clusterName,
privateEndpointConnectionName,
private_endpoint,
private_link_service_connection_state,
provisioning_state,
resourceGroupName,
subscriptionId,
type
FROM azure.hdinsight.vw_private_endpoint_connections
WHERE clusterName = '{{ clusterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

private_endpoint_connections

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

INSERT example

Use the following StackQL query and manifest file to create a new private_endpoint_connections resource.

All Properties

/*+ create */
INSERT INTO azure.hdinsight.private_endpoint_connections (
clusterName,
privateEndpointConnectionName,
resourceGroupName,
subscriptionId,
properties
)
SELECT 
'{{ clusterName }}',
'{{ privateEndpointConnectionName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: privateEndpoint
          value:
            - name: id
              value: string
        - name: privateLinkServiceConnectionState
          value:
            - name: status
              value: []
            - name: description
              value: string
            - name: actionsRequired
              value: string
        - name: provisioningState
          value: []
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string

DELETE example

Deletes the specified private_endpoint_connections resource.

/*+ delete */
DELETE FROM azure.hdinsight.private_endpoint_connections
WHERE clusterName = '{{ clusterName }}'
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';