Export (0) Print
Expand All
Expand Minimize

Get-SPAuthenticationRealm

SharePoint 2013
 

Applies to: SharePoint Server 2013 Enterprise, SharePoint Foundation 2013

Topic Last Modified: 2013-12-18

Returns the authentication realm ID for the entire farm or for a specific site in a site subscription.

Get-SPAuthenticationRealm [[-ServiceContext] <SPServiceContextPipeBind>] [-AssignmentCollection <SPAssignmentCollection>]

Use the Get-SPAuthenticationRealm cmdlet to display the authentication realm ID of the farm or for a specific site in a site subscription. In environments where site subscriptions have been set up, you can use the –ServiceContext parameter and the full URL for a site in the site subscription to get the authentication realm ID for that site subscription. If you have not set up site subscriptions, the –ServiceContext parameter will have no effect and will return the farm authentication realm ID. By default, the farm authentication realm ID is the same as the farm ID.

 

Parameter Required Type Description

ServiceContext

Optional

Microsoft.SharePoint.PowerShell.SPServiceContextPipeBind

Specifies the full URL of a site in a site subscription for which the realm ID needs to be displayed.

NoteNote:
If the site specified in with the parameter is a part of a site subscription, then the cmdlet will return the authentication realm ID for the site subscription. Otherwise, the cmdlet will return the authentication realm ID for the farm.

AssignmentCollection

Optional

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

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.

NoteNote:
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.

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

Get-SPAuthenticationRealm

This example displays the authentication realm ID for the entire farm.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft