workspace_aad_admins

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

Overview

Name	workspace_aad_admins
Type	Resource
Id	azure.synapse.workspace_aad_admins

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	Workspace active directory administrator properties

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, workspaceName		Gets a workspace active directory admin
create_or_update	insert	subscriptionId, resourceGroupName, workspaceName		Creates or updates a workspace active directory admin
delete	delete	subscriptionId, resourceGroupName, workspaceName		Deletes a workspace active directory admin

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
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 workspace active directory admin

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

INSERT examples

create_or_update

Creates or updates a workspace active directory admin

INSERT INTO azure.synapse.workspace_aad_admins (
data__properties,
subscriptionId,
resourceGroupName,
workspaceName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ workspaceName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: workspace_aad_admins
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the workspace_aad_admins resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the workspace_aad_admins resource.
    - name: workspaceName
      value: string
      description: Required parameter for the workspace_aad_admins resource.
    - name: properties
      value: object
      description: |
        Workspace active directory administrator properties

DELETE examples

delete

Deletes a workspace active directory admin

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