kusto_pool_database_principal_assignments

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

Overview

Name	kusto_pool_database_principal_assignments
Type	Resource
Id	azure.synapse.kusto_pool_database_principal_assignments

Fields

vw_kusto_pool_database_principal_assignments

Name	Datatype	Description
aad_object_id	text	field from the properties object
databaseName	text	field from the properties object
kustoPoolName	text	field from the properties object
principalAssignmentName	text	field from the properties object
principal_id	text	field from the properties object
principal_name	text	field from the properties object
principal_type	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
role	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
tenant_id	text	field from the properties object
tenant_name	text	field from the properties object
workspaceName	text	field from the properties object

kusto_pool_database_principal_assignments

Name	Datatype	Description
properties	object	A class representing database principal property.
systemData	object	Metadata pertaining to creation and last modification of the resource.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	databaseName, kustoPoolName, principalAssignmentName, resourceGroupName, subscriptionId, workspaceName	Gets a Kusto pool database principalAssignment.
list	SELECT	databaseName, kustoPoolName, resourceGroupName, subscriptionId, workspaceName	Lists all Kusto pool database principalAssignments.
create_or_update	INSERT	databaseName, kustoPoolName, principalAssignmentName, resourceGroupName, subscriptionId, workspaceName	Creates a Kusto pool database principalAssignment.
delete	DELETE	databaseName, kustoPoolName, principalAssignmentName, resourceGroupName, subscriptionId, workspaceName	Deletes a Kusto pool principalAssignment.
check_name_availability	EXEC	databaseName, kustoPoolName, resourceGroupName, subscriptionId, workspaceName, data__name, data__type	Checks that the database principal assignment is valid and is not already in use.

SELECT examples

Lists all Kusto pool database principalAssignments.

vw_kusto_pool_database_principal_assignments

SELECT
aad_object_id,
databaseName,
kustoPoolName,
principalAssignmentName,
principal_id,
principal_name,
principal_type,
provisioning_state,
resourceGroupName,
role,
subscriptionId,
system_data,
tenant_id,
tenant_name,
workspaceName
FROM azure.synapse.vw_kusto_pool_database_principal_assignments
WHERE databaseName = '{{ databaseName }}'
AND kustoPoolName = '{{ kustoPoolName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

kusto_pool_database_principal_assignments

SELECT
properties,
systemData
FROM azure.synapse.kusto_pool_database_principal_assignments
WHERE databaseName = '{{ databaseName }}'
AND kustoPoolName = '{{ kustoPoolName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

INSERT example

Use the following StackQL query and manifest file to create a new kusto_pool_database_principal_assignments resource.

All Properties

/*+ create */
INSERT INTO azure.synapse.kusto_pool_database_principal_assignments (
databaseName,
kustoPoolName,
principalAssignmentName,
resourceGroupName,
subscriptionId,
workspaceName,
properties
)
SELECT 
'{{ databaseName }}',
'{{ kustoPoolName }}',
'{{ principalAssignmentName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ workspaceName }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: principalId
          value: string
        - name: role
          value: string
        - name: tenantId
          value: string
        - name: principalType
          value: string
        - name: tenantName
          value: string
        - name: principalName
          value: string
        - name: provisioningState
          value: []
        - name: aadObjectId
          value: string
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string

DELETE example

Deletes the specified kusto_pool_database_principal_assignments resource.

/*+ delete */
DELETE FROM azure.synapse.kusto_pool_database_principal_assignments
WHERE databaseName = '{{ databaseName }}'
AND kustoPoolName = '{{ kustoPoolName }}'
AND principalAssignmentName = '{{ principalAssignmentName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';