Connect-StaffHub

The `Connect-StaffHub` cmdlet connects an authenticated account to use for Microsoft StaffHub cmdlet requests. You can use this authenticated account only with Microsoft StaffHub cmdlets.

Note: The cmdlet is currently in Beta.

Syntax

Connect-StaffHub
       [[-Credentials] <PSCredential>]
       [[-LogLocation] <String>]
       [[-LogHistoryInDays] <Int32>]
       [[-CultureInfo] <String>]

Description

The Connect-StaffHub cmdlet connects an authenticated account. This cmdlet authenticates a user for Staff Hub. You can use this authenticated account only with Microsoft StaffHub cmdlets.

Examples

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

Connect-StaffHub -Credentials $mycreds

LogIn the session with the specified credential.

-------------------------- Example 2 --------------------------

Connect-StaffHub

Prompts to enter credentials and then Log in.

Parameters

-Credentials

PSCredential object of the credential. Eg: $secpasswd = ConvertTo-SecureString "password" -AsPlainText -Force $mycreds = New-Object System.Management.Automation.PSCredential ("username", $secpasswd)

Type:PSCredential
Position:0
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Microsoft StaffHub
-CultureInfo

CultureInfo in which the message is to be displayed.

Type:String
Position:3
Default value:en-US
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Microsoft StaffHub
-LogHistoryInDays

Number of days the logs are to be persisted. Default value is 10 days.

Type:Int32
Position:2
Default value:10
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Microsoft StaffHub
-LogLocation

Location where the logs are to be persisted in user's box.

Type:String
Position:1
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Microsoft StaffHub

Inputs

None

Outputs

System.Object

Notes

The cmdlet is currently in Beta.