managed_private_endpoints

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

Overview

Name	managed_private_endpoints
Type	Resource
Id	azure.data_explorer.managed_private_endpoints

Fields

The following fields are returned by SELECT queries:

get

The managed private endpoint object.

Name	Datatype	Description
properties	object	A managed private endpoint.
systemData	object	Metadata pertaining to creation and last modification of the resource.

list

The list result of managed private endpoints.

Name	Datatype	Description
properties	object	A managed private endpoint.
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, managedPrivateEndpointName		Gets a managed private endpoint.
list	select	subscriptionId, resourceGroupName, clusterName		Returns the list of managed private endpoints.
create_or_update	insert	subscriptionId, resourceGroupName, clusterName, managedPrivateEndpointName		Creates a managed private endpoint.
update	update	subscriptionId, resourceGroupName, clusterName, managedPrivateEndpointName		Updates a managed private endpoint.
delete	delete	subscriptionId, resourceGroupName, clusterName, managedPrivateEndpointName		Deletes a managed private endpoint.
check_name_availability	exec	resourceGroupName, clusterName, subscriptionId, name, type		Checks that the managed private endpoints resource name is valid and is not already in use.

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

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

list

Returns the list of managed private endpoints.

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

INSERT examples

create_or_update

Creates a managed private endpoint.

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

Manifest

# Description fields are for documentation purposes
- name: managed_private_endpoints
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the managed_private_endpoints resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the managed_private_endpoints resource.
    - name: clusterName
      value: string
      description: Required parameter for the managed_private_endpoints resource.
    - name: managedPrivateEndpointName
      value: string
      description: Required parameter for the managed_private_endpoints resource.
    - name: properties
      value: object
      description: |
        A managed private endpoint.

UPDATE examples

update

Updates a managed private endpoint.

UPDATE azure.data_explorer.managed_private_endpoints
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND managedPrivateEndpointName = '{{ managedPrivateEndpointName }}' --required
RETURNING
properties,
systemData;

DELETE examples

delete

Deletes a managed private endpoint.

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

Lifecycle Methods

check_name_availability

Checks that the managed private endpoints resource name is valid and is not already in use.

EXEC azure.data_explorer.managed_private_endpoints.check_name_availability 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"name": "{{ name }}", 
"type": "{{ type }}"
}'
;