Get-WFWindowsCredential

Get-WFWindowsCredential

This cmdlet returns WFCredential required when using Windows authentication mode.

Syntax

Parameter Set: Default
Get-WFWindowsCredential [-Credential <PSCredential> ] [-Password <SecureString> ] [-UserName <String> ] [ <CommonParameters>]

Detailed Description

Run Get-WFWindowsCredential to return WFCredential required when using Windows authentication mode.

Parameters

-Credential<PSCredential>

Specifies the credential to use when connecting to the Workflow service. If not specified, then the currently logged in users Windows credentials are used to connect to the service.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Password<SecureString>

Specifies the password. Consider using the Read-Host cmdlet with the AsSecureString option to securely read the users password from the console.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-UserName<String>

The username of the user. Can be supplied as Domain\Username or Username@Domain.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

 

Returns WFCredential required when using Windows authentication mode.

PS C:\> $Password = Read-Host -assecurestring "Please enter your password"
Get-WFWindowsCredential -UserName Contoso\Bob -Password $Password