Microsoft.DBforMySQL/flexibleServers 2023-06-01-preview - Bicep, ARM template & Terraform AzAPI reference

Bicep 资源定义

可以使用目标操作部署 flexibleServers 资源类型：

资源组 - 请参阅资源组部署命令

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

言论

仅在更新现有灵活服务器时使用 maintenanceWindow 属性。创建新的灵活服务器时，请不要为此属性指定值。

资源格式

若要创建 Microsoft.DBforMySQL/flexibleServers 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.DBforMySQL/flexibleServers@2023-06-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

名字	描述	价值
名字	资源名称	string （必需）
位置	资源所在的地理位置	string （必需）
标签	资源标记。	标记名称和值的字典。请参阅模板中的标记
sku	服务器的 SKU（定价层）。	MySQLServerSku
身份	服务器的 cmk 标识。	MySQLServerIdentity
性能	服务器的属性。	ServerProperties

MySQLServerIdentity

名字	描述	价值
类型	托管服务标识的类型。	“UserAssigned”
userAssignedIdentities	用户分配标识的元数据。	MySQLServerIdentityUserAssignedIdentities

MySQLServerIdentityUserAssignedIdentities

名字	描述	价值
{自定义属性}		对于 Bicep，可以使用 any（）函数。

ServerProperties

名字	描述	价值
administratorLogin	管理员的服务器登录名。只能在创建服务器时指定（并且是创建所必需的）。	字符串
administratorLoginPassword	管理员登录名的密码（创建服务器时需要）。	字符串约束：敏感值。以安全参数的形式传入。
availabilityZone	服务器的可用性区域信息。	字符串
备份	备份服务器的相关属性。	备份
createMode	创建新的 MySQL 服务器的模式。	“Default” “GeoRestore” “PointInTimeRestore” “Replica”
dataEncryption	CMK 的数据加密。	DataEncryption
highAvailability	服务器的高可用性相关属性。	HighAvailability
importSourceProperties	从存储导入的源属性。	ImportSourceProperties
maintenanceWindow	服务器的维护时段。	MaintenanceWindow
网络	服务器的网络相关属性。	网络
replicationRole	复制角色。	“None” “Replica” “Source”
restorePointInTime	还原点创建时间（ISO8601格式），指定要从中还原的时间。	字符串
sourceServerResourceId	源 MySQL 服务器 ID。	字符串
存储	服务器的存储相关属性。	存储
版本	服务器版本。	'5.7' '8.0.21'

备份

名字	描述	价值
backupRetentionDays	服务器的备份保留日。	int
geoRedundantBackup	是否启用异地冗余备份。	“Disabled” “Enabled”

DataEncryption

名字	描述	价值
geoBackupKeyURI	异地备份密钥 URI，因为密钥保管库不能跨区域，需要与异地备份位于同一区域中的 cmk	字符串
geoBackupUserAssignedIdentityId	异地备份用户标识资源 ID 作为标识不能跨区域，需要与异地备份位于同一区域中的标识	字符串
primaryKeyURI	主键 URI	字符串
primaryUserAssignedIdentityId	主要用户标识资源 ID	字符串
类型	密钥类型，用于启用 cmk 的 AzureKeyVault、用于禁用 cmk 的 SystemManaged。	“AzureKeyVault” “SystemManaged”

HighAvailability

名字	描述	价值
模式	服务器的高可用性模式。	“Disabled” “SameZone” “ZoneRedundant”
standbyAvailabilityZone	备用服务器的可用性区域。	字符串

ImportSourceProperties

名字	描述	价值
dataDirPath	存储中的数据目录的相对路径。	字符串
sasToken	用于访问源存储的 Sas 令牌。 SAS 令牌需要读取和列出权限。	字符串约束：敏感值。以安全参数的形式传入。
storageType	导入源的存储类型。	“AzureBlob”
storageUrl	导入源存储的 URI。	字符串

MaintenanceWindow

名字	描述	价值
customWindow	指示是启用还是禁用自定义窗口	字符串
dayOfWeek	维护时段的星期几	int
startHour	维护时段的开始时间	int
startMinute	维护时段的开始时间	int

网络

名字	描述	价值
delegatedSubnetResourceId	用于为服务器设置 vnet 的委托子网资源 ID。	字符串
privateDnsZoneResourceId	专用 DNS 区域资源 ID。	字符串
publicNetworkAccess	是否允许此服务器访问公用网络。当服务器具有 VNet 集成时，值为“Disabled”。	“Disabled” “Enabled”

存储

名字	描述	价值
autoGrow	启用存储自动增长。	“Disabled” “Enabled”
autoIoScaling	启用 IO 自动缩放。	“Disabled” “Enabled”
iops	服务器的存储 IOPS。	int
logOnDisk	启用登录磁盘。	“Disabled” “Enabled”
storageSizeGB	服务器允许的最大存储大小。	int

MySQLServerSku

名字	描述	价值
名字	sku 的名称，例如Standard_D32s_v3。	string （必需）
层	特定 SKU 的层，例如 GeneralPurpose。	“可突发” “GeneralPurpose” “MemoryOptimized”（必需）

快速入门模板

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

模板	描述
创建 MySqlFlex 服务器 & 通过备份保管库启用保护	创建 MySQL 灵活服务器的模板，并通过备份保管库启用保护
使用专用终结点部署 MySQL 灵活服务器	此模板提供了使用专用终结点部署 Azure Database for MySQL 灵活服务器的方法。
使用 Vnet 集成部署 MySQL 灵活服务器	此模板提供了使用 VNet 集成部署 Azure Database for MySQL 灵活服务器的方法。

ARM 模板资源定义

可以使用目标操作部署 flexibleServers 资源类型：

资源组 - 请参阅资源组部署命令

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

言论

仅在更新现有灵活服务器时使用 maintenanceWindow 属性。创建新的灵活服务器时，请不要为此属性指定值。

资源格式

若要创建 Microsoft.DBforMySQL/flexibleServers 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.DBforMySQL/flexibleServers",
  "apiVersion": "2023-06-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-06-01-preview'
名字	资源名称	string （必需）
位置	资源所在的地理位置	string （必需）
标签	资源标记。	标记名称和值的字典。请参阅模板中的标记
sku	服务器的 SKU（定价层）。	MySQLServerSku
身份	服务器的 cmk 标识。	MySQLServerIdentity
性能	服务器的属性。	ServerProperties

MySQLServerIdentity

名字	描述	价值
类型	托管服务标识的类型。	“UserAssigned”
userAssignedIdentities	用户分配标识的元数据。	MySQLServerIdentityUserAssignedIdentities

MySQLServerIdentityUserAssignedIdentities

名字	描述	价值
{自定义属性}

ServerProperties

名字	描述	价值
administratorLogin	管理员的服务器登录名。只能在创建服务器时指定（并且是创建所必需的）。	字符串
administratorLoginPassword	管理员登录名的密码（创建服务器时需要）。	字符串约束：敏感值。以安全参数的形式传入。
availabilityZone	服务器的可用性区域信息。	字符串
备份	备份服务器的相关属性。	备份
createMode	创建新的 MySQL 服务器的模式。	“Default” “GeoRestore” “PointInTimeRestore” “Replica”
dataEncryption	CMK 的数据加密。	DataEncryption
highAvailability	服务器的高可用性相关属性。	HighAvailability
importSourceProperties	从存储导入的源属性。	ImportSourceProperties
maintenanceWindow	服务器的维护时段。	MaintenanceWindow
网络	服务器的网络相关属性。	网络
replicationRole	复制角色。	“None” “Replica” “Source”
restorePointInTime	还原点创建时间（ISO8601格式），指定要从中还原的时间。	字符串
sourceServerResourceId	源 MySQL 服务器 ID。	字符串
存储	服务器的存储相关属性。	存储
版本	服务器版本。	'5.7' '8.0.21'

备份

名字	描述	价值
backupRetentionDays	服务器的备份保留日。	int
geoRedundantBackup	是否启用异地冗余备份。	“Disabled” “Enabled”

DataEncryption

名字	描述	价值
geoBackupKeyURI	异地备份密钥 URI，因为密钥保管库不能跨区域，需要与异地备份位于同一区域中的 cmk	字符串
geoBackupUserAssignedIdentityId	异地备份用户标识资源 ID 作为标识不能跨区域，需要与异地备份位于同一区域中的标识	字符串
primaryKeyURI	主键 URI	字符串
primaryUserAssignedIdentityId	主要用户标识资源 ID	字符串
类型	密钥类型，用于启用 cmk 的 AzureKeyVault、用于禁用 cmk 的 SystemManaged。	“AzureKeyVault” “SystemManaged”

HighAvailability

名字	描述	价值
模式	服务器的高可用性模式。	“Disabled” “SameZone” “ZoneRedundant”
standbyAvailabilityZone	备用服务器的可用性区域。	字符串

ImportSourceProperties

名字	描述	价值
dataDirPath	存储中的数据目录的相对路径。	字符串
sasToken	用于访问源存储的 Sas 令牌。 SAS 令牌需要读取和列出权限。	字符串约束：敏感值。以安全参数的形式传入。
storageType	导入源的存储类型。	“AzureBlob”
storageUrl	导入源存储的 URI。	字符串

MaintenanceWindow

名字	描述	价值
customWindow	指示是启用还是禁用自定义窗口	字符串
dayOfWeek	维护时段的星期几	int
startHour	维护时段的开始时间	int
startMinute	维护时段的开始时间	int

网络

名字	描述	价值
delegatedSubnetResourceId	用于为服务器设置 vnet 的委托子网资源 ID。	字符串
privateDnsZoneResourceId	专用 DNS 区域资源 ID。	字符串
publicNetworkAccess	是否允许此服务器访问公用网络。当服务器具有 VNet 集成时，值为“Disabled”。	“Disabled” “Enabled”

存储

名字	描述	价值
autoGrow	启用存储自动增长。	“Disabled” “Enabled”
autoIoScaling	启用 IO 自动缩放。	“Disabled” “Enabled”
iops	服务器的存储 IOPS。	int
logOnDisk	启用登录磁盘。	“Disabled” “Enabled”
storageSizeGB	服务器允许的最大存储大小。	int

MySQLServerSku

名字	描述	价值
名字	sku 的名称，例如Standard_D32s_v3。	string （必需）
层	特定 SKU 的层，例如 GeneralPurpose。	“可突发” “GeneralPurpose” “MemoryOptimized”（必需）

快速入门模板

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

模板	描述
创建 MySqlFlex 服务器 & 通过备份保管库启用保护	创建 MySQL 灵活服务器的模板，并通过备份保管库启用保护
使用专用终结点部署 MySQL 灵活服务器	此模板提供了使用专用终结点部署 Azure Database for MySQL 灵活服务器的方法。
使用 Vnet 集成部署 MySQL 灵活服务器	此模板提供了使用 VNet 集成部署 Azure Database for MySQL 灵活服务器的方法。

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署 flexibleServers 资源类型：

资源组

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

资源格式

若要创建 Microsoft.DBforMySQL/flexibleServers 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DBforMySQL/flexibleServers@2023-06-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-06-01-preview”
名字	资源名称	string （必需）
位置	资源所在的地理位置	string （必需）
parent_id	若要部署到资源组，请使用该资源组的 ID。	string （必需）
标签	资源标记。	标记名称和值的字典。
sku	服务器的 SKU（定价层）。	MySQLServerSku
身份	服务器的 cmk 标识。	MySQLServerIdentity
性能	服务器的属性。	ServerProperties

MySQLServerIdentity

名字	描述	价值
类型	托管服务标识的类型。	“UserAssigned”
identity_ids	用户分配标识的元数据。	用户标识 ID 的数组。

MySQLServerIdentityUserAssignedIdentities

名字	描述	价值
{自定义属性}

ServerProperties

名字	描述	价值
administratorLogin	管理员的服务器登录名。只能在创建服务器时指定（并且是创建所必需的）。	字符串
administratorLoginPassword	管理员登录名的密码（创建服务器时需要）。	字符串约束：敏感值。以安全参数的形式传入。
availabilityZone	服务器的可用性区域信息。	字符串
备份	备份服务器的相关属性。	备份
createMode	创建新的 MySQL 服务器的模式。	“Default” “GeoRestore” “PointInTimeRestore” “Replica”
dataEncryption	CMK 的数据加密。	DataEncryption
highAvailability	服务器的高可用性相关属性。	HighAvailability
importSourceProperties	从存储导入的源属性。	ImportSourceProperties
maintenanceWindow	服务器的维护时段。	MaintenanceWindow
网络	服务器的网络相关属性。	网络
replicationRole	复制角色。	“None” “Replica” “源”
restorePointInTime	还原点创建时间（ISO8601格式），指定要从中还原的时间。	字符串
sourceServerResourceId	源 MySQL 服务器 ID。	字符串
存储	服务器的存储相关属性。	存储
版本	服务器版本。	"5.7" "8.0.21"

备份

名字	描述	价值
backupRetentionDays	服务器的备份保留日。	int
geoRedundantBackup	是否启用异地冗余备份。	“Disabled” “已启用”

DataEncryption

名字	描述	价值
geoBackupKeyURI	异地备份密钥 URI，因为密钥保管库不能跨区域，需要与异地备份位于同一区域中的 cmk	字符串
geoBackupUserAssignedIdentityId	异地备份用户标识资源 ID 作为标识不能跨区域，需要与异地备份位于同一区域中的标识	字符串
primaryKeyURI	主键 URI	字符串
primaryUserAssignedIdentityId	主要用户标识资源 ID	字符串
类型	密钥类型，用于启用 cmk 的 AzureKeyVault、用于禁用 cmk 的 SystemManaged。	“AzureKeyVault” “SystemManaged”

HighAvailability

名字	描述	价值
模式	服务器的高可用性模式。	“Disabled” “SameZone” “ZoneRedundant”
standbyAvailabilityZone	备用服务器的可用性区域。	字符串

ImportSourceProperties

名字	描述	价值
dataDirPath	存储中的数据目录的相对路径。	字符串
sasToken	用于访问源存储的 Sas 令牌。 SAS 令牌需要读取和列出权限。	字符串约束：敏感值。以安全参数的形式传入。
storageType	导入源的存储类型。	“AzureBlob”
storageUrl	导入源存储的 URI。	字符串

MaintenanceWindow

名字	描述	价值
customWindow	指示是启用还是禁用自定义窗口	字符串
dayOfWeek	维护时段的星期几	int
startHour	维护时段的开始时间	int
startMinute	维护时段的开始时间	int

网络

名字	描述	价值
delegatedSubnetResourceId	用于为服务器设置 vnet 的委托子网资源 ID。	字符串
privateDnsZoneResourceId	专用 DNS 区域资源 ID。	字符串
publicNetworkAccess	是否允许此服务器访问公用网络。当服务器具有 VNet 集成时，值为“Disabled”。	“Disabled” “已启用”

存储

名字	描述	价值
autoGrow	启用存储自动增长。	“Disabled” “已启用”
autoIoScaling	启用 IO 自动缩放。	“Disabled” “已启用”
iops	服务器的存储 IOPS。	int
logOnDisk	启用登录磁盘。	“Disabled” “已启用”
storageSizeGB	服务器允许的最大存储大小。	int

MySQLServerSku

名字	描述	价值
名字	sku 的名称，例如Standard_D32s_v3。	string （必需）
层	特定 SKU 的层，例如 GeneralPurpose。	“可突发” “GeneralPurpose” “MemoryOptimized”（必需）

通过

Microsoft.DBforMySQL flexibleServers 2023-06-01-preview

Bicep 资源定义

言论

资源格式

属性值

flexibleServers

MySQLServerIdentity

MySQLServerIdentityUserAssignedIdentities

ServerProperties

备份

DataEncryption

HighAvailability

ImportSourceProperties

MaintenanceWindow

网络

存储

MySQLServerSku

快速入门模板

ARM 模板资源定义

言论

资源格式

属性值

flexibleServers

MySQLServerIdentity

MySQLServerIdentityUserAssignedIdentities

ServerProperties

备份

DataEncryption

HighAvailability

ImportSourceProperties

MaintenanceWindow

网络

存储

MySQLServerSku

快速入门模板

Terraform （AzAPI 提供程序）资源定义

资源格式

属性值

flexibleServers

MySQLServerIdentity

MySQLServerIdentityUserAssignedIdentities

ServerProperties

备份

DataEncryption

HighAvailability

ImportSourceProperties

MaintenanceWindow

网络

存储

MySQLServerSku

反馈

其他资源