Get-SPServiceApplicationProxyGroup

Reference

Module:: SharePointServer

Applies to:: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Returns the proxy group for the specified service application.

Syntax

Get-SPServiceApplicationProxyGroup
   [[-Identity] <SPServiceApplicationProxyGroupPipeBind>]
   [-AssignmentCollection <SPAssignmentCollection>]
   [<CommonParameters>]

Get-SPServiceApplicationProxyGroup
   [-Default]
   [-AssignmentCollection <SPAssignmentCollection>]
   [<CommonParameters>]

Description

The Get-SPServiceApplicationProxyGroup cmdlet displays a list of the proxy groups in the farm. To display a specific proxy group, use the Identity parameter. If no parameter value is specified, a list of all proxy groups is displayed.

For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.

Examples

--------------EXAMPLE-----------------

Get-SPServiceApplicationProxyGroup

This example retrieves all of the service application proxy groups in the farm.

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.

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 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-Default

Returns the default service proxy group for the farm.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-Identity

Specifies the name or the GUID of the proxy group.

Type:	SPServiceApplicationProxyGroupPipeBind
Position:	1
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Share via