Microsoft.Synapse ワークスペース/managedIdentitySqlControlSettings

Bicep リソース定義

workspaces/managedIdentitySqlControlSettings リソースの種類は、次をターゲットとする操作と共にデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings リソースを作成するには、次の Bicep をテンプレートに追加します。

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

プロパティ値

Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings

名前 形容 価値
名前 リソース名 'default' (必須)
Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「親リソースの外部 子リソース」を参照してください。
種類のリソースのシンボリック名: ワークスペース
プロパティ ワークスペースマネージド ID の SQL コントロール設定 ManagedIdentitySqlControlSettingsModelProperties の

ManagedIdentitySqlControlSettingsModelProperties の

名前 形容 価値
grantSqlControlToManagedIdentity マネージド ID に SQL 制御を付与する ManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentity

ManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentity

名前 形容 価値
望ましい状態 目的の状態 「無効」
「有効」

使用例

Bicep サンプル

Synapse Workspaces マネージド ID SQL コントロール設定のデプロイの基本的な例。

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 テンプレート リソース定義

workspaces/managedIdentitySqlControlSettings リソースの種類は、次をターゲットとする操作と共にデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings リソースを作成するには、次の JSON をテンプレートに追加します。

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

プロパティ値

Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings

名前 形容 価値
apiVersion (英語) API のバージョン '2021-06-01'
名前 リソース名 'default' (必須)
プロパティ ワークスペースマネージド ID の SQL コントロール設定 ManagedIdentitySqlControlSettingsModelProperties の
リソースの種類 'Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings'

ManagedIdentitySqlControlSettingsModelProperties の

名前 形容 価値
grantSqlControlToManagedIdentity マネージド ID に SQL 制御を付与する ManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentity

ManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentity

名前 形容 価値
望ましい状態 目的の状態 「無効」
「有効」

使用例

Terraform (AzAPI プロバイダー) リソース定義

workspaces/managedIdentitySqlControlSettings リソースの種類は、次をターゲットとする操作と共にデプロイできます。

  • リソース グループ

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings リソースを作成するには、次の Terraform をテンプレートに追加します。

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

プロパティ値

Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings

名前 形容 価値
名前 リソース名 'default' (必須)
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: ワークスペース
プロパティ ワークスペースマネージド ID の SQL コントロール設定 ManagedIdentitySqlControlSettingsModelProperties の
リソースの種類 「Microsoft.Synapse/ワークスペース/managedIdentitySqlControlSettings@2021-06-01」

ManagedIdentitySqlControlSettingsModelProperties の

名前 形容 価値
grantSqlControlToManagedIdentity マネージド ID に SQL 制御を付与する ManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentity

ManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentity

名前 形容 価値
望ましい状態 目的の状態 「無効」
「有効」

使用例

Terraformサンプル

Synapse Workspaces マネージド ID SQL コントロール設定のデプロイの基本的な例。

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