Microsoft.DBforMySQL (preview:2024-10-01)

2025/06/19 • 19 new, 19 deleted methods

AdvancedThreatProtectionSettings_Get (new)
Description :  Get a server's Advanced Threat Protection state
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/advancedThreatProtectionSettings/{advancedThreatProtectionName}
{
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 ,
advancedThreatProtectionName:
{
Description: The name of the Advanced Threat Protection state. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Threat Protection. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
AdvancedThreatProtectionSettings_Update (new)
Description :  Updates a server's Advanced Threat Protection state.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/advancedThreatProtectionSettings/{advancedThreatProtectionName}
{
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 ,
advancedThreatProtectionName:
{
Description: The name of the Advanced Threat Protection state. ,
Required: True ,
}
string ,
parameters:
{
Description: The server's Advanced Threat Protection body to update. ,
Required: True ,
}
{
properties:
{
Description: Resource update properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Threat Protection. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: URL to retrieve the final result after operation completes. ,
}
string ,
azure-asyncoperation:
{
Description: URL to query for status of the operation. ,
}
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 ,
}
,
]
,
}
,
}
AdvancedThreatProtectionSettings_UpdatePut (new)
Description :  Updates a server's Advanced Threat Protection state.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/advancedThreatProtectionSettings/{advancedThreatProtectionName}
{
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 ,
advancedThreatProtectionName:
{
Description: The name of the Advanced Threat Protection state. ,
Required: True ,
}
string ,
parameters:
{
Description: The server's Advanced Threat Protection body to update. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Threat Protection. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Threat Protection. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Threat Protection. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: URL to retrieve the final result after operation completes. ,
}
string ,
azure-asyncoperation:
{
Description: URL to query for status of the operation. ,
}
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 ,
}
,
]
,
}
,
}
AdvancedThreatProtectionSettings_List (new)
Description :  Gets a list of server's Advanced Threat Protection states.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/advancedThreatProtectionSettings
{
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 ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Threat Protection. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
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_Create (new)
Description :  Creates a new server or updates an existing server. The update action will overwrite the existing server.
Reference :  Link ¶

⚼ 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 ,
}
{
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: 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. ,
}
,
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 ,
}
,
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 ,
}
,
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. ,
Required: False ,
}
string ,
dataDirPath:
{
Description: Relative path of data directory in storage. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
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: 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. ,
}
,
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 ,
}
,
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 ,
}
,
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. ,
Required: False ,
}
string ,
dataDirPath:
{
Description: Relative path of data directory in storage. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
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: 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. ,
}
,
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 ,
}
,
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 ,
}
,
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. ,
Required: False ,
}
string ,
dataDirPath:
{
Description: Relative path of data directory in storage. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
location: 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_Update (new)
Description :  Updates an existing server. The request body can contain one to many of the properties present in the normal server definition.
Reference :  Link ¶

⚼ 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. ,
}
,
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 ,
}
,
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 ,
}
,
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)

{
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: 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. ,
}
,
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 ,
}
,
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 ,
}
,
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. ,
Required: False ,
}
string ,
dataDirPath:
{
Description: Relative path of data directory in storage. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
location: 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_Delete (new)
Description :  Deletes a server.
Reference :  Link ¶

⚼ Request

DELETE:  /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)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ 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 (new)
Description :  Gets information about a server.
Reference :  Link ¶

⚼ 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)

{
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: 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. ,
}
,
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 ,
}
,
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 ,
}
,
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. ,
Required: False ,
}
string ,
dataDirPath:
{
Description: Relative path of data directory in storage. ,
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 (new)
Description :  List all the servers in a given resource group.
Reference :  Link ¶

⚼ 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 list of servers ,
Required: False ,
}
[
{
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: 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. ,
}
,
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 ,
}
,
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 ,
}
,
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. ,
Required: False ,
}
string ,
dataDirPath:
{
Description: Relative path of data directory in storage. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
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_List (new)
Description :  List all the servers in a given subscription.
Reference :  Link ¶

⚼ 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 list of servers ,
Required: False ,
}
[
{
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: 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. ,
}
,
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 ,
}
,
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 ,
}
,
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. ,
Required: False ,
}
string ,
dataDirPath:
{
Description: Relative path of data directory in storage. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
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_Failover (new)
Description :  Manual failover a server.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/failover
{
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)

{}

⚐ Response (202)

{
location: 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_ValidateEstimateHighAvailability (new)
Description :  Validate a deployment of high availability.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/validateEstimateHighAvailability
{
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 validation of high availability deployment. ,
Required: True ,
}
{
estimatedDowntime:
{
Description: Estimated seconds of downtime for the deployment. ,
Format: int32 ,
Required: False ,
}
integer ,
scheduledStandbyAvailabilityZone:
{
Description: Scheduled Availability zone of the standby server. ,
Required: False ,
}
string ,
expectedStandbyAvailabilityZone:
{
Description: Expected Availability zone of the standby server. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
estimatedDowntime:
{
Description: Estimated seconds of downtime for the deployment. ,
Format: int32 ,
Required: False ,
}
integer ,
scheduledStandbyAvailabilityZone:
{
Description: Scheduled Availability zone of the standby server. ,
Required: False ,
}
string ,
expectedStandbyAvailabilityZone:
{
Description: Expected Availability zone of the standby server. ,
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_Restart (new)
Description :  Restarts a server.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/restart
{
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 restarting a server. ,
Required: True ,
}
{
restartWithFailover:
{
Description: Whether or not failover to standby server when restarting a server with high availability enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
maxFailoverSeconds:
{
Description: The maximum allowed failover time in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: 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_Start (new)
Description :  Starts a server.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/start
{
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)

{}

⚐ Response (202)

{
location: 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_Stop (new)
Description :  Stops a server.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/stop
{
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)

{}

⚐ Response (202)

{
location: 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_ResetGtid (new)
Description :  Resets GTID on a server.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/resetGtid
{
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 resetting GTID on a server. ,
Required: True ,
}
{
gtidSet:
{
Description: The Gtid set of server. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: 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 (new)
Description :  Detach VNet on a server.
Reference :  Link ¶

⚼ 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)

{
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: 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. ,
}
,
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 ,
}
,
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 ,
}
,
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. ,
Required: False ,
}
string ,
dataDirPath:
{
Description: Relative path of data directory in storage. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
location: 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 (new)
Description :  List all the replicas for a given server.
Reference :  Link ¶

⚼ 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 list of servers ,
Required: False ,
}
[
{
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: 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. ,
}
,
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 ,
}
,
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 ,
}
,
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. ,
Required: False ,
}
string ,
dataDirPath:
{
Description: Relative path of data directory in storage. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
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 ,
}
,
]
,
}
,
}
ServersMigration_CutoverMigration (new)
Description :  Cutover migration for MySQL import, it will switch source elastic server DNS to flexible server.
Reference :  Link ¶

⚼ 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)

{
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: 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. ,
}
,
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 ,
}
,
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 ,
}
,
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. ,
Required: False ,
}
string ,
dataDirPath:
{
Description: Relative path of data directory in storage. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
location:
{
Description: URL to retrieve the final result after operation completes. ,
}
string ,
azure-asyncoperation:
{
Description: URL to query for status of the operation. ,
}
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 ,
}
,
]
,
}
,
}
AdvancedThreatProtectionSettings_Get (removed)
Description :  Get a server's Advanced Threat Protection state
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/advancedThreatProtectionSettings/{advancedThreatProtectionName}
{
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 ,
advancedThreatProtectionName:
{
Description: The name of the Advanced Threat Protection state. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Threat Protection. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
AdvancedThreatProtectionSettings_Update (removed)
Description :  Updates a server's Advanced Threat Protection state.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/advancedThreatProtectionSettings/{advancedThreatProtectionName}
{
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 ,
advancedThreatProtectionName:
{
Description: The name of the Advanced Threat Protection state. ,
Required: True ,
}
string ,
parameters:
{
Description: The server's Advanced Threat Protection body to update. ,
Required: True ,
}
{
properties:
{
Description: Resource update properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Threat Protection. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: URL to retrieve the final result after operation completes. ,
}
string ,
azure-asyncoperation:
{
Description: URL to query for status of the operation. ,
}
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 ,
}
,
]
,
}
,
}
AdvancedThreatProtectionSettings_UpdatePut (removed)
Description :  Updates a server's Advanced Threat Protection state.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/advancedThreatProtectionSettings/{advancedThreatProtectionName}
{
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 ,
advancedThreatProtectionName:
{
Description: The name of the Advanced Threat Protection state. ,
Required: True ,
}
string ,
parameters:
{
Description: The server's Advanced Threat Protection body to update. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Threat Protection. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Threat Protection. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Threat Protection. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: URL to retrieve the final result after operation completes. ,
}
string ,
azure-asyncoperation:
{
Description: URL to query for status of the operation. ,
}
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 ,
}
,
]
,
}
,
}
AdvancedThreatProtectionSettings_List (removed)
Description :  Gets a list of server's Advanced Threat Protection states.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/advancedThreatProtectionSettings
{
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 ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Threat Protection. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
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_Create (removed)
Description :  Creates a new server or updates an existing server. The update action will overwrite the existing server.
Reference :  Link ¶

⚼ 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 ,
}
{
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: 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. ,
}
,
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 ,
}
,
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 ,
}
,
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. ,
Required: False ,
}
string ,
dataDirPath:
{
Description: Relative path of data directory in storage. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
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: 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. ,
}
,
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 ,
}
,
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 ,
}
,
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. ,
Required: False ,
}
string ,
dataDirPath:
{
Description: Relative path of data directory in storage. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
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: 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. ,
}
,
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 ,
}
,
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 ,
}
,
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. ,
Required: False ,
}
string ,
dataDirPath:
{
Description: Relative path of data directory in storage. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
location: 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_Update (removed)
Description :  Updates an existing server. The request body can contain one to many of the properties present in the normal server definition.
Reference :  Link ¶

⚼ 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. ,
}
,
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 ,
}
,
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 ,
}
,
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)

{
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: 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. ,
}
,
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 ,
}
,
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 ,
}
,
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. ,
Required: False ,
}
string ,
dataDirPath:
{
Description: Relative path of data directory in storage. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
location: 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_Delete (removed)
Description :  Deletes a server.
Reference :  Link ¶

⚼ Request

DELETE:  /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)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ 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 (removed)
Description :  Gets information about a server.
Reference :  Link ¶

⚼ 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)

{
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: 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. ,
}
,
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 ,
}
,
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 ,
}
,
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. ,
Required: False ,
}
string ,
dataDirPath:
{
Description: Relative path of data directory in storage. ,
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 (removed)
Description :  List all the servers in a given resource group.
Reference :  Link ¶

⚼ 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 list of servers ,
Required: False ,
}
[
{
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: 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. ,
}
,
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 ,
}
,
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 ,
}
,
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. ,
Required: False ,
}
string ,
dataDirPath:
{
Description: Relative path of data directory in storage. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
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_List (removed)
Description :  List all the servers in a given subscription.
Reference :  Link ¶

⚼ 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 list of servers ,
Required: False ,
}
[
{
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: 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. ,
}
,
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 ,
}
,
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 ,
}
,
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. ,
Required: False ,
}
string ,
dataDirPath:
{
Description: Relative path of data directory in storage. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
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_Failover (removed)
Description :  Manual failover a server.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/failover
{
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)

{}

⚐ Response (202)

{
location: 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_ValidateEstimateHighAvailability (removed)
Description :  Validate a deployment of high availability.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/validateEstimateHighAvailability
{
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 validation of high availability deployment. ,
Required: True ,
}
{
estimatedDowntime:
{
Description: Estimated seconds of downtime for the deployment. ,
Format: int32 ,
Required: False ,
}
integer ,
scheduledStandbyAvailabilityZone:
{
Description: Scheduled Availability zone of the standby server. ,
Required: False ,
}
string ,
expectedStandbyAvailabilityZone:
{
Description: Expected Availability zone of the standby server. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
estimatedDowntime:
{
Description: Estimated seconds of downtime for the deployment. ,
Format: int32 ,
Required: False ,
}
integer ,
scheduledStandbyAvailabilityZone:
{
Description: Scheduled Availability zone of the standby server. ,
Required: False ,
}
string ,
expectedStandbyAvailabilityZone:
{
Description: Expected Availability zone of the standby server. ,
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_Restart (removed)
Description :  Restarts a server.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/restart
{
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 restarting a server. ,
Required: True ,
}
{
restartWithFailover:
{
Description: Whether or not failover to standby server when restarting a server with high availability enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
maxFailoverSeconds:
{
Description: The maximum allowed failover time in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: 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_Start (removed)
Description :  Starts a server.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/start
{
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)

{}

⚐ Response (202)

{
location: 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_Stop (removed)
Description :  Stops a server.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/stop
{
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)

{}

⚐ Response (202)

{
location: 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_ResetGtid (removed)
Description :  Resets GTID on a server.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/resetGtid
{
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 resetting GTID on a server. ,
Required: True ,
}
{
gtidSet:
{
Description: The Gtid set of server. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: 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 (removed)
Description :  Detach VNet on a server.
Reference :  Link ¶

⚼ 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)

{
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: 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. ,
}
,
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 ,
}
,
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 ,
}
,
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. ,
Required: False ,
}
string ,
dataDirPath:
{
Description: Relative path of data directory in storage. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
location: 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 (removed)
Description :  List all the replicas for a given server.
Reference :  Link ¶

⚼ 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 list of servers ,
Required: False ,
}
[
{
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: 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. ,
}
,
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 ,
}
,
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 ,
}
,
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. ,
Required: False ,
}
string ,
dataDirPath:
{
Description: Relative path of data directory in storage. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
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 ,
}
,
]
,
}
,
}
ServersMigration_CutoverMigration (removed)
Description :  Cutover migration for MySQL import, it will switch source elastic server DNS to flexible server.
Reference :  Link ¶

⚼ 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)

{
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: 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. ,
}
,
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 ,
}
,
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 ,
}
,
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. ,
Required: False ,
}
string ,
dataDirPath:
{
Description: Relative path of data directory in storage. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
location:
{
Description: URL to retrieve the final result after operation completes. ,
}
string ,
azure-asyncoperation:
{
Description: URL to query for status of the operation. ,
}
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 ,
}
,
]
,
}
,
}