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
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
administratorType	string	Workspace active directory administrator type.
login	string	Login of the workspace active directory administrator.
sid	string	Object ID of the workspace active directory administrator.
tenantId	string	Tenant ID of the workspace active directory administrator.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, workspace_name, subscription_id		Gets a workspace active directory admin.
create_or_update	insert	resource_group_name, workspace_name, subscription_id		Creates or updates a workspace active directory admin.
create_or_update	replace	resource_group_name, workspace_name, subscription_id		Creates or updates a workspace active directory admin.
delete	delete	resource_group_name, workspace_name, subscription_id		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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
workspace_name	string	The name of the workspace. Required.

SELECT examples

get

Gets a workspace active directory admin.

SELECT
id,
name,
administratorType,
login,
sid,
tenantId,
type
FROM azure.synapse.workspace_aad_admins
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a workspace active directory admin.

INSERT INTO azure.synapse.workspace_aad_admins (
properties,
resource_group_name,
workspace_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: workspace_aad_admins
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the workspace_aad_admins resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the workspace_aad_admins resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the workspace_aad_admins resource.
  - name: properties
    value:
      tenantId: "{{ tenantId }}"
      login: "{{ login }}"
      administratorType: "{{ administratorType }}"
      sid: "{{ sid }}"

REPLACE examples

create_or_update

Creates or updates a workspace active directory admin.

REPLACE azure.synapse.workspace_aad_admins
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
type;

DELETE examples

delete

Deletes a workspace active directory admin.

DELETE FROM azure.synapse.workspace_aad_admins
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;