private_endpoint_connections

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

Overview

Name	private_endpoint_connections
Type	Resource
Id	azure.data_explorer.private_endpoint_connections

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved a specified private endpoint connection.

Name	Datatype	Description
properties	object	Resource properties.
systemData	object	Metadata pertaining to creation and last modification of the resource.

list

The list result of private endpoint connections.

Name	Datatype	Description
properties	object	Resource properties.
systemData	object	Metadata pertaining to creation and last modification of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, clusterName, privateEndpointConnectionName		Gets a private endpoint connection.
list	select	subscriptionId, resourceGroupName, clusterName		Returns the list of private endpoint connections.
create_or_update	insert	subscriptionId, resourceGroupName, clusterName, privateEndpointConnectionName		Approve or reject a private endpoint connection with a given name.
delete	delete	subscriptionId, resourceGroupName, clusterName, privateEndpointConnectionName		Deletes a private endpoint connection with a given name.

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 Kusto cluster.
privateEndpointConnectionName	string	The name of the private endpoint connection.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets a private endpoint connection.

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

list

Returns the list of private endpoint connections.

SELECT
properties,
systemData
FROM azure.data_explorer.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 with a given name.

INSERT INTO azure.data_explorer.private_endpoint_connections (
data__properties,
subscriptionId,
resourceGroupName,
clusterName,
privateEndpointConnectionName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ clusterName }}',
'{{ privateEndpointConnectionName }}'
RETURNING
properties,
systemData
;

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: |
        Resource properties.

DELETE examples

delete

Deletes a private endpoint connection with a given name.

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