Microsoft.DBforMySQL (preview:2025-06-01)

2025/11/10 • 8 updated methods

Servers_List (updated)
Description :  List all the servers in a given subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Servers_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "version",
                "Enum": {
                  "new": [
                    [
                      "5.7",
                      ""
                    ],
                    [
                      "8.0.21",
                      ""
                    ],
                    [
                      "8.4",
                      ""
                    ]
                  ],
                  "old": [
                    [
                      "5.7",
                      ""
                    ],
                    [
                      "8.0.21",
                      ""
                    ]
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/flexibleServers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Server items on this page ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the server. ,
Required: False ,
}
{
administratorLogin:
{
Description: The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login (required for server creation). ,
Format: password ,
Required: False ,
}
string ,
version:
{
Description: Major version of MySQL. 8.0.21 stands for MySQL 8.0, 5.7.44 stands for MySQL 5.7 ,
Enum:
{
5.7: No description available. ,
8.0.21: No description available. ,
8.4: No description available. ,
}
,
Required: False ,
}
enum ,
fullVersion:
{
Description: Major version and actual engine version ,
Required: False ,
}
string ,
availabilityZone:
{
Description: availability Zone information of the server. ,
Required: False ,
}
string ,
createMode:
{
Description: The mode to create a new MySQL server. ,
Enum:
{
Default: No description available. ,
PointInTimeRestore: No description available. ,
Replica: No description available. ,
GeoRestore: No description available. ,
}
,
Required: False ,
}
enum ,
sourceServerResourceId:
{
Description: The source MySQL server id. ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Restore point creation time (ISO8601 format), specifying the time to restore from. ,
Format: date-time ,
Required: False ,
}
string ,
replicationRole:
{
Description: The replication role. ,
Enum:
{
None: No description available. ,
Source: No description available. ,
Replica: No description available. ,
}
,
Required: False ,
}
enum ,
replicaCapacity:
{
Description: The maximum number of replicas that a primary server can have. ,
Format: int32 ,
Required: False ,
}
integer ,
dataEncryption:
{
Description: The Data Encryption for CMK. ,
Required: False ,
}
{
primaryUserAssignedIdentityId:
{
Description: Primary user identity resource id ,
Required: False ,
}
string ,
primaryKeyURI:
{
Description: Primary key uri ,
Required: False ,
}
string ,
geoBackupUserAssignedIdentityId:
{
Description: Geo backup user identity resource id as identity can't cross region, need identity in same region as geo backup ,
Required: False ,
}
string ,
geoBackupKeyURI:
{
Description: Geo backup key uri as key vault can't cross region, need cmk in same region as geo backup ,
Required: False ,
}
string ,
type:
{
Description: The key type, AzureKeyVault for enable cmk, SystemManaged for disable cmk. ,
Enum:
{
AzureKeyVault: No description available. ,
SystemManaged: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
state:
{
Description: The state of a server. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
databasePort:
{
Description: The server database port. Can only be specified when the server is being created. ,
Format: int32 ,
Required: False ,
}
integer ,
storage:
{
Description: Storage related properties of a server. ,
Required: False ,
}
{
storageSizeGB:
{
Description: Max storage size allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
iops:
{
Description: Storage IOPS for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
autoGrow:
{
Description: Enable Storage Auto Grow or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
logOnDisk:
{
Description: Enable Log On Disk or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
storageSku:
{
Description: The sku name of the server storage. ,
Required: False ,
}
string ,
autoIoScaling:
{
Description: Enable IO Auto Scaling or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
storageRedundancy:
{
Description: The redundant type of the server storage. The parameter is used for server creation. ,
Enum:
{
LocalRedundancy: No description available. ,
ZoneRedundancy: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
backup:
{
Description: Backup related properties of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
backupIntervalHours:
{
Description: Backup interval hours for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRedundantBackup:
{
Description: Whether or not geo redundant backup is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreDate:
{
Description: Earliest restore point creation time (ISO8601 format) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
highAvailability:
{
Description: High availability related properties of a server. ,
Required: False ,
}
{
mode:
{
Description: High availability mode for a server. ,
Enum:
{
Disabled: No description available. ,
ZoneRedundant: No description available. ,
SameZone: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of server high availability. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
Healthy: No description available. ,
FailingOver: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
standbyAvailabilityZone:
{
Description: Availability zone of the standby server. ,
Required: False ,
}
string ,
replicationMode:
{
Description: HA Replication mode for a server. ,
Enum:
{
BinaryLog: Binary log replication ,
RedoLog: Redo log replication ,
}
,
Required: False ,
}
enum ,
}
,
network:
{
Description: Network related properties of a server. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for this server. Value is 'Disabled' when server has VNet integration. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
delegatedSubnetResourceId:
{
Description: Delegated subnet resource id used to setup vnet for a server. ,
Required: False ,
}
string ,
privateDnsZoneResourceId:
{
Description: Private DNS zone resource id. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: PrivateEndpointConnections related properties of a server. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
maintenancePolicy:
{
Description: Maintenance policy of a server. ,
Required: False ,
}
{
patchStrategy:
{
Description: The patch strategy of this server ,
Enum:
{
Regular: No description available. ,
VirtualCanary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
maintenanceWindow:
{
Description: Maintenance window of a server. Known issue: cannot be set during server creation or updated with other properties during server update; must be updated separately. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
batchOfMaintenance:
{
Description: The batch of maintenance when enabled the custom managed maintenance window of a server. ,
Enum:
{
Default: No description available. ,
Batch1: No description available. ,
Batch2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
importSourceProperties:
{
Description: Source properties for import from storage. ,
Required: False ,
}
{
storageType:
{
Description: Storage type of import source. ,
Enum:
{
AzureBlob: No description available. ,
}
,
Required: False ,
}
enum ,
storageUrl:
{
Description: Uri of the import source storage. ,
Required: False ,
}
string ,
sasToken:
{
Description: Sas token for accessing source storage. Read and list permissions are required for sas token. ,
Format: password ,
Required: False ,
}
string ,
dataDirPath:
{
Description: Relative path of data directory in storage. ,
Required: False ,
}
string ,
}
,
lowerCaseTableNames:
{
Description: The mysql parameter lower_case_table_names. Can only be specified when the server is being created. Allowed values 1 or 2. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The cmk identity for the server. ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Metadata of user assigned identity. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: The SKU (pricing tier) of the server. ,
Required: False ,
}
{
name:
{
Description: The name of the sku, e.g. Standard_D32s_v3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier of the particular SKU, e.g. GeneralPurpose. ,
Enum:
{
Burstable: No description available. ,
GeneralPurpose: No description available. ,
MemoryOptimized: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Servers_ListByResourceGroup (updated)
Description :  List all the servers in a given resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Servers_ListByResourceGroup",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "version",
                "Enum": {
                  "new": [
                    [
                      "5.7",
                      ""
                    ],
                    [
                      "8.0.21",
                      ""
                    ],
                    [
                      "8.4",
                      ""
                    ]
                  ],
                  "old": [
                    [
                      "5.7",
                      ""
                    ],
                    [
                      "8.0.21",
                      ""
                    ]
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Server items on this page ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the server. ,
Required: False ,
}
{
administratorLogin:
{
Description: The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login (required for server creation). ,
Format: password ,
Required: False ,
}
string ,
version:
{
Description: Major version of MySQL. 8.0.21 stands for MySQL 8.0, 5.7.44 stands for MySQL 5.7 ,
Enum:
{
5.7: No description available. ,
8.0.21: No description available. ,
8.4: No description available. ,
}
,
Required: False ,
}
enum ,
fullVersion:
{
Description: Major version and actual engine version ,
Required: False ,
}
string ,
availabilityZone:
{
Description: availability Zone information of the server. ,
Required: False ,
}
string ,
createMode:
{
Description: The mode to create a new MySQL server. ,
Enum:
{
Default: No description available. ,
PointInTimeRestore: No description available. ,
Replica: No description available. ,
GeoRestore: No description available. ,
}
,
Required: False ,
}
enum ,
sourceServerResourceId:
{
Description: The source MySQL server id. ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Restore point creation time (ISO8601 format), specifying the time to restore from. ,
Format: date-time ,
Required: False ,
}
string ,
replicationRole:
{
Description: The replication role. ,
Enum:
{
None: No description available. ,
Source: No description available. ,
Replica: No description available. ,
}
,
Required: False ,
}
enum ,
replicaCapacity:
{
Description: The maximum number of replicas that a primary server can have. ,
Format: int32 ,
Required: False ,
}
integer ,
dataEncryption:
{
Description: The Data Encryption for CMK. ,
Required: False ,
}
{
primaryUserAssignedIdentityId:
{
Description: Primary user identity resource id ,
Required: False ,
}
string ,
primaryKeyURI:
{
Description: Primary key uri ,
Required: False ,
}
string ,
geoBackupUserAssignedIdentityId:
{
Description: Geo backup user identity resource id as identity can't cross region, need identity in same region as geo backup ,
Required: False ,
}
string ,
geoBackupKeyURI:
{
Description: Geo backup key uri as key vault can't cross region, need cmk in same region as geo backup ,
Required: False ,
}
string ,
type:
{
Description: The key type, AzureKeyVault for enable cmk, SystemManaged for disable cmk. ,
Enum:
{
AzureKeyVault: No description available. ,
SystemManaged: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
state:
{
Description: The state of a server. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
databasePort:
{
Description: The server database port. Can only be specified when the server is being created. ,
Format: int32 ,
Required: False ,
}
integer ,
storage:
{
Description: Storage related properties of a server. ,
Required: False ,
}
{
storageSizeGB:
{
Description: Max storage size allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
iops:
{
Description: Storage IOPS for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
autoGrow:
{
Description: Enable Storage Auto Grow or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
logOnDisk:
{
Description: Enable Log On Disk or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
storageSku:
{
Description: The sku name of the server storage. ,
Required: False ,
}
string ,
autoIoScaling:
{
Description: Enable IO Auto Scaling or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
storageRedundancy:
{
Description: The redundant type of the server storage. The parameter is used for server creation. ,
Enum:
{
LocalRedundancy: No description available. ,
ZoneRedundancy: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
backup:
{
Description: Backup related properties of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
backupIntervalHours:
{
Description: Backup interval hours for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRedundantBackup:
{
Description: Whether or not geo redundant backup is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreDate:
{
Description: Earliest restore point creation time (ISO8601 format) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
highAvailability:
{
Description: High availability related properties of a server. ,
Required: False ,
}
{
mode:
{
Description: High availability mode for a server. ,
Enum:
{
Disabled: No description available. ,
ZoneRedundant: No description available. ,
SameZone: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of server high availability. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
Healthy: No description available. ,
FailingOver: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
standbyAvailabilityZone:
{
Description: Availability zone of the standby server. ,
Required: False ,
}
string ,
replicationMode:
{
Description: HA Replication mode for a server. ,
Enum:
{
BinaryLog: Binary log replication ,
RedoLog: Redo log replication ,
}
,
Required: False ,
}
enum ,
}
,
network:
{
Description: Network related properties of a server. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for this server. Value is 'Disabled' when server has VNet integration. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
delegatedSubnetResourceId:
{
Description: Delegated subnet resource id used to setup vnet for a server. ,
Required: False ,
}
string ,
privateDnsZoneResourceId:
{
Description: Private DNS zone resource id. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: PrivateEndpointConnections related properties of a server. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
maintenancePolicy:
{
Description: Maintenance policy of a server. ,
Required: False ,
}
{
patchStrategy:
{
Description: The patch strategy of this server ,
Enum:
{
Regular: No description available. ,
VirtualCanary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
maintenanceWindow:
{
Description: Maintenance window of a server. Known issue: cannot be set during server creation or updated with other properties during server update; must be updated separately. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
batchOfMaintenance:
{
Description: The batch of maintenance when enabled the custom managed maintenance window of a server. ,
Enum:
{
Default: No description available. ,
Batch1: No description available. ,
Batch2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
importSourceProperties:
{
Description: Source properties for import from storage. ,
Required: False ,
}
{
storageType:
{
Description: Storage type of import source. ,
Enum:
{
AzureBlob: No description available. ,
}
,
Required: False ,
}
enum ,
storageUrl:
{
Description: Uri of the import source storage. ,
Required: False ,
}
string ,
sasToken:
{
Description: Sas token for accessing source storage. Read and list permissions are required for sas token. ,
Format: password ,
Required: False ,
}
string ,
dataDirPath:
{
Description: Relative path of data directory in storage. ,
Required: False ,
}
string ,
}
,
lowerCaseTableNames:
{
Description: The mysql parameter lower_case_table_names. Can only be specified when the server is being created. Allowed values 1 or 2. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The cmk identity for the server. ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Metadata of user assigned identity. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: The SKU (pricing tier) of the server. ,
Required: False ,
}
{
name:
{
Description: The name of the sku, e.g. Standard_D32s_v3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier of the particular SKU, e.g. GeneralPurpose. ,
Enum:
{
Burstable: No description available. ,
GeneralPurpose: No description available. ,
MemoryOptimized: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Servers_Get (updated)
Description :  Gets information about a server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Servers_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "version",
            "Enum": {
              "new": [
                [
                  "5.7",
                  ""
                ],
                [
                  "8.0.21",
                  ""
                ],
                [
                  "8.4",
                  ""
                ]
              ],
              "old": [
                [
                  "5.7",
                  ""
                ],
                [
                  "8.0.21",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the server. ,
Required: False ,
}
{
administratorLogin:
{
Description: The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login (required for server creation). ,
Format: password ,
Required: False ,
}
string ,
version:
{
Description: Major version of MySQL. 8.0.21 stands for MySQL 8.0, 5.7.44 stands for MySQL 5.7 ,
Enum:
{
5.7: No description available. ,
8.0.21: No description available. ,
8.4: No description available. ,
}
,
Required: False ,
}
enum ,
fullVersion:
{
Description: Major version and actual engine version ,
Required: False ,
}
string ,
availabilityZone:
{
Description: availability Zone information of the server. ,
Required: False ,
}
string ,
createMode:
{
Description: The mode to create a new MySQL server. ,
Enum:
{
Default: No description available. ,
PointInTimeRestore: No description available. ,
Replica: No description available. ,
GeoRestore: No description available. ,
}
,
Required: False ,
}
enum ,
sourceServerResourceId:
{
Description: The source MySQL server id. ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Restore point creation time (ISO8601 format), specifying the time to restore from. ,
Format: date-time ,
Required: False ,
}
string ,
replicationRole:
{
Description: The replication role. ,
Enum:
{
None: No description available. ,
Source: No description available. ,
Replica: No description available. ,
}
,
Required: False ,
}
enum ,
replicaCapacity:
{
Description: The maximum number of replicas that a primary server can have. ,
Format: int32 ,
Required: False ,
}
integer ,
dataEncryption:
{
Description: The Data Encryption for CMK. ,
Required: False ,
}
{
primaryUserAssignedIdentityId:
{
Description: Primary user identity resource id ,
Required: False ,
}
string ,
primaryKeyURI:
{
Description: Primary key uri ,
Required: False ,
}
string ,
geoBackupUserAssignedIdentityId:
{
Description: Geo backup user identity resource id as identity can't cross region, need identity in same region as geo backup ,
Required: False ,
}
string ,
geoBackupKeyURI:
{
Description: Geo backup key uri as key vault can't cross region, need cmk in same region as geo backup ,
Required: False ,
}
string ,
type:
{
Description: The key type, AzureKeyVault for enable cmk, SystemManaged for disable cmk. ,
Enum:
{
AzureKeyVault: No description available. ,
SystemManaged: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
state:
{
Description: The state of a server. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
databasePort:
{
Description: The server database port. Can only be specified when the server is being created. ,
Format: int32 ,
Required: False ,
}
integer ,
storage:
{
Description: Storage related properties of a server. ,
Required: False ,
}
{
storageSizeGB:
{
Description: Max storage size allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
iops:
{
Description: Storage IOPS for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
autoGrow:
{
Description: Enable Storage Auto Grow or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
logOnDisk:
{
Description: Enable Log On Disk or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
storageSku:
{
Description: The sku name of the server storage. ,
Required: False ,
}
string ,
autoIoScaling:
{
Description: Enable IO Auto Scaling or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
storageRedundancy:
{
Description: The redundant type of the server storage. The parameter is used for server creation. ,
Enum:
{
LocalRedundancy: No description available. ,
ZoneRedundancy: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
backup:
{
Description: Backup related properties of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
backupIntervalHours:
{
Description: Backup interval hours for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRedundantBackup:
{
Description: Whether or not geo redundant backup is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreDate:
{
Description: Earliest restore point creation time (ISO8601 format) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
highAvailability:
{
Description: High availability related properties of a server. ,
Required: False ,
}
{
mode:
{
Description: High availability mode for a server. ,
Enum:
{
Disabled: No description available. ,
ZoneRedundant: No description available. ,
SameZone: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of server high availability. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
Healthy: No description available. ,
FailingOver: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
standbyAvailabilityZone:
{
Description: Availability zone of the standby server. ,
Required: False ,
}
string ,
replicationMode:
{
Description: HA Replication mode for a server. ,
Enum:
{
BinaryLog: Binary log replication ,
RedoLog: Redo log replication ,
}
,
Required: False ,
}
enum ,
}
,
network:
{
Description: Network related properties of a server. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for this server. Value is 'Disabled' when server has VNet integration. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
delegatedSubnetResourceId:
{
Description: Delegated subnet resource id used to setup vnet for a server. ,
Required: False ,
}
string ,
privateDnsZoneResourceId:
{
Description: Private DNS zone resource id. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: PrivateEndpointConnections related properties of a server. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
maintenancePolicy:
{
Description: Maintenance policy of a server. ,
Required: False ,
}
{
patchStrategy:
{
Description: The patch strategy of this server ,
Enum:
{
Regular: No description available. ,
VirtualCanary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
maintenanceWindow:
{
Description: Maintenance window of a server. Known issue: cannot be set during server creation or updated with other properties during server update; must be updated separately. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
batchOfMaintenance:
{
Description: The batch of maintenance when enabled the custom managed maintenance window of a server. ,
Enum:
{
Default: No description available. ,
Batch1: No description available. ,
Batch2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
importSourceProperties:
{
Description: Source properties for import from storage. ,
Required: False ,
}
{
storageType:
{
Description: Storage type of import source. ,
Enum:
{
AzureBlob: No description available. ,
}
,
Required: False ,
}
enum ,
storageUrl:
{
Description: Uri of the import source storage. ,
Required: False ,
}
string ,
sasToken:
{
Description: Sas token for accessing source storage. Read and list permissions are required for sas token. ,
Format: password ,
Required: False ,
}
string ,
dataDirPath:
{
Description: Relative path of data directory in storage. ,
Required: False ,
}
string ,
}
,
lowerCaseTableNames:
{
Description: The mysql parameter lower_case_table_names. Can only be specified when the server is being created. Allowed values 1 or 2. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The cmk identity for the server. ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Metadata of user assigned identity. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: The SKU (pricing tier) of the server. ,
Required: False ,
}
{
name:
{
Description: The name of the sku, e.g. Standard_D32s_v3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier of the particular SKU, e.g. GeneralPurpose. ,
Enum:
{
Burstable: No description available. ,
GeneralPurpose: No description available. ,
MemoryOptimized: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Servers_Create (updated)
Description :  Creates a new server or updates an existing server. The update action will overwrite the existing server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Servers_Create",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "#name": "version",
            "Enum": {
              "new": [
                [
                  "5.7",
                  ""
                ],
                [
                  "8.0.21",
                  ""
                ],
                [
                  "8.4",
                  ""
                ]
              ],
              "old": [
                [
                  "5.7",
                  ""
                ],
                [
                  "8.0.21",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "version",
            "Enum": {
              "new": [
                [
                  "5.7",
                  ""
                ],
                [
                  "8.0.21",
                  ""
                ],
                [
                  "8.4",
                  ""
                ]
              ],
              "old": [
                [
                  "5.7",
                  ""
                ],
                [
                  "8.0.21",
                  ""
                ]
              ]
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "version",
            "Enum": {
              "new": [
                [
                  "5.7",
                  ""
                ],
                [
                  "8.0.21",
                  ""
                ],
                [
                  "8.4",
                  ""
                ]
              ],
              "old": [
                [
                  "5.7",
                  ""
                ],
                [
                  "8.0.21",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for creating or updating a server. ,
Required: True ,
}
{
properties:
{
Description: Properties of the server. ,
Required: False ,
}
{
administratorLogin:
{
Description: The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login (required for server creation). ,
Format: password ,
Required: False ,
}
string ,
version:
{
Description: Major version of MySQL. 8.0.21 stands for MySQL 8.0, 5.7.44 stands for MySQL 5.7 ,
Enum:
{
5.7: No description available. ,
8.0.21: No description available. ,
8.4: No description available. ,
}
,
Required: False ,
}
enum ,
fullVersion:
{
Description: Major version and actual engine version ,
Required: False ,
}
string ,
availabilityZone:
{
Description: availability Zone information of the server. ,
Required: False ,
}
string ,
createMode:
{
Description: The mode to create a new MySQL server. ,
Enum:
{
Default: No description available. ,
PointInTimeRestore: No description available. ,
Replica: No description available. ,
GeoRestore: No description available. ,
}
,
Required: False ,
}
enum ,
sourceServerResourceId:
{
Description: The source MySQL server id. ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Restore point creation time (ISO8601 format), specifying the time to restore from. ,
Format: date-time ,
Required: False ,
}
string ,
replicationRole:
{
Description: The replication role. ,
Enum:
{
None: No description available. ,
Source: No description available. ,
Replica: No description available. ,
}
,
Required: False ,
}
enum ,
replicaCapacity:
{
Description: The maximum number of replicas that a primary server can have. ,
Format: int32 ,
Required: False ,
}
integer ,
dataEncryption:
{
Description: The Data Encryption for CMK. ,
Required: False ,
}
{
primaryUserAssignedIdentityId:
{
Description: Primary user identity resource id ,
Required: False ,
}
string ,
primaryKeyURI:
{
Description: Primary key uri ,
Required: False ,
}
string ,
geoBackupUserAssignedIdentityId:
{
Description: Geo backup user identity resource id as identity can't cross region, need identity in same region as geo backup ,
Required: False ,
}
string ,
geoBackupKeyURI:
{
Description: Geo backup key uri as key vault can't cross region, need cmk in same region as geo backup ,
Required: False ,
}
string ,
type:
{
Description: The key type, AzureKeyVault for enable cmk, SystemManaged for disable cmk. ,
Enum:
{
AzureKeyVault: No description available. ,
SystemManaged: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
state:
{
Description: The state of a server. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
databasePort:
{
Description: The server database port. Can only be specified when the server is being created. ,
Format: int32 ,
Required: False ,
}
integer ,
storage:
{
Description: Storage related properties of a server. ,
Required: False ,
}
{
storageSizeGB:
{
Description: Max storage size allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
iops:
{
Description: Storage IOPS for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
autoGrow:
{
Description: Enable Storage Auto Grow or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
logOnDisk:
{
Description: Enable Log On Disk or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
storageSku:
{
Description: The sku name of the server storage. ,
Required: False ,
}
string ,
autoIoScaling:
{
Description: Enable IO Auto Scaling or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
storageRedundancy:
{
Description: The redundant type of the server storage. The parameter is used for server creation. ,
Enum:
{
LocalRedundancy: No description available. ,
ZoneRedundancy: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
backup:
{
Description: Backup related properties of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
backupIntervalHours:
{
Description: Backup interval hours for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRedundantBackup:
{
Description: Whether or not geo redundant backup is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreDate:
{
Description: Earliest restore point creation time (ISO8601 format) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
highAvailability:
{
Description: High availability related properties of a server. ,
Required: False ,
}
{
mode:
{
Description: High availability mode for a server. ,
Enum:
{
Disabled: No description available. ,
ZoneRedundant: No description available. ,
SameZone: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of server high availability. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
Healthy: No description available. ,
FailingOver: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
standbyAvailabilityZone:
{
Description: Availability zone of the standby server. ,
Required: False ,
}
string ,
replicationMode:
{
Description: HA Replication mode for a server. ,
Enum:
{
BinaryLog: Binary log replication ,
RedoLog: Redo log replication ,
}
,
Required: False ,
}
enum ,
}
,
network:
{
Description: Network related properties of a server. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for this server. Value is 'Disabled' when server has VNet integration. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
delegatedSubnetResourceId:
{
Description: Delegated subnet resource id used to setup vnet for a server. ,
Required: False ,
}
string ,
privateDnsZoneResourceId:
{
Description: Private DNS zone resource id. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: PrivateEndpointConnections related properties of a server. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
maintenancePolicy:
{
Description: Maintenance policy of a server. ,
Required: False ,
}
{
patchStrategy:
{
Description: The patch strategy of this server ,
Enum:
{
Regular: No description available. ,
VirtualCanary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
maintenanceWindow:
{
Description: Maintenance window of a server. Known issue: cannot be set during server creation or updated with other properties during server update; must be updated separately. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
batchOfMaintenance:
{
Description: The batch of maintenance when enabled the custom managed maintenance window of a server. ,
Enum:
{
Default: No description available. ,
Batch1: No description available. ,
Batch2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
importSourceProperties:
{
Description: Source properties for import from storage. ,
Required: False ,
}
{
storageType:
{
Description: Storage type of import source. ,
Enum:
{
AzureBlob: No description available. ,
}
,
Required: False ,
}
enum ,
storageUrl:
{
Description: Uri of the import source storage. ,
Required: False ,
}
string ,
sasToken:
{
Description: Sas token for accessing source storage. Read and list permissions are required for sas token. ,
Format: password ,
Required: False ,
}
string ,
dataDirPath:
{
Description: Relative path of data directory in storage. ,
Required: False ,
}
string ,
}
,
lowerCaseTableNames:
{
Description: The mysql parameter lower_case_table_names. Can only be specified when the server is being created. Allowed values 1 or 2. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The cmk identity for the server. ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Metadata of user assigned identity. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: The SKU (pricing tier) of the server. ,
Required: False ,
}
{
name:
{
Description: The name of the sku, e.g. Standard_D32s_v3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier of the particular SKU, e.g. GeneralPurpose. ,
Enum:
{
Burstable: No description available. ,
GeneralPurpose: No description available. ,
MemoryOptimized: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the server. ,
Required: False ,
}
{
administratorLogin:
{
Description: The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login (required for server creation). ,
Format: password ,
Required: False ,
}
string ,
version:
{
Description: Major version of MySQL. 8.0.21 stands for MySQL 8.0, 5.7.44 stands for MySQL 5.7 ,
Enum:
{
5.7: No description available. ,
8.0.21: No description available. ,
8.4: No description available. ,
}
,
Required: False ,
}
enum ,
fullVersion:
{
Description: Major version and actual engine version ,
Required: False ,
}
string ,
availabilityZone:
{
Description: availability Zone information of the server. ,
Required: False ,
}
string ,
createMode:
{
Description: The mode to create a new MySQL server. ,
Enum:
{
Default: No description available. ,
PointInTimeRestore: No description available. ,
Replica: No description available. ,
GeoRestore: No description available. ,
}
,
Required: False ,
}
enum ,
sourceServerResourceId:
{
Description: The source MySQL server id. ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Restore point creation time (ISO8601 format), specifying the time to restore from. ,
Format: date-time ,
Required: False ,
}
string ,
replicationRole:
{
Description: The replication role. ,
Enum:
{
None: No description available. ,
Source: No description available. ,
Replica: No description available. ,
}
,
Required: False ,
}
enum ,
replicaCapacity:
{
Description: The maximum number of replicas that a primary server can have. ,
Format: int32 ,
Required: False ,
}
integer ,
dataEncryption:
{
Description: The Data Encryption for CMK. ,
Required: False ,
}
{
primaryUserAssignedIdentityId:
{
Description: Primary user identity resource id ,
Required: False ,
}
string ,
primaryKeyURI:
{
Description: Primary key uri ,
Required: False ,
}
string ,
geoBackupUserAssignedIdentityId:
{
Description: Geo backup user identity resource id as identity can't cross region, need identity in same region as geo backup ,
Required: False ,
}
string ,
geoBackupKeyURI:
{
Description: Geo backup key uri as key vault can't cross region, need cmk in same region as geo backup ,
Required: False ,
}
string ,
type:
{
Description: The key type, AzureKeyVault for enable cmk, SystemManaged for disable cmk. ,
Enum:
{
AzureKeyVault: No description available. ,
SystemManaged: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
state:
{
Description: The state of a server. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
databasePort:
{
Description: The server database port. Can only be specified when the server is being created. ,
Format: int32 ,
Required: False ,
}
integer ,
storage:
{
Description: Storage related properties of a server. ,
Required: False ,
}
{
storageSizeGB:
{
Description: Max storage size allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
iops:
{
Description: Storage IOPS for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
autoGrow:
{
Description: Enable Storage Auto Grow or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
logOnDisk:
{
Description: Enable Log On Disk or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
storageSku:
{
Description: The sku name of the server storage. ,
Required: False ,
}
string ,
autoIoScaling:
{
Description: Enable IO Auto Scaling or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
storageRedundancy:
{
Description: The redundant type of the server storage. The parameter is used for server creation. ,
Enum:
{
LocalRedundancy: No description available. ,
ZoneRedundancy: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
backup:
{
Description: Backup related properties of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
backupIntervalHours:
{
Description: Backup interval hours for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRedundantBackup:
{
Description: Whether or not geo redundant backup is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreDate:
{
Description: Earliest restore point creation time (ISO8601 format) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
highAvailability:
{
Description: High availability related properties of a server. ,
Required: False ,
}
{
mode:
{
Description: High availability mode for a server. ,
Enum:
{
Disabled: No description available. ,
ZoneRedundant: No description available. ,
SameZone: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of server high availability. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
Healthy: No description available. ,
FailingOver: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
standbyAvailabilityZone:
{
Description: Availability zone of the standby server. ,
Required: False ,
}
string ,
replicationMode:
{
Description: HA Replication mode for a server. ,
Enum:
{
BinaryLog: Binary log replication ,
RedoLog: Redo log replication ,
}
,
Required: False ,
}
enum ,
}
,
network:
{
Description: Network related properties of a server. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for this server. Value is 'Disabled' when server has VNet integration. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
delegatedSubnetResourceId:
{
Description: Delegated subnet resource id used to setup vnet for a server. ,
Required: False ,
}
string ,
privateDnsZoneResourceId:
{
Description: Private DNS zone resource id. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: PrivateEndpointConnections related properties of a server. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
maintenancePolicy:
{
Description: Maintenance policy of a server. ,
Required: False ,
}
{
patchStrategy:
{
Description: The patch strategy of this server ,
Enum:
{
Regular: No description available. ,
VirtualCanary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
maintenanceWindow:
{
Description: Maintenance window of a server. Known issue: cannot be set during server creation or updated with other properties during server update; must be updated separately. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
batchOfMaintenance:
{
Description: The batch of maintenance when enabled the custom managed maintenance window of a server. ,
Enum:
{
Default: No description available. ,
Batch1: No description available. ,
Batch2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
importSourceProperties:
{
Description: Source properties for import from storage. ,
Required: False ,
}
{
storageType:
{
Description: Storage type of import source. ,
Enum:
{
AzureBlob: No description available. ,
}
,
Required: False ,
}
enum ,
storageUrl:
{
Description: Uri of the import source storage. ,
Required: False ,
}
string ,
sasToken:
{
Description: Sas token for accessing source storage. Read and list permissions are required for sas token. ,
Format: password ,
Required: False ,
}
string ,
dataDirPath:
{
Description: Relative path of data directory in storage. ,
Required: False ,
}
string ,
}
,
lowerCaseTableNames:
{
Description: The mysql parameter lower_case_table_names. Can only be specified when the server is being created. Allowed values 1 or 2. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The cmk identity for the server. ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Metadata of user assigned identity. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: The SKU (pricing tier) of the server. ,
Required: False ,
}
{
name:
{
Description: The name of the sku, e.g. Standard_D32s_v3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier of the particular SKU, e.g. GeneralPurpose. ,
Enum:
{
Burstable: No description available. ,
GeneralPurpose: No description available. ,
MemoryOptimized: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Represents a server. ,
}
{
properties:
{
Description: Properties of the server. ,
Required: False ,
}
{
administratorLogin:
{
Description: The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login (required for server creation). ,
Format: password ,
Required: False ,
}
string ,
version:
{
Description: Major version of MySQL. 8.0.21 stands for MySQL 8.0, 5.7.44 stands for MySQL 5.7 ,
Enum:
{
5.7: No description available. ,
8.0.21: No description available. ,
8.4: No description available. ,
}
,
Required: False ,
}
enum ,
fullVersion:
{
Description: Major version and actual engine version ,
Required: False ,
}
string ,
availabilityZone:
{
Description: availability Zone information of the server. ,
Required: False ,
}
string ,
createMode:
{
Description: The mode to create a new MySQL server. ,
Enum:
{
Default: No description available. ,
PointInTimeRestore: No description available. ,
Replica: No description available. ,
GeoRestore: No description available. ,
}
,
Required: False ,
}
enum ,
sourceServerResourceId:
{
Description: The source MySQL server id. ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Restore point creation time (ISO8601 format), specifying the time to restore from. ,
Format: date-time ,
Required: False ,
}
string ,
replicationRole:
{
Description: The replication role. ,
Enum:
{
None: No description available. ,
Source: No description available. ,
Replica: No description available. ,
}
,
Required: False ,
}
enum ,
replicaCapacity:
{
Description: The maximum number of replicas that a primary server can have. ,
Format: int32 ,
Required: False ,
}
integer ,
dataEncryption:
{
Description: The Data Encryption for CMK. ,
Required: False ,
}
{
primaryUserAssignedIdentityId:
{
Description: Primary user identity resource id ,
Required: False ,
}
string ,
primaryKeyURI:
{
Description: Primary key uri ,
Required: False ,
}
string ,
geoBackupUserAssignedIdentityId:
{
Description: Geo backup user identity resource id as identity can't cross region, need identity in same region as geo backup ,
Required: False ,
}
string ,
geoBackupKeyURI:
{
Description: Geo backup key uri as key vault can't cross region, need cmk in same region as geo backup ,
Required: False ,
}
string ,
type:
{
Description: The key type, AzureKeyVault for enable cmk, SystemManaged for disable cmk. ,
Enum:
{
AzureKeyVault: No description available. ,
SystemManaged: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
state:
{
Description: The state of a server. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
databasePort:
{
Description: The server database port. Can only be specified when the server is being created. ,
Format: int32 ,
Required: False ,
}
integer ,
storage:
{
Description: Storage related properties of a server. ,
Required: False ,
}
{
storageSizeGB:
{
Description: Max storage size allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
iops:
{
Description: Storage IOPS for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
autoGrow:
{
Description: Enable Storage Auto Grow or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
logOnDisk:
{
Description: Enable Log On Disk or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
storageSku:
{
Description: The sku name of the server storage. ,
Required: False ,
}
string ,
autoIoScaling:
{
Description: Enable IO Auto Scaling or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
storageRedundancy:
{
Description: The redundant type of the server storage. The parameter is used for server creation. ,
Enum:
{
LocalRedundancy: No description available. ,
ZoneRedundancy: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
backup:
{
Description: Backup related properties of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
backupIntervalHours:
{
Description: Backup interval hours for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRedundantBackup:
{
Description: Whether or not geo redundant backup is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreDate:
{
Description: Earliest restore point creation time (ISO8601 format) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
highAvailability:
{
Description: High availability related properties of a server. ,
Required: False ,
}
{
mode:
{
Description: High availability mode for a server. ,
Enum:
{
Disabled: No description available. ,
ZoneRedundant: No description available. ,
SameZone: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of server high availability. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
Healthy: No description available. ,
FailingOver: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
standbyAvailabilityZone:
{
Description: Availability zone of the standby server. ,
Required: False ,
}
string ,
replicationMode:
{
Description: HA Replication mode for a server. ,
Enum:
{
BinaryLog: Binary log replication ,
RedoLog: Redo log replication ,
}
,
Required: False ,
}
enum ,
}
,
network:
{
Description: Network related properties of a server. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for this server. Value is 'Disabled' when server has VNet integration. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
delegatedSubnetResourceId:
{
Description: Delegated subnet resource id used to setup vnet for a server. ,
Required: False ,
}
string ,
privateDnsZoneResourceId:
{
Description: Private DNS zone resource id. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: PrivateEndpointConnections related properties of a server. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
maintenancePolicy:
{
Description: Maintenance policy of a server. ,
Required: False ,
}
{
patchStrategy:
{
Description: The patch strategy of this server ,
Enum:
{
Regular: No description available. ,
VirtualCanary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
maintenanceWindow:
{
Description: Maintenance window of a server. Known issue: cannot be set during server creation or updated with other properties during server update; must be updated separately. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
batchOfMaintenance:
{
Description: The batch of maintenance when enabled the custom managed maintenance window of a server. ,
Enum:
{
Default: No description available. ,
Batch1: No description available. ,
Batch2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
importSourceProperties:
{
Description: Source properties for import from storage. ,
Required: False ,
}
{
storageType:
{
Description: Storage type of import source. ,
Enum:
{
AzureBlob: No description available. ,
}
,
Required: False ,
}
enum ,
storageUrl:
{
Description: Uri of the import source storage. ,
Required: False ,
}
string ,
sasToken:
{
Description: Sas token for accessing source storage. Read and list permissions are required for sas token. ,
Format: password ,
Required: False ,
}
string ,
dataDirPath:
{
Description: Relative path of data directory in storage. ,
Required: False ,
}
string ,
}
,
lowerCaseTableNames:
{
Description: The mysql parameter lower_case_table_names. Can only be specified when the server is being created. Allowed values 1 or 2. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The cmk identity for the server. ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Metadata of user assigned identity. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: The SKU (pricing tier) of the server. ,
Required: False ,
}
{
name:
{
Description: The name of the sku, e.g. Standard_D32s_v3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier of the particular SKU, e.g. GeneralPurpose. ,
Enum:
{
Burstable: No description available. ,
GeneralPurpose: No description available. ,
MemoryOptimized: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Servers_Update (updated)
Description :  Updates an existing server. The request body can contain one to many of the properties present in the normal server definition.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Servers_Update",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "#name": "version",
            "Enum": {
              "new": [
                [
                  "5.7",
                  ""
                ],
                [
                  "8.0.21",
                  ""
                ],
                [
                  "8.4",
                  ""
                ]
              ],
              "old": [
                [
                  "5.7",
                  ""
                ],
                [
                  "8.0.21",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "version",
            "Enum": {
              "new": [
                [
                  "5.7",
                  ""
                ],
                [
                  "8.0.21",
                  ""
                ],
                [
                  "8.4",
                  ""
                ]
              ],
              "old": [
                [
                  "5.7",
                  ""
                ],
                [
                  "8.0.21",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for updating a server. ,
Required: True ,
}
{
identity:
{
Description: The cmk identity for the server. ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Metadata of user assigned identity. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: The SKU (pricing tier) of the server. ,
Required: False ,
}
{
name:
{
Description: The name of the sku, e.g. Standard_D32s_v3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier of the particular SKU, e.g. GeneralPurpose. ,
Enum:
{
Burstable: No description available. ,
GeneralPurpose: No description available. ,
MemoryOptimized: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: The properties that can be updated for a server. ,
Required: False ,
}
{
administratorLoginPassword:
{
Description: The password of the administrator login. ,
Format: password ,
Required: False ,
}
string ,
version:
{
Description: Server version. ,
Enum:
{
5.7: No description available. ,
8.0.21: No description available. ,
8.4: No description available. ,
}
,
Required: False ,
}
enum ,
storage:
{
Description: Storage related properties of a server. ,
Required: False ,
}
{
storageSizeGB:
{
Description: Max storage size allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
iops:
{
Description: Storage IOPS for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
autoGrow:
{
Description: Enable Storage Auto Grow or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
logOnDisk:
{
Description: Enable Log On Disk or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
storageSku:
{
Description: The sku name of the server storage. ,
Required: False ,
}
string ,
autoIoScaling:
{
Description: Enable IO Auto Scaling or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
storageRedundancy:
{
Description: The redundant type of the server storage. The parameter is used for server creation. ,
Enum:
{
LocalRedundancy: No description available. ,
ZoneRedundancy: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
backup:
{
Description: Backup related properties of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
backupIntervalHours:
{
Description: Backup interval hours for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRedundantBackup:
{
Description: Whether or not geo redundant backup is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreDate:
{
Description: Earliest restore point creation time (ISO8601 format) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
highAvailability:
{
Description: High availability related properties of a server. ,
Required: False ,
}
{
mode:
{
Description: High availability mode for a server. ,
Enum:
{
Disabled: No description available. ,
ZoneRedundant: No description available. ,
SameZone: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of server high availability. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
Healthy: No description available. ,
FailingOver: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
standbyAvailabilityZone:
{
Description: Availability zone of the standby server. ,
Required: False ,
}
string ,
replicationMode:
{
Description: HA Replication mode for a server. ,
Enum:
{
BinaryLog: Binary log replication ,
RedoLog: Redo log replication ,
}
,
Required: False ,
}
enum ,
}
,
maintenancePolicy:
{
Description: Maintenance policy of a server. ,
Required: False ,
}
{
patchStrategy:
{
Description: The patch strategy of this server ,
Enum:
{
Regular: No description available. ,
VirtualCanary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
maintenanceWindow:
{
Description: Maintenance window of a server. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
batchOfMaintenance:
{
Description: The batch of maintenance when enabled the custom managed maintenance window of a server. ,
Enum:
{
Default: No description available. ,
Batch1: No description available. ,
Batch2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
replicationRole:
{
Description: The replication role of the server. ,
Enum:
{
None: No description available. ,
Source: No description available. ,
Replica: No description available. ,
}
,
Required: False ,
}
enum ,
dataEncryption:
{
Description: The Data Encryption for CMK. ,
Required: False ,
}
{
primaryUserAssignedIdentityId:
{
Description: Primary user identity resource id ,
Required: False ,
}
string ,
primaryKeyURI:
{
Description: Primary key uri ,
Required: False ,
}
string ,
geoBackupUserAssignedIdentityId:
{
Description: Geo backup user identity resource id as identity can't cross region, need identity in same region as geo backup ,
Required: False ,
}
string ,
geoBackupKeyURI:
{
Description: Geo backup key uri as key vault can't cross region, need cmk in same region as geo backup ,
Required: False ,
}
string ,
type:
{
Description: The key type, AzureKeyVault for enable cmk, SystemManaged for disable cmk. ,
Enum:
{
AzureKeyVault: No description available. ,
SystemManaged: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
network:
{
Description: Network related properties of a server ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for this server. Value is 'Disabled' when server has VNet integration. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
delegatedSubnetResourceId:
{
Description: Delegated subnet resource id used to setup vnet for a server. ,
Required: False ,
}
string ,
privateDnsZoneResourceId:
{
Description: Private DNS zone resource id. ,
Required: False ,
}
string ,
}
,
}
,
tags:
{
Description: Application-specific metadata in the form of key-value pairs. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the server. ,
Required: False ,
}
{
administratorLogin:
{
Description: The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login (required for server creation). ,
Format: password ,
Required: False ,
}
string ,
version:
{
Description: Major version of MySQL. 8.0.21 stands for MySQL 8.0, 5.7.44 stands for MySQL 5.7 ,
Enum:
{
5.7: No description available. ,
8.0.21: No description available. ,
8.4: No description available. ,
}
,
Required: False ,
}
enum ,
fullVersion:
{
Description: Major version and actual engine version ,
Required: False ,
}
string ,
availabilityZone:
{
Description: availability Zone information of the server. ,
Required: False ,
}
string ,
createMode:
{
Description: The mode to create a new MySQL server. ,
Enum:
{
Default: No description available. ,
PointInTimeRestore: No description available. ,
Replica: No description available. ,
GeoRestore: No description available. ,
}
,
Required: False ,
}
enum ,
sourceServerResourceId:
{
Description: The source MySQL server id. ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Restore point creation time (ISO8601 format), specifying the time to restore from. ,
Format: date-time ,
Required: False ,
}
string ,
replicationRole:
{
Description: The replication role. ,
Enum:
{
None: No description available. ,
Source: No description available. ,
Replica: No description available. ,
}
,
Required: False ,
}
enum ,
replicaCapacity:
{
Description: The maximum number of replicas that a primary server can have. ,
Format: int32 ,
Required: False ,
}
integer ,
dataEncryption:
{
Description: The Data Encryption for CMK. ,
Required: False ,
}
{
primaryUserAssignedIdentityId:
{
Description: Primary user identity resource id ,
Required: False ,
}
string ,
primaryKeyURI:
{
Description: Primary key uri ,
Required: False ,
}
string ,
geoBackupUserAssignedIdentityId:
{
Description: Geo backup user identity resource id as identity can't cross region, need identity in same region as geo backup ,
Required: False ,
}
string ,
geoBackupKeyURI:
{
Description: Geo backup key uri as key vault can't cross region, need cmk in same region as geo backup ,
Required: False ,
}
string ,
type:
{
Description: The key type, AzureKeyVault for enable cmk, SystemManaged for disable cmk. ,
Enum:
{
AzureKeyVault: No description available. ,
SystemManaged: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
state:
{
Description: The state of a server. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
databasePort:
{
Description: The server database port. Can only be specified when the server is being created. ,
Format: int32 ,
Required: False ,
}
integer ,
storage:
{
Description: Storage related properties of a server. ,
Required: False ,
}
{
storageSizeGB:
{
Description: Max storage size allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
iops:
{
Description: Storage IOPS for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
autoGrow:
{
Description: Enable Storage Auto Grow or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
logOnDisk:
{
Description: Enable Log On Disk or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
storageSku:
{
Description: The sku name of the server storage. ,
Required: False ,
}
string ,
autoIoScaling:
{
Description: Enable IO Auto Scaling or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
storageRedundancy:
{
Description: The redundant type of the server storage. The parameter is used for server creation. ,
Enum:
{
LocalRedundancy: No description available. ,
ZoneRedundancy: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
backup:
{
Description: Backup related properties of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
backupIntervalHours:
{
Description: Backup interval hours for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRedundantBackup:
{
Description: Whether or not geo redundant backup is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreDate:
{
Description: Earliest restore point creation time (ISO8601 format) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
highAvailability:
{
Description: High availability related properties of a server. ,
Required: False ,
}
{
mode:
{
Description: High availability mode for a server. ,
Enum:
{
Disabled: No description available. ,
ZoneRedundant: No description available. ,
SameZone: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of server high availability. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
Healthy: No description available. ,
FailingOver: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
standbyAvailabilityZone:
{
Description: Availability zone of the standby server. ,
Required: False ,
}
string ,
replicationMode:
{
Description: HA Replication mode for a server. ,
Enum:
{
BinaryLog: Binary log replication ,
RedoLog: Redo log replication ,
}
,
Required: False ,
}
enum ,
}
,
network:
{
Description: Network related properties of a server. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for this server. Value is 'Disabled' when server has VNet integration. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
delegatedSubnetResourceId:
{
Description: Delegated subnet resource id used to setup vnet for a server. ,
Required: False ,
}
string ,
privateDnsZoneResourceId:
{
Description: Private DNS zone resource id. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: PrivateEndpointConnections related properties of a server. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
maintenancePolicy:
{
Description: Maintenance policy of a server. ,
Required: False ,
}
{
patchStrategy:
{
Description: The patch strategy of this server ,
Enum:
{
Regular: No description available. ,
VirtualCanary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
maintenanceWindow:
{
Description: Maintenance window of a server. Known issue: cannot be set during server creation or updated with other properties during server update; must be updated separately. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
batchOfMaintenance:
{
Description: The batch of maintenance when enabled the custom managed maintenance window of a server. ,
Enum:
{
Default: No description available. ,
Batch1: No description available. ,
Batch2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
importSourceProperties:
{
Description: Source properties for import from storage. ,
Required: False ,
}
{
storageType:
{
Description: Storage type of import source. ,
Enum:
{
AzureBlob: No description available. ,
}
,
Required: False ,
}
enum ,
storageUrl:
{
Description: Uri of the import source storage. ,
Required: False ,
}
string ,
sasToken:
{
Description: Sas token for accessing source storage. Read and list permissions are required for sas token. ,
Format: password ,
Required: False ,
}
string ,
dataDirPath:
{
Description: Relative path of data directory in storage. ,
Required: False ,
}
string ,
}
,
lowerCaseTableNames:
{
Description: The mysql parameter lower_case_table_names. Can only be specified when the server is being created. Allowed values 1 or 2. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The cmk identity for the server. ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Metadata of user assigned identity. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: The SKU (pricing tier) of the server. ,
Required: False ,
}
{
name:
{
Description: The name of the sku, e.g. Standard_D32s_v3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier of the particular SKU, e.g. GeneralPurpose. ,
Enum:
{
Burstable: No description available. ,
GeneralPurpose: No description available. ,
MemoryOptimized: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServersMigration_CutoverMigration (updated)
Description :  Cutover migration for MySQL import, it will switch source elastic server DNS to flexible server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ServersMigration_CutoverMigration",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "version",
            "Enum": {
              "new": [
                [
                  "5.7",
                  ""
                ],
                [
                  "8.0.21",
                  ""
                ],
                [
                  "8.4",
                  ""
                ]
              ],
              "old": [
                [
                  "5.7",
                  ""
                ],
                [
                  "8.0.21",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/cutoverMigration
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the server. ,
Required: False ,
}
{
administratorLogin:
{
Description: The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login (required for server creation). ,
Format: password ,
Required: False ,
}
string ,
version:
{
Description: Major version of MySQL. 8.0.21 stands for MySQL 8.0, 5.7.44 stands for MySQL 5.7 ,
Enum:
{
5.7: No description available. ,
8.0.21: No description available. ,
8.4: No description available. ,
}
,
Required: False ,
}
enum ,
fullVersion:
{
Description: Major version and actual engine version ,
Required: False ,
}
string ,
availabilityZone:
{
Description: availability Zone information of the server. ,
Required: False ,
}
string ,
createMode:
{
Description: The mode to create a new MySQL server. ,
Enum:
{
Default: No description available. ,
PointInTimeRestore: No description available. ,
Replica: No description available. ,
GeoRestore: No description available. ,
}
,
Required: False ,
}
enum ,
sourceServerResourceId:
{
Description: The source MySQL server id. ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Restore point creation time (ISO8601 format), specifying the time to restore from. ,
Format: date-time ,
Required: False ,
}
string ,
replicationRole:
{
Description: The replication role. ,
Enum:
{
None: No description available. ,
Source: No description available. ,
Replica: No description available. ,
}
,
Required: False ,
}
enum ,
replicaCapacity:
{
Description: The maximum number of replicas that a primary server can have. ,
Format: int32 ,
Required: False ,
}
integer ,
dataEncryption:
{
Description: The Data Encryption for CMK. ,
Required: False ,
}
{
primaryUserAssignedIdentityId:
{
Description: Primary user identity resource id ,
Required: False ,
}
string ,
primaryKeyURI:
{
Description: Primary key uri ,
Required: False ,
}
string ,
geoBackupUserAssignedIdentityId:
{
Description: Geo backup user identity resource id as identity can't cross region, need identity in same region as geo backup ,
Required: False ,
}
string ,
geoBackupKeyURI:
{
Description: Geo backup key uri as key vault can't cross region, need cmk in same region as geo backup ,
Required: False ,
}
string ,
type:
{
Description: The key type, AzureKeyVault for enable cmk, SystemManaged for disable cmk. ,
Enum:
{
AzureKeyVault: No description available. ,
SystemManaged: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
state:
{
Description: The state of a server. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
databasePort:
{
Description: The server database port. Can only be specified when the server is being created. ,
Format: int32 ,
Required: False ,
}
integer ,
storage:
{
Description: Storage related properties of a server. ,
Required: False ,
}
{
storageSizeGB:
{
Description: Max storage size allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
iops:
{
Description: Storage IOPS for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
autoGrow:
{
Description: Enable Storage Auto Grow or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
logOnDisk:
{
Description: Enable Log On Disk or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
storageSku:
{
Description: The sku name of the server storage. ,
Required: False ,
}
string ,
autoIoScaling:
{
Description: Enable IO Auto Scaling or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
storageRedundancy:
{
Description: The redundant type of the server storage. The parameter is used for server creation. ,
Enum:
{
LocalRedundancy: No description available. ,
ZoneRedundancy: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
backup:
{
Description: Backup related properties of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
backupIntervalHours:
{
Description: Backup interval hours for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRedundantBackup:
{
Description: Whether or not geo redundant backup is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreDate:
{
Description: Earliest restore point creation time (ISO8601 format) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
highAvailability:
{
Description: High availability related properties of a server. ,
Required: False ,
}
{
mode:
{
Description: High availability mode for a server. ,
Enum:
{
Disabled: No description available. ,
ZoneRedundant: No description available. ,
SameZone: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of server high availability. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
Healthy: No description available. ,
FailingOver: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
standbyAvailabilityZone:
{
Description: Availability zone of the standby server. ,
Required: False ,
}
string ,
replicationMode:
{
Description: HA Replication mode for a server. ,
Enum:
{
BinaryLog: Binary log replication ,
RedoLog: Redo log replication ,
}
,
Required: False ,
}
enum ,
}
,
network:
{
Description: Network related properties of a server. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for this server. Value is 'Disabled' when server has VNet integration. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
delegatedSubnetResourceId:
{
Description: Delegated subnet resource id used to setup vnet for a server. ,
Required: False ,
}
string ,
privateDnsZoneResourceId:
{
Description: Private DNS zone resource id. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: PrivateEndpointConnections related properties of a server. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
maintenancePolicy:
{
Description: Maintenance policy of a server. ,
Required: False ,
}
{
patchStrategy:
{
Description: The patch strategy of this server ,
Enum:
{
Regular: No description available. ,
VirtualCanary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
maintenanceWindow:
{
Description: Maintenance window of a server. Known issue: cannot be set during server creation or updated with other properties during server update; must be updated separately. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
batchOfMaintenance:
{
Description: The batch of maintenance when enabled the custom managed maintenance window of a server. ,
Enum:
{
Default: No description available. ,
Batch1: No description available. ,
Batch2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
importSourceProperties:
{
Description: Source properties for import from storage. ,
Required: False ,
}
{
storageType:
{
Description: Storage type of import source. ,
Enum:
{
AzureBlob: No description available. ,
}
,
Required: False ,
}
enum ,
storageUrl:
{
Description: Uri of the import source storage. ,
Required: False ,
}
string ,
sasToken:
{
Description: Sas token for accessing source storage. Read and list permissions are required for sas token. ,
Format: password ,
Required: False ,
}
string ,
dataDirPath:
{
Description: Relative path of data directory in storage. ,
Required: False ,
}
string ,
}
,
lowerCaseTableNames:
{
Description: The mysql parameter lower_case_table_names. Can only be specified when the server is being created. Allowed values 1 or 2. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The cmk identity for the server. ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Metadata of user assigned identity. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: The SKU (pricing tier) of the server. ,
Required: False ,
}
{
name:
{
Description: The name of the sku, e.g. Standard_D32s_v3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier of the particular SKU, e.g. GeneralPurpose. ,
Enum:
{
Burstable: No description available. ,
GeneralPurpose: No description available. ,
MemoryOptimized: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Servers_DetachVNet (updated)
Description :  Detach VNet on a server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Servers_DetachVNet",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "version",
            "Enum": {
              "new": [
                [
                  "5.7",
                  ""
                ],
                [
                  "8.0.21",
                  ""
                ],
                [
                  "8.4",
                  ""
                ]
              ],
              "old": [
                [
                  "5.7",
                  ""
                ],
                [
                  "8.0.21",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/detachVNet
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for detach vnet on a server. ,
Required: True ,
}
{
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for this server. Value is 'Disabled' when server has VNet integration. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the server. ,
Required: False ,
}
{
administratorLogin:
{
Description: The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login (required for server creation). ,
Format: password ,
Required: False ,
}
string ,
version:
{
Description: Major version of MySQL. 8.0.21 stands for MySQL 8.0, 5.7.44 stands for MySQL 5.7 ,
Enum:
{
5.7: No description available. ,
8.0.21: No description available. ,
8.4: No description available. ,
}
,
Required: False ,
}
enum ,
fullVersion:
{
Description: Major version and actual engine version ,
Required: False ,
}
string ,
availabilityZone:
{
Description: availability Zone information of the server. ,
Required: False ,
}
string ,
createMode:
{
Description: The mode to create a new MySQL server. ,
Enum:
{
Default: No description available. ,
PointInTimeRestore: No description available. ,
Replica: No description available. ,
GeoRestore: No description available. ,
}
,
Required: False ,
}
enum ,
sourceServerResourceId:
{
Description: The source MySQL server id. ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Restore point creation time (ISO8601 format), specifying the time to restore from. ,
Format: date-time ,
Required: False ,
}
string ,
replicationRole:
{
Description: The replication role. ,
Enum:
{
None: No description available. ,
Source: No description available. ,
Replica: No description available. ,
}
,
Required: False ,
}
enum ,
replicaCapacity:
{
Description: The maximum number of replicas that a primary server can have. ,
Format: int32 ,
Required: False ,
}
integer ,
dataEncryption:
{
Description: The Data Encryption for CMK. ,
Required: False ,
}
{
primaryUserAssignedIdentityId:
{
Description: Primary user identity resource id ,
Required: False ,
}
string ,
primaryKeyURI:
{
Description: Primary key uri ,
Required: False ,
}
string ,
geoBackupUserAssignedIdentityId:
{
Description: Geo backup user identity resource id as identity can't cross region, need identity in same region as geo backup ,
Required: False ,
}
string ,
geoBackupKeyURI:
{
Description: Geo backup key uri as key vault can't cross region, need cmk in same region as geo backup ,
Required: False ,
}
string ,
type:
{
Description: The key type, AzureKeyVault for enable cmk, SystemManaged for disable cmk. ,
Enum:
{
AzureKeyVault: No description available. ,
SystemManaged: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
state:
{
Description: The state of a server. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
databasePort:
{
Description: The server database port. Can only be specified when the server is being created. ,
Format: int32 ,
Required: False ,
}
integer ,
storage:
{
Description: Storage related properties of a server. ,
Required: False ,
}
{
storageSizeGB:
{
Description: Max storage size allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
iops:
{
Description: Storage IOPS for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
autoGrow:
{
Description: Enable Storage Auto Grow or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
logOnDisk:
{
Description: Enable Log On Disk or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
storageSku:
{
Description: The sku name of the server storage. ,
Required: False ,
}
string ,
autoIoScaling:
{
Description: Enable IO Auto Scaling or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
storageRedundancy:
{
Description: The redundant type of the server storage. The parameter is used for server creation. ,
Enum:
{
LocalRedundancy: No description available. ,
ZoneRedundancy: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
backup:
{
Description: Backup related properties of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
backupIntervalHours:
{
Description: Backup interval hours for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRedundantBackup:
{
Description: Whether or not geo redundant backup is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreDate:
{
Description: Earliest restore point creation time (ISO8601 format) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
highAvailability:
{
Description: High availability related properties of a server. ,
Required: False ,
}
{
mode:
{
Description: High availability mode for a server. ,
Enum:
{
Disabled: No description available. ,
ZoneRedundant: No description available. ,
SameZone: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of server high availability. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
Healthy: No description available. ,
FailingOver: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
standbyAvailabilityZone:
{
Description: Availability zone of the standby server. ,
Required: False ,
}
string ,
replicationMode:
{
Description: HA Replication mode for a server. ,
Enum:
{
BinaryLog: Binary log replication ,
RedoLog: Redo log replication ,
}
,
Required: False ,
}
enum ,
}
,
network:
{
Description: Network related properties of a server. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for this server. Value is 'Disabled' when server has VNet integration. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
delegatedSubnetResourceId:
{
Description: Delegated subnet resource id used to setup vnet for a server. ,
Required: False ,
}
string ,
privateDnsZoneResourceId:
{
Description: Private DNS zone resource id. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: PrivateEndpointConnections related properties of a server. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
maintenancePolicy:
{
Description: Maintenance policy of a server. ,
Required: False ,
}
{
patchStrategy:
{
Description: The patch strategy of this server ,
Enum:
{
Regular: No description available. ,
VirtualCanary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
maintenanceWindow:
{
Description: Maintenance window of a server. Known issue: cannot be set during server creation or updated with other properties during server update; must be updated separately. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
batchOfMaintenance:
{
Description: The batch of maintenance when enabled the custom managed maintenance window of a server. ,
Enum:
{
Default: No description available. ,
Batch1: No description available. ,
Batch2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
importSourceProperties:
{
Description: Source properties for import from storage. ,
Required: False ,
}
{
storageType:
{
Description: Storage type of import source. ,
Enum:
{
AzureBlob: No description available. ,
}
,
Required: False ,
}
enum ,
storageUrl:
{
Description: Uri of the import source storage. ,
Required: False ,
}
string ,
sasToken:
{
Description: Sas token for accessing source storage. Read and list permissions are required for sas token. ,
Format: password ,
Required: False ,
}
string ,
dataDirPath:
{
Description: Relative path of data directory in storage. ,
Required: False ,
}
string ,
}
,
lowerCaseTableNames:
{
Description: The mysql parameter lower_case_table_names. Can only be specified when the server is being created. Allowed values 1 or 2. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The cmk identity for the server. ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Metadata of user assigned identity. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: The SKU (pricing tier) of the server. ,
Required: False ,
}
{
name:
{
Description: The name of the sku, e.g. Standard_D32s_v3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier of the particular SKU, e.g. GeneralPurpose. ,
Enum:
{
Burstable: No description available. ,
GeneralPurpose: No description available. ,
MemoryOptimized: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Replicas_ListByServer (updated)
Description :  List all the replicas for a given server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Replicas_ListByServer",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "version",
                "Enum": {
                  "new": [
                    [
                      "5.7",
                      ""
                    ],
                    [
                      "8.0.21",
                      ""
                    ],
                    [
                      "8.4",
                      ""
                    ]
                  ],
                  "old": [
                    [
                      "5.7",
                      ""
                    ],
                    [
                      "8.0.21",
                      ""
                    ]
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/replicas
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Server items on this page ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the server. ,
Required: False ,
}
{
administratorLogin:
{
Description: The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login (required for server creation). ,
Format: password ,
Required: False ,
}
string ,
version:
{
Description: Major version of MySQL. 8.0.21 stands for MySQL 8.0, 5.7.44 stands for MySQL 5.7 ,
Enum:
{
5.7: No description available. ,
8.0.21: No description available. ,
8.4: No description available. ,
}
,
Required: False ,
}
enum ,
fullVersion:
{
Description: Major version and actual engine version ,
Required: False ,
}
string ,
availabilityZone:
{
Description: availability Zone information of the server. ,
Required: False ,
}
string ,
createMode:
{
Description: The mode to create a new MySQL server. ,
Enum:
{
Default: No description available. ,
PointInTimeRestore: No description available. ,
Replica: No description available. ,
GeoRestore: No description available. ,
}
,
Required: False ,
}
enum ,
sourceServerResourceId:
{
Description: The source MySQL server id. ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Restore point creation time (ISO8601 format), specifying the time to restore from. ,
Format: date-time ,
Required: False ,
}
string ,
replicationRole:
{
Description: The replication role. ,
Enum:
{
None: No description available. ,
Source: No description available. ,
Replica: No description available. ,
}
,
Required: False ,
}
enum ,
replicaCapacity:
{
Description: The maximum number of replicas that a primary server can have. ,
Format: int32 ,
Required: False ,
}
integer ,
dataEncryption:
{
Description: The Data Encryption for CMK. ,
Required: False ,
}
{
primaryUserAssignedIdentityId:
{
Description: Primary user identity resource id ,
Required: False ,
}
string ,
primaryKeyURI:
{
Description: Primary key uri ,
Required: False ,
}
string ,
geoBackupUserAssignedIdentityId:
{
Description: Geo backup user identity resource id as identity can't cross region, need identity in same region as geo backup ,
Required: False ,
}
string ,
geoBackupKeyURI:
{
Description: Geo backup key uri as key vault can't cross region, need cmk in same region as geo backup ,
Required: False ,
}
string ,
type:
{
Description: The key type, AzureKeyVault for enable cmk, SystemManaged for disable cmk. ,
Enum:
{
AzureKeyVault: No description available. ,
SystemManaged: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
state:
{
Description: The state of a server. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
databasePort:
{
Description: The server database port. Can only be specified when the server is being created. ,
Format: int32 ,
Required: False ,
}
integer ,
storage:
{
Description: Storage related properties of a server. ,
Required: False ,
}
{
storageSizeGB:
{
Description: Max storage size allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
iops:
{
Description: Storage IOPS for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
autoGrow:
{
Description: Enable Storage Auto Grow or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
logOnDisk:
{
Description: Enable Log On Disk or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
storageSku:
{
Description: The sku name of the server storage. ,
Required: False ,
}
string ,
autoIoScaling:
{
Description: Enable IO Auto Scaling or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
storageRedundancy:
{
Description: The redundant type of the server storage. The parameter is used for server creation. ,
Enum:
{
LocalRedundancy: No description available. ,
ZoneRedundancy: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
backup:
{
Description: Backup related properties of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
backupIntervalHours:
{
Description: Backup interval hours for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRedundantBackup:
{
Description: Whether or not geo redundant backup is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreDate:
{
Description: Earliest restore point creation time (ISO8601 format) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
highAvailability:
{
Description: High availability related properties of a server. ,
Required: False ,
}
{
mode:
{
Description: High availability mode for a server. ,
Enum:
{
Disabled: No description available. ,
ZoneRedundant: No description available. ,
SameZone: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of server high availability. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
Healthy: No description available. ,
FailingOver: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
standbyAvailabilityZone:
{
Description: Availability zone of the standby server. ,
Required: False ,
}
string ,
replicationMode:
{
Description: HA Replication mode for a server. ,
Enum:
{
BinaryLog: Binary log replication ,
RedoLog: Redo log replication ,
}
,
Required: False ,
}
enum ,
}
,
network:
{
Description: Network related properties of a server. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for this server. Value is 'Disabled' when server has VNet integration. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
delegatedSubnetResourceId:
{
Description: Delegated subnet resource id used to setup vnet for a server. ,
Required: False ,
}
string ,
privateDnsZoneResourceId:
{
Description: Private DNS zone resource id. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: PrivateEndpointConnections related properties of a server. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
maintenancePolicy:
{
Description: Maintenance policy of a server. ,
Required: False ,
}
{
patchStrategy:
{
Description: The patch strategy of this server ,
Enum:
{
Regular: No description available. ,
VirtualCanary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
maintenanceWindow:
{
Description: Maintenance window of a server. Known issue: cannot be set during server creation or updated with other properties during server update; must be updated separately. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
batchOfMaintenance:
{
Description: The batch of maintenance when enabled the custom managed maintenance window of a server. ,
Enum:
{
Default: No description available. ,
Batch1: No description available. ,
Batch2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
importSourceProperties:
{
Description: Source properties for import from storage. ,
Required: False ,
}
{
storageType:
{
Description: Storage type of import source. ,
Enum:
{
AzureBlob: No description available. ,
}
,
Required: False ,
}
enum ,
storageUrl:
{
Description: Uri of the import source storage. ,
Required: False ,
}
string ,
sasToken:
{
Description: Sas token for accessing source storage. Read and list permissions are required for sas token. ,
Format: password ,
Required: False ,
}
string ,
dataDirPath:
{
Description: Relative path of data directory in storage. ,
Required: False ,
}
string ,
}
,
lowerCaseTableNames:
{
Description: The mysql parameter lower_case_table_names. Can only be specified when the server is being created. Allowed values 1 or 2. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The cmk identity for the server. ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Metadata of user assigned identity. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: The SKU (pricing tier) of the server. ,
Required: False ,
}
{
name:
{
Description: The name of the sku, e.g. Standard_D32s_v3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier of the particular SKU, e.g. GeneralPurpose. ,
Enum:
{
Burstable: No description available. ,
GeneralPurpose: No description available. ,
MemoryOptimized: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}