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

Bicep リソース定義

ワークスペース/sqlPools リソースの種類は、次を対象とする操作でデプロイできます。

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

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

使用例

Bicep サンプル

Synapse SQL プールのデプロイの基本的な例。

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 = {
  name: 'default'
  parent: storageAccount
}

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 sqlPool 'Microsoft.Synapse/workspaces/sqlPools@2021-06-01' = {
  name: resourceName
  location: location
  parent: workspace
  sku: {
    name: 'DW100c'
  }
  properties: {
    createMode: 'Default'
  }
}

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: {}
}

リソースの形式

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

resource symbolicname 'Microsoft.Synapse/workspaces/sqlPools@2021-06-01' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    collation: 'string'
    createMode: 'string'
    maxSizeBytes: int
    provisioningState: 'string'
    recoverableDatabaseId: 'string'
    restorePointInTime: 'string'
    sourceDatabaseDeletionDate: 'string'
    sourceDatabaseId: 'string'
    storageAccountType: 'string'
  }
  sku: {
    capacity: int
    name: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

プロパティ値

Microsoft.Synapse/workspaces/sqlPools

名前	形容	価値
位置	リソースが存在する地理的な場所	string (必須)
名前	リソース名	string (必須)
親	Bicep では、子リソースの親リソースを指定できます。このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。詳細については、「親リソースの外部子リソース」を参照してください。	種類のリソースのシンボリック名: ワークスペース
プロパティ	SQL プールのプロパティ	sqlPoolResourceProperties の
エスケーユー	SQL プール SKU	SKU
タグ	リソースタグ	タグ名と値のディクショナリ。テンプレートのタグを参照してください

SKU

名前	形容	価値
キャパシティ	SKU でスケールアウト/インがサポートされている場合は、容量の整数を含める必要があります。リソースに対してスケールアウト/インができない場合は、これを省略できます。	整数 (int)
名前	SKU 名	文字列
レベル	サービスレベル	文字列

SqlPoolResourceProperties

名前	形容	価値
照合順序	照合順序モード	文字列
createMode	SQL プールの作成モードを指定します。既定値: 通常の SQL プールの作成。 PointInTimeRestore: 既存の SQL プールの特定の時点のバックアップを復元することによって、SQL プールを作成します。 sourceDatabaseId を既存の SQL プールのリソース ID として指定し、restorePointInTime を指定する必要があります。復旧: geo レプリケートバックアップによって SQL プールを作成します。 sourceDatabaseId は、復元する recoverableDatabaseId として指定する必要があります。復元: 削除された SQL プールのバックアップを復元して、SQL プールを作成します。 SourceDatabaseId は、SQL プールの元のリソース ID である必要があります。 SourceDatabaseId と sourceDatabaseDeletionDate を指定する必要があります。	デフォルト 'PointInTimeRestore' 'Recovery' 'Restore'
maxSizeBytes	最大サイズ (バイト単位)	整数 (int)
provisioningState	リソースの状態	文字列
recoverableDatabaseId	復元元のバックアップデータベース	文字列
restorePointInTime	復元するスナップショットの時刻	文字列
sourceDatabaseDeletionDate	SQL プールが削除された時刻を指定します	文字列
sourceDatabaseId	作成元のソースデータベース	文字列
storageAccountType	この SQL プールのバックアップを格納するために使用されるストレージアカウントの種類。	'GRS' 'LRS'

TrackedResourceTags

名前	形容	価値

ARM テンプレートリソース定義

ワークスペース/sqlPools リソースの種類は、次を対象とする操作でデプロイできます。

リソースグループ - リソースグループのデプロイコマンドを参照してください。各APIバージョンの変更プロパティ一覧は変更ログをご覧ください。

使用例

Azure クイックスタートテンプレート

このリソースの種類デプロイする Azure クイックスタートテンプレート次に示します。

テンプレート	形容
Azure Synapse 概念実証 Azure にデプロイする	このテンプレートは、SQL プールやオプションの Apache Spark プールなど、Azure Synapse の概念実証環境を作成します

リソースの形式

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

{
  "type": "Microsoft.Synapse/workspaces/sqlPools",
  "apiVersion": "2021-06-01",
  "name": "string",
  "location": "string",
  "properties": {
    "collation": "string",
    "createMode": "string",
    "maxSizeBytes": "int",
    "provisioningState": "string",
    "recoverableDatabaseId": "string",
    "restorePointInTime": "string",
    "sourceDatabaseDeletionDate": "string",
    "sourceDatabaseId": "string",
    "storageAccountType": "string"
  },
  "sku": {
    "capacity": "int",
    "name": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

プロパティ値

Microsoft.Synapse/workspaces/sqlPools

名前	形容	価値
apiVersion	API のバージョン	'2021-06-01'
位置	リソースが存在する地理的な場所	string (必須)
名前	リソース名	string (必須)
プロパティ	SQL プールのプロパティ	sqlPoolResourceProperties の
エスケーユー	SQL プール SKU	SKU
タグ	リソースタグ	タグ名と値のディクショナリ。テンプレートのタグを参照してください
型	リソースの種類	'Microsoft.Synapse/workspaces/sqlPools'

SKU

名前	形容	価値
キャパシティ	SKU でスケールアウト/インがサポートされている場合は、容量の整数を含める必要があります。リソースに対してスケールアウト/インができない場合は、これを省略できます。	整数 (int)
名前	SKU 名	文字列
レベル	サービスレベル	文字列

SqlPoolResourceProperties

名前	形容	価値
照合順序	照合順序モード	文字列
createMode	SQL プールの作成モードを指定します。既定値: 通常の SQL プールの作成。 PointInTimeRestore: 既存の SQL プールの特定の時点のバックアップを復元することによって、SQL プールを作成します。 sourceDatabaseId を既存の SQL プールのリソース ID として指定し、restorePointInTime を指定する必要があります。復旧: geo レプリケートバックアップによって SQL プールを作成します。 sourceDatabaseId は、復元する recoverableDatabaseId として指定する必要があります。復元: 削除された SQL プールのバックアップを復元して、SQL プールを作成します。 SourceDatabaseId は、SQL プールの元のリソース ID である必要があります。 SourceDatabaseId と sourceDatabaseDeletionDate を指定する必要があります。	デフォルト 'PointInTimeRestore' 'Recovery' 'Restore'
maxSizeBytes	最大サイズ (バイト単位)	整数 (int)
provisioningState	リソースの状態	文字列
recoverableDatabaseId	復元元のバックアップデータベース	文字列
restorePointInTime	復元するスナップショットの時刻	文字列
sourceDatabaseDeletionDate	SQL プールが削除された時刻を指定します	文字列
sourceDatabaseId	作成元のソースデータベース	文字列
storageAccountType	この SQL プールのバックアップを格納するために使用されるストレージアカウントの種類。	'GRS' 'LRS'

TrackedResourceTags

名前	形容	価値

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

ワークスペース/sqlPools リソースの種類は、次を対象とする操作でデプロイできます。

リソースグループ 各APIバージョンの変更プロパティ一覧については、変更ログをご覧ください。

使用例

Terraformサンプル

Synapse 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_resource" "sqlPool" {
  type      = "Microsoft.Synapse/workspaces/sqlPools@2021-06-01"
  parent_id = azapi_resource.workspace.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      createMode = "Default"
    }
    sku = {
      name = "DW100c"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

リソースの形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Synapse/workspaces/sqlPools@2021-06-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      collation = "string"
      createMode = "string"
      maxSizeBytes = int
      provisioningState = "string"
      recoverableDatabaseId = "string"
      restorePointInTime = "string"
      sourceDatabaseDeletionDate = "string"
      sourceDatabaseId = "string"
      storageAccountType = "string"
    }
    sku = {
      capacity = int
      name = "string"
      tier = "string"
    }
  }
}

プロパティ値

Microsoft.Synapse/workspaces/sqlPools

名前	形容	価値
位置	リソースが存在する地理的な場所	string (必須)
名前	リソース名	string (必須)
parent_id	このリソースの親であるリソースの ID。	種類のリソースの ID: ワークスペース
プロパティ	SQL プールのプロパティ	sqlPoolResourceProperties の
エスケーユー	SQL プール SKU	SKU
タグ	リソースタグ	タグ名と値のディクショナリ。
型	リソースの種類	"Microsoft.Synapse/workspaces/sqlPools@2021-06-01"

SKU

名前	形容	価値
キャパシティ	SKU でスケールアウト/インがサポートされている場合は、容量の整数を含める必要があります。リソースに対してスケールアウト/インができない場合は、これを省略できます。	整数 (int)
名前	SKU 名	文字列
レベル	サービスレベル	文字列

SqlPoolResourceProperties

名前	形容	価値
照合順序	照合順序モード	文字列
createMode	SQL プールの作成モードを指定します。既定値: 通常の SQL プールの作成。 PointInTimeRestore: 既存の SQL プールの特定の時点のバックアップを復元することによって、SQL プールを作成します。 sourceDatabaseId を既存の SQL プールのリソース ID として指定し、restorePointInTime を指定する必要があります。復旧: geo レプリケートバックアップによって SQL プールを作成します。 sourceDatabaseId は、復元する recoverableDatabaseId として指定する必要があります。復元: 削除された SQL プールのバックアップを復元して、SQL プールを作成します。 SourceDatabaseId は、SQL プールの元のリソース ID である必要があります。 SourceDatabaseId と sourceDatabaseDeletionDate を指定する必要があります。	デフォルト 'PointInTimeRestore' 'Recovery' 'Restore'
maxSizeBytes	最大サイズ (バイト単位)	整数 (int)
provisioningState	リソースの状態	文字列
recoverableDatabaseId	復元元のバックアップデータベース	文字列
restorePointInTime	復元するスナップショットの時刻	文字列
sourceDatabaseDeletionDate	SQL プールが削除された時刻を指定します	文字列
sourceDatabaseId	作成元のソースデータベース	文字列
storageAccountType	この SQL プールのバックアップを格納するために使用されるストレージアカウントの種類。	'GRS' 'LRS'

TrackedResourceTags

名前	形容	価値

フィードバック

このページはお役に立ちましたか?

最終更新: 2025-09-17

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

Bicep リソース定義

使用例

Bicep サンプル

リソースの形式

プロパティ値

Microsoft.Synapse/workspaces/sqlPools

SKU

SqlPoolResourceProperties

TrackedResourceTags

ARM テンプレート リソース定義

使用例

Azure クイック スタート テンプレート

リソースの形式

プロパティ値

Microsoft.Synapse/workspaces/sqlPools

SKU

SqlPoolResourceProperties

TrackedResourceTags

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

使用例

Terraformサンプル

リソースの形式

プロパティ値

Microsoft.Synapse/workspaces/sqlPools

SKU

SqlPoolResourceProperties

TrackedResourceTags

フィードバック

その他のリソース

ARM テンプレートリソース定義

Azure クイックスタートテンプレート