Gets the details of all of the Availability Groups for the given Cluster.

Syntax

Get-SqlMonitorAvailabilityGroup [[-Cluster] <Cluster>] [[-Name] <string>] [<CommonParameters>]

Description

The Get-SqlMonitorAvailabilityGroup cmdlet gets details of Availability Groups from a SQL Monitor Server.

Without parameters, this cmdlet gets details of all Availability Groups. You can specify a particular Availability group by name or a specific cluster to limit the result to.

Parameters

-Cluster <Cluster>

The Cluster to limit results to. For more information, see https://documentation.red-gate.com/sm/api/powershell-cmdlet-reference/get-sqlmonitorcluster.

-Name <String>

The Availability Group name to match.

-ProgressAction <ActionPreference>

{{ Fill ProgressAction Description }}

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see http://technet.microsoft.com/en-us/library/hh847884.aspx.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

• [Cluster] For more information, see https://www.red-gate.com/SM13/powershell-custom-types#CustomTypes-Cluster.

Return values

The output type is the type of the objects that the cmdlet emits.

• [AvailabilityGroup] For more information, see https://www.red-gate.com/SM13/powershell-custom-types#CustomTypes-AvailabilityGroup.

Examples

-------------------------- EXAMPLE 1 --------------------------

Get-SqlMonitorAvailabilityGroup

-------------------------- EXAMPLE 2 --------------------------

Get-SqlMonitorAvailabilityGroup -Cluster $cluster

-------------------------- EXAMPLE 3 --------------------------

Get-SqlMonitorAvailabilityGroup -Name "ExampleAvailabilityGroup"

-------------------------- EXAMPLE 4 --------------------------

Get-SqlMonitorAvailabilityGroup -Cluster $cluster -Name "ExampleAvailabilityGroup"