workspace_sql_aad_admins

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

Overview

Name	workspace_sql_aad_admins
Type	Resource
Id	azure.synapse.workspace_sql_aad_admins

Fields

vw_workspace_sql_aad_admins

Name	Datatype	Description
administrator_type	text	field from the properties object
login	text	field from the properties object
resourceGroupName	text	field from the properties object
sid	text	field from the properties object
subscriptionId	text	field from the properties object
tenant_id	text	field from the properties object
workspaceName	text	field from the properties object

workspace_sql_aad_admins

Name	Datatype	Description
properties	object	Workspace active directory administrator properties

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, subscriptionId, workspaceName	Gets a workspace SQL active directory admin
create_or_update	INSERT	resourceGroupName, subscriptionId, workspaceName	Creates or updates a workspace SQL active directory admin
delete	DELETE	resourceGroupName, subscriptionId, workspaceName	Deletes a workspace SQL active directory admin

SELECT examples

Gets a workspace SQL active directory admin

vw_workspace_sql_aad_admins

SELECT
administrator_type,
login,
resourceGroupName,
sid,
subscriptionId,
tenant_id,
workspaceName
FROM azure.synapse.vw_workspace_sql_aad_admins
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

workspace_sql_aad_admins

SELECT
properties
FROM azure.synapse.workspace_sql_aad_admins
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

INSERT example

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

All Properties

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

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: tenantId
          value: string
        - name: login
          value: string
        - name: administratorType
          value: string
        - name: sid
          value: string

DELETE example

Deletes the specified workspace_sql_aad_admins resource.

/*+ delete */
DELETE FROM azure.synapse.workspace_sql_aad_admins
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';