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

2025/06/19 • 64 new methods

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AdvancedThreatProtectionSettings_Update (new)
Description :  Updates a server's Advanced Threat Protection state.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (202)

{
location:
{
Description: URL to retrieve the final result after operation completes. ,
}
string ,
azure-asyncoperation:
{
Description: URL to query for status of the operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AdvancedThreatProtectionSettings_UpdatePut (new)
Description :  Updates a server's Advanced Threat Protection state.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (201)

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

⚐ Response (202)

{
location:
{
Description: URL to retrieve the final result after operation completes. ,
}
string ,
azure-asyncoperation:
{
Description: URL to query for status of the operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AdvancedThreatProtectionSettings_List (new)
Description :  Gets a list of server's Advanced Threat Protection states.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AzureADAdministrators_CreateOrUpdate (new)
Description :  Creates or updates an existing Azure Active Directory administrator.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/administrators/{administratorName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
administratorName:
{
Description: The name of the Azure AD Administrator. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for creating or updating an aad administrator. ,
Required: True ,
}
{
properties:
{
Description: The properties of an administrator. ,
Required: False ,
}
{
administratorType:
{
Description: Type of the sever administrator. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
login:
{
Description: Login name of the server administrator. ,
Required: False ,
}
string ,
sid:
{
Description: SID (object ID) of the server administrator. ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID of the administrator. ,
Required: False ,
}
string ,
identityResourceId:
{
Description: The resource id of the identity used for AAD Authentication. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an administrator. ,
Required: False ,
}
{
administratorType:
{
Description: Type of the sever administrator. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
login:
{
Description: Login name of the server administrator. ,
Required: False ,
}
string ,
sid:
{
Description: SID (object ID) of the server administrator. ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID of the administrator. ,
Required: False ,
}
string ,
identityResourceId:
{
Description: The resource id of the identity used for AAD Authentication. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of an administrator. ,
Required: False ,
}
{
administratorType:
{
Description: Type of the sever administrator. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
login:
{
Description: Login name of the server administrator. ,
Required: False ,
}
string ,
sid:
{
Description: SID (object ID) of the server administrator. ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID of the administrator. ,
Required: False ,
}
string ,
identityResourceId:
{
Description: The resource id of the identity used for AAD Authentication. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AzureADAdministrators_Delete (new)
Description :  Deletes an Azure AD Administrator.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AzureADAdministrators_Get (new)
Description :  Gets information about an azure ad administrator.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The properties of an administrator. ,
Required: False ,
}
{
administratorType:
{
Description: Type of the sever administrator. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
login:
{
Description: Login name of the server administrator. ,
Required: False ,
}
string ,
sid:
{
Description: SID (object ID) of the server administrator. ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID of the administrator. ,
Required: False ,
}
string ,
identityResourceId:
{
Description: The resource id of the identity used for AAD Authentication. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AzureADAdministrators_ListByServer (new)
Description :  List all the AAD administrators in a given server.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of azure ad administrator of a server ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an administrator. ,
Required: False ,
}
{
administratorType:
{
Description: Type of the sever administrator. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
login:
{
Description: Login name of the server administrator. ,
Required: False ,
}
string ,
sid:
{
Description: SID (object ID) of the server administrator. ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID of the administrator. ,
Required: False ,
}
string ,
identityResourceId:
{
Description: The resource id of the identity used for AAD Authentication. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BackupAndExport_Create (new)
Description :  Exports the backup of the given server by creating a backup if not existing.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/backupAndExport
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for creating and exporting backup of the given server. ,
Required: True ,
}
{
targetDetails:
{
Description: Backup Target Store Details ,
Required: True ,
}
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
status:
{
Description: The operation status ,
Enum:
{
Pending: The operation has been accepted but hasn't started. ,
InProgress: The operation is running ,
Succeeded: The operation Succeeded ,
Failed: The operation Failed ,
CancelInProgress: The cancellation in progress ,
Canceled: The operation has been Canceled ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time ,
Format: date-time ,
Required: False ,
}
string ,
percentComplete:
{
Description: Operation progress (0-100). ,
Format: double ,
Required: False ,
}
number ,
properties:
{
Description: The response properties of a backup and export operation. ,
Required: False ,
}
{
datasourceSizeInBytes:
{
Description: Size of datasource in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
dataTransferredInBytes:
{
Description: Data transferred in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
backupMetadata:
{
Description: Metadata related to backup to be stored for restoring resource in key-value pairs. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: URL to retrieve the final result after operation completes. ,
}
string ,
azure-asyncoperation:
{
Description: URL to query for status of the operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BackupAndExport_ValidateBackup (new)
Description :  Validates if backup can be performed for given server.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The response properties of a pre backup operation. ,
Required: False ,
}
{
numberOfContainers:
{
Description: Estimated no of storage containers required for resource data to be backed up. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Backups_Put (new)
Description :  Create backup for a given server with specified backup name.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The properties of a server backup. ,
Required: False ,
}
{
backupType:
{
Description: Backup type. ,
Required: False ,
}
string ,
completedTime:
{
Description: Backup completed time (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Backup source ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The properties of a server backup. ,
Required: False ,
}
{
backupType:
{
Description: Backup type. ,
Required: False ,
}
string ,
completedTime:
{
Description: Backup completed time (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Backup source ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of backups of a server. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a server backup. ,
Required: False ,
}
{
backupType:
{
Description: Backup type. ,
Required: False ,
}
string ,
completedTime:
{
Description: Backup completed time (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Backup source ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Configurations_CreateOrUpdate (new)
Description :  Updates a configuration of a server.
Reference :  Link ¶

⚼ Request

PUT:  /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. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
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 ,
currentValue:
{
Description: Current value of the configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description of the configuration. ,
Required: False ,
}
string ,
documentationLink:
{
Description: The link used to get the document from community or Azure site. ,
Required: False ,
}
string ,
defaultValue:
{
Description: Default value of the configuration. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the configuration. ,
Required: False ,
}
string ,
allowedValues:
{
Description: Allowed values of the configuration. ,
Required: False ,
}
string ,
source:
{
Description: Source of the configuration. ,
Enum:
{
system-default: No description available. ,
user-override: No description available. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: If is the configuration read only. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
isConfigPendingRestart:
{
Description: If is the configuration pending restart or not. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
isDynamicConfig:
{
Description: If is the configuration dynamic. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a configuration. ,
Required: False ,
}
{
value:
{
Description: Value of the configuration. ,
Required: False ,
}
string ,
currentValue:
{
Description: Current value of the configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description of the configuration. ,
Required: False ,
}
string ,
documentationLink:
{
Description: The link used to get the document from community or Azure site. ,
Required: False ,
}
string ,
defaultValue:
{
Description: Default value of the configuration. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the configuration. ,
Required: False ,
}
string ,
allowedValues:
{
Description: Allowed values of the configuration. ,
Required: False ,
}
string ,
source:
{
Description: Source of the configuration. ,
Enum:
{
system-default: No description available. ,
user-override: No description available. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: If is the configuration read only. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
isConfigPendingRestart:
{
Description: If is the configuration pending restart or not. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
isDynamicConfig:
{
Description: If is the configuration dynamic. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
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 ,
currentValue:
{
Description: Current value of the configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description of the configuration. ,
Required: False ,
}
string ,
documentationLink:
{
Description: The link used to get the document from community or Azure site. ,
Required: False ,
}
string ,
defaultValue:
{
Description: Default value of the configuration. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the configuration. ,
Required: False ,
}
string ,
allowedValues:
{
Description: Allowed values of the configuration. ,
Required: False ,
}
string ,
source:
{
Description: Source of the configuration. ,
Enum:
{
system-default: No description available. ,
user-override: No description available. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: If is the configuration read only. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
isConfigPendingRestart:
{
Description: If is the configuration pending restart or not. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
isDynamicConfig:
{
Description: If is the configuration dynamic. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a configuration. ,
Required: False ,
}
{
value:
{
Description: Value of the configuration. ,
Required: False ,
}
string ,
currentValue:
{
Description: Current value of the configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description of the configuration. ,
Required: False ,
}
string ,
documentationLink:
{
Description: The link used to get the document from community or Azure site. ,
Required: False ,
}
string ,
defaultValue:
{
Description: Default value of the configuration. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the configuration. ,
Required: False ,
}
string ,
allowedValues:
{
Description: Allowed values of the configuration. ,
Required: False ,
}
string ,
source:
{
Description: Source of the configuration. ,
Enum:
{
system-default: No description available. ,
user-override: No description available. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: If is the configuration read only. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
isConfigPendingRestart:
{
Description: If is the configuration pending restart or not. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
isDynamicConfig:
{
Description: If is the configuration dynamic. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
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 ,
currentValue:
{
Description: Current value of the configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description of the configuration. ,
Required: False ,
}
string ,
documentationLink:
{
Description: The link used to get the document from community or Azure site. ,
Required: False ,
}
string ,
defaultValue:
{
Description: Default value of the configuration. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the configuration. ,
Required: False ,
}
string ,
allowedValues:
{
Description: Allowed values of the configuration. ,
Required: False ,
}
string ,
source:
{
Description: Source of the configuration. ,
Enum:
{
system-default: No description available. ,
user-override: No description available. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: If is the configuration read only. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
isConfigPendingRestart:
{
Description: If is the configuration pending restart or not. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
isDynamicConfig:
{
Description: If is the configuration dynamic. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Configurations_BatchUpdate (new)
Description :  Update a list of configurations in a given server.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/updateConfigurations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters for updating a list of server configuration. ,
Required: True ,
}
{
value:
{
Description: The list of server configurations. ,
Required: False ,
}
[
{
name:
{
Description: Name of the configuration. ,
Required: False ,
}
string ,
properties:
{
Description: The properties can be updated for a configuration. ,
Required: False ,
}
{
value:
{
Description: Value of the configuration. ,
Required: False ,
}
string ,
source:
{
Description: Source of the configuration. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resetAllToDefault:
{
Description: Whether to reset all server parameters to default. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 ,
currentValue:
{
Description: Current value of the configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description of the configuration. ,
Required: False ,
}
string ,
documentationLink:
{
Description: The link used to get the document from community or Azure site. ,
Required: False ,
}
string ,
defaultValue:
{
Description: Default value of the configuration. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the configuration. ,
Required: False ,
}
string ,
allowedValues:
{
Description: Allowed values of the configuration. ,
Required: False ,
}
string ,
source:
{
Description: Source of the configuration. ,
Enum:
{
system-default: No description available. ,
user-override: No description available. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: If is the configuration read only. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
isConfigPendingRestart:
{
Description: If is the configuration pending restart or not. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
isDynamicConfig:
{
Description: If is the configuration dynamic. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
tags:
{
Description: The tags of the server configuration. ,
Required: False ,
}
string ,
keyword:
{
Description: The keyword of the server configuration. ,
Required: False ,
}
string ,
page:
{
Description: The page of the server configuration. ,
Format: int32 ,
Required: False ,
}
integer ,
pageSize:
{
Description: The pageSize of the server configuration. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ 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 ,
currentValue:
{
Description: Current value of the configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description of the configuration. ,
Required: False ,
}
string ,
documentationLink:
{
Description: The link used to get the document from community or Azure site. ,
Required: False ,
}
string ,
defaultValue:
{
Description: Default value of the configuration. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the configuration. ,
Required: False ,
}
string ,
allowedValues:
{
Description: Allowed values of the configuration. ,
Required: False ,
}
string ,
source:
{
Description: Source of the configuration. ,
Enum:
{
system-default: No description available. ,
user-override: No description available. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: If is the configuration read only. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
isConfigPendingRestart:
{
Description: If is the configuration pending restart or not. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
isDynamicConfig:
{
Description: If is the configuration dynamic. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
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 error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
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 error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of 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 error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
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 error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
firewallRuleName:
{
Description: The name of the server firewall rule. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
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 error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of 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 error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Servers_Create (new)
Description :  Creates a new server or updates an existing server. The update action will overwrite the existing server.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (201)

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

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Servers_Delete (new)
Description :  Deletes a server.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Servers_Failover (new)
Description :  Manual failover a server.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Servers_ValidateEstimateHighAvailability (new)
Description :  Validate a deployment of high availability.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/validateEstimateHighAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for validation of high availability deployment. ,
Required: True ,
}
{
estimatedDowntime:
{
Description: Estimated seconds of downtime for the deployment. ,
Format: int32 ,
Required: False ,
}
integer ,
scheduledStandbyAvailabilityZone:
{
Description: Scheduled Availability zone of the standby server. ,
Required: False ,
}
string ,
expectedStandbyAvailabilityZone:
{
Description: Expected Availability zone of the standby server. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
estimatedDowntime:
{
Description: Estimated seconds of downtime for the deployment. ,
Format: int32 ,
Required: False ,
}
integer ,
scheduledStandbyAvailabilityZone:
{
Description: Scheduled Availability zone of the standby server. ,
Required: False ,
}
string ,
expectedStandbyAvailabilityZone:
{
Description: Expected Availability zone of the standby server. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Servers_Restart (new)
Description :  Restarts a server.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/restart
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for restarting a server. ,
Required: True ,
}
{
restartWithFailover:
{
Description: Whether or not failover to standby server when restarting a server with high availability enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
maxFailoverSeconds:
{
Description: The maximum allowed failover time in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Servers_Start (new)
Description :  Starts a server.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Servers_Stop (new)
Description :  Stops a server.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Servers_ResetGtid (new)
Description :  Resets GTID on a server.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (202)

{
location:
{
Description: URL to retrieve the final result after operation completes. ,
}
string ,
azure-asyncoperation:
{
Description: URL to query for status of the operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LogFiles_ListByServer (new)
Description :  List all the server log files in a given server.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of logFiles in a server ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a logFile. ,
Required: False ,
}
{
sizeInKB:
{
Description: The size in kb of the logFile. ,
Format: int64 ,
Required: False ,
}
integer ,
createdTime:
{
Description: Creation timestamp of the log file. ,
Format: date-time ,
Required: False ,
}
string ,
type:
{
Description: Type of the log file. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Last modified timestamp of the log file. ,
Format: date-time ,
Required: False ,
}
string ,
url:
{
Description: The url to download the log file from. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LongRunningBackup_Create (new)
Description :  Create backup for a given server with specified backup name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/backupsV2/{backupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
backupName:
{
Description: The name of the backup. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for creating and exporting backup of the given server. ,
Required: False ,
}
{
properties:
{
Description: The properties of a server backup. ,
Required: False ,
}
{
backupNameV2:
{
Description: Backup name ,
Required: False ,
}
string ,
backupType:
{
Enum:
{
FULL: No description available. ,
}
,
Required: False ,
}
enum ,
completedTime:
{
Description: Backup completed time (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Backup source ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of backup resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a server backup. ,
Required: False ,
}
{
backupNameV2:
{
Description: Backup name ,
Required: False ,
}
string ,
backupType:
{
Enum:
{
FULL: No description available. ,
}
,
Required: False ,
}
enum ,
completedTime:
{
Description: Backup completed time (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Backup source ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of backup resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of a server backup. ,
Required: False ,
}
{
backupNameV2:
{
Description: Backup name ,
Required: False ,
}
string ,
backupType:
{
Enum:
{
FULL: No description available. ,
}
,
Required: False ,
}
enum ,
completedTime:
{
Description: Backup completed time (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Backup source ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of backup resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: URL to retrieve the final result after operation completes. ,
}
string ,
azure-asyncoperation:
{
Description: URL to query for status of the operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LongRunningBackups_Get (new)
Description :  Get backup for a given server.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The properties of a server backup. ,
Required: False ,
}
{
backupNameV2:
{
Description: Backup name ,
Required: False ,
}
string ,
backupType:
{
Enum:
{
FULL: No description available. ,
}
,
Required: False ,
}
enum ,
completedTime:
{
Description: Backup completed time (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Backup source ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of backup resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of backups of a server. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a server backup. ,
Required: False ,
}
{
backupNameV2:
{
Description: Backup name ,
Required: False ,
}
string ,
backupType:
{
Enum:
{
FULL: No description available. ,
}
,
Required: False ,
}
enum ,
completedTime:
{
Description: Backup completed time (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Backup source ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of backup resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: 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 error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Maintenances_Read (new)
Description :  Read maintenance.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The properties of a maintenance ,
Required: True ,
}
{
maintenanceType:
{
Description: A string defines maintenance type. ,
Enum:
{
RoutineMaintenance: No description available. ,
MinorVersionUpgrade: No description available. ,
SecurityPatches: No description available. ,
HotFixes: No description available. ,
}
,
Required: False ,
}
enum ,
maintenanceState:
{
Description: A string describes the maintenance status ,
Enum:
{
Scheduled: No description available. ,
ReScheduled: No description available. ,
InPreparation: No description available. ,
Processing: No description available. ,
Completed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
maintenanceStartTime:
{
Description: The start time for a maintenance. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceEndTime:
{
Description: The end time for a maintenance. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceExecutionStartTime:
{
Description: The start time for a maintenance execution. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceExecutionEndTime:
{
Description: The end time for a maintenance execution. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceAvailableScheduleMinTime:
{
Description: The min time the maintenance can be rescheduled. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceAvailableScheduleMaxTime:
{
Description: The max time the maintenance can be rescheduled. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceTitle:
{
Description: The maintenance title. ,
Required: False ,
}
string ,
maintenanceDescription:
{
Description: The maintenance description. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Maintenance. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Maintenances_Update (new)
Description :  Update maintenances.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/maintenances/{maintenanceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
maintenanceName:
{
Description: The name of the maintenance. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for update maintenance on a server. ,
Required: False ,
}
{
properties:
{
Description: The properties of a maintenance update parameter ,
Required: False ,
}
{
maintenanceStartTime:
{
Description: The start time for a maintenance. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a maintenance ,
Required: True ,
}
{
maintenanceType:
{
Description: A string defines maintenance type. ,
Enum:
{
RoutineMaintenance: No description available. ,
MinorVersionUpgrade: No description available. ,
SecurityPatches: No description available. ,
HotFixes: No description available. ,
}
,
Required: False ,
}
enum ,
maintenanceState:
{
Description: A string describes the maintenance status ,
Enum:
{
Scheduled: No description available. ,
ReScheduled: No description available. ,
InPreparation: No description available. ,
Processing: No description available. ,
Completed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
maintenanceStartTime:
{
Description: The start time for a maintenance. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceEndTime:
{
Description: The end time for a maintenance. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceExecutionStartTime:
{
Description: The start time for a maintenance execution. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceExecutionEndTime:
{
Description: The end time for a maintenance execution. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceAvailableScheduleMinTime:
{
Description: The min time the maintenance can be rescheduled. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceAvailableScheduleMaxTime:
{
Description: The max time the maintenance can be rescheduled. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceTitle:
{
Description: The maintenance title. ,
Required: False ,
}
string ,
maintenanceDescription:
{
Description: The maintenance description. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Maintenance. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Maintenances_List (new)
Description :  List maintenances.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of maintenances in a server. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a maintenance ,
Required: True ,
}
{
maintenanceType:
{
Description: A string defines maintenance type. ,
Enum:
{
RoutineMaintenance: No description available. ,
MinorVersionUpgrade: No description available. ,
SecurityPatches: No description available. ,
HotFixes: No description available. ,
}
,
Required: False ,
}
enum ,
maintenanceState:
{
Description: A string describes the maintenance status ,
Enum:
{
Scheduled: No description available. ,
ReScheduled: No description available. ,
InPreparation: No description available. ,
Processing: No description available. ,
Completed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
maintenanceStartTime:
{
Description: The start time for a maintenance. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceEndTime:
{
Description: The end time for a maintenance. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceExecutionStartTime:
{
Description: The start time for a maintenance execution. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceExecutionEndTime:
{
Description: The end time for a maintenance execution. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceAvailableScheduleMinTime:
{
Description: The min time the maintenance can be rescheduled. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceAvailableScheduleMaxTime:
{
Description: The max time the maintenance can be rescheduled. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceTitle:
{
Description: The maintenance title. ,
Required: False ,
}
string ,
maintenanceDescription:
{
Description: The maintenance description. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Maintenance. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: 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 error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Get (new)
Description :  Gets a private endpoint connection.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_CreateOrUpdate (new)
Description :  Approve or reject a private endpoint connection with a given name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/privateEndpointConnections/{privateEndpointConnectionName}
{
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 ,
privateEndpointConnectionName:
{
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Delete (new)
Description :  Deletes a private endpoint connection with a given name.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_ListByServer (new)
Description :  Gets all private endpoint connections on a server.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Array of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkResources_ListByServer (new)
Description :  Lists the private link resources for MySQL server.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Array of private link resources ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkResources_Get (new)
Description :  Gets a private link resource for MySQL server.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
locationName:
{
Description: The name of the location. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LocationBasedCapabilitySet_List (new)
Description :  Get capabilities at specified location in a given subscription.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: A list of supported capability sets. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a location capability set. ,
Required: False ,
}
{
supportedGeoBackupRegions:
{
Description: supported geo backup regions ,
Required: False ,
}
[
string ,
]
,
supportedFlexibleServerEditions:
{
Description: A list of supported flexible server editions. ,
Required: False ,
}
[
{
name:
{
Description: Server edition name ,
Required: False ,
}
string ,
defaultSku:
{
Description: Default Sku name ,
Required: False ,
}
string ,
defaultStorageSize:
{
Description: Default storage size ,
Format: int32 ,
Required: False ,
}
integer ,
supportedStorageEditions:
{
Description: A list of supported storage editions ,
Required: False ,
}
[
{
name:
{
Description: storage edition name ,
Required: False ,
}
string ,
minStorageSize:
{
Description: The minimal supported storage size. ,
Format: int64 ,
Required: False ,
}
integer ,
maxStorageSize:
{
Description: The maximum supported storage size. ,
Format: int64 ,
Required: False ,
}
integer ,
minBackupRetentionDays:
{
Description: Minimal backup retention days ,
Format: int64 ,
Required: False ,
}
integer ,
maxBackupRetentionDays:
{
Description: Maximum backup retention days ,
Format: int64 ,
Required: False ,
}
integer ,
minBackupIntervalHours:
{
Description: Minimal backup interval hours ,
Format: int64 ,
Required: False ,
}
integer ,
maxBackupIntervalHours:
{
Description: Maximum backup interval hours ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
supportedSkus:
{
Description: A list of supported Skus ,
Required: False ,
}
[
{
name:
{
Description: vCore name ,
Required: False ,
}
string ,
vCores:
{
Description: supported vCores ,
Format: int64 ,
Required: False ,
}
integer ,
supportedIops:
{
Description: supported IOPS ,
Format: int64 ,
Required: False ,
}
integer ,
supportedMemoryPerVCoreMB:
{
Description: supported memory per vCore in MB ,
Format: int64 ,
Required: False ,
}
integer ,
supportedZones:
{
Description: Supported zones ,
Required: False ,
}
[
string ,
]
,
supportedHAMode:
{
Description: Supported high availability mode ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
supportedServerVersions:
{
Description: A list of supported server versions. ,
Required: False ,
}
[
{
name:
{
Description: server version ,
Required: False ,
}
string ,
}
,
]
,
supportedFeatures:
{
Description: A list of supported features. ,
Required: False ,
}
[
{
featureName:
{
Description: feature name ,
Required: False ,
}
string ,
featureValue:
{
Description: feature value ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LocationBasedCapabilitySet_Get (new)
Description :  Get capabilities at specified location in a given subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/locations/{locationName}/capabilitySets/{capabilitySetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
locationName:
{
Description: The name of the location. ,
Required: True ,
}
string ,
capabilitySetName:
{
Description: Name of capability set ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a location capability set. ,
Required: False ,
}
{
supportedGeoBackupRegions:
{
Description: supported geo backup regions ,
Required: False ,
}
[
string ,
]
,
supportedFlexibleServerEditions:
{
Description: A list of supported flexible server editions. ,
Required: False ,
}
[
{
name:
{
Description: Server edition name ,
Required: False ,
}
string ,
defaultSku:
{
Description: Default Sku name ,
Required: False ,
}
string ,
defaultStorageSize:
{
Description: Default storage size ,
Format: int32 ,
Required: False ,
}
integer ,
supportedStorageEditions:
{
Description: A list of supported storage editions ,
Required: False ,
}
[
{
name:
{
Description: storage edition name ,
Required: False ,
}
string ,
minStorageSize:
{
Description: The minimal supported storage size. ,
Format: int64 ,
Required: False ,
}
integer ,
maxStorageSize:
{
Description: The maximum supported storage size. ,
Format: int64 ,
Required: False ,
}
integer ,
minBackupRetentionDays:
{
Description: Minimal backup retention days ,
Format: int64 ,
Required: False ,
}
integer ,
maxBackupRetentionDays:
{
Description: Maximum backup retention days ,
Format: int64 ,
Required: False ,
}
integer ,
minBackupIntervalHours:
{
Description: Minimal backup interval hours ,
Format: int64 ,
Required: False ,
}
integer ,
maxBackupIntervalHours:
{
Description: Maximum backup interval hours ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
supportedSkus:
{
Description: A list of supported Skus ,
Required: False ,
}
[
{
name:
{
Description: vCore name ,
Required: False ,
}
string ,
vCores:
{
Description: supported vCores ,
Format: int64 ,
Required: False ,
}
integer ,
supportedIops:
{
Description: supported IOPS ,
Format: int64 ,
Required: False ,
}
integer ,
supportedMemoryPerVCoreMB:
{
Description: supported memory per vCore in MB ,
Format: int64 ,
Required: False ,
}
integer ,
supportedZones:
{
Description: Supported zones ,
Required: False ,
}
[
string ,
]
,
supportedHAMode:
{
Description: Supported high availability mode ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
supportedServerVersions:
{
Description: A list of supported server versions. ,
Required: False ,
}
[
{
name:
{
Description: server version ,
Required: False ,
}
string ,
}
,
]
,
supportedFeatures:
{
Description: A list of supported features. ,
Required: False ,
}
[
{
featureName:
{
Description: feature name ,
Required: False ,
}
string ,
featureValue:
{
Description: feature value ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
locationName:
{
Description: The name of the location. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for creating or updating a server. ,
Required: True ,
}
{
virtualNetworkResourceId:
{
Description: Virtual network resource id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
location:
{
Description: The location name. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription id. ,
Required: False ,
}
string ,
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 error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CheckNameAvailability_Execute (new)
Description :  Check the availability of name for server
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CheckNameAvailabilityWithoutLocation_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. The value must be an UUID. ,
Format: uuid ,
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 error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OperationResults_Get (new)
Description :  Get the operation result for a long running operation.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The extended properties of Operation Results ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OperationProgress_Get (new)
Description :  Get the operation result for a long running operation.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The response properties specific to the operation ,
Required: False ,
}
{
objectType:
{
Description: Identifies the type of source operation ,
Enum:
{
BackupAndExportResponse: No description available. ,
ImportFromStorageResponse: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GetPrivateDnsZoneSuffix_Execute (new)
Description :  Get private DNS zone suffix in the cloud.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  Lists all of the available REST API operations.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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