Workspaces/managedIdentitySqlControlSettings do Microsoft.Synapse

• última
• 2021-06-01
• 2021-06-01-visualização
• 2021-05-01
• 2021-04-01-visualização
• 2021-03-01
• 2020-12-01
• 2019-06-01-visualização

Definição de recurso do Bicep

O tipo de recurso workspaces/managedIdentitySqlControlSettings pode ser implantado com operações direcionadas:

• Grupos de recursos - Consulte comandos de implantação do grupo de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings, adicione o seguinte Bicep ao modelo.

resource symbolicname 'Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings@2021-06-01' = {
  parent: resourceSymbolicName
  name: 'default'
  properties: {
    grantSqlControlToManagedIdentity: {
      desiredState: 'string'
    }
  }
}

Valores da propriedade

Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings

Nome	Descrição	Valor
nome	O nome do recurso	'default' (obrigatório)
pai	No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai. Para obter mais informações, consulte recurso filho fora do recurso pai.	Nome simbólico para o recurso do tipo: workspaces
Propriedades	Configurações de controle sql para identidade gerenciada do workspace	ManagedIdentitySqlControlSettingsModelProperties

ManagedIdentitySqlControlSettingsModelProperties

Nome	Descrição	Valor
grantSqlControlToManagedIdentity	Conceder controle sql à identidade gerenciada	ManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentity

ManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentity

Nome	Descrição	Valor
estado desejado	Estado desejado	'Desabilitado' 'Habilitado'

Exemplos de uso

Exemplos do Bicep

Um exemplo básico de implantação de Configurações de Controle SQL de Identidade Gerenciada de Workspaces do Synapse.

param resourceName string = 'acctest0001'
param location string = 'westeurope'
@description('The SQL administrator login name for the Synapse workspace')
param sqlAdministratorLogin string
@secure()
@description('The SQL administrator login password for the Synapse workspace')
param sqlAdministratorLoginPassword string

resource blobService 'Microsoft.Storage/storageAccounts/blobServices@2022-09-01' existing = {
  parent: storageAccount
  name: 'default'
}

resource storageAccount 'Microsoft.Storage/storageAccounts@2021-09-01' = {
  name: resourceName
  location: location
  kind: 'StorageV2'
  properties: {}
  sku: {
    name: 'Standard_LRS'
  }
}

resource workspace 'Microsoft.Synapse/workspaces@2021-06-01' = {
  name: resourceName
  location: location
  properties: {
    defaultDataLakeStorage: {
      accountUrl: storageAccount.properties.primaryEndpoints.dfs
      filesystem: container.name
    }

    managedVirtualNetwork: ''
    publicNetworkAccess: 'Enabled'
    sqlAdministratorLogin: sqlAdministratorLogin
    sqlAdministratorLoginPassword: sqlAdministratorLoginPassword
  }
}

resource managedIdentitySqlControlSetting 'Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings@2021-06-01' = {
  parent: workspace
  name: 'default'
  properties: {
    grantSqlControlToManagedIdentity: {
      desiredState: 'Disabled'
    }
  }
}

resource container 'Microsoft.Storage/storageAccounts/blobServices/containers@2022-09-01' = {
  parent: blobService
  name: resourceName
  properties: {
    metadata: {
      key: 'value'
    }
  }
}

Definição de recurso de modelo do ARM

O tipo de recurso workspaces/managedIdentitySqlControlSettings pode ser implantado com operações direcionadas:

• Grupos de recursos - Consulte comandos de implantação do grupo de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings, adicione o JSON a seguir ao modelo.

{
  "type": "Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings",
  "apiVersion": "2021-06-01",
  "name": "string",
  "properties": {
    "grantSqlControlToManagedIdentity": {
      "desiredState": "string"
    }
  }
}

Valores da propriedade

Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings

Nome	Descrição	Valor
apiVersion	A versão da API	'2021-06-01'
nome	O nome do recurso	'default' (obrigatório)
Propriedades	Configurações de controle sql para identidade gerenciada do workspace	ManagedIdentitySqlControlSettingsModelProperties
tipo	O tipo de recurso	'Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings'

ManagedIdentitySqlControlSettingsModelProperties

Nome	Descrição	Valor
grantSqlControlToManagedIdentity	Conceder controle sql à identidade gerenciada	ManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentity

ManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentity

Nome	Descrição	Valor
estado desejado	Estado desejado	'Desabilitado' 'Habilitado'

Exemplos de uso

Definição de recurso do Terraform (provedor de AzAPI)

O tipo de recurso workspaces/managedIdentitySqlControlSettings pode ser implantado com operações direcionadas:

• Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings, adicione o Terraform a seguir ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings@2021-06-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      grantSqlControlToManagedIdentity = {
        desiredState = "string"
      }
    }
  }
}

Valores da propriedade

Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings

Nome	Descrição	Valor
nome	O nome do recurso	'default' (obrigatório)
parent_id	A ID do recurso que é o pai desse recurso.	ID do recurso do tipo: workspaces
Propriedades	Configurações de controle sql para identidade gerenciada do workspace	ManagedIdentitySqlControlSettingsModelProperties
tipo	O tipo de recurso	"Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings@2021-06-01"

ManagedIdentitySqlControlSettingsModelProperties

Nome	Descrição	Valor
grantSqlControlToManagedIdentity	Conceder controle sql à identidade gerenciada	ManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentity

ManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentity

Nome	Descrição	Valor
estado desejado	Estado desejado	'Desabilitado' 'Habilitado'

Exemplos de uso

Exemplos do Terraform

Um exemplo básico de implantação de Configurações de Controle SQL de Identidade Gerenciada de Workspaces do Synapse.

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 = "westeurope"
}

variable "sql_administrator_login" {
  type        = string
  description = "The SQL administrator login name 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" "managedIdentitySqlControlSetting" {
  type      = "Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings@2021-06-01"
  parent_id = azapi_resource.workspace.id
  name      = "default"
  body = {
    properties = {
      grantSqlControlToManagedIdentity = {
        desiredState = "Disabled"
      }
    }
  }
  response_export_values = ["*"]
}