Get-SPAvailabilityGroupStatus

Reference

Module:: sharepoint-server

Applies to:: SharePoint Server Subscription Edition

Returns one or more objects representing the availability groups known to the SharePoint farm.

Syntax

Get-SPAvailabilityGroupStatus
   [-AssignmentCollection <SPAssignmentCollection>]
   [-Identity <String>]
   [<CommonParameters>]

Description

Returns one or more objects representing the availability groups known to the SharePoint farm.

Examples

------------Example 1 -----------

Get-SPAvailabilityGroupStatus -Identity MyAvailabilityGroup

This example returns an availability group named "MyAvailabilityGroup".

Parameters

-AssignmentCollection

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

NOTE: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

Type:	SPAssignmentCollection
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-Identity

Finds the availability group whose name property matches this string. Otherwise, returns all availability groups.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

Inputs

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

Outputs

System.Object