Microsoft.DBforMySQL 彈性伺服器

Bicep 資源定義

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

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

資源格式

若要建立 Microsoft.DBforMySQL/flexibleServers 資源,請將下列 Bicep 新增至您的範本。

resource symbolicname 'Microsoft.DBforMySQL/flexibleServers@2023-10-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    name: 'string'
    tier: 'string'
  }
  identity: {
    type: 'UserAssigned'
    userAssignedIdentities: {
      {customized property}: any()
    }
  }
  properties: {
    administratorLogin: 'string'
    administratorLoginPassword: 'string'
    availabilityZone: 'string'
    backup: {
      backupRetentionDays: int
      geoRedundantBackup: 'string'
    }
    createMode: 'string'
    dataEncryption: {
      geoBackupKeyURI: 'string'
      geoBackupUserAssignedIdentityId: 'string'
      primaryKeyURI: 'string'
      primaryUserAssignedIdentityId: 'string'
      type: 'string'
    }
    highAvailability: {
      mode: 'string'
      standbyAvailabilityZone: 'string'
    }
    importSourceProperties: {
      dataDirPath: 'string'
      sasToken: 'string'
      storageType: 'AzureBlob'
      storageUrl: 'string'
    }
    maintenanceWindow: {
      customWindow: 'string'
      dayOfWeek: int
      startHour: int
      startMinute: int
    }
    network: {
      delegatedSubnetResourceId: 'string'
      privateDnsZoneResourceId: 'string'
      publicNetworkAccess: 'string'
    }
    replicationRole: 'string'
    restorePointInTime: 'string'
    sourceServerResourceId: 'string'
    storage: {
      autoGrow: 'string'
      autoIoScaling: 'string'
      iops: int
      logOnDisk: 'string'
      storageSizeGB: int
    }
    version: 'string'
  }
}

屬性值

flexibleServers

名稱 描述
NAME 資源名稱 字串 (必要)
location 資源所在的地理位置 字串 (必要)
tags 資源標籤。 標記名稱和值的字典。 請參閱 範本中的標記
sku 伺服器的 SKU (定價層) 。 MySQLServerSku
身分識別 伺服器的 Cmk 身分識別。 MySQLServerIdentity
properties 伺服器的屬性。 ServerProperties

MySQLServerIdentity

名稱 描述
類型 受控服務識別的類型。 'UserAssigned'
userAssignedIdentities 使用者指派身分識別的元數據。 MySQLServerIdentityUserAssignedIdentities

MySQLServerIdentityUserAssignedIdentities

名稱 描述
{自定義屬性} 針對 Bicep,您可以使用 any () 函式。

ServerProperties

名稱 描述
administratorLogin 伺服器的系統管理員登入名稱。 只有在建立伺服器 (且建立) 時才能指定。 字串
administratorLoginPassword 伺服器建立) 所需的系統管理員登入密碼 (。 字串

約束:
敏感性值。 以安全參數的形式傳入。
availabilityZone 伺服器的可用性區域資訊。 字串
備份 (backup) 備份伺服器的相關屬性。 備份
createMode 建立新 MySQL 伺服器的模式。 'Default'
'GeoRestore'
'PointInTimeRestore'
'Replica'
dataEncryption CMK 的數據加密。 DataEncryption
highAvailability 伺服器的高可用性相關屬性。 HighAvailability
importSourceProperties 從記憶體匯入的來源屬性。 ImportSourceProperties
maintenanceWindow 伺服器的維護期間。 MaintenanceWindow
network 伺服器的網路相關屬性。 網路
replicationRole 複寫角色。 'None'
'Replica'
'Source'
restorePointInTime 還原點建立時間 (ISO8601 格式) ,指定要從中還原的時間。 字串
sourceServerResourceId 來源 MySQL 伺服器識別碼。 字串
儲存 伺服器的記憶體相關屬性。 儲存體
version 伺服器版本。 '5.7'
'8.0.21'

備份

名稱 描述
backupRetentionDays 伺服器的備份保留天數。 int
geoRedundantBackup 是否啟用異地備援備份。 'Disabled'
'Enabled'

DataEncryption

名稱 描述
geoBackupKeyURI 異地備份密鑰 URI,因為密鑰保存庫無法跨區域,需要在與異地備份相同的區域中使用 Cmk 字串
geoBackupUserAssignedIdentityId 異地備份使用者身分識別資源標識符,因為身分識別無法跨區域,需要與異地備份相同的區域中的身分識別 字串
primaryKeyURI 主鍵 URI 字串
primaryUserAssignedIdentityId 主要使用者身分識別資源標識碼 字串
type 密鑰類型:適用於 enable cmk 的 AzureKeyVault、適用於停用 cmk 的 SystemManaged。 'AzureKeyVault'
'SystemManaged'

HighAvailability

名稱 描述
mode 伺服器的高可用性模式。 'Disabled'
'SameZone'
'ZoneRedundant'
standbyAvailabilityZone 待命伺服器的可用性區域。 字串

ImportSourceProperties

名稱 描述
dataDirPath 記憶體中資料目錄的相對路徑。 字串
sasToken 用於存取來源記憶體的 Sas 令牌。 sas 令牌需要讀取和列表許可權。 字串

約束:
敏感性值。 以安全參數的形式傳入。
storageType 匯入來源的儲存類型。 'AzureBlob'
storageUrl 匯入來源記憶體的 URI。 字串

MaintenanceWindow

名稱 描述
customWindow 指出是否啟用或停用自定義視窗 字串
dayOfWeek 維護時段的星期數 int
startHour 維護時段的開始時間 int
startMinute 維護時段的開始分鐘 int

網路

名稱 描述
delegatedSubnetResourceId 用來設定伺服器的 vnet 的委派子網資源標識碼。 字串
privateDnsZoneResourceId 私用 DNS 區域資源標識碼。 字串
publicNetworkAccess 此伺服器是否允許公用網路存取。 當伺服器具有 VNet 整合時,值為 『Disabled』。 'Disabled'
'Enabled'

儲存體

名稱 描述
autoGrow 啟用記憶體自動成長。 'Disabled'
'Enabled'
autoIoScaling 啟用 IO 自動調整。 'Disabled'
'Enabled'
iops 伺服器的記憶體 IOPS。 int
logOnDisk 啟用登入磁碟。 'Disabled'
'Enabled'
storageSizeGB 伺服器允許的記憶體大小上限。 int

MySQLServerSku

名稱 描述
NAME sku 的名稱,例如Standard_D32s_v3。 需要字串 ()
tier 特定 SKU 的層級,例如 GeneralPurpose。 「高載」
'GeneralPurpose'
需要 'MemoryOptimized' ()

快速入門範本

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

範本 描述
使用 VNet 部署 適用於 MySQL 的 Azure 資料庫 (彈性)

部署至 Azure
此範本提供使用 VNet 整合部署適用於 MySQL 的彈性伺服器 Azure 資料庫的方法。

ARM 範本資源定義

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

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

資源格式

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

{
  "type": "Microsoft.DBforMySQL/flexibleServers",
  "apiVersion": "2023-10-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "name": "string",
    "tier": "string"
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "administratorLogin": "string",
    "administratorLoginPassword": "string",
    "availabilityZone": "string",
    "backup": {
      "backupRetentionDays": "int",
      "geoRedundantBackup": "string"
    },
    "createMode": "string",
    "dataEncryption": {
      "geoBackupKeyURI": "string",
      "geoBackupUserAssignedIdentityId": "string",
      "primaryKeyURI": "string",
      "primaryUserAssignedIdentityId": "string",
      "type": "string"
    },
    "highAvailability": {
      "mode": "string",
      "standbyAvailabilityZone": "string"
    },
    "importSourceProperties": {
      "dataDirPath": "string",
      "sasToken": "string",
      "storageType": "AzureBlob",
      "storageUrl": "string"
    },
    "maintenanceWindow": {
      "customWindow": "string",
      "dayOfWeek": "int",
      "startHour": "int",
      "startMinute": "int"
    },
    "network": {
      "delegatedSubnetResourceId": "string",
      "privateDnsZoneResourceId": "string",
      "publicNetworkAccess": "string"
    },
    "replicationRole": "string",
    "restorePointInTime": "string",
    "sourceServerResourceId": "string",
    "storage": {
      "autoGrow": "string",
      "autoIoScaling": "string",
      "iops": "int",
      "logOnDisk": "string",
      "storageSizeGB": "int"
    },
    "version": "string"
  }
}

屬性值

flexibleServers

名稱 描述
類型 資源類型 'Microsoft.DBforMySQL/flexibleServers'
apiVersion 資源 API 版本 '2023-10-01-preview'
NAME 資源名稱 需要字串 ()
location 資源所在的地理位置 需要字串 ()
tags 資源標籤。 標記名稱和值的字典。 請參閱 範本中的標籤
sku SKU (伺服器) 定價層。 MySQLServerSku
身分識別 伺服器的 cmk 身分識別。 MySQLServerIdentity
properties 伺服器的屬性。 ServerProperties

MySQLServerIdentity

名稱 描述
類型 受控服務識別的類型。 'UserAssigned'
userAssignedIdentities 使用者指派身分識別的元數據。 MySQLServerIdentityUserAssignedIdentities

MySQLServerIdentityUserAssignedIdentities

名稱 描述
{自定義屬性}

ServerProperties

名稱 描述
administratorLogin 伺服器的系統管理員登入名稱。 只有在建立伺服器 (且建立) 時,才能指定。 字串
administratorLoginPassword 伺服器建立) 所需的系統管理員登入密碼 (。 字串

約束:
敏感性值。 以安全參數的形式傳入。
availabilityZone 伺服器的可用性區域資訊。 字串
備份 (backup) 備份伺服器的相關屬性。 備份
createMode 建立新 MySQL 伺服器的模式。 'Default'
'GeoRestore'
'PointInTimeRestore'
'Replica'
dataEncryption CMK 的數據加密。 DataEncryption
highAvailability 伺服器的高可用性相關屬性。 HighAvailability
importSourceProperties 從記憶體匯入的來源屬性。 ImportSourceProperties
maintenanceWindow 伺服器的維護期間。 MaintenanceWindow
network 伺服器的網路相關屬性。 網路
replicationRole 複寫角色。 'None'
'Replica'
'Source'
restorePointInTime 還原點建立時間 (ISO8601 格式) ,指定要還原的時間。 字串
sourceServerResourceId 來源 MySQL 伺服器識別碼。 字串
儲存 伺服器的記憶體相關屬性。 儲存體
version 伺服器版本。 '5.7'
'8.0.21'

備份

名稱 描述
backupRetentionDays 伺服器的備份保留天數。 int
geoRedundantBackup 是否啟用異地備援備份。 'Disabled'
'Enabled'

DataEncryption

名稱 描述
geoBackupKeyURI 異地備份密鑰 URI 作為金鑰保存庫無法跨區域,需要在與異地備份相同的區域中使用 cmk 字串
geoBackupUserAssignedIdentityId 異地備份使用者身分識別資源標識符,因為身分識別無法跨區域,需要與異地備份相同的區域中的身分識別 字串
primaryKeyURI 主鍵 URI 字串
primaryUserAssignedIdentityId 主要使用者身分識別資源標識碼 字串
type 密鑰類型:啟用 cmk 的 AzureKeyVault、停用 cmk 的 SystemManaged。 'AzureKeyVault'
'SystemManaged'

HighAvailability

名稱 描述
mode 伺服器的高可用性模式。 'Disabled'
'SameZone'
'ZoneRedundant'
standbyAvailabilityZone 待命伺服器的可用性區域。 字串

ImportSourceProperties

名稱 描述
dataDirPath 記憶體中資料目錄的相對路徑。 字串
sasToken 用於存取來源記憶體的 Sas 令牌。 sas 令牌需要讀取和列表許可權。 字串

約束:
敏感性值。 以安全參數的形式傳入。
storageType 匯入來源的儲存類型。 'AzureBlob'
storageUrl 匯入來源記憶體的 URI。 字串

MaintenanceWindow

名稱 描述
customWindow 指出是否啟用或停用自定義視窗 字串
dayOfWeek 維護時段的星期數 int
startHour 維護時段的開始時間 int
startMinute 維護時段的開始分鐘 int

網路

名稱 描述
delegatedSubnetResourceId 用來設定伺服器的 vnet 的委派子網資源標識碼。 字串
privateDnsZoneResourceId 私用 DNS 區域資源標識碼。 字串
publicNetworkAccess 是否允許此伺服器的公用網路存取。 當伺服器具有 VNet 整合時,值為 『Disabled』。 'Disabled'
'Enabled'

儲存體

名稱 描述
autoGrow 啟用記憶體自動成長。 'Disabled'
'Enabled'
autoIoScaling 啟用 IO 自動調整。 'Disabled'
'Enabled'
iops 伺服器的記憶體 IOPS。 int
logOnDisk 啟用登入磁碟。 'Disabled'
'Enabled'
storageSizeGB 伺服器允許的記憶體大小上限。 int

MySQLServerSku

名稱 描述
NAME sku 的名稱,例如Standard_D32s_v3。 字串 (必要)
tier 特定 SKU 的層,例如 GeneralPurpose。 「高載」
'GeneralPurpose'
需要 'MemoryOptimized' ()

快速入門範本

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

範本 描述
使用 VNet 部署 適用於 MySQL 的 Azure 資料庫 (彈性)

部署至 Azure
此範本提供使用 VNet 整合部署適用於 MySQL 的彈性伺服器 Azure 資料庫的方法。

Terraform (AzAPI 提供者) 資源定義

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

  • 資源群組

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

資源格式

若要建立 Microsoft.DBforMySQL/flexibleServers 資源,請將下列 Terraform 新增至您的範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DBforMySQL/flexibleServers@2023-10-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "UserAssigned"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      administratorLogin = "string"
      administratorLoginPassword = "string"
      availabilityZone = "string"
      backup = {
        backupRetentionDays = int
        geoRedundantBackup = "string"
      }
      createMode = "string"
      dataEncryption = {
        geoBackupKeyURI = "string"
        geoBackupUserAssignedIdentityId = "string"
        primaryKeyURI = "string"
        primaryUserAssignedIdentityId = "string"
        type = "string"
      }
      highAvailability = {
        mode = "string"
        standbyAvailabilityZone = "string"
      }
      importSourceProperties = {
        dataDirPath = "string"
        sasToken = "string"
        storageType = "AzureBlob"
        storageUrl = "string"
      }
      maintenanceWindow = {
        customWindow = "string"
        dayOfWeek = int
        startHour = int
        startMinute = int
      }
      network = {
        delegatedSubnetResourceId = "string"
        privateDnsZoneResourceId = "string"
        publicNetworkAccess = "string"
      }
      replicationRole = "string"
      restorePointInTime = "string"
      sourceServerResourceId = "string"
      storage = {
        autoGrow = "string"
        autoIoScaling = "string"
        iops = int
        logOnDisk = "string"
        storageSizeGB = int
      }
      version = "string"
    }
    sku = {
      name = "string"
      tier = "string"
    }
  })
}

屬性值

flexibleServers

名稱 描述
類型 資源類型 “Microsoft.DBforMySQL/flexibleServers@2023-10-01-preview”
NAME 資源名稱 字串 (必要)
location 資源所在的地理位置 字串 (必要)
parent_id 若要部署至資源群組,請使用該資源群組的標識碼。 字串 (必要)
tags 資源標籤。 標記名稱和值的字典。
sku 伺服器的 SKU (定價層) 。 MySQLServerSku
身分識別 伺服器的 Cmk 身分識別。 MySQLServerIdentity
properties 伺服器的屬性。 ServerProperties

MySQLServerIdentity

名稱 描述
類型 受控服務識別的類型。 “UserAssigned”
identity_ids 使用者指派身分識別的元數據。 使用者身分識別標識碼的陣列。

MySQLServerIdentityUserAssignedIdentities

名稱 描述
{自定義屬性}

ServerProperties

名稱 描述
administratorLogin 伺服器的系統管理員登入名稱。 只有在建立伺服器 (且建立) 時才能指定。 字串
administratorLoginPassword 伺服器建立) 所需的系統管理員登入密碼 (。 字串

約束:
敏感性值。 以安全參數的形式傳入。
availabilityZone 伺服器的可用性區域資訊。 字串
備份 (backup) 備份伺服器的相關屬性。 備份
createMode 建立新 MySQL 伺服器的模式。 “Default”
“GeoRestore”
“PointInTimeRestore”
“Replica”
dataEncryption CMK 的數據加密。 DataEncryption
highAvailability 伺服器的高可用性相關屬性。 HighAvailability
importSourceProperties 從記憶體匯入的來源屬性。 ImportSourceProperties
maintenanceWindow 伺服器的維護期間。 MaintenanceWindow
network 伺服器的網路相關屬性。 網路
replicationRole 複寫角色。 "None"
“Replica”
“Source”
restorePointInTime 還原點建立時間 (ISO8601 格式) ,指定要從中還原的時間。 字串
sourceServerResourceId 來源 MySQL 伺服器識別碼。 字串
儲存 伺服器的記憶體相關屬性。 儲存體
version 伺服器版本。 "5.7"
"8.0.21"

備份

名稱 描述
backupRetentionDays 伺服器的備份保留天數。 int
geoRedundantBackup 是否啟用異地備援備份。 “Disabled”
“Enabled”

DataEncryption

名稱 描述
geoBackupKeyURI 異地備份密鑰 URI 作為金鑰保存庫無法跨區域,需要在與異地備份相同的區域中使用 cmk 字串
geoBackupUserAssignedIdentityId 異地備份使用者身分識別資源標識符,因為身分識別無法跨區域,需要與異地備份相同的區域中的身分識別 字串
primaryKeyURI 主鍵 URI 字串
primaryUserAssignedIdentityId 主要使用者身分識別資源標識碼 字串
type 密鑰類型:啟用 cmk 的 AzureKeyVault、停用 cmk 的 SystemManaged。 “AzureKeyVault”
“SystemManaged”

HighAvailability

名稱 描述
mode 伺服器的高可用性模式。 “Disabled”
“SameZone”
“ZoneRedundant”
standbyAvailabilityZone 待命伺服器的可用性區域。 字串

ImportSourceProperties

名稱 描述
dataDirPath 記憶體中資料目錄的相對路徑。 字串
sasToken 用來存取來源記憶體的 Sas 令牌。 SAS 令牌需要讀取和列出許可權。 字串

約束:
敏感性值。 以安全參數的形式傳入。
storageType 匯入來源的儲存類型。 “AzureBlob”
storageUrl 匯入來源記憶體的 URI。 字串

MaintenanceWindow

名稱 描述
customWindow 指出是否啟用或停用自定義視窗 字串
dayOfWeek 維護時段的星期數 int
startHour 維護時段的開始時間 int
startMinute 維護時段的開始分鐘數 int

網路

名稱 描述
delegatedSubnetResourceId 用來設定伺服器的 vnet 的委派子網資源標識碼。 字串
privateDnsZoneResourceId 私用 DNS 區域資源標識碼。 字串
publicNetworkAccess 此伺服器是否允許公用網路存取。 當伺服器具有 VNet 整合時,值為 『Disabled』。 “Disabled”
“Enabled”

儲存體

名稱 描述
autoGrow 啟用記憶體自動成長。 “Disabled”
“Enabled”
autoIoScaling 啟用 IO 自動調整。 “Disabled”
“Enabled”
iops 伺服器的記憶體 IOPS。 int
logOnDisk 啟用登入磁碟。 “Disabled”
“Enabled”
storageSizeGB 伺服器允許的記憶體大小上限。 int

MySQLServerSku

名稱 描述
NAME sku 的名稱,例如Standard_D32s_v3。 需要字串 ()
tier 特定 SKU 的層級,例如 GeneralPurpose。 “高載”
“GeneralPurpose”
“MemoryOptimized” (必要)