Microsoft.DBforMySQL (preview:2021-05-01)

2025/07/31 • 30 new, 30 deleted methods

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. ,
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 Azure Active Directory identity of the server. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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: Server version. ,
Enum:
{
5.7: No description available. ,
8.0.21: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
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 ,
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 ,
storageSku:
{
Description: The sku name of the server storage. ,
Required: False ,
}
string ,
}
,
backup:
{
Description: Backup related properties of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days 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:
{
Enabled: No description available. ,
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 ,
}
,
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 ,
}
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: The Azure Active Directory identity of the server. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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: Server version. ,
Enum:
{
5.7: No description available. ,
8.0.21: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
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 ,
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 ,
storageSku:
{
Description: The sku name of the server storage. ,
Required: False ,
}
string ,
}
,
backup:
{
Description: Backup related properties of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days 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:
{
Enabled: No description available. ,
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 ,
}
,
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 ,
}
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
identity:
{
Description: The Azure Active Directory identity of the server. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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: Server version. ,
Enum:
{
5.7: No description available. ,
8.0.21: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
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 ,
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 ,
storageSku:
{
Description: The sku name of the server storage. ,
Required: False ,
}
string ,
}
,
backup:
{
Description: Backup related properties of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days 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:
{
Enabled: No description available. ,
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 ,
}
,
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 ,
}
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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. ,
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 ,
}
{
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 ,
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 ,
storageSku:
{
Description: The sku name of the server storage. ,
Required: False ,
}
string ,
}
,
backup:
{
Description: Backup related properties of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days 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:
{
Enabled: No description available. ,
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 ,
}
,
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 ,
}
,
tags:
{
Description: Application-specific metadata in the form of key-value pairs. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
identity:
{
Description: The Azure Active Directory identity of the server. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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: Server version. ,
Enum:
{
5.7: No description available. ,
8.0.21: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
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 ,
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 ,
storageSku:
{
Description: The sku name of the server storage. ,
Required: False ,
}
string ,
}
,
backup:
{
Description: Backup related properties of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days 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:
{
Enabled: No description available. ,
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 ,
}
,
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 ,
}
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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. ,
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)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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. ,
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 Azure Active Directory identity of the server. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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: Server version. ,
Enum:
{
5.7: No description available. ,
8.0.21: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
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 ,
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 ,
storageSku:
{
Description: The sku name of the server storage. ,
Required: False ,
}
string ,
}
,
backup:
{
Description: Backup related properties of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days 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:
{
Enabled: No description available. ,
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 ,
}
,
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 ,
}
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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. ,
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 Azure Active Directory identity of the server. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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: Server version. ,
Enum:
{
5.7: No description available. ,
8.0.21: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
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 ,
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 ,
storageSku:
{
Description: The sku name of the server storage. ,
Required: False ,
}
string ,
}
,
backup:
{
Description: Backup related properties of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days 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:
{
Enabled: No description available. ,
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 ,
}
,
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 ,
}
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of servers ,
Required: False ,
}
[
{
identity:
{
Description: The Azure Active Directory identity of the server. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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: Server version. ,
Enum:
{
5.7: No description available. ,
8.0.21: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
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 ,
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 ,
storageSku:
{
Description: The sku name of the server storage. ,
Required: False ,
}
string ,
}
,
backup:
{
Description: Backup related properties of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days 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:
{
Enabled: No description available. ,
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 ,
}
,
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 ,
}
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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. ,
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)

{}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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. ,
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)

{}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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. ,
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)

{}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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. ,
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)

{}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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. ,
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 Azure Active Directory identity of the server. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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: Server version. ,
Enum:
{
5.7: No description available. ,
8.0.21: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
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 ,
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 ,
storageSku:
{
Description: The sku name of the server storage. ,
Required: False ,
}
string ,
}
,
backup:
{
Description: Backup related properties of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days 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:
{
Enabled: No description available. ,
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 ,
}
,
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 ,
}
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Backups_Get (new)
Description :  List all the backups for a given server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/backups/{backupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
backupName:
{
Description: The name of the backup. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a server backup. ,
Required: False ,
}
{
backupType:
{
Description: Backup type. ,
Required: False ,
}
string ,
completedTime:
{
Description: Backup completed time (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Backup source ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Backups_ListByServer (new)
Description :  List all the backups for a given server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/backups
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 backups of a server. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a server backup. ,
Required: False ,
}
{
backupType:
{
Description: Backup type. ,
Required: False ,
}
string ,
completedTime:
{
Description: Backup completed time (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Backup source ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
FirewallRules_CreateOrUpdate (new)
Description :  Creates a new firewall rule or updates an existing firewall rule.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/firewallRules/{firewallRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
firewallRuleName:
{
Description: The name of the server firewall rule. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for creating or updating a firewall rule. ,
Required: True ,
}
{
properties:
{
Description: The properties of a firewall rule. ,
Required: True ,
}
{
startIpAddress:
{
Description: The start IP address of the server firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
endIpAddress:
{
Description: The end IP address of the server firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a firewall rule. ,
Required: True ,
}
{
startIpAddress:
{
Description: The start IP address of the server firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
endIpAddress:
{
Description: The end IP address of the server firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of a firewall rule. ,
Required: True ,
}
{
startIpAddress:
{
Description: The start IP address of the server firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
endIpAddress:
{
Description: The end IP address of the server firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
FirewallRules_Delete (new)
Description :  Deletes a firewall rule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/firewallRules/{firewallRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
firewallRuleName:
{
Description: The name of the server firewall rule. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
FirewallRules_Get (new)
Description :  Gets information about a server firewall rule.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/firewallRules/{firewallRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
firewallRuleName:
{
Description: The name of the server firewall rule. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a firewall rule. ,
Required: True ,
}
{
startIpAddress:
{
Description: The start IP address of the server firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
endIpAddress:
{
Description: The end IP address of the server firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
FirewallRules_ListByServer (new)
Description :  List all the firewall rules in a given server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/firewallRules
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 firewall rules in a server. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a firewall rule. ,
Required: True ,
}
{
startIpAddress:
{
Description: The start IP address of the server firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
endIpAddress:
{
Description: The end IP address of the server firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Databases_CreateOrUpdate (new)
Description :  Creates a new database or updates an existing database.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/databases/{databaseName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for creating or updating a database. ,
Required: True ,
}
{
properties:
{
Description: The properties of a database. ,
Required: False ,
}
{
charset:
{
Description: The charset of the database. ,
Required: False ,
}
string ,
collation:
{
Description: The collation of the database. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a database. ,
Required: False ,
}
{
charset:
{
Description: The charset of the database. ,
Required: False ,
}
string ,
collation:
{
Description: The collation of the database. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of a database. ,
Required: False ,
}
{
charset:
{
Description: The charset of the database. ,
Required: False ,
}
string ,
collation:
{
Description: The collation of the database. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Databases_Delete (new)
Description :  Deletes a database.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/databases/{databaseName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Databases_Get (new)
Description :  Gets information about a database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/databases/{databaseName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a database. ,
Required: False ,
}
{
charset:
{
Description: The charset of the database. ,
Required: False ,
}
string ,
collation:
{
Description: The collation of the database. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Databases_ListByServer (new)
Description :  List all the databases in a given server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/databases
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 databases housed in a server ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a database. ,
Required: False ,
}
{
charset:
{
Description: The charset of the database. ,
Required: False ,
}
string ,
collation:
{
Description: The collation of the database. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Configurations_Update (new)
Description :  Updates a configuration of a server.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/configurations/{configurationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
configurationName:
{
Description: The name of the server configuration. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for updating a server configuration. ,
Required: True ,
}
{
properties:
{
Description: The properties of a configuration. ,
Required: False ,
}
{
value:
{
Description: Value of the configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description of the configuration. ,
Required: False ,
}
string ,
defaultValue:
{
Description: Default value of the configuration. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the configuration. ,
Required: False ,
}
string ,
allowedValues:
{
Description: Allowed values of the configuration. ,
Required: False ,
}
string ,
source:
{
Description: Source of the configuration. ,
Enum:
{
system-default: No description available. ,
user-override: No description available. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: If is the configuration read only. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
isConfigPendingRestart:
{
Description: If is the configuration pending restart or not. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
isDynamicConfig:
{
Description: If is the configuration dynamic. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a configuration. ,
Required: False ,
}
{
value:
{
Description: Value of the configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description of the configuration. ,
Required: False ,
}
string ,
defaultValue:
{
Description: Default value of the configuration. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the configuration. ,
Required: False ,
}
string ,
allowedValues:
{
Description: Allowed values of the configuration. ,
Required: False ,
}
string ,
source:
{
Description: Source of the configuration. ,
Enum:
{
system-default: No description available. ,
user-override: No description available. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: If is the configuration read only. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
isConfigPendingRestart:
{
Description: If is the configuration pending restart or not. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
isDynamicConfig:
{
Description: If is the configuration dynamic. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Configurations_Get (new)
Description :  Gets information about a configuration of server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/configurations/{configurationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
configurationName:
{
Description: The name of the server configuration. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a configuration. ,
Required: False ,
}
{
value:
{
Description: Value of the configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description of the configuration. ,
Required: False ,
}
string ,
defaultValue:
{
Description: Default value of the configuration. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the configuration. ,
Required: False ,
}
string ,
allowedValues:
{
Description: Allowed values of the configuration. ,
Required: False ,
}
string ,
source:
{
Description: Source of the configuration. ,
Enum:
{
system-default: No description available. ,
user-override: No description available. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: If is the configuration read only. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
isConfigPendingRestart:
{
Description: If is the configuration pending restart or not. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
isDynamicConfig:
{
Description: If is the configuration dynamic. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Configurations_BatchUpdate (new)
Description :  Update a list of configurations in a given server.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/updateConfigurations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 parameters for updating a list of server configuration. ,
Required: True ,
}
{
value:
{
Description: The list of server configurations. ,
Required: False ,
}
[
{
name:
{
Description: Name of the configuration. ,
Required: False ,
}
string ,
properties:
{
Description: The properties can be updated for a configuration. ,
Required: False ,
}
{
value:
{
Description: Value of the configuration. ,
Required: False ,
}
string ,
source:
{
Description: Source of the configuration. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (200)

{
value:
{
Description: The list of server configurations. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a configuration. ,
Required: False ,
}
{
value:
{
Description: Value of the configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description of the configuration. ,
Required: False ,
}
string ,
defaultValue:
{
Description: Default value of the configuration. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the configuration. ,
Required: False ,
}
string ,
allowedValues:
{
Description: Allowed values of the configuration. ,
Required: False ,
}
string ,
source:
{
Description: Source of the configuration. ,
Enum:
{
system-default: No description available. ,
user-override: No description available. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: If is the configuration read only. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
isConfigPendingRestart:
{
Description: If is the configuration pending restart or not. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
isDynamicConfig:
{
Description: If is the configuration dynamic. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Configurations_ListByServer (new)
Description :  List all the configurations in a given server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/configurations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 server configurations. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a configuration. ,
Required: False ,
}
{
value:
{
Description: Value of the configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description of the configuration. ,
Required: False ,
}
string ,
defaultValue:
{
Description: Default value of the configuration. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the configuration. ,
Required: False ,
}
string ,
allowedValues:
{
Description: Allowed values of the configuration. ,
Required: False ,
}
string ,
source:
{
Description: Source of the configuration. ,
Enum:
{
system-default: No description available. ,
user-override: No description available. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: If is the configuration read only. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
isConfigPendingRestart:
{
Description: If is the configuration pending restart or not. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
isDynamicConfig:
{
Description: If is the configuration dynamic. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
LocationBasedCapabilities_List (new)
Description :  Get capabilities at specified location in a given subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/locations/{locationName}/capabilities
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
locationName:
{
Description: The name of the location. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of supported capabilities. ,
Required: False ,
}
[
{
zone:
{
Description: zone name ,
Required: False ,
}
string ,
supportedHAMode:
{
Description: Supported high availability mode ,
Required: False ,
}
[
string ,
]
,
supportedGeoBackupRegions:
{
Description: supported geo backup regions ,
Required: False ,
}
[
string ,
]
,
supportedFlexibleServerEditions:
{
Description: A list of supported flexible server editions. ,
Required: False ,
}
[
{
name:
{
Description: Server edition name ,
Required: False ,
}
string ,
supportedStorageEditions:
{
Description: A list of supported storage editions ,
Required: False ,
}
[
{
name:
{
Description: storage edition name ,
Required: False ,
}
string ,
minStorageSize:
{
Description: The minimal supported storage size. ,
Format: int64 ,
Required: False ,
}
integer ,
maxStorageSize:
{
Description: The maximum supported storage size. ,
Format: int64 ,
Required: False ,
}
integer ,
minBackupRetentionDays:
{
Description: Minimal backup retention days ,
Format: int64 ,
Required: False ,
}
integer ,
maxBackupRetentionDays:
{
Description: Maximum backup retention days ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
supportedServerVersions:
{
Description: A list of supported server versions. ,
Required: False ,
}
[
{
name:
{
Description: server version ,
Required: False ,
}
string ,
supportedSkus:
{
Description: A list of supported Skus ,
Required: False ,
}
[
{
name:
{
Description: vCore name ,
Required: False ,
}
string ,
vCores:
{
Description: supported vCores ,
Format: int64 ,
Required: False ,
}
integer ,
supportedIops:
{
Description: supported IOPS ,
Format: int64 ,
Required: False ,
}
integer ,
supportedMemoryPerVCoreMB:
{
Description: supported memory per vCore in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
CheckVirtualNetworkSubnetUsage_Execute (new)
Description :  Get virtual network subnet usage for a given vNet resource id.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/locations/{locationName}/checkVirtualNetworkSubnetUsage
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
locationName:
{
Description: The name of the location. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for creating or updating a server. ,
Required: True ,
}
{
virtualNetworkResourceId:
{
Description: Virtual network resource id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
delegatedSubnetsUsage:
{
Description: A list of delegated subnet usage ,
Required: False ,
}
[
{
subnetName:
{
Description: name of the subnet ,
Required: False ,
}
string ,
usage:
{
Description: Number of used delegated subnets ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
CheckNameAvailability_Execute (new)
Description :  Check the availability of name for server
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/locations/{locationName}/checkNameAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
locationName:
{
Description: The name of the location. ,
Required: True ,
}
string ,
nameAvailabilityRequest:
{
Description: The required parameters for checking if server name is available. ,
Required: True ,
}
{
name:
{
Description: Resource name to verify. ,
Required: True ,
}
string ,
type:
{
Description: Resource type used for verification. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
message:
{
Description: Error Message. ,
Required: False ,
}
string ,
nameAvailable:
{
Description: Indicates whether the resource name is available. ,
Required: False ,
}
boolean ,
reason:
{
Description: Reason for name being unavailable. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
GetPrivateDnsZoneSuffix_Execute (new)
Description :  Get private DNS zone suffix in the cloud.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.DBforMySQL/getPrivateDnsZoneSuffix
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
privateDnsZoneSuffix:
{
Description: Represents the private DNS zone suffix. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  Lists all of the available REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.DBforMySQL/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of available operation details ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation being performed on this particular object. ,
Required: False ,
}
string ,
display:
{
Description: The localized display information for this particular operation or action. ,
Required: False ,
}
{
provider:
{
Description: Operation resource provider name. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed. ,
Required: False ,
}
string ,
operation:
{
Description: Localized friendly name for the operation. ,
Required: False ,
}
string ,
description:
{
Description: Operation description. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation. ,
Required: False ,
}
string ,
properties:
{
Description: Additional descriptions for the operation. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: URL client should use to fetch the next page (per server side paging). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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. ,
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 Azure Active Directory identity of the server. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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: Server version. ,
Enum:
{
5.7: No description available. ,
8.0.21: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
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 ,
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 ,
storageSku:
{
Description: The sku name of the server storage. ,
Required: False ,
}
string ,
}
,
backup:
{
Description: Backup related properties of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days 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:
{
Enabled: No description available. ,
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 ,
}
,
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 ,
}
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: The Azure Active Directory identity of the server. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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: Server version. ,
Enum:
{
5.7: No description available. ,
8.0.21: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
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 ,
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 ,
storageSku:
{
Description: The sku name of the server storage. ,
Required: False ,
}
string ,
}
,
backup:
{
Description: Backup related properties of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days 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:
{
Enabled: No description available. ,
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 ,
}
,
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 ,
}
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
identity:
{
Description: The Azure Active Directory identity of the server. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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: Server version. ,
Enum:
{
5.7: No description available. ,
8.0.21: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
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 ,
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 ,
storageSku:
{
Description: The sku name of the server storage. ,
Required: False ,
}
string ,
}
,
backup:
{
Description: Backup related properties of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days 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:
{
Enabled: No description available. ,
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 ,
}
,
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 ,
}
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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. ,
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 ,
}
{
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 ,
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 ,
storageSku:
{
Description: The sku name of the server storage. ,
Required: False ,
}
string ,
}
,
backup:
{
Description: Backup related properties of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days 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:
{
Enabled: No description available. ,
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 ,
}
,
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 ,
}
,
tags:
{
Description: Application-specific metadata in the form of key-value pairs. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
identity:
{
Description: The Azure Active Directory identity of the server. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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: Server version. ,
Enum:
{
5.7: No description available. ,
8.0.21: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
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 ,
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 ,
storageSku:
{
Description: The sku name of the server storage. ,
Required: False ,
}
string ,
}
,
backup:
{
Description: Backup related properties of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days 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:
{
Enabled: No description available. ,
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 ,
}
,
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 ,
}
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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. ,
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)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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. ,
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 Azure Active Directory identity of the server. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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: Server version. ,
Enum:
{
5.7: No description available. ,
8.0.21: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
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 ,
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 ,
storageSku:
{
Description: The sku name of the server storage. ,
Required: False ,
}
string ,
}
,
backup:
{
Description: Backup related properties of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days 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:
{
Enabled: No description available. ,
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 ,
}
,
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 ,
}
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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. ,
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 Azure Active Directory identity of the server. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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: Server version. ,
Enum:
{
5.7: No description available. ,
8.0.21: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
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 ,
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 ,
storageSku:
{
Description: The sku name of the server storage. ,
Required: False ,
}
string ,
}
,
backup:
{
Description: Backup related properties of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days 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:
{
Enabled: No description available. ,
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 ,
}
,
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 ,
}
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of servers ,
Required: False ,
}
[
{
identity:
{
Description: The Azure Active Directory identity of the server. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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: Server version. ,
Enum:
{
5.7: No description available. ,
8.0.21: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
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 ,
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 ,
storageSku:
{
Description: The sku name of the server storage. ,
Required: False ,
}
string ,
}
,
backup:
{
Description: Backup related properties of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days 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:
{
Enabled: No description available. ,
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 ,
}
,
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 ,
}
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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. ,
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)

{}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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. ,
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)

{}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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. ,
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)

{}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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. ,
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)

{}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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. ,
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 Azure Active Directory identity of the server. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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: Server version. ,
Enum:
{
5.7: No description available. ,
8.0.21: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
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 ,
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 ,
storageSku:
{
Description: The sku name of the server storage. ,
Required: False ,
}
string ,
}
,
backup:
{
Description: Backup related properties of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days 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:
{
Enabled: No description available. ,
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 ,
}
,
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 ,
}
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Backups_Get (removed)
Description :  List all the backups for a given server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/backups/{backupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
backupName:
{
Description: The name of the backup. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a server backup. ,
Required: False ,
}
{
backupType:
{
Description: Backup type. ,
Required: False ,
}
string ,
completedTime:
{
Description: Backup completed time (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Backup source ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Backups_ListByServer (removed)
Description :  List all the backups for a given server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/backups
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 backups of a server. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a server backup. ,
Required: False ,
}
{
backupType:
{
Description: Backup type. ,
Required: False ,
}
string ,
completedTime:
{
Description: Backup completed time (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Backup source ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
FirewallRules_CreateOrUpdate (removed)
Description :  Creates a new firewall rule or updates an existing firewall rule.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/firewallRules/{firewallRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
firewallRuleName:
{
Description: The name of the server firewall rule. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for creating or updating a firewall rule. ,
Required: True ,
}
{
properties:
{
Description: The properties of a firewall rule. ,
Required: True ,
}
{
startIpAddress:
{
Description: The start IP address of the server firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
endIpAddress:
{
Description: The end IP address of the server firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a firewall rule. ,
Required: True ,
}
{
startIpAddress:
{
Description: The start IP address of the server firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
endIpAddress:
{
Description: The end IP address of the server firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of a firewall rule. ,
Required: True ,
}
{
startIpAddress:
{
Description: The start IP address of the server firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
endIpAddress:
{
Description: The end IP address of the server firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
FirewallRules_Delete (removed)
Description :  Deletes a firewall rule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/firewallRules/{firewallRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
firewallRuleName:
{
Description: The name of the server firewall rule. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
FirewallRules_Get (removed)
Description :  Gets information about a server firewall rule.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/firewallRules/{firewallRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
firewallRuleName:
{
Description: The name of the server firewall rule. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a firewall rule. ,
Required: True ,
}
{
startIpAddress:
{
Description: The start IP address of the server firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
endIpAddress:
{
Description: The end IP address of the server firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
FirewallRules_ListByServer (removed)
Description :  List all the firewall rules in a given server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/firewallRules
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 firewall rules in a server. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a firewall rule. ,
Required: True ,
}
{
startIpAddress:
{
Description: The start IP address of the server firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
endIpAddress:
{
Description: The end IP address of the server firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Databases_CreateOrUpdate (removed)
Description :  Creates a new database or updates an existing database.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/databases/{databaseName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for creating or updating a database. ,
Required: True ,
}
{
properties:
{
Description: The properties of a database. ,
Required: False ,
}
{
charset:
{
Description: The charset of the database. ,
Required: False ,
}
string ,
collation:
{
Description: The collation of the database. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a database. ,
Required: False ,
}
{
charset:
{
Description: The charset of the database. ,
Required: False ,
}
string ,
collation:
{
Description: The collation of the database. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of a database. ,
Required: False ,
}
{
charset:
{
Description: The charset of the database. ,
Required: False ,
}
string ,
collation:
{
Description: The collation of the database. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Databases_Delete (removed)
Description :  Deletes a database.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/databases/{databaseName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Databases_Get (removed)
Description :  Gets information about a database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/databases/{databaseName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a database. ,
Required: False ,
}
{
charset:
{
Description: The charset of the database. ,
Required: False ,
}
string ,
collation:
{
Description: The collation of the database. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Databases_ListByServer (removed)
Description :  List all the databases in a given server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/databases
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 databases housed in a server ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a database. ,
Required: False ,
}
{
charset:
{
Description: The charset of the database. ,
Required: False ,
}
string ,
collation:
{
Description: The collation of the database. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Configurations_Update (removed)
Description :  Updates a configuration of a server.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/configurations/{configurationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
configurationName:
{
Description: The name of the server configuration. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for updating a server configuration. ,
Required: True ,
}
{
properties:
{
Description: The properties of a configuration. ,
Required: False ,
}
{
value:
{
Description: Value of the configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description of the configuration. ,
Required: False ,
}
string ,
defaultValue:
{
Description: Default value of the configuration. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the configuration. ,
Required: False ,
}
string ,
allowedValues:
{
Description: Allowed values of the configuration. ,
Required: False ,
}
string ,
source:
{
Description: Source of the configuration. ,
Enum:
{
system-default: No description available. ,
user-override: No description available. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: If is the configuration read only. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
isConfigPendingRestart:
{
Description: If is the configuration pending restart or not. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
isDynamicConfig:
{
Description: If is the configuration dynamic. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a configuration. ,
Required: False ,
}
{
value:
{
Description: Value of the configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description of the configuration. ,
Required: False ,
}
string ,
defaultValue:
{
Description: Default value of the configuration. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the configuration. ,
Required: False ,
}
string ,
allowedValues:
{
Description: Allowed values of the configuration. ,
Required: False ,
}
string ,
source:
{
Description: Source of the configuration. ,
Enum:
{
system-default: No description available. ,
user-override: No description available. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: If is the configuration read only. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
isConfigPendingRestart:
{
Description: If is the configuration pending restart or not. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
isDynamicConfig:
{
Description: If is the configuration dynamic. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Configurations_Get (removed)
Description :  Gets information about a configuration of server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/configurations/{configurationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
configurationName:
{
Description: The name of the server configuration. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a configuration. ,
Required: False ,
}
{
value:
{
Description: Value of the configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description of the configuration. ,
Required: False ,
}
string ,
defaultValue:
{
Description: Default value of the configuration. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the configuration. ,
Required: False ,
}
string ,
allowedValues:
{
Description: Allowed values of the configuration. ,
Required: False ,
}
string ,
source:
{
Description: Source of the configuration. ,
Enum:
{
system-default: No description available. ,
user-override: No description available. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: If is the configuration read only. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
isConfigPendingRestart:
{
Description: If is the configuration pending restart or not. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
isDynamicConfig:
{
Description: If is the configuration dynamic. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Configurations_BatchUpdate (removed)
Description :  Update a list of configurations in a given server.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/updateConfigurations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 parameters for updating a list of server configuration. ,
Required: True ,
}
{
value:
{
Description: The list of server configurations. ,
Required: False ,
}
[
{
name:
{
Description: Name of the configuration. ,
Required: False ,
}
string ,
properties:
{
Description: The properties can be updated for a configuration. ,
Required: False ,
}
{
value:
{
Description: Value of the configuration. ,
Required: False ,
}
string ,
source:
{
Description: Source of the configuration. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (200)

{
value:
{
Description: The list of server configurations. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a configuration. ,
Required: False ,
}
{
value:
{
Description: Value of the configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description of the configuration. ,
Required: False ,
}
string ,
defaultValue:
{
Description: Default value of the configuration. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the configuration. ,
Required: False ,
}
string ,
allowedValues:
{
Description: Allowed values of the configuration. ,
Required: False ,
}
string ,
source:
{
Description: Source of the configuration. ,
Enum:
{
system-default: No description available. ,
user-override: No description available. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: If is the configuration read only. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
isConfigPendingRestart:
{
Description: If is the configuration pending restart or not. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
isDynamicConfig:
{
Description: If is the configuration dynamic. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Configurations_ListByServer (removed)
Description :  List all the configurations in a given server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/configurations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 server configurations. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a configuration. ,
Required: False ,
}
{
value:
{
Description: Value of the configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description of the configuration. ,
Required: False ,
}
string ,
defaultValue:
{
Description: Default value of the configuration. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the configuration. ,
Required: False ,
}
string ,
allowedValues:
{
Description: Allowed values of the configuration. ,
Required: False ,
}
string ,
source:
{
Description: Source of the configuration. ,
Enum:
{
system-default: No description available. ,
user-override: No description available. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: If is the configuration read only. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
isConfigPendingRestart:
{
Description: If is the configuration pending restart or not. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
isDynamicConfig:
{
Description: If is the configuration dynamic. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
LocationBasedCapabilities_List (removed)
Description :  Get capabilities at specified location in a given subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/locations/{locationName}/capabilities
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
locationName:
{
Description: The name of the location. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of supported capabilities. ,
Required: False ,
}
[
{
zone:
{
Description: zone name ,
Required: False ,
}
string ,
supportedHAMode:
{
Description: Supported high availability mode ,
Required: False ,
}
[
string ,
]
,
supportedGeoBackupRegions:
{
Description: supported geo backup regions ,
Required: False ,
}
[
string ,
]
,
supportedFlexibleServerEditions:
{
Description: A list of supported flexible server editions. ,
Required: False ,
}
[
{
name:
{
Description: Server edition name ,
Required: False ,
}
string ,
supportedStorageEditions:
{
Description: A list of supported storage editions ,
Required: False ,
}
[
{
name:
{
Description: storage edition name ,
Required: False ,
}
string ,
minStorageSize:
{
Description: The minimal supported storage size. ,
Format: int64 ,
Required: False ,
}
integer ,
maxStorageSize:
{
Description: The maximum supported storage size. ,
Format: int64 ,
Required: False ,
}
integer ,
minBackupRetentionDays:
{
Description: Minimal backup retention days ,
Format: int64 ,
Required: False ,
}
integer ,
maxBackupRetentionDays:
{
Description: Maximum backup retention days ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
supportedServerVersions:
{
Description: A list of supported server versions. ,
Required: False ,
}
[
{
name:
{
Description: server version ,
Required: False ,
}
string ,
supportedSkus:
{
Description: A list of supported Skus ,
Required: False ,
}
[
{
name:
{
Description: vCore name ,
Required: False ,
}
string ,
vCores:
{
Description: supported vCores ,
Format: int64 ,
Required: False ,
}
integer ,
supportedIops:
{
Description: supported IOPS ,
Format: int64 ,
Required: False ,
}
integer ,
supportedMemoryPerVCoreMB:
{
Description: supported memory per vCore in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
CheckVirtualNetworkSubnetUsage_Execute (removed)
Description :  Get virtual network subnet usage for a given vNet resource id.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/locations/{locationName}/checkVirtualNetworkSubnetUsage
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
locationName:
{
Description: The name of the location. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for creating or updating a server. ,
Required: True ,
}
{
virtualNetworkResourceId:
{
Description: Virtual network resource id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
delegatedSubnetsUsage:
{
Description: A list of delegated subnet usage ,
Required: False ,
}
[
{
subnetName:
{
Description: name of the subnet ,
Required: False ,
}
string ,
usage:
{
Description: Number of used delegated subnets ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
CheckNameAvailability_Execute (removed)
Description :  Check the availability of name for server
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/locations/{locationName}/checkNameAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
locationName:
{
Description: The name of the location. ,
Required: True ,
}
string ,
nameAvailabilityRequest:
{
Description: The required parameters for checking if server name is available. ,
Required: True ,
}
{
name:
{
Description: Resource name to verify. ,
Required: True ,
}
string ,
type:
{
Description: Resource type used for verification. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
message:
{
Description: Error Message. ,
Required: False ,
}
string ,
nameAvailable:
{
Description: Indicates whether the resource name is available. ,
Required: False ,
}
boolean ,
reason:
{
Description: Reason for name being unavailable. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
GetPrivateDnsZoneSuffix_Execute (removed)
Description :  Get private DNS zone suffix in the cloud.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.DBforMySQL/getPrivateDnsZoneSuffix
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
privateDnsZoneSuffix:
{
Description: Represents the private DNS zone suffix. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Operations_List (removed)
Description :  Lists all of the available REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.DBforMySQL/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of available operation details ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation being performed on this particular object. ,
Required: False ,
}
string ,
display:
{
Description: The localized display information for this particular operation or action. ,
Required: False ,
}
{
provider:
{
Description: Operation resource provider name. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed. ,
Required: False ,
}
string ,
operation:
{
Description: Localized friendly name for the operation. ,
Required: False ,
}
string ,
description:
{
Description: Operation description. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation. ,
Required: False ,
}
string ,
properties:
{
Description: Additional descriptions for the operation. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: URL client should use to fetch the next page (per server side paging). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}