Set-MsolADFSContext

Reference

Module:: MSOnline

Sets the context and credentials to connect to Microsoft Online and to the Active Directory Federation Services 2.0 server.

Syntax

Set-MsolADFSContext
   [-ADFSUserCredentials <PSCredential>]
   -Computer <String>
   [-LogFile <String>]
   [<CommonParameters>]

Description

The Set-MsolADFSContext cmdlet sets the credentials to connect to Microsoft Online and to the Active Directory Federation Services 2.0 (AD FS 2.0) server. This cmdlet must be run before running other single sign-on cmdlets. Single sign-on is also known as identity federation.

If you do not specify parameters for this cmdlet, you are prompted for credentials to connect to the different systems.

If the AD FS 2.0 server is used remotely, you must specify the computer name of the primary AD FS 2.0 server.

The specified logfile is shared by all single sign-on cmdlets for the session. A default logfile is created if one is not specified.

Parameters

-ADFSUserCredentials

Specifies the credential object used to establish the administrative session on the Active Directory Federation Services 2.0 server.

Type:	PSCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Computer

Specifies computer name of the primary AD FS 2.0 server. Specify this parameter if the AD FS 2.0 server is used remotely.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-LogFile

Specifies the log file used to log all single sign-on cmdlet operations for the Windows PowerShell session. If not specified, the Windows PowerShell module creates a log file in %USERPROFILE%\Documents\MicrosoftOnline.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False