kusto_pool_principal_assignments

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

Overview

Name	kusto_pool_principal_assignments
Type	Resource
Id	azure.synapse.kusto_pool_principal_assignments

Fields

The following fields are returned by SELECT queries:

get

The Kusto pool principal assignment object.

Name	Datatype	Description
properties	object	The cluster principal.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.

list

OK.

Name	Datatype	Description
properties	object	The cluster principal.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	workspaceName, kustoPoolName, principalAssignmentName, subscriptionId, resourceGroupName		Gets a Kusto pool principalAssignment.
list	select	workspaceName, kustoPoolName, subscriptionId, resourceGroupName		Lists all Kusto pool principalAssignments.
create_or_update	insert	workspaceName, kustoPoolName, principalAssignmentName, subscriptionId, resourceGroupName		Create a Kusto pool principalAssignment.
delete	delete	workspaceName, kustoPoolName, principalAssignmentName, subscriptionId, resourceGroupName		Deletes a Kusto pool principalAssignment.
check_name_availability	exec	workspaceName, kustoPoolName, subscriptionId, resourceGroupName, 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
kustoPoolName	string	The name of the Kusto pool.
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.
workspaceName	string	The name of the workspace.

SELECT examples

get

Gets a Kusto pool principalAssignment.

SELECT
properties,
systemData
FROM azure.synapse.kusto_pool_principal_assignments
WHERE workspaceName = '{{ workspaceName }}' -- required
AND kustoPoolName = '{{ kustoPoolName }}' -- required
AND principalAssignmentName = '{{ principalAssignmentName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list

Lists all Kusto pool principalAssignments.

SELECT
properties,
systemData
FROM azure.synapse.kusto_pool_principal_assignments
WHERE workspaceName = '{{ workspaceName }}' -- required
AND kustoPoolName = '{{ kustoPoolName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

INSERT examples

create_or_update

Create a Kusto pool principalAssignment.

INSERT INTO azure.synapse.kusto_pool_principal_assignments (
data__properties,
workspaceName,
kustoPoolName,
principalAssignmentName,
subscriptionId,
resourceGroupName
)
SELECT 
'{{ properties }}',
'{{ workspaceName }}',
'{{ kustoPoolName }}',
'{{ principalAssignmentName }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}'
RETURNING
properties,
systemData
;

Manifest

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

DELETE examples

delete

Deletes a Kusto pool principalAssignment.

DELETE FROM azure.synapse.kusto_pool_principal_assignments
WHERE workspaceName = '{{ workspaceName }}' --required
AND kustoPoolName = '{{ kustoPoolName }}' --required
AND principalAssignmentName = '{{ principalAssignmentName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
;

Lifecycle Methods

check_name_availability

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

EXEC azure.synapse.kusto_pool_principal_assignments.check_name_availability 
@workspaceName='{{ workspaceName }}' --required, 
@kustoPoolName='{{ kustoPoolName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required 
@@json=
'{
"name": "{{ name }}", 
"type": "{{ type }}"
}'
;