Microsoft.DBforMySQL/servers - Bicep, ARM template & Terraform AzAPI reference

Bicep 資源定義

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

資源群組 - 請參閱資源群組部署命令

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

資源格式

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

resource symbolicname 'Microsoft.DBforMySQL/servers@2017-12-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  identity: {
    type: 'SystemAssigned'
  }
  properties: {
    infrastructureEncryption: 'string'
    minimalTlsVersion: 'string'
    publicNetworkAccess: 'string'
    sslEnforcement: 'string'
    storageProfile: {
      backupRetentionDays: int
      geoRedundantBackup: 'string'
      storageAutogrow: 'string'
      storageMB: int
    }
    version: 'string'
    createMode: 'string'
    // For remaining properties, see ServerPropertiesForCreateOrServerProperties objects
  }
}

ServerPropertiesForCreateOrServerProperties 物件

設定 createMode 屬性，以指定物件的類型。

針對 Default，請使用：

  createMode: 'Default'
  administratorLogin: 'string'
  administratorLoginPassword: 'string'

針對 GeoRestore，請使用：

  createMode: 'GeoRestore'
  sourceServerId: 'string'

針對 PointInTimeRestore，請使用：

  createMode: 'PointInTimeRestore'
  restorePointInTime: 'string'
  sourceServerId: 'string'

針對複本，請使用：

注意

使用範本建立具有複本值的 MySQL 伺服器並非等冪。第一次成功建立伺服器。不過，當復本伺服器已經存在時部署範本會傳回錯誤。

  createMode: 'Replica'
  sourceServerId: 'string'

屬性值

伺服器

名字	描述	價值
名字	資源名稱	字串（必要）字元限制：3-63 合法字元：小寫字母、連字元和數位。無法以連字元開頭或結尾。資源名稱在整個 Azure 中必須是唯一的。
位置	資源所在的位置。	字串（必要）
標籤	以索引鍵/值組形式的應用程式特定元數據。	標記名稱和值的字典。請參閱範本中的標籤
sku	伺服器的 SKU（定價層）。	Sku
身份	伺服器的 Azure Active Directory 身分識別。	ResourceIdentity
性能	伺服器的屬性。	ServerPropertiesForCreateOrServerProperties （必要）

ResourceIdentity

名字	描述	價值
類型	識別類型。將此設定為『SystemAssigned』，以自動建立和指派資源的 Azure Active Directory 主體。	'SystemAssigned'

ServerPropertiesForCreateOrServerProperties

名字	描述	價值
infrastructureEncryption	顯示伺服器是否啟用基礎結構加密的狀態。	'Disabled' 'Enabled'
minimalTlsVersion	為伺服器強制執行最低 Tls 版本。	'TLS1_0' 'TLS1_1' 'TLS1_2' 'TLSEnforcementDisabled'
publicNetworkAccess	此伺服器是否允許公用網路存取。值為選擇性值，但如果傳入，則必須是 'Enabled' 或 'Disabled'	'Disabled' 'Enabled'
sslEnforcement	連線到伺服器時，啟用 SSL 強制。	'Disabled' 'Enabled'
storageProfile	伺服器的記憶體配置檔。	StorageProfile
版本	伺服器版本。	'5.6' '5.7' '8.0'
createMode	設定物件類型	預設 GeoRestore PointInTimeRestore 複本（必要）

StorageProfile

名字	描述	價值
backupRetentionDays	伺服器的備份保留天數。	int
geoRedundantBackup	針對伺服器備份啟用異地備援或不啟用。	'Disabled' 'Enabled'
storageAutogrow	啟用記憶體自動成長。	'Disabled' 'Enabled'
storageMB	伺服器允許的最大記憶體。	int

ServerPropertiesForDefaultCreate

名字	描述	價值
createMode	建立新伺服器的模式。	'Default' （必要）
administratorLogin	系統管理員的伺服器登入名稱。只有在建立伺服器時才能指定（而且是建立的必要專案）。更新密碼時，需要登入名稱。	字串（必要）
administratorLoginPassword	系統管理員登入的密碼。	字串（必要）約束：敏感性值。以安全參數的形式傳入。

ServerPropertiesForGeoRestore

名字	描述	價值
createMode	建立新伺服器的模式。	'GeoRestore' （必要）
sourceServerId	要從中還原的來源伺服器標識碼。	字串（必要）

ServerPropertiesForRestore

名字	描述	價值
createMode	建立新伺服器的模式。	'PointInTimeRestore' （必要）
restorePointInTime	還原點建立時間（ISO8601格式），指定要還原的時間。	字串（必要）
sourceServerId	要從中還原的來源伺服器標識碼。	字串（必要）

ServerPropertiesForReplica

名字	描述	價值
createMode	建立新伺服器的模式。	'Replica' （必要）
sourceServerId	要從中建立複本的主伺服器標識碼。	字串（必要）

Sku

名字	描述	價值
能力	相應增加/相應放大容量，代表伺服器的計算單位。	int 約束：最小值 = 0
家庭	硬體系列。	字串
名字	sku 的名稱，通常是階層 + 系列 + 核心，例如B_Gen4_1，GP_Gen5_8。	字串（必要）
大小	要適當地由資源解譯的大小代碼。	字串
層	特定 SKU 的層，例如基本。	'Basic' 'GeneralPurpose' 'MemoryOptimized'

快速入門範本

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

範本	描述
Buffalo Web App	在 Azure 上快速且便宜地開始執行 Golang Buffalo 應用程式。
使用 Jenkins 和 Azure Web Apps Java CI/CD	這是使用 Jenkins 和 Azure Web Apps 的 Java CI/CD 範例。
部署 1 個 MySQL PaaS 實例，以及最多 5 個唯讀複本	此範本會部署 MySQL PaaS 伺服器實例，以及從 0 到 5 個唯讀複本。它們全都會設定在與主復寫相同的位置上，而且會自動設定複寫。
使用 VNet 部署適用於 MySQL 的 Azure 資料庫	此範本提供部署適用於 MySQL 的 Azure 資料庫與 VNet 整合的方式。
具有IP限制的Web應用程式應用程式閘道	此範本會在 Azure Web 應用程式前面建立應用程式閘道，並在 Web 應用程式上啟用 IP 限制。
使用適用於 MySQL 的 Azure 資料庫在 Linux 上建置 Web 應用程式	此範本提供使用適用於 MySQL 的 Azure 資料庫在 Linux 上部署 Web Apps 的方式。
使用 MySQL 在 Linux 上 Sonarqube Docker Web 應用程式	此範本提供在Linux Web 應用程式上使用適用於 MySQL 的 Azure 資料庫部署 Sonarqube Docker 映像（alpine tag）的簡單方式
使用適用於 MySQL 的 Azure 資料庫 Web 應用程式	此範本提供簡單的方式，透過適用於 MySQL 的 Azure 資料庫，在 Azure App Service Web Apps 上部署 Web 應用程式。

ARM 樣本資源定義

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

資源群組 - 請參閱資源群組部署命令

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

資源格式

若要建立 Microsoft.DBforMySQL/servers 資源，請將下列 JSON 新增至範本。

{
  "type": "Microsoft.DBforMySQL/servers",
  "apiVersion": "2017-12-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "identity": {
    "type": "SystemAssigned"
  },
  "properties": {
    "infrastructureEncryption": "string",
    "minimalTlsVersion": "string",
    "publicNetworkAccess": "string",
    "sslEnforcement": "string",
    "storageProfile": {
      "backupRetentionDays": "int",
      "geoRedundantBackup": "string",
      "storageAutogrow": "string",
      "storageMB": "int"
    },
    "version": "string",
    "createMode": "string"
    // For remaining properties, see ServerPropertiesForCreateOrServerProperties objects
  }
}

ServerPropertiesForCreateOrServerProperties 物件

設定 createMode 屬性，以指定物件的類型。

針對 Default，請使用：

  "createMode": "Default",
  "administratorLogin": "string",
  "administratorLoginPassword": "string"

針對 GeoRestore，請使用：

  "createMode": "GeoRestore",
  "sourceServerId": "string"

針對 PointInTimeRestore，請使用：

  "createMode": "PointInTimeRestore",
  "restorePointInTime": "string",
  "sourceServerId": "string"

針對複本，請使用：

注意

使用範本建立具有複本值的 MySQL 伺服器並非等冪。第一次成功建立伺服器。不過，當復本伺服器已經存在時部署範本會傳回錯誤。

  "createMode": "Replica",
  "sourceServerId": "string"

屬性值

伺服器

名字	描述	價值
類型	資源類型	'Microsoft.DBforMySQL/servers'
apiVersion	資源 API 版本	'2017-12-01'
名字	資源名稱	字串（必要）字元限制：3-63 合法字元：小寫字母、連字元和數位。無法以連字元開頭或結尾。資源名稱在整個 Azure 中必須是唯一的。
位置	資源所在的位置。	字串（必要）
標籤	以索引鍵/值組形式的應用程式特定元數據。	標記名稱和值的字典。請參閱範本中的標籤
sku	伺服器的 SKU（定價層）。	Sku
身份	伺服器的 Azure Active Directory 身分識別。	ResourceIdentity
性能	伺服器的屬性。	ServerPropertiesForCreateOrServerProperties （必要）

ResourceIdentity

名字	描述	價值
類型	識別類型。將此設定為『SystemAssigned』，以自動建立和指派資源的 Azure Active Directory 主體。	'SystemAssigned'

ServerPropertiesForCreateOrServerProperties

名字	描述	價值
infrastructureEncryption	顯示伺服器是否啟用基礎結構加密的狀態。	'Disabled' 'Enabled'
minimalTlsVersion	為伺服器強制執行最低 Tls 版本。	'TLS1_0' 'TLS1_1' 'TLS1_2' 'TLSEnforcementDisabled'
publicNetworkAccess	此伺服器是否允許公用網路存取。值為選擇性值，但如果傳入，則必須是 'Enabled' 或 'Disabled'	'Disabled' 'Enabled'
sslEnforcement	連線到伺服器時，啟用 SSL 強制。	'Disabled' 'Enabled'
storageProfile	伺服器的記憶體配置檔。	StorageProfile
版本	伺服器版本。	'5.6' '5.7' '8.0'
createMode	設定物件類型	預設 GeoRestore PointInTimeRestore 複本（必要）

StorageProfile

名字	描述	價值
backupRetentionDays	伺服器的備份保留天數。	int
geoRedundantBackup	針對伺服器備份啟用異地備援或不啟用。	'Disabled' 'Enabled'
storageAutogrow	啟用記憶體自動成長。	'Disabled' 'Enabled'
storageMB	伺服器允許的最大記憶體。	int

ServerPropertiesForDefaultCreate

名字	描述	價值
createMode	建立新伺服器的模式。	'Default' （必要）
administratorLogin	系統管理員的伺服器登入名稱。只有在建立伺服器時才能指定（而且是建立的必要專案）。更新密碼時，需要登入名稱。	字串（必要）
administratorLoginPassword	系統管理員登入的密碼。	字串（必要）約束：敏感性值。以安全參數的形式傳入。

ServerPropertiesForGeoRestore

名字	描述	價值
createMode	建立新伺服器的模式。	'GeoRestore' （必要）
sourceServerId	要從中還原的來源伺服器標識碼。	字串（必要）

ServerPropertiesForRestore

名字	描述	價值
createMode	建立新伺服器的模式。	'PointInTimeRestore' （必要）
restorePointInTime	還原點建立時間（ISO8601格式），指定要還原的時間。	字串（必要）
sourceServerId	要從中還原的來源伺服器標識碼。	字串（必要）

ServerPropertiesForReplica

名字	描述	價值
createMode	建立新伺服器的模式。	'Replica' （必要）
sourceServerId	要從中建立複本的主伺服器標識碼。	字串（必要）

Sku

名字	描述	價值
能力	相應增加/相應放大容量，代表伺服器的計算單位。	int 約束：最小值 = 0
家庭	硬體系列。	字串
名字	sku 的名稱，通常是階層 + 系列 + 核心，例如B_Gen4_1，GP_Gen5_8。	字串（必要）
大小	要適當地由資源解譯的大小代碼。	字串
層	特定 SKU 的層，例如基本。	'Basic' 'GeneralPurpose' 'MemoryOptimized'

快速入門範本

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

範本	描述
Buffalo Web App	在 Azure 上快速且便宜地開始執行 Golang Buffalo 應用程式。
使用 Jenkins 和 Azure Web Apps Java CI/CD	這是使用 Jenkins 和 Azure Web Apps 的 Java CI/CD 範例。
部署 1 個 MySQL PaaS 實例，以及最多 5 個唯讀複本	此範本會部署 MySQL PaaS 伺服器實例，以及從 0 到 5 個唯讀複本。它們全都會設定在與主復寫相同的位置上，而且會自動設定複寫。
使用 VNet 部署適用於 MySQL 的 Azure 資料庫	此範本提供部署適用於 MySQL 的 Azure 資料庫與 VNet 整合的方式。
具有IP限制的Web應用程式應用程式閘道	此範本會在 Azure Web 應用程式前面建立應用程式閘道，並在 Web 應用程式上啟用 IP 限制。
使用適用於 MySQL 的 Azure 資料庫在 Linux 上建置 Web 應用程式	此範本提供使用適用於 MySQL 的 Azure 資料庫在 Linux 上部署 Web Apps 的方式。
使用 MySQL 在 Linux 上 Sonarqube Docker Web 應用程式	此範本提供在Linux Web 應用程式上使用適用於 MySQL 的 Azure 資料庫部署 Sonarqube Docker 映像（alpine tag）的簡單方式
使用適用於 MySQL 的 Azure 資料庫 Web 應用程式	此範本提供簡單的方式，透過適用於 MySQL 的 Azure 資料庫，在 Azure App Service Web Apps 上部署 Web 應用程式。

Terraform （AzAPI 提供者）資源定義

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

資源群組

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

資源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DBforMySQL/servers@2017-12-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "SystemAssigned"
  }
  body = jsonencode({
    properties = {
      infrastructureEncryption = "string"
      minimalTlsVersion = "string"
      publicNetworkAccess = "string"
      sslEnforcement = "string"
      storageProfile = {
        backupRetentionDays = int
        geoRedundantBackup = "string"
        storageAutogrow = "string"
        storageMB = int
      }
      version = "string"
      createMode = "string"
      // For remaining properties, see ServerPropertiesForCreateOrServerProperties objects
    }
    sku = {
      capacity = int
      family = "string"
      name = "string"
      size = "string"
      tier = "string"
    }
  })
}

ServerPropertiesForCreateOrServerProperties 物件

設定 createMode 屬性，以指定物件的類型。

針對 Default，請使用：

  createMode = "Default"
  administratorLogin = "string"
  administratorLoginPassword = "string"

針對 GeoRestore，請使用：

  createMode = "GeoRestore"
  sourceServerId = "string"

針對 PointInTimeRestore，請使用：

  createMode = "PointInTimeRestore"
  restorePointInTime = "string"
  sourceServerId = "string"

針對複本，請使用：

注意

使用範本建立具有複本值的 MySQL 伺服器並非等冪。第一次成功建立伺服器。不過，當復本伺服器已經存在時部署範本會傳回錯誤。

  createMode = "Replica"
  sourceServerId = "string"

屬性值

伺服器

名字	描述	價值
類型	資源類型	“Microsoft.DBforMySQL/servers@2017-12-01”
名字	資源名稱	字串（必要）字元限制：3-63 合法字元：小寫字母、連字元和數位。無法以連字元開頭或結尾。資源名稱在整個 Azure 中必須是唯一的。
位置	資源所在的位置。	字串（必要）
parent_id	若要部署至資源群組，請使用該資源群組的標識碼。	字串（必要）
標籤	以索引鍵/值組形式的應用程式特定元數據。	標記名稱和值的字典。
sku	伺服器的 SKU（定價層）。	Sku
身份	伺服器的 Azure Active Directory 身分識別。	ResourceIdentity
性能	伺服器的屬性。	ServerPropertiesForCreateOrServerProperties （必要）

ResourceIdentity

名字	描述	價值
類型	識別類型。將此設定為『SystemAssigned』，以自動建立和指派資源的 Azure Active Directory 主體。	“SystemAssigned”

ServerPropertiesForCreateOrServerProperties

名字	描述	價值
infrastructureEncryption	顯示伺服器是否啟用基礎結構加密的狀態。	“Disabled” “Enabled”
minimalTlsVersion	為伺服器強制執行最低 Tls 版本。	“TLS1_0” “TLS1_1” “TLS1_2” “TLSEnforcementDisabled”
publicNetworkAccess	此伺服器是否允許公用網路存取。值為選擇性值，但如果傳入，則必須是 'Enabled' 或 'Disabled'	“Disabled” “Enabled”
sslEnforcement	連線到伺服器時，啟用 SSL 強制。	“Disabled” “Enabled”
storageProfile	伺服器的記憶體配置檔。	StorageProfile
版本	伺服器版本。	"5.6" "5.7" "8.0"
createMode	設定物件類型	預設 GeoRestore PointInTimeRestore 複本（必要）

StorageProfile

名字	描述	價值
backupRetentionDays	伺服器的備份保留天數。	int
geoRedundantBackup	針對伺服器備份啟用異地備援或不啟用。	“Disabled” “Enabled”
storageAutogrow	啟用記憶體自動成長。	“Disabled” “Enabled”
storageMB	伺服器允許的最大記憶體。	int

ServerPropertiesForDefaultCreate

名字	描述	價值
createMode	建立新伺服器的模式。	“Default” （必要）
administratorLogin	系統管理員的伺服器登入名稱。只有在建立伺服器時才能指定（而且是建立的必要專案）。更新密碼時，需要登入名稱。	字串（必要）
administratorLoginPassword	系統管理員登入的密碼。	字串（必要）約束：敏感性值。以安全參數的形式傳入。

ServerPropertiesForGeoRestore

名字	描述	價值
createMode	建立新伺服器的模式。	“GeoRestore” （必要）
sourceServerId	要從中還原的來源伺服器標識碼。	字串（必要）

ServerPropertiesForRestore

名字	描述	價值
createMode	建立新伺服器的模式。	“PointInTimeRestore” （必要）
restorePointInTime	還原點建立時間（ISO8601格式），指定要還原的時間。	字串（必要）
sourceServerId	要從中還原的來源伺服器標識碼。	字串（必要）

ServerPropertiesForReplica

名字	描述	價值
createMode	建立新伺服器的模式。	複本“（必要）
sourceServerId	要從中建立複本的主伺服器標識碼。	字串（必要）

Sku

名字	描述	價值
能力	相應增加/相應放大容量，代表伺服器的計算單位。	int 約束：最小值 = 0
家庭	硬體系列。	字串
名字	sku 的名稱，通常是階層 + 系列 + 核心，例如B_Gen4_1，GP_Gen5_8。	字串（必要）
大小	要適當地由資源解譯的大小代碼。	字串
層	特定 SKU 的層，例如基本。	“Basic” “GeneralPurpose” “MemoryOptimized”

共用方式為

Microsoft.DBforMySQL 伺服器

Bicep 資源定義

資源格式

ServerPropertiesForCreateOrServerProperties 物件

屬性值

伺服器

ResourceIdentity

ServerPropertiesForCreateOrServerProperties

StorageProfile

ServerPropertiesForDefaultCreate

ServerPropertiesForGeoRestore

ServerPropertiesForRestore

ServerPropertiesForReplica

Sku

快速入門範本

ARM 樣本資源定義

資源格式

ServerPropertiesForCreateOrServerProperties 物件

屬性值

伺服器

ResourceIdentity

ServerPropertiesForCreateOrServerProperties

StorageProfile

ServerPropertiesForDefaultCreate

ServerPropertiesForGeoRestore

ServerPropertiesForRestore

ServerPropertiesForReplica

Sku

快速入門範本

Terraform （AzAPI 提供者） 資源定義

資源格式

ServerPropertiesForCreateOrServerProperties 物件

屬性值

伺服器

ResourceIdentity

ServerPropertiesForCreateOrServerProperties

StorageProfile

ServerPropertiesForDefaultCreate

ServerPropertiesForGeoRestore

ServerPropertiesForRestore

ServerPropertiesForReplica

Sku

意見反應

其他資源

Terraform （AzAPI 提供者）資源定義