az mysql flexible-server replica

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Manage read replicas.

Commands

az mysql flexible-server replica create	Create a read replica for a server.
az mysql flexible-server replica list	List all read replicas for a given server.
az mysql flexible-server replica stop-replication	Stop replication to a read replica and make it a read/write server.

az mysql flexible-server replica create

Create a read replica for a server.

az mysql flexible-server replica create --replica-name
                                        --resource-group
                                        --source-server
                                        [--no-wait]
                                        [--zone]

Examples

Create a read replica 'testReplicaServer' for 'testserver' in the specified zone if available.

az mysql flexible-server replica create --replica-name testReplicaServer -g testGroup --source-server testserver --zone 3

Required Parameters

--replica-name

The name of the server to restore to.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--source-server

The name or resource ID of the source server to restore from.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

--zone -z

Availability zone into which to provision the resource.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az mysql flexible-server replica list

List all read replicas for a given server.

az mysql flexible-server replica list --name
                                      --resource-group

Examples

List all read replicas for master server 'testserver'.

az mysql flexible-server replica list -g testGroup -n primaryservername

Required Parameters

--name -n

Name of the source server.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az mysql flexible-server replica stop-replication

Stop replication to a read replica and make it a read/write server.

az mysql flexible-server replica stop-replication [--ids]
                                                  [--name]
                                                  [--resource-group]
                                                  [--yes]

Examples

Stop replication to 'testReplicaServer' and make it a read/write server.

az mysql flexible-server replica stop-replication -g testGroup -n testReplicaServer

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of the server. The name can contain only lowercase letters, numbers, and the hyphen (-) character. Minimum 3 characters and maximum 63 characters.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--yes -y

Do not prompt for confirmation.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.