Рабочие области Microsoft.Synapse/sqlPools

Определение ресурсов Bicep

Тип ресурса workspaces/sqlPools можно развернуть с помощью операций, предназначенных для следующих операций:

Список измененных свойств в каждой версии API см. в журнала изменений.

Примеры использования

Примеры Bicep

Простой пример развертывания Synapse SQL Pool.

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

Проверенные модули Azure

Следующие проверенные модули Azure можно использовать для развертывания этого типа ресурсов.

Module Описание
Azure Synapse Analytics Workspace - Sql Pool AVM Child Module for Azure Synapse Analytics Workspace - SQL Pool

Формат ресурса

Чтобы создать ресурс 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

Имя Описание Ценность
местоположение Географическое расположение, в котором находится ресурс строка (обязательно)
имя Имя ресурса строка (обязательно)
родитель В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса.

Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.
Символьное имя ресурса типа: рабочих областей
свойства Свойства пула SQL SqlPoolResourceProperties
SKU Номер SKU пула SQL SKU
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах

Sku

Имя Описание Ценность
способность Если номер SKU поддерживает горизонтальное масштабирование или в, то целое число емкости должно быть включено. Если горизонтальное масштабирование невозможно для ресурса, это может быть опущено. инт
имя Имя SKU струна
ярус Уровень служб струна

SqlPoolResourceProperties

Имя Описание Ценность
закуска Режим сортировки струна
createMode Задает режим создания пула SQL.

По умолчанию: обычное создание пула SQL.

PointInTimeRestore: создает пул SQL, восстанавливая резервную копию существующего пула SQL. sourceDatabaseId необходимо указать в качестве идентификатора ресурса существующего пула SQL, а restorePointInTime необходимо указать.

Восстановление. Создает пул SQL с помощью геореплицированной резервной копии. sourceDatabaseId необходимо указать в качестве восстанавливаемого объекта RestoreableDatabaseId.

Восстановление. Создание пула SQL путем восстановления резервной копии удаленного пула SQL. SourceDatabaseId должен быть исходным идентификатором ресурса пула SQL. Необходимо указать SourceDatabaseId и sourceDatabaseDeletionDate.
По умолчанию
"PointInTimeRestore"
"Восстановление"
"Восстановить"
maxSizeBytes Максимальный размер в байтах инт
Состояние обеспечения Состояние ресурса струна
recoverableDatabaseId Резервное копирование базы данных для восстановления из струна
restorePointInTime Время восстановления моментального снимка струна
sourceDatabaseDeletionDate Указывает время удаления пула SQL струна
sourceDatabaseId Исходная база данных для создания из струна
storageAccountType Тип учетной записи хранения, используемый для хранения резервных копий для этого пула SQL. GRS
"LRS"

TrackedResourceTags

Имя Описание Ценность

Определение ресурса шаблона ARM

Тип ресурса workspaces/sqlPools можно развернуть с помощью операций, предназначенных для следующих операций:

Примеры использования

Шаблоны быстрого запуска Azure

Следующие шаблоны быстрого запуска Azure развернуть этот тип ресурса.

Шаблон Описание
azure Synapse Proof-of-Concept

развертывание в Azure
Этот шаблон создает подтверждение концепции среды для Azure Synapse, включая пулы SQL и необязательные пулы Apache Spark.

Формат ресурса

Чтобы создать ресурс 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'
местоположение Географическое расположение, в котором находится ресурс строка (обязательно)
имя Имя ресурса строка (обязательно)
свойства Свойства пула SQL SqlPoolResourceProperties
SKU Номер SKU пула SQL SKU
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах
тип Тип ресурса "Microsoft.Synapse/workspaces/sqlPools"

Sku

Имя Описание Ценность
способность Если номер SKU поддерживает горизонтальное масштабирование или в, то целое число емкости должно быть включено. Если горизонтальное масштабирование невозможно для ресурса, это может быть опущено. инт
имя Имя SKU струна
ярус Уровень служб струна

SqlPoolResourceProperties

Имя Описание Ценность
закуска Режим сортировки струна
createMode Задает режим создания пула SQL.

По умолчанию: обычное создание пула SQL.

PointInTimeRestore: создает пул SQL, восстанавливая резервную копию существующего пула SQL. sourceDatabaseId необходимо указать в качестве идентификатора ресурса существующего пула SQL, а restorePointInTime необходимо указать.

Восстановление. Создает пул SQL с помощью геореплицированной резервной копии. sourceDatabaseId необходимо указать в качестве восстанавливаемого объекта RestoreableDatabaseId.

Восстановление. Создание пула SQL путем восстановления резервной копии удаленного пула SQL. SourceDatabaseId должен быть исходным идентификатором ресурса пула SQL. Необходимо указать SourceDatabaseId и sourceDatabaseDeletionDate.
По умолчанию
"PointInTimeRestore"
"Восстановление"
"Восстановить"
maxSizeBytes Максимальный размер в байтах инт
Состояние обеспечения Состояние ресурса струна
recoverableDatabaseId Резервное копирование базы данных для восстановления из струна
restorePointInTime Время восстановления моментального снимка струна
sourceDatabaseDeletionDate Указывает время удаления пула SQL струна
sourceDatabaseId Исходная база данных для создания из струна
storageAccountType Тип учетной записи хранения, используемый для хранения резервных копий для этого пула SQL. GRS
"LRS"

TrackedResourceTags

Имя Описание Ценность

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса workspaces/sqlPools можно развернуть с помощью операций, предназначенных для следующих операций:

Примеры использования

Примеры Terraform

Простой пример развертывания Synapse SQL Pool.

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

Имя Описание Ценность
местоположение Географическое расположение, в котором находится ресурс строка (обязательно)
имя Имя ресурса строка (обязательно)
parent_id Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: рабочих областей
свойства Свойства пула SQL SqlPoolResourceProperties
SKU Номер SKU пула SQL SKU
Теги Теги ресурсов Словарь имен и значений тегов.
тип Тип ресурса "Microsoft.Synapse/workspaces/sqlPools@2021-06-01"

Sku

Имя Описание Ценность
способность Если номер SKU поддерживает горизонтальное масштабирование или в, то целое число емкости должно быть включено. Если горизонтальное масштабирование невозможно для ресурса, это может быть опущено. инт
имя Имя SKU струна
ярус Уровень служб струна

SqlPoolResourceProperties

Имя Описание Ценность
закуска Режим сортировки струна
createMode Задает режим создания пула SQL.

По умолчанию: обычное создание пула SQL.

PointInTimeRestore: создает пул SQL, восстанавливая резервную копию существующего пула SQL. sourceDatabaseId необходимо указать в качестве идентификатора ресурса существующего пула SQL, а restorePointInTime необходимо указать.

Восстановление. Создает пул SQL с помощью геореплицированной резервной копии. sourceDatabaseId необходимо указать в качестве восстанавливаемого объекта RestoreableDatabaseId.

Восстановление. Создание пула SQL путем восстановления резервной копии удаленного пула SQL. SourceDatabaseId должен быть исходным идентификатором ресурса пула SQL. Необходимо указать SourceDatabaseId и sourceDatabaseDeletionDate.
По умолчанию
"PointInTimeRestore"
"Восстановление"
"Восстановить"
maxSizeBytes Максимальный размер в байтах инт
Состояние обеспечения Состояние ресурса струна
recoverableDatabaseId Резервное копирование базы данных для восстановления из струна
restorePointInTime Время восстановления моментального снимка струна
sourceDatabaseDeletionDate Указывает время удаления пула SQL струна
sourceDatabaseId Исходная база данных для создания из струна
storageAccountType Тип учетной записи хранения, используемый для хранения резервных копий для этого пула SQL. GRS
"LRS"

TrackedResourceTags

Имя Описание Ценность