Share via


Microsoft.Sql server/elasticPools 2021-11-01

Bicep 資源定義

伺服器/elasticPools 資源類型可以使用目標作業進行部署:

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.Sql/servers/elasticPools 資源,請將下列 Bicep 新增至範本。

resource symbolicname 'Microsoft.Sql/servers/elasticPools@2021-11-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  parent: resourceSymbolicName
  properties: {
    highAvailabilityReplicaCount: int
    licenseType: 'string'
    maintenanceConfigurationId: 'string'
    maxSizeBytes: int
    minCapacity: int
    perDatabaseSettings: {
      maxCapacity: int
      minCapacity: int
    }
    zoneRedundant: bool
  }
}

屬性值

servers/elasticPools

名稱 描述
NAME 資源名稱

瞭解如何在 Bicep 中設定子資源的名稱和類型。
需要字串 ()

字元限制:1-128

合法字元:
不能使用:
<>*%&:\/? 或控制字元

不能以句號或空格結尾。
location 資源位置。 需要字串 ()
tags 資源標籤。 標記名稱和值的字典。 請參閱 範本中的標籤
sku 彈性集區 SKU。

SKU 清單可能會因區域和支援供應項目而異。 若要判斷 SKU (包括 SKU 名稱、層/版本、系列和容量) ,這些 SKU 可供您在 Azure 區域中的訂用帳戶使用,請使用 Capabilities_ListByLocation REST API 或下列命令:

Azure CLI:
az sql elastic-pool list-editions -l {location} -o table

Sku
父系 (parent) 在 Bicep 中,您可以指定子資源的父資源。 只有在父資源外部宣告子資源時,才需要新增此屬性。

如需詳細資訊,請參閱 父資源外部的子資源
類型資源的符號名稱: 伺服器
properties 資源屬性。 ElasticPoolProperties

ElasticPoolProperties

名稱 描述
highAvailabilityReplicaCount 與彈性集區相關聯的次要複本數目,可用來提供高可用性。 僅適用於超大規模資料庫彈性集區。 int
licenseType 要套用至此彈性集區的授權類型。 'BasePrice'
'LicenseIncluded'
maintenanceConfigurationId 指派給彈性集區的維護設定標識符。 此組態會定義將發生維護更新的期間。 字串
maxSizeBytes 資料庫彈性集區的記憶體限制,以位元組為單位。 int
minCapacity 無伺服器集區的最小容量不會縮小到下方,如果未暫停 int
perDatabaseSettings 彈性集區的每個資料庫設定。 ElasticPoolPerDatabaseSettings
zoneRedundant 不論此彈性集區是否為區域備援,這表示此彈性集區的複本會分散到多個可用性區域。 bool

ElasticPoolPerDatabaseSettings

名稱 描述
maxCapacity 任何一個資料庫可以取用的最大容量。 int
minCapacity 保證所有資料庫的最小容量。 int

SKU

名稱 描述
處理能力 特定 SKU 的容量。 int
family 如果服務有不同層代的硬體,則針對相同的SKU,則可以在這裡擷取。 字串
NAME SKU 的名稱,通常是字母 + 數字代碼,例如 P3。 字串 (必要)
{1}size{2} 特定 SKU 的大小 字串
tier 特定 SKU 的層級或版本,例如基本、進階。 字串

快速入門範本

下列快速入門範本會部署此資源類型。

範本 描述
部署新的 SQL 彈性集區

部署至 Azure
此範本可讓您部署新的 SQL 彈性集區及其新的相關聯 SQL Server,以及要指派給它的新 SQL Database。

ARM 範本資源定義

伺服器/elasticPools 資源類型可以使用目標作業來部署:

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄

資源格式

若要建立 Microsoft.Sql/servers/elasticPools 資源,請將下列 JSON 新增至您的範本。

{
  "type": "Microsoft.Sql/servers/elasticPools",
  "apiVersion": "2021-11-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "properties": {
    "highAvailabilityReplicaCount": "int",
    "licenseType": "string",
    "maintenanceConfigurationId": "string",
    "maxSizeBytes": "int",
    "minCapacity": "int",
    "perDatabaseSettings": {
      "maxCapacity": "int",
      "minCapacity": "int"
    },
    "zoneRedundant": "bool"
  }
}

屬性值

servers/elasticPools

名稱 描述
類型 資源類型 'Microsoft.Sql/servers/elasticPools'
apiVersion 資源 API 版本 '2021-11-01'
NAME 資源名稱

請參閱如何在 JSON ARM 樣本中設定子資源的名稱和類型。
字串 (必要)

字元限制:1-128

合法字元:
不能使用:
<>*%&:\/? 或控制字元

不能以句號或空格結尾。
location 資源位置。 字串 (必要)
tags 資源標籤。 標記名稱和值的字典。 請參閱 範本中的標記
sku 彈性集區 SKU。

SKU 清單可能會因區域和支援供應專案而有所不同。 若要判斷 SKU (包括 SKU 名稱、層/版本、系列和容量) ,這些 SKU 可供您在 Azure 區域中的訂用帳戶使用,請使用 Capabilities_ListByLocation REST API 或下列命令:

Azure CLI:
az sql elastic-pool list-editions -l {location} -o table

Sku
properties 資源屬性。 ElasticPoolProperties

ElasticPoolProperties

名稱 描述
highAvailabilityReplicaCount 與彈性集區相關聯的次要複本數目,可用來提供高可用性。 僅適用於超大規模彈性集區。 int
licenseType 要套用此彈性集區的授權類型。 'BasePrice'
'LicenseIncluded'
maintenanceConfigurationId 指派給彈性集區的維護組態標識碼。 此組態會定義維護更新將發生的期間。 字串
maxSizeBytes 資料庫彈性集區的儲存限制,以位元組為單位。 int
minCapacity 無伺服器集區在未暫停的情況下,不會縮小的最小容量 int
perDatabaseSettings 彈性集區的每個資料庫設定。 ElasticPoolPerDatabaseSettings
zoneRedundant 此彈性集區是否為區域備援,這表示此彈性集區的複本會分散到多個可用性區域。 bool

ElasticPoolPerDatabaseSettings

名稱 描述
maxCapacity 任何一個資料庫可以取用的最大容量。 int
minCapacity 保證所有資料庫的最小容量。 int

SKU

名稱 描述
處理能力 特定 SKU 的容量。 int
family 如果服務有不同的硬體世代,則針對相同的 SKU,則可以在這裡擷取。 字串
NAME SKU 的名稱,通常是字母 + 編號代碼,例如 P3。 需要字串 ()
{1}size{2} 特定 SKU 的大小 字串
tier 特定 SKU 的層級或版本,例如基本、進階。 字串

快速入門範本

下列快速入門範本會部署此資源類型。

範本 描述
部署新的 SQL 彈性集區

部署至 Azure
此範本可讓您部署新的 SQL 彈性集區及其新的相關聯 SQL Server,以及要指派給它的新 SQL Database。

Terraform (AzAPI 提供者) 資源定義

伺服器/elasticPools 資源類型可以使用目標作業進行部署:

  • 資源群組

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.Sql/servers/elasticPools 資源,請將下列 Terraform 新增至範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Sql/servers/elasticPools@2021-11-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      highAvailabilityReplicaCount = int
      licenseType = "string"
      maintenanceConfigurationId = "string"
      maxSizeBytes = int
      minCapacity = int
      perDatabaseSettings = {
        maxCapacity = int
        minCapacity = int
      }
      zoneRedundant = bool
    }
    sku = {
      capacity = int
      family = "string"
      name = "string"
      size = "string"
      tier = "string"
    }
  })
}

屬性值

servers/elasticPools

名稱 描述
類型 資源類型 “Microsoft.Sql/servers/elasticPools@2021-11-01”
NAME 資源名稱 需要字串 ()

字元限制:1-128

合法字元:
不能使用:
<>*%&:\/? 或控制字元

不能以句號或空格結尾。
location 資源位置。 需要字串 ()
parent_id 此資源父系之資源的標識碼。 類型資源的識別碼: 伺服器
tags 資源標籤。 標記名稱和值的字典。
sku 彈性集區 SKU。

SKU 清單可能會因區域和支援供應項目而異。 若要判斷 SKU (包括 SKU 名稱、層/版本、系列和容量) ,這些 SKU 可供您在 Azure 區域中的訂用帳戶使用,請使用 Capabilities_ListByLocation REST API 或下列命令:

Azure CLI:
az sql elastic-pool list-editions -l {location} -o table

Sku
properties 資源屬性。 ElasticPoolProperties

ElasticPoolProperties

名稱 描述
highAvailabilityReplicaCount 與彈性集區相關聯的次要複本數目,可用來提供高可用性。 僅適用於超大規模資料庫彈性集區。 int
licenseType 要套用至此彈性集區的授權類型。 “BasePrice”
“LicenseIncluded”
maintenanceConfigurationId 指派給彈性集區的維護設定標識符。 此組態會定義將發生維護更新的期間。 字串
maxSizeBytes 資料庫彈性集區的記憶體限制,以位元組為單位。 int
minCapacity 無伺服器集區的最小容量不會縮小到下方,如果未暫停 int
perDatabaseSettings 彈性集區的每個資料庫設定。 ElasticPoolPerDatabaseSettings
zoneRedundant 此彈性集區是否為區域備援,這表示此彈性集區的複本會分散到多個可用性區域。 bool

ElasticPoolPerDatabaseSettings

名稱 描述
maxCapacity 任何一個資料庫都可以取用的最大容量。 int
minCapacity 保證所有資料庫的最小容量。 int

SKU

名稱 描述
處理能力 特定 SKU 的容量。 int
family 如果服務有不同層代的硬體,則針對相同的SKU,則可以在這裡擷取。 字串
NAME SKU 的名稱,通常是字母 + 數字代碼,例如 P3。 字串 (必要)
{1}size{2} 特定 SKU 的大小 字串
tier 特定 SKU 的層級或版本,例如基本、進階。 字串