你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Microsoft.Synapse workspaces/sqlPools

Bicep 资源定义

可以使用面向以下操作部署 workspaces/sqlPools 资源类型:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Synapse/workspaces/sqlPools 资源,请将以下 Bicep 添加到模板。

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

属性值

workspaces/sqlPools

名称 说明
name 资源名称

了解如何在 Bicep 中设置子资源的名称和类型。
字符串 (必需)

字符限制:1-60

有效字符:
不能包含 <>*%&:\/?@- 或控制字符。

不能以 . 或空格结尾。

不能包含保留字
location 资源所在的地理位置 字符串 (必需)
标记 资源标记。 标记名称和值的字典。 请参阅 模板中的标记
sku SQL 池 SKU Sku
父级 (parent) 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。

有关详细信息,请参阅 父资源之外的子资源
类型为的资源的符号名称: 工作区
properties SQL 池属性 SqlPoolResourceProperties

SqlPoolResourceProperties

名称 说明
collation 排序规则模式 string
createMode 指定 sql 池创建模式。

默认值:常规 SQL 池创建。

PointInTimeRestore:通过还原现有 sql 池的时间点备份来创建 sql 池。 sourceDatabaseId 必须指定为现有 sql 池的资源 ID,并且必须指定 restorePointInTime。

恢复:通过异地复制的备份创建 sql 池。 sourceDatabaseId 必须指定为要还原的 recoverableDatabaseId。

还原:通过还原已删除 sql 池的备份来创建 sql 池。 SourceDatabaseId 应为 sql 池的原始资源 ID。 必须指定 SourceDatabaseId 和 sourceDatabaseDeletionDate。
'Default'
“PointInTimeRestore”
“恢复”
“还原”
maxSizeBytes 最大大小(以字节为单位) int
provisioningState 资源状态 string
recoverableDatabaseId 要从中还原的备份数据库 字符串
restorePointInTime 要还原的快照时间 字符串
sourceDatabaseDeletionDate 指定删除 sql 池的时间 字符串
sourceDatabaseId 要从中创建的源数据库 字符串
storageAccountType 用于存储此 sql 池的备份的存储帐户类型。 'GRS'
'LRS'

SKU

名称 说明
容量 如果 SKU 支持横向扩展/缩减,则应包含容量整数。 如果资源无法横向扩展/缩减,则可能会省略这一点。 int
name SKU 名称 字符串
服务层 字符串

快速入门模板

以下快速入门模板部署此资源类型。

模板 说明
Azure Synapse概念证明

部署到 Azure
此模板为Azure Synapse创建概念证明环境,包括 SQL 池和可选的 Apache Spark 池

ARM 模板资源定义

workspaces/sqlPools 资源类型可以使用以下目标操作进行部署:

有关每个 API 版本中更改的属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Synapse/workspaces/sqlPools 资源,请将以下 JSON 添加到模板。

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

属性值

workspaces/sqlPools

名称 说明 Value
type 资源类型 “Microsoft.Synapse/workspaces/sqlPools”
apiVersion 资源 API 版本 '2021-06-01'
name 资源名称

了解如何在 JSON ARM 模板中为子资源设置名称和类型。
字符串 (必需)

字符限制:1-60

有效字符:
不能包含 <>*%&:\/?@- 或控制字符。

不能以 . 或空格结尾。

不能包含保留字
location 资源所在的地理位置 字符串 (必需)
标记 资源标记。 标记名称和值的字典。 请参阅 模板中的标记
sku SQL 池 SKU Sku
properties SQL 池属性 SqlPoolResourceProperties

SqlPoolResourceProperties

名称 说明
collation 排序规则模式 string
createMode 指定 sql 池创建模式。

默认值:常规 sql 池创建。

PointInTimeRestore:通过还原现有 sql 池的时间点备份来创建 sql 池。 sourceDatabaseId 必须指定为现有 sql 池的资源 ID,并且必须指定 restorePointInTime。

恢复:通过异地复制的备份创建 sql 池。 sourceDatabaseId 必须指定为 recoverableDatabaseId 才能还原。

还原:通过还原已删除 sql 池的备份来创建 sql 池。 SourceDatabaseId 应该是 sql 池的原始资源 ID。 必须指定 SourceDatabaseId 和 sourceDatabaseDeletionDate。
'Default'
“PointInTimeRestore”
“恢复”
“还原”
maxSizeBytes 最大大小(以字节为单位) int
provisioningState 资源状态 string
recoverableDatabaseId 要从中还原的备份数据库 字符串
restorePointInTime 要还原的快照时间 字符串
sourceDatabaseDeletionDate 指定删除 sql 池的时间 字符串
sourceDatabaseId 要从中创建的源数据库 string
storageAccountType 用于存储此 sql 池备份的存储帐户类型。 “GRS”
“LRS”

SKU

名称 说明
容量 如果 SKU 支持横向扩展/缩减,则应包含容量整数。 如果资源无法横向扩展/缩减,则可能会省略这一点。 int
name SKU 名称 字符串
服务层 字符串

快速入门模板

以下快速入门模板部署此资源类型。

模板 说明
Azure Synapse概念证明

部署到 Azure
此模板为Azure Synapse创建概念证明环境,包括 SQL 池和可选的 Apache Spark 池

Terraform (AzAPI 提供程序) 资源定义

workspaces/sqlPools 资源类型可以使用以下目标操作进行部署:

  • 资源组

有关每个 API 版本中更改的属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Synapse/workspaces/sqlPools 资源,请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Synapse/workspaces/sqlPools@2021-06-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    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"
    }
  })
}

属性值

workspaces/sqlPools

名称 说明 Value
type 资源类型 “Microsoft.Synapse/workspaces/sqlPools@2021-06-01”
name 资源名称 字符串 (必需)

字符限制:1-60

有效字符:
不能包含 <>*%&:\/?@- 或控制字符。

不能以 . 或空格结尾。

不能包含保留字
location 资源所在的地理位置 字符串 (必需)
parent_id 此资源的父资源 ID。 类型为“工作区”的资源的 ID
标记 资源标记。 标记名称和值的字典。
sku SQL 池 SKU Sku
properties SQL 池属性 SqlPoolResourceProperties

SqlPoolResourceProperties

名称 说明
collation 排序规则模式 字符串
createMode 指定 sql 池创建模式。

默认值:常规 sql 池创建。

PointInTimeRestore:通过还原现有 sql 池的时间点备份来创建 sql 池。 sourceDatabaseId 必须指定为现有 sql 池的资源 ID,并且必须指定 restorePointInTime。

恢复:通过异地复制的备份创建 sql 池。 sourceDatabaseId 必须指定为 recoverableDatabaseId 才能还原。

还原:通过还原已删除 sql 池的备份来创建 sql 池。 SourceDatabaseId 应该是 sql 池的原始资源 ID。 必须指定 SourceDatabaseId 和 sourceDatabaseDeletionDate。
“Default”
“PointInTimeRestore”
“恢复”
“还原”
maxSizeBytes 最大大小(以字节为单位) int
provisioningState 资源状态 字符串
recoverableDatabaseId 要从中还原的备份数据库 字符串
restorePointInTime 要还原的快照时间 字符串
sourceDatabaseDeletionDate 指定删除 sql 池的时间 字符串
sourceDatabaseId 要从中创建的源数据库 string
storageAccountType 用于存储此 sql 池备份的存储帐户类型。 “GRS”
“LRS”

SKU

名称 说明
容量 如果 SKU 支持横向扩展/缩减,则应包含容量整数。 如果无法对资源进行横向扩展/缩减,则可能会省略此项。 int
name SKU 名称 字符串
服务层 字符串