< Back

Get-AzureRmSqlDatabaseFailoverGroup

Tue Jan 29, 2019 10:08 pm

NAME Get-AzureRmSqlDatabaseFailoverGroup



SYNOPSIS

Gets or lists Azure SQL Database Failover Groups.





SYNTAX

Get-AzureRmSqlDatabaseFailoverGroup [-ResourceGroupName] <String> [-ServerName] <String> [[-FailoverGroupName] <String>] [-DefaultProfile

<IAzureContextContainer>] [<CommonParameters>]





DESCRIPTION

Gets a specific Azure SQL Database Failover Group or lists the Failover Groups on a server.



Either server in the Failover Group may be used to execute the command. The returned values will reflect the state of the specified server with

respect to the Failover Group.





PARAMETERS

-DefaultProfile <IAzureContextContainer>

The credentials, account, tenant, and subscription used for communication with azure



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-FailoverGroupName <String>

The name of the Azure SQL Database Failover Group to retrieve.



Required? false

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceGroupName <String>

The name of the resource group.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ServerName <String>

The name of the Azure SQL Database Server from which to retrieve the Failover Group.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

System.String







OUTPUTS

System.Object







NOTES









Example 1



PS C:\\> $failoverGroups = Get-AzureRMSqlDatabaseFailoverGroup -ResourceGroupName rg -ServerName server



Lists all Failover Groups on a server.





Example 2



PS C:\\> $failoverGroup = Get-AzureRMSqlDatabaseFailoverGroup -ResourceGroupName rg -ServerName server -FailoverGroupName fg



Get a specific Failover Group.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... lovergroup

New-AzureRmSqlDatabaseFailoverGroup

Set-AzureRmSqlDatabaseFailoverGroup

Add-AzureRmSqlDatabaseToFailoverGroup

Remove-AzureRmSqlDatabaseFromFailoverGroup

Switch-AzureRmSqlDatabaseFailoverGroup

Remove-AzureRmSqlDatabaseFailoverGroup

SQL Database Documentation https://docs.microsoft.com/azure/sql-database/