Microsoft.DBForMySql (preview:2020-07-01-privatepreview)

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. ,
}
,
Required: False ,
}
enum ,
sslEnforcement:
{
Description: Enable ssl enforcement or not when connect to server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
infrastructureEncryption:
{
Description: Status showing whether the server enabled infrastructure encryption. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of a server. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
haState:
{
Description: The state of a HA server. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
ReplicatingData: No description available. ,
FailingOver: No description available. ,
Healthy: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
haEnabled:
{
Description: Enable HA or not for a server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
earliestRestoreDate:
{
Description: Earliest restore point creation time (ISO8601 format) ,
Format: date-time ,
Required: False ,
}
string ,
storageProfile:
{
Description: Storage profile of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageMB:
{
Description: Max storage allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageIops:
{
Description: Storage IOPS for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAutogrow:
{
Description: Enable Storage Auto Grow. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
fileStorageSkuName:
{
Description: The sku name of the file storage. ,
Required: False ,
}
string ,
}
,
replicationRole:
{
Description: The replication role. ,
Required: False ,
}
string ,
replicaCapacity:
{
Description: The maximum number of replicas that a primary server can have. ,
Format: int32 ,
Required: False ,
}
integer ,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
maintenanceWindow:
{
Description: Maintenance window of a server. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceServerId:
{
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 ,
availabilityZone:
{
Description: availability Zone information of the server. ,
Required: False ,
}
string ,
standbyAvailabilityZone:
{
Description: availability Zone information of the server. ,
Required: False ,
}
string ,
byokEnforcement:
{
Description: Status showing whether the data encryption is enabled with customer-managed keys. ,
Required: False ,
}
string ,
delegatedSubnetArguments:
{
Description: Delegated subnet arguments. ,
Required: False ,
}
{
subnetArmResourceId:
{
Description: delegated subnet arm resource id. ,
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. ,
}
,
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. ,
}
,
Required: False ,
}
enum ,
sslEnforcement:
{
Description: Enable ssl enforcement or not when connect to server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
infrastructureEncryption:
{
Description: Status showing whether the server enabled infrastructure encryption. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of a server. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
haState:
{
Description: The state of a HA server. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
ReplicatingData: No description available. ,
FailingOver: No description available. ,
Healthy: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
haEnabled:
{
Description: Enable HA or not for a server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
earliestRestoreDate:
{
Description: Earliest restore point creation time (ISO8601 format) ,
Format: date-time ,
Required: False ,
}
string ,
storageProfile:
{
Description: Storage profile of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageMB:
{
Description: Max storage allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageIops:
{
Description: Storage IOPS for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAutogrow:
{
Description: Enable Storage Auto Grow. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
fileStorageSkuName:
{
Description: The sku name of the file storage. ,
Required: False ,
}
string ,
}
,
replicationRole:
{
Description: The replication role. ,
Required: False ,
}
string ,
replicaCapacity:
{
Description: The maximum number of replicas that a primary server can have. ,
Format: int32 ,
Required: False ,
}
integer ,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
maintenanceWindow:
{
Description: Maintenance window of a server. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceServerId:
{
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 ,
availabilityZone:
{
Description: availability Zone information of the server. ,
Required: False ,
}
string ,
standbyAvailabilityZone:
{
Description: availability Zone information of the server. ,
Required: False ,
}
string ,
byokEnforcement:
{
Description: Status showing whether the data encryption is enabled with customer-managed keys. ,
Required: False ,
}
string ,
delegatedSubnetArguments:
{
Description: Delegated subnet arguments. ,
Required: False ,
}
{
subnetArmResourceId:
{
Description: delegated subnet arm resource id. ,
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. ,
}
,
Required: False ,
}
enum ,
tags:
{
Description: Application-specific metadata in the form of key-value pairs. ,
Required: False ,
}
object ,
}
,
}

⚐ 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. ,
}
,
Required: False ,
}
enum ,
sslEnforcement:
{
Description: Enable ssl enforcement or not when connect to server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
infrastructureEncryption:
{
Description: Status showing whether the server enabled infrastructure encryption. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of a server. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
haState:
{
Description: The state of a HA server. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
ReplicatingData: No description available. ,
FailingOver: No description available. ,
Healthy: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
haEnabled:
{
Description: Enable HA or not for a server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
earliestRestoreDate:
{
Description: Earliest restore point creation time (ISO8601 format) ,
Format: date-time ,
Required: False ,
}
string ,
storageProfile:
{
Description: Storage profile of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageMB:
{
Description: Max storage allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageIops:
{
Description: Storage IOPS for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAutogrow:
{
Description: Enable Storage Auto Grow. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
fileStorageSkuName:
{
Description: The sku name of the file storage. ,
Required: False ,
}
string ,
}
,
replicationRole:
{
Description: The replication role. ,
Required: False ,
}
string ,
replicaCapacity:
{
Description: The maximum number of replicas that a primary server can have. ,
Format: int32 ,
Required: False ,
}
integer ,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
maintenanceWindow:
{
Description: Maintenance window of a server. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceServerId:
{
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 ,
availabilityZone:
{
Description: availability Zone information of the server. ,
Required: False ,
}
string ,
standbyAvailabilityZone:
{
Description: availability Zone information of the server. ,
Required: False ,
}
string ,
byokEnforcement:
{
Description: Status showing whether the data encryption is enabled with customer-managed keys. ,
Required: False ,
}
string ,
delegatedSubnetArguments:
{
Description: Delegated subnet arguments. ,
Required: False ,
}
{
subnetArmResourceId:
{
Description: delegated subnet arm resource id. ,
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. ,
}
,
Required: False ,
}
enum ,
tags:
{
Description: Application-specific metadata in the form of key-value pairs. ,
Required: False ,
}
object ,
}
,
}

⚐ 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 ,
}
{
storageProfile:
{
Description: Storage profile of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageMB:
{
Description: Max storage allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageIops:
{
Description: Storage IOPS for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAutogrow:
{
Description: Enable Storage Auto Grow. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
fileStorageSkuName:
{
Description: The sku name of the file storage. ,
Required: False ,
}
string ,
}
,
administratorLoginPassword:
{
Description: The password of the administrator login. ,
Format: password ,
Required: False ,
}
string ,
sslEnforcement:
{
Description: Enable ssl enforcement or not when connect to server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
delegatedSubnetArguments:
{
Description: Delegated subnet arguments. ,
Required: False ,
}
{
subnetArmResourceId:
{
Description: delegated subnet arm resource id. ,
Required: False ,
}
string ,
}
,
haEnabled:
{
Description: Enable HA or not for a server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
maintenanceWindow:
{
Description: Maintenance window of a server. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
replicationRole:
{
Description: The replication role of the server. ,
Required: False ,
}
string ,
}
,
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. ,
}
,
Required: False ,
}
enum ,
sslEnforcement:
{
Description: Enable ssl enforcement or not when connect to server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
infrastructureEncryption:
{
Description: Status showing whether the server enabled infrastructure encryption. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of a server. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
haState:
{
Description: The state of a HA server. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
ReplicatingData: No description available. ,
FailingOver: No description available. ,
Healthy: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
haEnabled:
{
Description: Enable HA or not for a server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
earliestRestoreDate:
{
Description: Earliest restore point creation time (ISO8601 format) ,
Format: date-time ,
Required: False ,
}
string ,
storageProfile:
{
Description: Storage profile of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageMB:
{
Description: Max storage allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageIops:
{
Description: Storage IOPS for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAutogrow:
{
Description: Enable Storage Auto Grow. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
fileStorageSkuName:
{
Description: The sku name of the file storage. ,
Required: False ,
}
string ,
}
,
replicationRole:
{
Description: The replication role. ,
Required: False ,
}
string ,
replicaCapacity:
{
Description: The maximum number of replicas that a primary server can have. ,
Format: int32 ,
Required: False ,
}
integer ,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
maintenanceWindow:
{
Description: Maintenance window of a server. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceServerId:
{
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 ,
availabilityZone:
{
Description: availability Zone information of the server. ,
Required: False ,
}
string ,
standbyAvailabilityZone:
{
Description: availability Zone information of the server. ,
Required: False ,
}
string ,
byokEnforcement:
{
Description: Status showing whether the data encryption is enabled with customer-managed keys. ,
Required: False ,
}
string ,
delegatedSubnetArguments:
{
Description: Delegated subnet arguments. ,
Required: False ,
}
{
subnetArmResourceId:
{
Description: delegated subnet arm resource id. ,
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. ,
}
,
Required: False ,
}
enum ,
tags:
{
Description: Application-specific metadata in the form of key-value pairs. ,
Required: False ,
}
object ,
}
,
}

⚐ 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. ,
}
,
Required: False ,
}
enum ,
sslEnforcement:
{
Description: Enable ssl enforcement or not when connect to server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
infrastructureEncryption:
{
Description: Status showing whether the server enabled infrastructure encryption. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of a server. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
haState:
{
Description: The state of a HA server. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
ReplicatingData: No description available. ,
FailingOver: No description available. ,
Healthy: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
haEnabled:
{
Description: Enable HA or not for a server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
earliestRestoreDate:
{
Description: Earliest restore point creation time (ISO8601 format) ,
Format: date-time ,
Required: False ,
}
string ,
storageProfile:
{
Description: Storage profile of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageMB:
{
Description: Max storage allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageIops:
{
Description: Storage IOPS for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAutogrow:
{
Description: Enable Storage Auto Grow. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
fileStorageSkuName:
{
Description: The sku name of the file storage. ,
Required: False ,
}
string ,
}
,
replicationRole:
{
Description: The replication role. ,
Required: False ,
}
string ,
replicaCapacity:
{
Description: The maximum number of replicas that a primary server can have. ,
Format: int32 ,
Required: False ,
}
integer ,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
maintenanceWindow:
{
Description: Maintenance window of a server. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceServerId:
{
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 ,
availabilityZone:
{
Description: availability Zone information of the server. ,
Required: False ,
}
string ,
standbyAvailabilityZone:
{
Description: availability Zone information of the server. ,
Required: False ,
}
string ,
byokEnforcement:
{
Description: Status showing whether the data encryption is enabled with customer-managed keys. ,
Required: False ,
}
string ,
delegatedSubnetArguments:
{
Description: Delegated subnet arguments. ,
Required: False ,
}
{
subnetArmResourceId:
{
Description: delegated subnet arm resource id. ,
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. ,
}
,
Required: False ,
}
enum ,
tags:
{
Description: Application-specific metadata in the form of key-value pairs. ,
Required: False ,
}
object ,
}
,
}

⚐ 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. ,
}
,
Required: False ,
}
enum ,
sslEnforcement:
{
Description: Enable ssl enforcement or not when connect to server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
infrastructureEncryption:
{
Description: Status showing whether the server enabled infrastructure encryption. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of a server. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
haState:
{
Description: The state of a HA server. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
ReplicatingData: No description available. ,
FailingOver: No description available. ,
Healthy: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
haEnabled:
{
Description: Enable HA or not for a server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
earliestRestoreDate:
{
Description: Earliest restore point creation time (ISO8601 format) ,
Format: date-time ,
Required: False ,
}
string ,
storageProfile:
{
Description: Storage profile of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageMB:
{
Description: Max storage allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageIops:
{
Description: Storage IOPS for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAutogrow:
{
Description: Enable Storage Auto Grow. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
fileStorageSkuName:
{
Description: The sku name of the file storage. ,
Required: False ,
}
string ,
}
,
replicationRole:
{
Description: The replication role. ,
Required: False ,
}
string ,
replicaCapacity:
{
Description: The maximum number of replicas that a primary server can have. ,
Format: int32 ,
Required: False ,
}
integer ,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
maintenanceWindow:
{
Description: Maintenance window of a server. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceServerId:
{
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 ,
availabilityZone:
{
Description: availability Zone information of the server. ,
Required: False ,
}
string ,
standbyAvailabilityZone:
{
Description: availability Zone information of the server. ,
Required: False ,
}
string ,
byokEnforcement:
{
Description: Status showing whether the data encryption is enabled with customer-managed keys. ,
Required: False ,
}
string ,
delegatedSubnetArguments:
{
Description: Delegated subnet arguments. ,
Required: False ,
}
{
subnetArmResourceId:
{
Description: delegated subnet arm resource id. ,
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. ,
}
,
Required: False ,
}
enum ,
tags:
{
Description: Application-specific metadata in the form of key-value pairs. ,
Required: False ,
}
object ,
}
,
}
,
]
,
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. ,
}
,
Required: False ,
}
enum ,
sslEnforcement:
{
Description: Enable ssl enforcement or not when connect to server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
infrastructureEncryption:
{
Description: Status showing whether the server enabled infrastructure encryption. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of a server. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
haState:
{
Description: The state of a HA server. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
ReplicatingData: No description available. ,
FailingOver: No description available. ,
Healthy: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
haEnabled:
{
Description: Enable HA or not for a server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
earliestRestoreDate:
{
Description: Earliest restore point creation time (ISO8601 format) ,
Format: date-time ,
Required: False ,
}
string ,
storageProfile:
{
Description: Storage profile of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageMB:
{
Description: Max storage allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageIops:
{
Description: Storage IOPS for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAutogrow:
{
Description: Enable Storage Auto Grow. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
fileStorageSkuName:
{
Description: The sku name of the file storage. ,
Required: False ,
}
string ,
}
,
replicationRole:
{
Description: The replication role. ,
Required: False ,
}
string ,
replicaCapacity:
{
Description: The maximum number of replicas that a primary server can have. ,
Format: int32 ,
Required: False ,
}
integer ,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
maintenanceWindow:
{
Description: Maintenance window of a server. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceServerId:
{
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 ,
availabilityZone:
{
Description: availability Zone information of the server. ,
Required: False ,
}
string ,
standbyAvailabilityZone:
{
Description: availability Zone information of the server. ,
Required: False ,
}
string ,
byokEnforcement:
{
Description: Status showing whether the data encryption is enabled with customer-managed keys. ,
Required: False ,
}
string ,
delegatedSubnetArguments:
{
Description: Delegated subnet arguments. ,
Required: False ,
}
{
subnetArmResourceId:
{
Description: delegated subnet arm resource id. ,
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. ,
}
,
Required: False ,
}
enum ,
tags:
{
Description: Application-specific metadata in the form of key-value pairs. ,
Required: False ,
}
object ,
}
,
}
,
]
,
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_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 ,
}

⚐ 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. ,
}
,
Required: False ,
}
enum ,
sslEnforcement:
{
Description: Enable ssl enforcement or not when connect to server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
infrastructureEncryption:
{
Description: Status showing whether the server enabled infrastructure encryption. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of a server. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
haState:
{
Description: The state of a HA server. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
ReplicatingData: No description available. ,
FailingOver: No description available. ,
Healthy: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
haEnabled:
{
Description: Enable HA or not for a server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
earliestRestoreDate:
{
Description: Earliest restore point creation time (ISO8601 format) ,
Format: date-time ,
Required: False ,
}
string ,
storageProfile:
{
Description: Storage profile of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageMB:
{
Description: Max storage allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageIops:
{
Description: Storage IOPS for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAutogrow:
{
Description: Enable Storage Auto Grow. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
fileStorageSkuName:
{
Description: The sku name of the file storage. ,
Required: False ,
}
string ,
}
,
replicationRole:
{
Description: The replication role. ,
Required: False ,
}
string ,
replicaCapacity:
{
Description: The maximum number of replicas that a primary server can have. ,
Format: int32 ,
Required: False ,
}
integer ,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
maintenanceWindow:
{
Description: Maintenance window of a server. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceServerId:
{
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 ,
availabilityZone:
{
Description: availability Zone information of the server. ,
Required: False ,
}
string ,
standbyAvailabilityZone:
{
Description: availability Zone information of the server. ,
Required: False ,
}
string ,
byokEnforcement:
{
Description: Status showing whether the data encryption is enabled with customer-managed keys. ,
Required: False ,
}
string ,
delegatedSubnetArguments:
{
Description: Delegated subnet arguments. ,
Required: False ,
}
{
subnetArmResourceId:
{
Description: delegated subnet arm resource id. ,
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. ,
}
,
Required: False ,
}
enum ,
tags:
{
Description: Application-specific metadata in the form of key-value pairs. ,
Required: False ,
}
object ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
ServerKeys_CreateOrUpdate (new)
Description :  Creates or updates a MySQL Server key.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySql/flexibleServers/{serverName}/keys/{keyName}
{
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 ,
keyName:
{
Description: The name of the server key. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested MySQL Server key resource state. ,
Required: True ,
}
{
kind:
{
Description: Kind of encryption protector used to protect the key. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the ServerKey Resource. ,
Required: False ,
}
{
serverKeyType:
{
Description: The key type like 'AzureKeyVault'. ,
Enum:
{
AzureKeyVault: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The URI of the key. ,
Required: False ,
}
string ,
creationDate:
{
Description: The key creation date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
kind:
{
Description: Kind of encryption protector used to protect the key. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the ServerKey Resource. ,
Required: False ,
}
{
serverKeyType:
{
Description: The key type like 'AzureKeyVault'. ,
Enum:
{
AzureKeyVault: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The URI of the key. ,
Required: False ,
}
string ,
creationDate:
{
Description: The key creation date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
kind:
{
Description: Kind of encryption protector used to protect the key. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the ServerKey Resource. ,
Required: False ,
}
{
serverKeyType:
{
Description: The key type like 'AzureKeyVault'. ,
Enum:
{
AzureKeyVault: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The URI of the key. ,
Required: False ,
}
string ,
creationDate:
{
Description: The key creation date. ,
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 ,
}
,
]
,
}
,
}
ServerKeys_Delete (new)
Description :  Deletes the MySQL Server key with the given name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySql/flexibleServers/{serverName}/keys/{keyName}
{
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 ,
keyName:
{
Description: The name of the server key. ,
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 ,
}
,
]
,
}
,
}
ServerKeys_Get (new)
Description :  Gets a server key.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySql/flexibleServers/{serverName}/keys/{keyName}
{
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 ,
keyName:
{
Description: The name of the server key. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Kind of encryption protector used to protect the key. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the ServerKey Resource. ,
Required: False ,
}
{
serverKeyType:
{
Description: The key type like 'AzureKeyVault'. ,
Enum:
{
AzureKeyVault: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The URI of the key. ,
Required: False ,
}
string ,
creationDate:
{
Description: The key creation date. ,
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 ,
}
,
]
,
}
,
}
ServerKeys_ListByServer (new)
Description :  Gets a list of Server keys.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySql/flexibleServers/{serverName}/keys
{
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: A list of MySQL Server keys. ,
Required: False ,
}
[
{
kind:
{
Description: Kind of encryption protector used to protect the key. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the ServerKey Resource. ,
Required: False ,
}
{
serverKeyType:
{
Description: The key type like 'AzureKeyVault'. ,
Enum:
{
AzureKeyVault: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The URI of the key. ,
Required: False ,
}
string ,
creationDate:
{
Description: The key creation date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
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 ,
}
,
}
,
}

⚐ 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 ,
}
,
}

⚐ 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 ,
}
,
}

⚐ 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 ,
}
,
}

⚐ 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 ,
}
,
}
,
]
,
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 ,
}
,
}
,
}

⚐ 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 ,
}
,
}

⚐ 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 ,
}
,
}

⚐ 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 ,
}
,
}

⚐ 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 ,
}
,
}
,
]
,
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. ,
Required: False ,
}
string ,
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 ,
}
,
}
,
}

⚐ 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. ,
Required: False ,
}
string ,
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 ,
}
,
}

⚐ 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. ,
Required: False ,
}
string ,
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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
ServerParameters_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 ,
value:
{
Description: The parameters for updating a list of server configuration. ,
Required: True ,
}
{
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. ,
Required: False ,
}
string ,
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 ,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
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. ,
Required: False ,
}
string ,
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 ,
}
,
}
,
]
,
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. ,
Required: False ,
}
string ,
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 ,
}
,
}
,
]
,
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 ,
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 in MB ,
Required: False ,
}
{
name:
{
Description: storage MB name ,
Required: False ,
}
string ,
storageSizeMB:
{
Description: storage size in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
maxStorageSize:
{
Description: The maximum supported storage size in MB ,
Required: False ,
}
{
name:
{
Description: storage MB name ,
Required: False ,
}
string ,
storageSizeMB:
{
Description: storage size in MB ,
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 ,
status:
{
Description: The status of the capability. ,
Required: False ,
}
string ,
}
,
]
,
supportedServerVersions:
{
Description: A list of supported server versions. ,
Required: False ,
}
[
{
name:
{
Description: server version ,
Required: False ,
}
string ,
supportedVcores:
{
Description: A list of supported Vcores ,
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 ,
status:
{
Description: The status of the capability. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the capability. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the capability. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the capability. ,
Required: False ,
}
string ,
}
,
]
,
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 ,
}
{
virtualNetworkArmResourceId:
{
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/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 ,
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 ,
}
,
]
,
}
,
}
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: The list of resource provider operations. ,
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. ,
Enum:
{
NotSpecified: No description available. ,
user: No description available. ,
system: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Additional descriptions for the operation. ,
Required: False ,
}
object ,
}
,
]
,
}

⚐ 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. ,
}
,
Required: False ,
}
enum ,
sslEnforcement:
{
Description: Enable ssl enforcement or not when connect to server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
infrastructureEncryption:
{
Description: Status showing whether the server enabled infrastructure encryption. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of a server. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
haState:
{
Description: The state of a HA server. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
ReplicatingData: No description available. ,
FailingOver: No description available. ,
Healthy: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
haEnabled:
{
Description: Enable HA or not for a server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
earliestRestoreDate:
{
Description: Earliest restore point creation time (ISO8601 format) ,
Format: date-time ,
Required: False ,
}
string ,
storageProfile:
{
Description: Storage profile of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageMB:
{
Description: Max storage allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageIops:
{
Description: Storage IOPS for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAutogrow:
{
Description: Enable Storage Auto Grow. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
fileStorageSkuName:
{
Description: The sku name of the file storage. ,
Required: False ,
}
string ,
}
,
replicationRole:
{
Description: The replication role. ,
Required: False ,
}
string ,
replicaCapacity:
{
Description: The maximum number of replicas that a primary server can have. ,
Format: int32 ,
Required: False ,
}
integer ,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
maintenanceWindow:
{
Description: Maintenance window of a server. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceServerId:
{
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 ,
availabilityZone:
{
Description: availability Zone information of the server. ,
Required: False ,
}
string ,
standbyAvailabilityZone:
{
Description: availability Zone information of the server. ,
Required: False ,
}
string ,
byokEnforcement:
{
Description: Status showing whether the data encryption is enabled with customer-managed keys. ,
Required: False ,
}
string ,
delegatedSubnetArguments:
{
Description: Delegated subnet arguments. ,
Required: False ,
}
{
subnetArmResourceId:
{
Description: delegated subnet arm resource id. ,
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. ,
}
,
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. ,
}
,
Required: False ,
}
enum ,
sslEnforcement:
{
Description: Enable ssl enforcement or not when connect to server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
infrastructureEncryption:
{
Description: Status showing whether the server enabled infrastructure encryption. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of a server. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
haState:
{
Description: The state of a HA server. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
ReplicatingData: No description available. ,
FailingOver: No description available. ,
Healthy: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
haEnabled:
{
Description: Enable HA or not for a server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
earliestRestoreDate:
{
Description: Earliest restore point creation time (ISO8601 format) ,
Format: date-time ,
Required: False ,
}
string ,
storageProfile:
{
Description: Storage profile of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageMB:
{
Description: Max storage allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageIops:
{
Description: Storage IOPS for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAutogrow:
{
Description: Enable Storage Auto Grow. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
fileStorageSkuName:
{
Description: The sku name of the file storage. ,
Required: False ,
}
string ,
}
,
replicationRole:
{
Description: The replication role. ,
Required: False ,
}
string ,
replicaCapacity:
{
Description: The maximum number of replicas that a primary server can have. ,
Format: int32 ,
Required: False ,
}
integer ,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
maintenanceWindow:
{
Description: Maintenance window of a server. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceServerId:
{
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 ,
availabilityZone:
{
Description: availability Zone information of the server. ,
Required: False ,
}
string ,
standbyAvailabilityZone:
{
Description: availability Zone information of the server. ,
Required: False ,
}
string ,
byokEnforcement:
{
Description: Status showing whether the data encryption is enabled with customer-managed keys. ,
Required: False ,
}
string ,
delegatedSubnetArguments:
{
Description: Delegated subnet arguments. ,
Required: False ,
}
{
subnetArmResourceId:
{
Description: delegated subnet arm resource id. ,
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. ,
}
,
Required: False ,
}
enum ,
tags:
{
Description: Application-specific metadata in the form of key-value pairs. ,
Required: False ,
}
object ,
}
,
}

⚐ 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. ,
}
,
Required: False ,
}
enum ,
sslEnforcement:
{
Description: Enable ssl enforcement or not when connect to server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
infrastructureEncryption:
{
Description: Status showing whether the server enabled infrastructure encryption. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of a server. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
haState:
{
Description: The state of a HA server. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
ReplicatingData: No description available. ,
FailingOver: No description available. ,
Healthy: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
haEnabled:
{
Description: Enable HA or not for a server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
earliestRestoreDate:
{
Description: Earliest restore point creation time (ISO8601 format) ,
Format: date-time ,
Required: False ,
}
string ,
storageProfile:
{
Description: Storage profile of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageMB:
{
Description: Max storage allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageIops:
{
Description: Storage IOPS for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAutogrow:
{
Description: Enable Storage Auto Grow. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
fileStorageSkuName:
{
Description: The sku name of the file storage. ,
Required: False ,
}
string ,
}
,
replicationRole:
{
Description: The replication role. ,
Required: False ,
}
string ,
replicaCapacity:
{
Description: The maximum number of replicas that a primary server can have. ,
Format: int32 ,
Required: False ,
}
integer ,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
maintenanceWindow:
{
Description: Maintenance window of a server. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceServerId:
{
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 ,
availabilityZone:
{
Description: availability Zone information of the server. ,
Required: False ,
}
string ,
standbyAvailabilityZone:
{
Description: availability Zone information of the server. ,
Required: False ,
}
string ,
byokEnforcement:
{
Description: Status showing whether the data encryption is enabled with customer-managed keys. ,
Required: False ,
}
string ,
delegatedSubnetArguments:
{
Description: Delegated subnet arguments. ,
Required: False ,
}
{
subnetArmResourceId:
{
Description: delegated subnet arm resource id. ,
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. ,
}
,
Required: False ,
}
enum ,
tags:
{
Description: Application-specific metadata in the form of key-value pairs. ,
Required: False ,
}
object ,
}
,
}

⚐ 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 ,
}
{
storageProfile:
{
Description: Storage profile of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageMB:
{
Description: Max storage allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageIops:
{
Description: Storage IOPS for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAutogrow:
{
Description: Enable Storage Auto Grow. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
fileStorageSkuName:
{
Description: The sku name of the file storage. ,
Required: False ,
}
string ,
}
,
administratorLoginPassword:
{
Description: The password of the administrator login. ,
Format: password ,
Required: False ,
}
string ,
sslEnforcement:
{
Description: Enable ssl enforcement or not when connect to server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
delegatedSubnetArguments:
{
Description: Delegated subnet arguments. ,
Required: False ,
}
{
subnetArmResourceId:
{
Description: delegated subnet arm resource id. ,
Required: False ,
}
string ,
}
,
haEnabled:
{
Description: Enable HA or not for a server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
maintenanceWindow:
{
Description: Maintenance window of a server. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
replicationRole:
{
Description: The replication role of the server. ,
Required: False ,
}
string ,
}
,
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. ,
}
,
Required: False ,
}
enum ,
sslEnforcement:
{
Description: Enable ssl enforcement or not when connect to server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
infrastructureEncryption:
{
Description: Status showing whether the server enabled infrastructure encryption. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of a server. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
haState:
{
Description: The state of a HA server. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
ReplicatingData: No description available. ,
FailingOver: No description available. ,
Healthy: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
haEnabled:
{
Description: Enable HA or not for a server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
earliestRestoreDate:
{
Description: Earliest restore point creation time (ISO8601 format) ,
Format: date-time ,
Required: False ,
}
string ,
storageProfile:
{
Description: Storage profile of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageMB:
{
Description: Max storage allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageIops:
{
Description: Storage IOPS for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAutogrow:
{
Description: Enable Storage Auto Grow. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
fileStorageSkuName:
{
Description: The sku name of the file storage. ,
Required: False ,
}
string ,
}
,
replicationRole:
{
Description: The replication role. ,
Required: False ,
}
string ,
replicaCapacity:
{
Description: The maximum number of replicas that a primary server can have. ,
Format: int32 ,
Required: False ,
}
integer ,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
maintenanceWindow:
{
Description: Maintenance window of a server. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceServerId:
{
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 ,
availabilityZone:
{
Description: availability Zone information of the server. ,
Required: False ,
}
string ,
standbyAvailabilityZone:
{
Description: availability Zone information of the server. ,
Required: False ,
}
string ,
byokEnforcement:
{
Description: Status showing whether the data encryption is enabled with customer-managed keys. ,
Required: False ,
}
string ,
delegatedSubnetArguments:
{
Description: Delegated subnet arguments. ,
Required: False ,
}
{
subnetArmResourceId:
{
Description: delegated subnet arm resource id. ,
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. ,
}
,
Required: False ,
}
enum ,
tags:
{
Description: Application-specific metadata in the form of key-value pairs. ,
Required: False ,
}
object ,
}
,
}

⚐ 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. ,
}
,
Required: False ,
}
enum ,
sslEnforcement:
{
Description: Enable ssl enforcement or not when connect to server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
infrastructureEncryption:
{
Description: Status showing whether the server enabled infrastructure encryption. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of a server. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
haState:
{
Description: The state of a HA server. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
ReplicatingData: No description available. ,
FailingOver: No description available. ,
Healthy: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
haEnabled:
{
Description: Enable HA or not for a server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
earliestRestoreDate:
{
Description: Earliest restore point creation time (ISO8601 format) ,
Format: date-time ,
Required: False ,
}
string ,
storageProfile:
{
Description: Storage profile of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageMB:
{
Description: Max storage allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageIops:
{
Description: Storage IOPS for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAutogrow:
{
Description: Enable Storage Auto Grow. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
fileStorageSkuName:
{
Description: The sku name of the file storage. ,
Required: False ,
}
string ,
}
,
replicationRole:
{
Description: The replication role. ,
Required: False ,
}
string ,
replicaCapacity:
{
Description: The maximum number of replicas that a primary server can have. ,
Format: int32 ,
Required: False ,
}
integer ,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
maintenanceWindow:
{
Description: Maintenance window of a server. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceServerId:
{
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 ,
availabilityZone:
{
Description: availability Zone information of the server. ,
Required: False ,
}
string ,
standbyAvailabilityZone:
{
Description: availability Zone information of the server. ,
Required: False ,
}
string ,
byokEnforcement:
{
Description: Status showing whether the data encryption is enabled with customer-managed keys. ,
Required: False ,
}
string ,
delegatedSubnetArguments:
{
Description: Delegated subnet arguments. ,
Required: False ,
}
{
subnetArmResourceId:
{
Description: delegated subnet arm resource id. ,
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. ,
}
,
Required: False ,
}
enum ,
tags:
{
Description: Application-specific metadata in the form of key-value pairs. ,
Required: False ,
}
object ,
}
,
}

⚐ 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. ,
}
,
Required: False ,
}
enum ,
sslEnforcement:
{
Description: Enable ssl enforcement or not when connect to server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
infrastructureEncryption:
{
Description: Status showing whether the server enabled infrastructure encryption. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of a server. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
haState:
{
Description: The state of a HA server. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
ReplicatingData: No description available. ,
FailingOver: No description available. ,
Healthy: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
haEnabled:
{
Description: Enable HA or not for a server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
earliestRestoreDate:
{
Description: Earliest restore point creation time (ISO8601 format) ,
Format: date-time ,
Required: False ,
}
string ,
storageProfile:
{
Description: Storage profile of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageMB:
{
Description: Max storage allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageIops:
{
Description: Storage IOPS for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAutogrow:
{
Description: Enable Storage Auto Grow. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
fileStorageSkuName:
{
Description: The sku name of the file storage. ,
Required: False ,
}
string ,
}
,
replicationRole:
{
Description: The replication role. ,
Required: False ,
}
string ,
replicaCapacity:
{
Description: The maximum number of replicas that a primary server can have. ,
Format: int32 ,
Required: False ,
}
integer ,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
maintenanceWindow:
{
Description: Maintenance window of a server. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceServerId:
{
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 ,
availabilityZone:
{
Description: availability Zone information of the server. ,
Required: False ,
}
string ,
standbyAvailabilityZone:
{
Description: availability Zone information of the server. ,
Required: False ,
}
string ,
byokEnforcement:
{
Description: Status showing whether the data encryption is enabled with customer-managed keys. ,
Required: False ,
}
string ,
delegatedSubnetArguments:
{
Description: Delegated subnet arguments. ,
Required: False ,
}
{
subnetArmResourceId:
{
Description: delegated subnet arm resource id. ,
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. ,
}
,
Required: False ,
}
enum ,
tags:
{
Description: Application-specific metadata in the form of key-value pairs. ,
Required: False ,
}
object ,
}
,
}
,
]
,
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. ,
}
,
Required: False ,
}
enum ,
sslEnforcement:
{
Description: Enable ssl enforcement or not when connect to server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
infrastructureEncryption:
{
Description: Status showing whether the server enabled infrastructure encryption. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of a server. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
haState:
{
Description: The state of a HA server. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
ReplicatingData: No description available. ,
FailingOver: No description available. ,
Healthy: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
haEnabled:
{
Description: Enable HA or not for a server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
earliestRestoreDate:
{
Description: Earliest restore point creation time (ISO8601 format) ,
Format: date-time ,
Required: False ,
}
string ,
storageProfile:
{
Description: Storage profile of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageMB:
{
Description: Max storage allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageIops:
{
Description: Storage IOPS for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAutogrow:
{
Description: Enable Storage Auto Grow. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
fileStorageSkuName:
{
Description: The sku name of the file storage. ,
Required: False ,
}
string ,
}
,
replicationRole:
{
Description: The replication role. ,
Required: False ,
}
string ,
replicaCapacity:
{
Description: The maximum number of replicas that a primary server can have. ,
Format: int32 ,
Required: False ,
}
integer ,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
maintenanceWindow:
{
Description: Maintenance window of a server. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceServerId:
{
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 ,
availabilityZone:
{
Description: availability Zone information of the server. ,
Required: False ,
}
string ,
standbyAvailabilityZone:
{
Description: availability Zone information of the server. ,
Required: False ,
}
string ,
byokEnforcement:
{
Description: Status showing whether the data encryption is enabled with customer-managed keys. ,
Required: False ,
}
string ,
delegatedSubnetArguments:
{
Description: Delegated subnet arguments. ,
Required: False ,
}
{
subnetArmResourceId:
{
Description: delegated subnet arm resource id. ,
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. ,
}
,
Required: False ,
}
enum ,
tags:
{
Description: Application-specific metadata in the form of key-value pairs. ,
Required: False ,
}
object ,
}
,
}
,
]
,
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_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 ,
}

⚐ 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. ,
}
,
Required: False ,
}
enum ,
sslEnforcement:
{
Description: Enable ssl enforcement or not when connect to server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
infrastructureEncryption:
{
Description: Status showing whether the server enabled infrastructure encryption. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of a server. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
haState:
{
Description: The state of a HA server. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
ReplicatingData: No description available. ,
FailingOver: No description available. ,
Healthy: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
haEnabled:
{
Description: Enable HA or not for a server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
earliestRestoreDate:
{
Description: Earliest restore point creation time (ISO8601 format) ,
Format: date-time ,
Required: False ,
}
string ,
storageProfile:
{
Description: Storage profile of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageMB:
{
Description: Max storage allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageIops:
{
Description: Storage IOPS for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAutogrow:
{
Description: Enable Storage Auto Grow. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
fileStorageSkuName:
{
Description: The sku name of the file storage. ,
Required: False ,
}
string ,
}
,
replicationRole:
{
Description: The replication role. ,
Required: False ,
}
string ,
replicaCapacity:
{
Description: The maximum number of replicas that a primary server can have. ,
Format: int32 ,
Required: False ,
}
integer ,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
maintenanceWindow:
{
Description: Maintenance window of a server. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceServerId:
{
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 ,
availabilityZone:
{
Description: availability Zone information of the server. ,
Required: False ,
}
string ,
standbyAvailabilityZone:
{
Description: availability Zone information of the server. ,
Required: False ,
}
string ,
byokEnforcement:
{
Description: Status showing whether the data encryption is enabled with customer-managed keys. ,
Required: False ,
}
string ,
delegatedSubnetArguments:
{
Description: Delegated subnet arguments. ,
Required: False ,
}
{
subnetArmResourceId:
{
Description: delegated subnet arm resource id. ,
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. ,
}
,
Required: False ,
}
enum ,
tags:
{
Description: Application-specific metadata in the form of key-value pairs. ,
Required: False ,
}
object ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
ServerKeys_CreateOrUpdate (removed)
Description :  Creates or updates a MySQL Server key.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySql/flexibleServers/{serverName}/keys/{keyName}
{
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 ,
keyName:
{
Description: The name of the server key. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested MySQL Server key resource state. ,
Required: True ,
}
{
kind:
{
Description: Kind of encryption protector used to protect the key. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the ServerKey Resource. ,
Required: False ,
}
{
serverKeyType:
{
Description: The key type like 'AzureKeyVault'. ,
Enum:
{
AzureKeyVault: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The URI of the key. ,
Required: False ,
}
string ,
creationDate:
{
Description: The key creation date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
kind:
{
Description: Kind of encryption protector used to protect the key. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the ServerKey Resource. ,
Required: False ,
}
{
serverKeyType:
{
Description: The key type like 'AzureKeyVault'. ,
Enum:
{
AzureKeyVault: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The URI of the key. ,
Required: False ,
}
string ,
creationDate:
{
Description: The key creation date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
kind:
{
Description: Kind of encryption protector used to protect the key. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the ServerKey Resource. ,
Required: False ,
}
{
serverKeyType:
{
Description: The key type like 'AzureKeyVault'. ,
Enum:
{
AzureKeyVault: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The URI of the key. ,
Required: False ,
}
string ,
creationDate:
{
Description: The key creation date. ,
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 ,
}
,
]
,
}
,
}
ServerKeys_Delete (removed)
Description :  Deletes the MySQL Server key with the given name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySql/flexibleServers/{serverName}/keys/{keyName}
{
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 ,
keyName:
{
Description: The name of the server key. ,
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 ,
}
,
]
,
}
,
}
ServerKeys_Get (removed)
Description :  Gets a server key.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySql/flexibleServers/{serverName}/keys/{keyName}
{
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 ,
keyName:
{
Description: The name of the server key. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Kind of encryption protector used to protect the key. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the ServerKey Resource. ,
Required: False ,
}
{
serverKeyType:
{
Description: The key type like 'AzureKeyVault'. ,
Enum:
{
AzureKeyVault: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The URI of the key. ,
Required: False ,
}
string ,
creationDate:
{
Description: The key creation date. ,
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 ,
}
,
]
,
}
,
}
ServerKeys_ListByServer (removed)
Description :  Gets a list of Server keys.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySql/flexibleServers/{serverName}/keys
{
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: A list of MySQL Server keys. ,
Required: False ,
}
[
{
kind:
{
Description: Kind of encryption protector used to protect the key. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the ServerKey Resource. ,
Required: False ,
}
{
serverKeyType:
{
Description: The key type like 'AzureKeyVault'. ,
Enum:
{
AzureKeyVault: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The URI of the key. ,
Required: False ,
}
string ,
creationDate:
{
Description: The key creation date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
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 ,
}
,
}
,
}

⚐ 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 ,
}
,
}

⚐ 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 ,
}
,
}

⚐ 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 ,
}
,
}

⚐ 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 ,
}
,
}
,
]
,
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 ,
}
,
}
,
}

⚐ 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 ,
}
,
}

⚐ 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 ,
}
,
}

⚐ 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 ,
}
,
}

⚐ 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 ,
}
,
}
,
]
,
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. ,
Required: False ,
}
string ,
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 ,
}
,
}
,
}

⚐ 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. ,
Required: False ,
}
string ,
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 ,
}
,
}

⚐ 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. ,
Required: False ,
}
string ,
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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
ServerParameters_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 ,
value:
{
Description: The parameters for updating a list of server configuration. ,
Required: True ,
}
{
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. ,
Required: False ,
}
string ,
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 ,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
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. ,
Required: False ,
}
string ,
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 ,
}
,
}
,
]
,
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. ,
Required: False ,
}
string ,
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 ,
}
,
}
,
]
,
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 ,
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 in MB ,
Required: False ,
}
{
name:
{
Description: storage MB name ,
Required: False ,
}
string ,
storageSizeMB:
{
Description: storage size in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
maxStorageSize:
{
Description: The maximum supported storage size in MB ,
Required: False ,
}
{
name:
{
Description: storage MB name ,
Required: False ,
}
string ,
storageSizeMB:
{
Description: storage size in MB ,
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 ,
status:
{
Description: The status of the capability. ,
Required: False ,
}
string ,
}
,
]
,
supportedServerVersions:
{
Description: A list of supported server versions. ,
Required: False ,
}
[
{
name:
{
Description: server version ,
Required: False ,
}
string ,
supportedVcores:
{
Description: A list of supported Vcores ,
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 ,
status:
{
Description: The status of the capability. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the capability. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the capability. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the capability. ,
Required: False ,
}
string ,
}
,
]
,
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 ,
}
{
virtualNetworkArmResourceId:
{
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/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 ,
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 ,
}
,
]
,
}
,
}
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: The list of resource provider operations. ,
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. ,
Enum:
{
NotSpecified: No description available. ,
user: No description available. ,
system: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Additional descriptions for the operation. ,
Required: False ,
}
object ,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}