AzMySQLFailoverGroup Cmdlet
The AzMySQLFailoverGroup cmdlets let you create, manage, and monitor failover groups for Azure Database for MySQL servers.
Syntax
New-AzMySQLFailoverGroup
-Name <String>
-ResourceGroupName <String>
-ServerName <String>
-PartnerServer <String>
[-PartnerResourceGroupName <String>]
[-Location <String>]
[-ReadWriteEndpointFailoverPolicy <String>]
[-ReadOnlyEndpointFailoverPolicy <String>]
[-Tag <Hashtable>]
[]
Get-AzMySQLFailoverGroup
[-ResourceGroupName <String>]
[-ServerName <String>]
[-Name <String>]
[]
Remove-AzMySQLFailoverGroup
-Name <String>
-ResourceGroupName <String>
-ServerName <String>
[-Force]
[]
Set-AzMySQLFailoverGroup
-Name <String>
-ResourceGroupName <String>
-ServerName <String>
[-ReadWriteEndpointFailoverPolicy <String>]
[-ReadOnlyEndpointFailoverPolicy <String>]
[-Tag <Hashtable>]
[]
Parameters
| Parameter | Description |
|---|---|
-Name | Name of the failover group. |
-ResourceGroupName | Resource group containing the primary server. |
-ServerName | Primary MySQL server name. |
-PartnerServer | Secondary server that participates in the failover group. |
-ReadWriteEndpointFailoverPolicy | Policy for automatic failover of the read‑write endpoint. Possible values: Automatic, Manual. |
-ReadOnlyEndpointFailoverPolicy | Policy for the read‑only endpoint. Options: Enabled, Disabled. |
-Tag | Hashtable of tags to assign to the failover group. |
-Force | Suppresses confirmation prompts for removal. |
Example 1: Create a Failover Group
New-AzMySQLFailoverGroup `
-Name "MyFailoverGroup" `
-ResourceGroupName "ProdRG" `
-ServerName "myprimaryserver" `
-PartnerServer "mysecondaryserver" `
-ReadWriteEndpointFailoverPolicy Automatic `
-ReadOnlyEndpointFailoverPolicy Enabled
Example 2: Retrieve Failover Group Details
Get-AzMySQLFailoverGroup -ResourceGroupName "ProdRG" -ServerName "myprimaryserver" -Name "MyFailoverGroup"
Example 3: Update Failover Policy
Set-AzMySQLFailoverGroup `
-Name "MyFailoverGroup" `
-ResourceGroupName "ProdRG" `
-ServerName "myprimaryserver" `
-ReadWriteEndpointFailoverPolicy Manual