cluster_principal_assignments

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

Overview

Name	cluster_principal_assignments
Type	Resource
Id	azure.data_explorer.cluster_principal_assignments

Fields

The following fields are returned by SELECT queries:

get

The Kusto cluster principal assignment object.

Name	Datatype	Description
properties	object	The cluster principal.

list

OK.

Name	Datatype	Description
properties	object	The cluster principal.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, clusterName, principalAssignmentName		Gets a Kusto cluster principalAssignment.
list	select	subscriptionId, resourceGroupName, clusterName		Lists all Kusto cluster principalAssignments.
create_or_update	insert	subscriptionId, resourceGroupName, clusterName, principalAssignmentName		Create a Kusto cluster principalAssignment.
delete	delete	subscriptionId, resourceGroupName, clusterName, principalAssignmentName		Deletes a Kusto cluster principalAssignment.
check_name_availability	exec	resourceGroupName, clusterName, subscriptionId, name, type		Checks that the principal assignment 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.
principalAssignmentName	string	The name of the Kusto principalAssignment.
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 Kusto cluster principalAssignment.

SELECT
properties
FROM azure.data_explorer.cluster_principal_assignments
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
AND principalAssignmentName = '{{ principalAssignmentName }}' -- required
;

list

Lists all Kusto cluster principalAssignments.

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

INSERT examples

create_or_update

Create a Kusto cluster principalAssignment.

INSERT INTO azure.data_explorer.cluster_principal_assignments (
data__properties,
subscriptionId,
resourceGroupName,
clusterName,
principalAssignmentName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ clusterName }}',
'{{ principalAssignmentName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: cluster_principal_assignments
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the cluster_principal_assignments resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the cluster_principal_assignments resource.
    - name: clusterName
      value: string
      description: Required parameter for the cluster_principal_assignments resource.
    - name: principalAssignmentName
      value: string
      description: Required parameter for the cluster_principal_assignments resource.
    - name: properties
      value: object
      description: |
        The cluster principal.

DELETE examples

delete

Deletes a Kusto cluster principalAssignment.

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

Lifecycle Methods

check_name_availability

Checks that the principal assignment name is valid and is not already in use.

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