Microsoft.Synapse-Arbeitsbereiche/managedIdentitySqlControlSettings

Bicep-Ressourcendefinition

Der Ressourcentyp "workspaces/managedIdentitySqlControlSettings" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings-Ressource zu erstellen, fügen Sie der Vorlage die folgende Bicep hinzu.

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

Eigenschaftswerte

Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings

Name Beschreibung Wert
Name Der Ressourcenname "default" (erforderlich)
Elternteil In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird.

Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource.
Symbolischer Name für Ressource des Typs: Arbeitsbereiche
Eigenschaften Sql-Steuerelementeinstellungen für verwaltete Arbeitsbereichsidentität ManagedIdentitySqlControlSettingsModelProperties

ManagedIdentitySqlControlSettingsModelProperties

Name Beschreibung Wert
grantSqlControlToManagedIdentity Gewähren von SQL-Steuerelementen für verwaltete Identität ManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentity

ManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentity

Name Beschreibung Wert
gewünschterZustand Gewünschter Zustand "Deaktiviert"
"Aktiviert"

Verwendungsbeispiele

Bicep-Beispiele

Ein grundlegendes Beispiel für die Bereitstellung von SQL-Steuerungseinstellungen für verwaltete Synapse-Arbeitsbereiche für verwaltete Identitäten.

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
param resourceName string = 'acctest0001'

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

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

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

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' = {
  name: 'default'
  parent: workspace
  properties: {
    grantSqlControlToManagedIdentity: {
      desiredState: 'Disabled'
    }
  }
}

ARM-Vorlagenressourcendefinition

Der Ressourcentyp "workspaces/managedIdentitySqlControlSettings" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

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

Eigenschaftswerte

Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings

Name Beschreibung Wert
apiVersion (Englisch) Die API-Version '2021-06-01'
Name Der Ressourcenname "default" (erforderlich)
Eigenschaften Sql-Steuerelementeinstellungen für verwaltete Arbeitsbereichsidentität ManagedIdentitySqlControlSettingsModelProperties
Art Der Ressourcentyp 'Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings'

ManagedIdentitySqlControlSettingsModelProperties

Name Beschreibung Wert
grantSqlControlToManagedIdentity Gewähren von SQL-Steuerelementen für verwaltete Identität ManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentity

ManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentity

Name Beschreibung Wert
gewünschterZustand Gewünschter Zustand "Deaktiviert"
"Aktiviert"

Verwendungsbeispiele

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp "workspaces/managedIdentitySqlControlSettings" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

  • Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

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

Eigenschaftswerte

Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings

Name Beschreibung Wert
Name Der Ressourcenname "default" (erforderlich)
Eltern-ID Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. ID für Ressource des Typs: Arbeitsbereiche
Eigenschaften Sql-Steuerelementeinstellungen für verwaltete Arbeitsbereichsidentität ManagedIdentitySqlControlSettingsModelProperties
Art Der Ressourcentyp "Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings@2021-06-01"

ManagedIdentitySqlControlSettingsModelProperties

Name Beschreibung Wert
grantSqlControlToManagedIdentity Gewähren von SQL-Steuerelementen für verwaltete Identität ManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentity

ManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentity

Name Beschreibung Wert
gewünschterZustand Gewünschter Zustand "Deaktiviert"
"Aktiviert"

Verwendungsbeispiele

Terraform-Beispiele

Ein grundlegendes Beispiel für die Bereitstellung von SQL-Steuerungseinstellungen für verwaltete Synapse-Arbeitsbereiche für verwaltete Identitäten.

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 = ["*"]
}