Set-SmaCredential

Creates or updates a credential in SMA.

Syntax

Set-SmaCredential [-AuthenticationType <String>] [-Confirm] [-Credential <PSCredential>]
 [-Description <String>] -Name <String> [-Port <Int32>] -Value <PSCredential> -WebServiceEndpoint <String>
 [-WhatIf] [<CommonParameters>]

Description

The Set-SmaCredential cmdlet creates or updates a credential, as a PSCredential object, in Service Management Automation (SMA).

Examples

Example 1: Create a credential

PS C:\> $Creds = Get-Credential
PS C:\> Set-SmaCredential -WebServiceEndpoint "https://contoso.com/app01" -Name "MyCredential" -Value $Creds

The first command uses the Get-Credential cmdlet to create a credential object and then stores the object in the $Creds variable.

The second command uses the credentials stored in $Creds to create a credential named MyCredential.

Parameters

-AuthenticationType

Specifies the authentication type. Valid values are:

- Basic

  • Windows

    The default value for this parameter is Windows. If you use Basic authentication, you must provide credentials by using the Credential parameter.

Type:String
Parameter Sets:Basic, Windows
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Required:False
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-Credential

Specifies a PSCredential object for the connection to the SMA web service. To obtain a credential object, use the Get-Credential cmdlet. For more information, type Get-Help Get-Credential.

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

Provides a description for the credential object.

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

Specifies the name of a credential object.

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

Specifies the port number of the SMA web service.

Type:Int32
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Value

Specifies a PSCredential object.

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

Specifies the endpoint, as a URL, of the SMA web service. You must include the protocol, for example, http:// or https://.

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

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Required:False
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False