Servers - List

Service:
MySQL
API Version:
2024-12-30

List all the servers in a given subscription.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/flexibleServers?api-version=2024-12-30

URI Parameters

Name In Required Type Description
subscriptionId
 path True

string (uuid)

The ID of the target subscription. The value must be an UUID.
api-version
 query True

string

minLength: 1

The API version to use for this operation.

Responses

Name Type Description
200 OK

ServerListResult

Azure operation completed successfully.
Other Status Codes

ErrorResponse

An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

List servers in a subscription

Sample request

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/flexibleServers?api-version=2024-12-30

Sample response

Status code:
200 
{
  "value": [
    {
      "name": "mysqltestserver1",
      "type": "Microsoft.DBforMySQL/flexibleServers",
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver1",
      "location": "Southeast Asia",
      "properties": {
        "administratorLogin": "cloudsa",
        "availabilityZone": "1",
        "backup": {
          "backupIntervalHours": 24,
          "backupRetentionDays": 7,
          "earliestRestoreDate": "2021-06-17T07:08:17.4259886+00:00",
          "geoRedundantBackup": "Disabled"
        },
        "databasePort": 3306,
        "fullVersion": "5.7.44",
        "fullyQualifiedDomainName": "mysqltestserver1.database.mysql.azure.com",
        "highAvailability": {
          "mode": "Disabled",
          "state": "NotEnabled"
        },
        "maintenancePolicy": {
          "patchStrategy": "Regular"
        },
        "maintenanceWindow": {
          "batchOfMaintenance": "Default",
          "customWindow": "Disabled",
          "dayOfWeek": 0,
          "startHour": 0,
          "startMinute": 0
        },
        "network": {
          "publicNetworkAccess": "Enabled"
        },
        "replicaCapacity": 10,
        "replicationRole": "None",
        "state": "Ready",
        "storage": {
          "autoGrow": "Enabled",
          "iops": 369,
          "storageRedundancy": "LocalRedundancy",
          "storageSizeGB": 23,
          "storageSku": "Premium_LRS"
        },
        "version": "5.7"
      },
      "sku": {
        "name": "Standard_B1ms",
        "tier": "Burstable"
      },
      "tags": {
        "num": "1"
      }
    },
    {
      "name": "mysqltestserver2",
      "type": "Microsoft.DBforMySQL/flexibleServers",
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup2/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver2",
      "location": "Southeast Asia",
      "properties": {
        "administratorLogin": "cloudsa",
        "availabilityZone": "2",
        "backup": {
          "backupIntervalHours": 24,
          "backupRetentionDays": 7,
          "earliestRestoreDate": "2021-06-17T07:08:17.4259886+00:00",
          "geoRedundantBackup": "Disabled"
        },
        "databasePort": 3306,
        "fullVersion": "5.7.44",
        "fullyQualifiedDomainName": "mysqltestserver2.mysql.database.azure.com",
        "highAvailability": {
          "mode": "Disabled",
          "state": "NotEnabled"
        },
        "maintenancePolicy": {
          "patchStrategy": "Default"
        },
        "maintenanceWindow": {
          "batchOfMaintenance": "Default",
          "customWindow": "Disabled",
          "dayOfWeek": 0,
          "startHour": 0,
          "startMinute": 0
        },
        "network": {
          "publicNetworkAccess": "Enabled"
        },
        "replicaCapacity": 10,
        "replicationRole": "None",
        "state": "Ready",
        "storage": {
          "autoGrow": "Enabled",
          "iops": 369,
          "storageRedundancy": "LocalRedundancy",
          "storageSizeGB": 23,
          "storageSku": "Premium_LRS"
        },
        "version": "5.7"
      },
      "sku": {
        "name": "Standard_D2ds_v4",
        "tier": "GeneralPurpose"
      },
      "tags": {
        "num": "1"
      }
    },
    {
      "name": "mysqltestserver3",
      "type": "Microsoft.DBforMySQL/flexibleServers",
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup3/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver3",
      "location": "Southeast Asia",
      "properties": {
        "administratorLogin": "cloudsa",
        "availabilityZone": "1",
        "backup": {
          "backupIntervalHours": 24,
          "backupRetentionDays": 7,
          "earliestRestoreDate": "2021-06-24T06:28:19.0611667+00:00",
          "geoRedundantBackup": "Disabled"
        },
        "databasePort": 3306,
        "fullVersion": "5.7.44",
        "fullyQualifiedDomainName": "mysqltestserver3.mysql.database.azure.com",
        "highAvailability": {
          "mode": "Disabled",
          "state": "NotEnabled"
        },
        "maintenancePolicy": {
          "patchStrategy": "Default"
        },
        "maintenanceWindow": {
          "batchOfMaintenance": "Default",
          "customWindow": "Disabled",
          "dayOfWeek": 0,
          "startHour": 0,
          "startMinute": 0
        },
        "network": {
          "publicNetworkAccess": "Enabled"
        },
        "replicaCapacity": 10,
        "replicationRole": "None",
        "state": "Ready",
        "storage": {
          "autoGrow": "Enabled",
          "iops": 600,
          "storageRedundancy": "ZoneRedundancy",
          "storageSizeGB": 100,
          "storageSku": "Premium_ZRS"
        },
        "version": "5.7"
      },
      "sku": {
        "name": "Standard_E2ds_v4",
        "tier": "MemoryOptimized"
      },
      "tags": {
        "num": "1"
      }
    }
  ]
}

Definitions

Name Description
Backup

Storage Profile properties of a server
BatchOfMaintenance

The batch of maintenance when enabled the custom managed maintenance window of a server.
createdByType

The type of identity that created the resource.
CreateMode

The mode to create a new MySQL server.
DataEncryption

The date encryption for cmk.
DataEncryptionType

The key type, AzureKeyVault for enable cmk, SystemManaged for disable cmk.
EnableStatusEnum

Enum to indicate whether value is 'Enabled' or 'Disabled'
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response
HighAvailability

High availability properties of a server
HighAvailabilityMode

High availability mode for a server.
HighAvailabilityState

The state of server high availability.
ImportSourceProperties

Import source related properties.
ImportSourceStorageType

Storage type of import source.
MaintenancePolicy

Maintenance policy of a server.
MaintenanceWindow

Maintenance window of a server.
ManagedServiceIdentityType

Type of managed service identity.
MySQLServerIdentity

Properties to configure Identity for Bring your Own Keys
MySQLServerSku

Billing information related properties of a server.
Network

Network related properties of a server
PatchStrategy

Enum to indicate the patch strategy of a server
PrivateEndpoint

The private endpoint resource.
PrivateEndpointConnection

The private endpoint connection resource.
PrivateEndpointConnectionProvisioningState

The current provisioning state.
PrivateEndpointServiceConnectionStatus

The private endpoint connection status.
PrivateLinkServiceConnectionState

A collection of information about the state of the connection between service consumer and provider.
ReplicationRole

The replication role.
Server

Represents a server.
ServerListResult

The response of a Server list operation.
ServerSkuTier

The tier of the particular SKU, e.g. GeneralPurpose.
ServerState

The state of a server.
ServerVersion

The major version of a server. 8.0.21 stands for MySQL 8.0, 5.7.44 stands for MySQL 5.7
Storage

Storage Profile properties of a server
StorageRedundancyEnum

The redundant type of the server storage. The parameter is used for server creation.
systemData

Metadata pertaining to creation and last modification of the resource.
UserAssignedIdentity

Metadata of user assigned identity.

Backup

Object

Storage Profile properties of a server

Name Type Default value Description
backupIntervalHours

integer (int32)

Backup interval hours for the server.
backupRetentionDays

integer (int32)

Backup retention days for the server.
earliestRestoreDate

string (date-time)

Earliest restore point creation time (ISO8601 format)
geoRedundantBackup

EnableStatusEnum

Disabled

Whether or not geo redundant backup is enabled.

BatchOfMaintenance

Enumeration

The batch of maintenance when enabled the custom managed maintenance window of a server.

Value Description
Default
Batch1
Batch2

createdByType

Enumeration

The type of identity that created the resource.

Value Description
User
Application
ManagedIdentity
Key

CreateMode

Enumeration

The mode to create a new MySQL server.

Value Description
Default
PointInTimeRestore
Replica
GeoRestore

DataEncryption

Object

The date encryption for cmk.

Name Type Description
geoBackupKeyURI

string

Geo backup key uri as key vault can't cross region, need cmk in same region as geo backup
geoBackupUserAssignedIdentityId

string

Geo backup user identity resource id as identity can't cross region, need identity in same region as geo backup
primaryKeyURI

string

Primary key uri
primaryUserAssignedIdentityId

string

Primary user identity resource id
type

DataEncryptionType

The key type, AzureKeyVault for enable cmk, SystemManaged for disable cmk.

DataEncryptionType

Enumeration

The key type, AzureKeyVault for enable cmk, SystemManaged for disable cmk.

Value Description
AzureKeyVault
SystemManaged

EnableStatusEnum

Enumeration

Enum to indicate whether value is 'Enabled' or 'Disabled'

Value Description
Enabled
Disabled

ErrorAdditionalInfo

Object

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorDetail

Object

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

The error code.
details

ErrorDetail[]

The error details.
message

string

The error message.
target

string

The error target.

ErrorResponse

Object

Error response

Name Type Description
error

ErrorDetail

The error object.

HighAvailability

Object

High availability properties of a server

Name Type Description
mode

HighAvailabilityMode

High availability mode for a server.
standbyAvailabilityZone

string

Availability zone of the standby server.
state

HighAvailabilityState

The state of server high availability.

HighAvailabilityMode

Enumeration

High availability mode for a server.

Value Description
Disabled
ZoneRedundant
SameZone

HighAvailabilityState

Enumeration

The state of server high availability.

Value Description
NotEnabled
CreatingStandby
Healthy
FailingOver
RemovingStandby

ImportSourceProperties

Object

Import source related properties.

Name Type Description
dataDirPath

string

Relative path of data directory in storage.
sasToken

string (password)

Sas token for accessing source storage. Read and list permissions are required for sas token.
storageType

ImportSourceStorageType

Storage type of import source.
storageUrl

string

Uri of the import source storage.

ImportSourceStorageType

Enumeration

Storage type of import source.

Value Description
AzureBlob

MaintenancePolicy

Object

Maintenance policy of a server.

Name Type Description
patchStrategy

PatchStrategy

The patch strategy of this server

MaintenanceWindow

Object

Maintenance window of a server.

Name Type Description
batchOfMaintenance

BatchOfMaintenance

The batch of maintenance when enabled the custom managed maintenance window of a server.
customWindow

string

indicates whether custom window is enabled or disabled
dayOfWeek

integer (int32)

day of week for maintenance window
startHour

integer (int32)

start hour for maintenance window
startMinute

integer (int32)

start minute for maintenance window

ManagedServiceIdentityType

Enumeration

Type of managed service identity.

Value Description
UserAssigned

MySQLServerIdentity

Object

Properties to configure Identity for Bring your Own Keys

Name Type Description
principalId

string

ObjectId from the KeyVault
tenantId

string

TenantId from the KeyVault
type

ManagedServiceIdentityType

Type of managed service identity.
userAssignedIdentities

<string,  UserAssignedIdentity>

Metadata of user assigned identity.

MySQLServerSku

Object

Billing information related properties of a server.

Name Type Description
name

string

The name of the sku, e.g. Standard_D32s_v3.
tier

ServerSkuTier

The tier of the particular SKU, e.g. GeneralPurpose.

Network

Object

Network related properties of a server

Name Type Description
delegatedSubnetResourceId

string

Delegated subnet resource id used to setup vnet for a server.
privateDnsZoneResourceId

string

Private DNS zone resource id.
publicNetworkAccess

EnableStatusEnum

Whether or not public network access is allowed for this server. Value is 'Disabled' when server has VNet integration.

PatchStrategy

Enumeration

Enum to indicate the patch strategy of a server

Value Description
Regular
VirtualCanary

PrivateEndpoint

Object

The private endpoint resource.

Name Type Description
id

string

The ARM identifier for private endpoint.

PrivateEndpointConnection

Object

The private endpoint connection resource.

Name Type Description
id

string (arm-id)

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name

string

The name of the resource
properties.groupIds

string[]

The group ids for the private endpoint resource.
properties.privateEndpoint

PrivateEndpoint

The private endpoint resource.
properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

A collection of information about the state of the connection between service consumer and provider.
properties.provisioningState

PrivateEndpointConnectionProvisioningState

The provisioning state of the private endpoint connection resource.
systemData

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.
type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Enumeration

The current provisioning state.

Value Description
Succeeded
Creating
Deleting
Failed

PrivateEndpointServiceConnectionStatus

Enumeration

The private endpoint connection status.

Value Description
Pending
Approved
Rejected

PrivateLinkServiceConnectionState

Object

A collection of information about the state of the connection between service consumer and provider.

Name Type Description
actionsRequired

string

A message indicating if changes on the service provider require any updates on the consumer.
description

string

The reason for approval/rejection of the connection.
status

PrivateEndpointServiceConnectionStatus

Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

ReplicationRole

Enumeration

The replication role.

Value Description
None
Source
Replica

Server

Object

Represents a server.

Name Type Description
id

string (arm-id)

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity

MySQLServerIdentity

The cmk identity for the server.
location

string

The geo-location where the resource lives
name

string

The name of the resource
properties.administratorLogin

string

The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation).
properties.administratorLoginPassword

string (password)

The password of the administrator login (required for server creation).
properties.availabilityZone

string

availability Zone information of the server.
properties.backup

Backup

Backup related properties of a server.
properties.createMode

CreateMode

The mode to create a new MySQL server.
properties.dataEncryption

DataEncryption

The Data Encryption for CMK.
properties.databasePort

integer (int32)

The server database port. Can only be specified when the server is being created.
properties.fullVersion

string

Major version and actual engine version
properties.fullyQualifiedDomainName

string

The fully qualified domain name of a server.
properties.highAvailability

HighAvailability

High availability related properties of a server.
properties.importSourceProperties

ImportSourceProperties

Source properties for import from storage.
properties.maintenancePolicy

MaintenancePolicy

Maintenance policy of a server.
properties.maintenanceWindow

MaintenanceWindow

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.
properties.network

Network

Network related properties of a server.
properties.privateEndpointConnections

PrivateEndpointConnection[]

PrivateEndpointConnections related properties of a server.
properties.replicaCapacity

integer (int32)

minimum: 0

The maximum number of replicas that a primary server can have.
properties.replicationRole

ReplicationRole

The replication role.
properties.restorePointInTime

string (date-time)

Restore point creation time (ISO8601 format), specifying the time to restore from.
properties.sourceServerResourceId

string

The source MySQL server id.
properties.state

ServerState

The state of a server.
properties.storage

Storage

Storage related properties of a server.
properties.version

ServerVersion

Major version of MySQL. 8.0.21 stands for MySQL 8.0, 5.7.44 stands for MySQL 5.7
sku

MySQLServerSku

The SKU (pricing tier) of the server.
systemData

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags

object

Resource tags.
type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ServerListResult

Object

The response of a Server list operation.

Name Type Description
nextLink

string (uri)

The link to the next page of items
value

Server[]

The Server items on this page

ServerSkuTier

Enumeration

The tier of the particular SKU, e.g. GeneralPurpose.

Value Description
Burstable
GeneralPurpose
MemoryOptimized

ServerState

Enumeration

The state of a server.

Value Description
Ready
Dropping
Disabled
Starting
Stopping
Stopped
Updating

ServerVersion

Enumeration

The major version of a server. 8.0.21 stands for MySQL 8.0, 5.7.44 stands for MySQL 5.7

Value Description
5.7
8.0.21

Storage

Object

Storage Profile properties of a server

Name Type Default value Description
autoGrow

EnableStatusEnum

Disabled

Enable Storage Auto Grow or not.
autoIoScaling

EnableStatusEnum

Enabled

Enable IO Auto Scaling or not.
iops

integer (int32)

Storage IOPS for a server.
logOnDisk

EnableStatusEnum

Disabled

Enable Log On Disk or not.
storageRedundancy

StorageRedundancyEnum

LocalRedundancy

The redundant type of the server storage. The parameter is used for server creation.
storageSizeGB

integer (int32)

Max storage size allowed for a server.
storageSku

string

The sku name of the server storage.

StorageRedundancyEnum

Enumeration

The redundant type of the server storage. The parameter is used for server creation.

Value Description
LocalRedundancy
ZoneRedundancy

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string (date-time)

The timestamp of resource creation (UTC).
createdBy

string

The identity that created the resource.
createdByType

createdByType

The type of identity that created the resource.
lastModifiedAt

string (date-time)

The timestamp of resource last modification (UTC)
lastModifiedBy

string

The identity that last modified the resource.
lastModifiedByType

createdByType

The type of identity that last modified the resource.

UserAssignedIdentity

Object

Metadata of user assigned identity.

Name Type Description
clientId

string

Client Id of user assigned identity
principalId

string

Principal Id of user assigned identity