managed_private_endpoints

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

Overview

Name	managed_private_endpoints
Type	Resource
Id	azure.kusto.managed_private_endpoints

Fields

The following fields are returned by SELECT queries:

check_name_availability

Name	Datatype	Description
name	string	The name that was checked.
message	string	Message indicating an unavailable name due to a conflict, or a description of the naming rules that are violated.
nameAvailable	boolean	Specifies a Boolean value that indicates if the name is available.
reason	string	Message providing the reason why the given name is invalid. Known values are: "Invalid" and "AlreadyExists". (Invalid, AlreadyExists)

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.
groupId	string	The groupId in which the managed private endpoint is created. Required.
privateLinkResourceId	string	The ARM resource ID of the resource for which the managed private endpoint is created. Required.
privateLinkResourceRegion	string	The region of the resource to which the managed private endpoint is created.
provisioningState	string	The provisioned state of the resource. Known values are: "Running", "Creating", "Deleting", "Succeeded", "Failed", "Moving", and "Canceled". (Running, Creating, Deleting, Succeeded, Failed, Moving, Canceled)
requestMessage	string	The user request message.
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

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.
groupId	string	The groupId in which the managed private endpoint is created. Required.
privateLinkResourceId	string	The ARM resource ID of the resource for which the managed private endpoint is created. Required.
privateLinkResourceRegion	string	The region of the resource to which the managed private endpoint is created.
provisioningState	string	The provisioned state of the resource. Known values are: "Running", "Creating", "Deleting", "Succeeded", "Failed", "Moving", and "Canceled". (Running, Creating, Deleting, Succeeded, Failed, Moving, Canceled)
requestMessage	string	The user request message.
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
check_name_availability	select	resource_group_name, cluster_name, subscription_id		Checks that the managed private endpoints resource name is valid and is not already in use.
get	select	resource_group_name, cluster_name, managed_private_endpoint_name, subscription_id		Gets a managed private endpoint.
list	select	resource_group_name, cluster_name, subscription_id		Returns the list of managed private endpoints.
create_or_update	insert	resource_group_name, cluster_name, managed_private_endpoint_name, subscription_id		Creates a managed private endpoint.
update	update	resource_group_name, cluster_name, managed_private_endpoint_name, subscription_id		Updates a managed private endpoint.
create_or_update	replace	resource_group_name, cluster_name, managed_private_endpoint_name, subscription_id		Creates a managed private endpoint.
delete	delete	resource_group_name, cluster_name, managed_private_endpoint_name, subscription_id		Deletes a managed private endpoint.

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 Kusto cluster. Required.
managed_private_endpoint_name	string	The name of the managed private endpoint. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

check_name_availability

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

SELECT
name,
message,
nameAvailable,
reason
FROM azure.kusto.managed_private_endpoints
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Gets a managed private endpoint.

SELECT
id,
name,
groupId,
privateLinkResourceId,
privateLinkResourceRegion,
provisioningState,
requestMessage,
systemData,
type
FROM azure.kusto.managed_private_endpoints
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND managed_private_endpoint_name = '{{ managed_private_endpoint_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Returns the list of managed private endpoints.

SELECT
id,
name,
groupId,
privateLinkResourceId,
privateLinkResourceRegion,
provisioningState,
requestMessage,
systemData,
type
FROM azure.kusto.managed_private_endpoints
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

Creates a managed private endpoint.

INSERT INTO azure.kusto.managed_private_endpoints (
properties,
resource_group_name,
cluster_name,
managed_private_endpoint_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ cluster_name }}',
'{{ managed_private_endpoint_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: managed_private_endpoints
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the managed_private_endpoints resource.
  - name: cluster_name
    value: "{{ cluster_name }}"
    description: Required parameter for the managed_private_endpoints resource.
  - name: managed_private_endpoint_name
    value: "{{ managed_private_endpoint_name }}"
    description: Required parameter for the managed_private_endpoints resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the managed_private_endpoints resource.
  - name: properties
    description: |
      A managed private endpoint.
    value:
      privateLinkResourceId: "{{ privateLinkResourceId }}"
      privateLinkResourceRegion: "{{ privateLinkResourceRegion }}"
      groupId: "{{ groupId }}"
      requestMessage: "{{ requestMessage }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

Updates a managed private endpoint.

UPDATE azure.kusto.managed_private_endpoints
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND managed_private_endpoint_name = '{{ managed_private_endpoint_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

Creates a managed private endpoint.

REPLACE azure.kusto.managed_private_endpoints
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND managed_private_endpoint_name = '{{ managed_private_endpoint_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes a managed private endpoint.

DELETE FROM azure.kusto.managed_private_endpoints
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND managed_private_endpoint_name = '{{ managed_private_endpoint_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;