Get-RedgateMonitorAvailabilityGroup
Published 18 April 2024
Gets the details of all of the Availability Groups for the given Cluster.
Syntax
Get-RedgateMonitorAvailabilityGroup [[-Cluster] <Cluster>] [[-Name] <string>] [<CommonParameters>]
Description
The Get-RedgateMonitorAvailabilityGroup cmdlet gets details of Availability Groups from a Redgate 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.
| Aliases | None |
| Required? | false |
| Position? | 1 |
| Default Value | None |
| Accept Pipeline Input | True (ByValue) |
| Accept Wildcard Characters | false |
-Name
<String>
The Availability Group name to match.
| Aliases | None |
| Required? | false |
| Position? | 2 |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-ProgressAction
<ActionPreference>
{{ Fill ProgressAction Description }}
| Aliases | None |
| Required? | false |
| Position? | named |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
<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/monitor14/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/monitor14/powershell-custom-types#CustomTypes-AvailabilityGroup.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-RedgateMonitorAvailabilityGroup
-------------------------- EXAMPLE 2 --------------------------
Get-RedgateMonitorAvailabilityGroup -Cluster $cluster
-------------------------- EXAMPLE 3 --------------------------
Get-RedgateMonitorAvailabilityGroup -Name "ExampleAvailabilityGroup"
-------------------------- EXAMPLE 4 --------------------------
Get-RedgateMonitorAvailabilityGroup -Cluster $cluster -Name "ExampleAvailabilityGroup"
