database_principal_assignments

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

Overview

Name	database_principal_assignments
Type	Resource
Id	azure.data_explorer.database_principal_assignments

Fields

The following fields are returned by SELECT queries:

get

The Kusto cluster database principal assignment object.

Name	Datatype	Description
properties	object	The database principal.

list

OK.

Name	Datatype	Description
properties	object	The database principal.

Methods

The following methods are available for this resource:

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

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

list

Lists all Kusto cluster database principalAssignments.

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

INSERT examples

create_or_update

Creates a Kusto cluster database principalAssignment.

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

Manifest

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

DELETE examples

delete

Deletes a Kusto principalAssignment.

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

Lifecycle Methods

check_name_availability

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

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