Share via

Microsoft.Synapse workspaces/azureADOnlyAuthentications 2021-06-01-preview

Bicep resource definition

The workspaces/azureADOnlyAuthentications resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

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

resource symbolicname 'Microsoft.Synapse/workspaces/azureADOnlyAuthentications@2021-06-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    azureADOnlyAuthentication: bool
  }
}

Property Values

Microsoft.Synapse/workspaces/azureADOnlyAuthentications

Name Description Value
name The resource name 'default' (required)
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 Azure Active Directory Only Authentication resource properties AzureADOnlyAuthenticationProperties

AzureADOnlyAuthenticationProperties

Name Description Value
azureADOnlyAuthentication Azure Active Directory Only Authentication enabled bool (required)

ARM template resource definition

The workspaces/azureADOnlyAuthentications resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

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

{
  "type": "Microsoft.Synapse/workspaces/azureADOnlyAuthentications",
  "apiVersion": "2021-06-01-preview",
  "name": "string",
  "properties": {
    "azureADOnlyAuthentication": "bool"
  }
}

Property Values

Microsoft.Synapse/workspaces/azureADOnlyAuthentications

Name Description Value
apiVersion The api version '2021-06-01-preview'
name The resource name 'default' (required)
properties Azure Active Directory Only Authentication resource properties AzureADOnlyAuthenticationProperties
type The resource type 'Microsoft.Synapse/workspaces/azureADOnlyAuthentications'

AzureADOnlyAuthenticationProperties

Name Description Value
azureADOnlyAuthentication Azure Active Directory Only Authentication enabled bool (required)

Usage Examples

Terraform (AzAPI provider) resource definition

The workspaces/azureADOnlyAuthentications resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Synapse/workspaces/azureADOnlyAuthentications resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Synapse/workspaces/azureADOnlyAuthentications@2021-06-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      azureADOnlyAuthentication = bool
    }
  }
}

Property Values

Microsoft.Synapse/workspaces/azureADOnlyAuthentications

Name Description Value
name The resource name 'default' (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: workspaces
properties Azure Active Directory Only Authentication resource properties AzureADOnlyAuthenticationProperties
type The resource type "Microsoft.Synapse/workspaces/azureADOnlyAuthentications@2021-06-01-preview"

AzureADOnlyAuthenticationProperties

Name Description Value
azureADOnlyAuthentication Azure Active Directory Only Authentication enabled bool (required)

Usage Examples

Terraform Samples

A basic example of deploying Synapse Workspaces Azure AD Only Authentications.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "eastus"
}

variable "sql_administrator_login" {
  type        = string
  description = "The SQL administrator login for the Synapse workspace"
}

variable "sql_administrator_login_password" {
  type        = string
  description = "The SQL administrator login password for the Synapse workspace"
  sensitive   = true
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "storageAccount" {
  type      = "Microsoft.Storage/storageAccounts@2021-09-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    kind = "StorageV2"
    properties = {
    }
    sku = {
      name = "Standard_LRS"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

data "azapi_resource_action" "listKeys" {
  type                   = "Microsoft.Storage/storageAccounts@2022-09-01"
  resource_id            = azapi_resource.storageAccount.id
  action                 = "listKeys"
  response_export_values = ["*"]
}

data "azapi_resource" "blobService" {
  type      = "Microsoft.Storage/storageAccounts/blobServices@2022-09-01"
  parent_id = azapi_resource.storageAccount.id
  name      = "default"
}

resource "azapi_resource" "container" {
  type      = "Microsoft.Storage/storageAccounts/blobServices/containers@2022-09-01"
  name      = var.resource_name
  parent_id = data.azapi_resource.blobService.id
  body = {
    properties = {
      metadata = {
        key = "value"
      }
    }
  }
  response_export_values = ["*"]
}

resource "azapi_resource" "workspace" {
  type      = "Microsoft.Synapse/workspaces@2021-06-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  identity {
    type         = "SystemAssigned"
    identity_ids = []
  }
  body = {
    properties = {
      defaultDataLakeStorage = {
        accountUrl = azapi_resource.storageAccount.output.properties.primaryEndpoints.dfs
        filesystem = azapi_resource.container.name
      }
      managedVirtualNetwork         = ""
      publicNetworkAccess           = "Enabled"
      sqlAdministratorLogin         = var.sql_administrator_login
      sqlAdministratorLoginPassword = var.sql_administrator_login_password
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_update_resource" "synapse_azuread_only_authentication" {
  type      = "Microsoft.Synapse/workspaces/azureADOnlyAuthentications@2021-06-01-preview"
  parent_id = azapi_resource.workspace.id
  name      = "default"

  body = {
    properties = {
      azureADOnlyAuthentication = true
    }
  }
}
  • Last updated on