Microsoft.Synapse workspaces/sqlAdministrators 2019-06-01-preview

The workspaces/sqlAdministrators resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.Synapse/workspaces/sqlAdministrators resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.Synapse/workspaces/sqlAdministrators@2019-06-01-preview' = {
  name: 'activeDirectory'
  parent: parentSymbolicName
  properties: {
    administratorType: 'string'
    login: 'string'
    sid: 'string'
    tenantId: 'string'
  }
}

Property values

workspaces/sqlAdministrators

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.Synapse/workspaces/sqlAdministrators'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2019-06-01-preview'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.
'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.
parentSymbolicName
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