Edit

Share via


Get-SPConnectedServiceApplicationInformation

Returns the health of the service application proxy.

Syntax

Default (Default)

Get-SPConnectedServiceApplicationInformation
    [[-ServiceApplicationProxy] <SPServiceApplicationProxyPipeBind>]
    [-AssignmentCollection <SPAssignmentCollection>]
    [<CommonParameters>]

Description

The Get-SPConnectedServiceApplicationInformation cmdlet checks whether the proxy to a service application is in good health.

For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at Windows PowerShell for SharePoint Server 2016, SharePoint Server 2019 reference https://go.microsoft.com/fwlink/p/?LinkId=671715.

Examples

Example 1

$validProxy = $false
$proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq "User Profile Service Application Proxy"}
$proxyHealth = Get-SPConnectedServiceApplicationInformation -ServiceApplicationProxy $proxy
if(($proxyHealth -ne $null) -and ($proxyHealth.ApplicationAddressesState -eq "UpToDate")) {
        $validProxy = $true
    } else {
        $validProxy = $false
    }
$validProxy

This example checks the health of the service application proxy server.

Parameters

-AssignmentCollection

Applicable: SharePoint Server 2016, SharePoint Server 2019

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.

Parameter properties

Type:SPAssignmentCollection
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-ServiceApplicationProxy

Applicable: SharePoint Server 2016, SharePoint Server 2019

Specifies the name of the service application proxy.

Parameter properties

Type:SPServiceApplicationProxyPipeBind
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.SharePoint.PowerShell.SPServiceApplicationProxyPipeBind

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

Outputs

System.Object