Replicas - List By Server

Reference

Service:: MySQL

API Version:: 2024-06-01-preview

List all the replicas for a given server.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/replicas?api-version=2024-06-01-preview

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
serverName	path	True	string	The name of the server. Regex pattern: `^[a-z0-9][-a-z0-9]*(?<!-)$`
subscriptionId	path	True	string uuid	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	ServerListResult	OK
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

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 replicas for a server

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/replicas?api-version=2024-06-01-preview

from azure.identity import DefaultAzureCredential

from azure.mgmt.mysqlflexibleservers import MySQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-mysqlflexibleservers
# USAGE
    python replicas_list_by_server.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = MySQLManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.replicas.list_by_server(
        resource_group_name="TestGroup",
        server_name="mysqltestserver",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-06-01-preview/examples/ReplicasListByServer.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "value": [
    {
      "sku": {
        "name": "Standard_D2ds_v4",
        "tier": "GeneralPurpose"
      },
      "properties": {
        "administratorLogin": "cloudsa",
        "storage": {
          "storageSizeGB": 20,
          "iops": 360,
          "autoGrow": "Enabled",
          "storageSku": "Premium_LRS"
        },
        "version": "5.7",
        "state": "Ready",
        "fullyQualifiedDomainName": "mysqltestserver-repl.orcabrci-seas1-a.mscds.com",
        "sourceServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver",
        "availabilityZone": "1",
        "maintenancePolicy": {
          "patchStrategy": "Regular"
        },
        "maintenanceWindow": {
          "customWindow": "Disabled",
          "dayOfWeek": 0,
          "startHour": 0,
          "startMinute": 0
        },
        "replicationRole": "Replica",
        "replicaCapacity": 0,
        "network": {
          "publicNetworkAccess": "Enabled"
        },
        "backup": {
          "backupRetentionDays": 7,
          "geoRedundantBackup": "Disabled",
          "earliestRestoreDate": "2021-06-24T08:19:18.00+00:00"
        },
        "highAvailability": {
          "mode": "Disabled",
          "state": "NotEnabled"
        }
      },
      "location": "Southeast Asia",
      "tags": {
        "num": "1"
      },
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver-repl",
      "name": "mysqltestserver-repl",
      "type": "Microsoft.DBforMySQL/flexibleServers"
    },
    {
      "sku": {
        "name": "Standard_D2ds_v4",
        "tier": "GeneralPurpose"
      },
      "properties": {
        "administratorLogin": "cloudsa",
        "storage": {
          "storageSizeGB": 20,
          "iops": 360,
          "autoGrow": "Enabled",
          "storageSku": "Premium_LRS"
        },
        "version": "5.7",
        "state": "Ready",
        "fullyQualifiedDomainName": "mysqltestserver-repl2.orcabrci-seas1-a.mscds.com",
        "sourceServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver",
        "availabilityZone": "1",
        "maintenancePolicy": {
          "patchStrategy": "Default"
        },
        "maintenanceWindow": {
          "customWindow": "Disabled",
          "dayOfWeek": 0,
          "startHour": 0,
          "startMinute": 0
        },
        "replicationRole": "Replica",
        "replicaCapacity": 0,
        "network": {
          "publicNetworkAccess": "Enabled"
        },
        "backup": {
          "backupRetentionDays": 7,
          "geoRedundantBackup": "Disabled",
          "earliestRestoreDate": "2021-06-23T08:19:18.00+00:00"
        },
        "highAvailability": {
          "mode": "Disabled",
          "state": "NotEnabled"
        }
      },
      "location": "Southeast Asia",
      "tags": {
        "num": "1"
      },
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver-repl2",
      "name": "mysqltestserver-repl",
      "type": "Microsoft.DBforMySQL/flexibleServers"
    }
  ]
}

Definitions

Name	Description
Backup	Storage Profile properties 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.
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	A list of servers.
ServerSkuTier	The tier of the particular SKU, e.g. GeneralPurpose.
ServerState	The state of a server.
ServerVersion	The version of a server.
Storage	Storage Profile properties of a server
StorageRedundancyEnum	Enum to indicate whether storage sku value is 'ZoneRedundancy' or 'LocalRedundancy'
systemData	Metadata pertaining to creation and last modification of the resource.

Backup

Storage Profile properties of a server

Name	Type	Default value	Description
backupIntervalHours	integer		Backup interval hours for the server.
backupRetentionDays	integer		Backup retention days for the server.
earliestRestoreDate	string		Earliest restore point creation time (ISO8601 format)
geoRedundantBackup	EnableStatusEnum	Disabled	Whether or not geo redundant backup is enabled.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CreateMode

The mode to create a new MySQL server.

Name	Type	Description
Default	string
GeoRestore	string
PointInTimeRestore	string
Replica	string

DataEncryption

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

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

Name	Type	Description
AzureKeyVault	string
SystemManaged	string

EnableStatusEnum

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

Name	Type	Description
Disabled	string
Enabled	string

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

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

Error response

Name	Type	Description
error	ErrorDetail	The error object.

HighAvailability

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

High availability mode for a server.

Name	Type	Description
Disabled	string
SameZone	string
ZoneRedundant	string

HighAvailabilityState

The state of server high availability.

Name	Type	Description
CreatingStandby	string
FailingOver	string
Healthy	string
NotEnabled	string
RemovingStandby	string

ImportSourceProperties

Import source related properties.

Name	Type	Description
dataDirPath	string	Relative path of data directory in storage.
sasToken	string	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

Storage type of import source.

Name	Type	Description
AzureBlob	string

MaintenancePolicy

Maintenance policy of a server.

Name	Type	Description
patchStrategy	PatchStrategy	The patch strategy of this server

MaintenanceWindow

Maintenance window of a server.

Name	Type	Description
customWindow	string	indicates whether custom window is enabled or disabled
dayOfWeek	integer	day of week for maintenance window
startHour	integer	start hour for maintenance window
startMinute	integer	start minute for maintenance window

ManagedServiceIdentityType

Type of managed service identity.

Name	Type	Description
UserAssigned	string

MySQLServerSku

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

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

Enum to indicate the patch strategy of a server

Name	Type	Description
Regular	string
VirtualCanary	string

PrivateEndpoint

The private endpoint resource.

Name	Type	Description
id	string	The ARM identifier for private endpoint.

PrivateEndpointConnection

The private endpoint connection resource.

Name	Type	Description
id	string	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

The current provisioning state.

Name	Type	Description
Creating	string
Deleting	string
Failed	string
Succeeded	string

PrivateEndpointServiceConnectionStatus

The private endpoint connection status.

Name	Type	Description
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

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

The replication role.

Name	Type	Description
None	string
Replica	string
Source	string

Server

Represents a server.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity.principalId	string	ObjectId from the KeyVault
identity.tenantId	string	TenantId from the KeyVault
identity.type	ManagedServiceIdentityType	Type of managed service identity.
identity.userAssignedIdentities	object	Metadata of user assigned identity.
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	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	The server database port. Can only be specified when the server is being created.
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	The maximum number of replicas that a primary server can have.
properties.replicationRole	ReplicationRole	The replication role.
properties.restorePointInTime	string	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	Server version.
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

A list of servers.

Name	Type	Description
nextLink	string	The link used to get the next page of operations.
value	Server[]	The list of servers

ServerSkuTier

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

Name	Type	Description
Burstable	string
GeneralPurpose	string
MemoryOptimized	string

ServerState

The state of a server.

Name	Type	Description
Disabled	string
Dropping	string
Ready	string
Starting	string
Stopped	string
Stopping	string
Updating	string

ServerVersion

The version of a server.

Name	Type	Description
5.7	string
8.0.21	string

Storage