Microsoft.Synapse workspaces/administrators 2021-04-01-preview
Bicep resource definition
The workspaces/administrators resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Synapse/workspaces/administrators resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Synapse/workspaces/administrators@2021-04-01-preview' = {
name: 'activeDirectory'
parent: resourceSymbolicName
properties: {
administratorType: 'string'
login: 'string'
sid: 'string'
tenantId: 'string'
}
}
Property values
workspaces/administrators
Name | Description | Value |
---|---|---|
name | The resource name See how to set names and types for child resources in Bicep. |
'activeDirectory' |
parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: workspaces |
properties | Workspace active directory administrator properties | AadAdminProperties |
AadAdminProperties
Name | Description | Value |
---|---|---|
administratorType | Workspace active directory administrator type | string |
login | Login of the workspace active directory administrator | string |
sid | Object ID of the workspace active directory administrator | string |
tenantId | Tenant ID of the workspace active directory administrator | string |
ARM template resource definition
The workspaces/administrators resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Synapse/workspaces/administrators resource, add the following JSON to your template.
{
"type": "Microsoft.Synapse/workspaces/administrators",
"apiVersion": "2021-04-01-preview",
"name": "activeDirectory",
"properties": {
"administratorType": "string",
"login": "string",
"sid": "string",
"tenantId": "string"
}
}
Property values
workspaces/administrators
Name | Description | Value |
---|---|---|
type | The resource type | 'Microsoft.Synapse/workspaces/administrators' |
apiVersion | The resource api version | '2021-04-01-preview' |
name | The resource name See how to set names and types for child resources in JSON ARM templates. |
'activeDirectory' |
properties | Workspace active directory administrator properties | AadAdminProperties |
AadAdminProperties
Name | Description | Value |
---|---|---|
administratorType | Workspace active directory administrator type | string |
login | Login of the workspace active directory administrator | string |
sid | Object ID of the workspace active directory administrator | string |
tenantId | Tenant ID of the workspace active directory administrator | string |
Terraform (AzAPI provider) resource definition
The workspaces/administrators resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Synapse/workspaces/administrators resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Synapse/workspaces/administrators@2021-04-01-preview"
name = "activeDirectory"
parent_id = "string"
body = jsonencode({
properties = {
administratorType = "string"
login = "string"
sid = "string"
tenantId = "string"
}
})
}
Property values
workspaces/administrators
Name | Description | Value |
---|---|---|
type | The resource type | "Microsoft.Synapse/workspaces/administrators@2021-04-01-preview" |
name | The resource name | "activeDirectory" |
parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: workspaces |
properties | Workspace active directory administrator properties | AadAdminProperties |
AadAdminProperties
Name | Description | Value |
---|---|---|
administratorType | Workspace active directory administrator type | string |
login | Login of the workspace active directory administrator | string |
sid | Object ID of the workspace active directory administrator | string |
tenantId | Tenant ID of the workspace active directory administrator | string |
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for