Set-SmaConnectionFieldValue

Applies To: System Center 2012 R2 Orchestrator, Windows Azure Pack for Windows Server

Set-SmaConnectionFieldValue

Modifies a connection field value for a connection object in Service Management Automation.

Syntax

Parameter Set: Default
Set-SmaConnectionFieldValue -ConnectionFieldName <String> -ConnectionName <String> -Value <Object> -WebServiceEndpoint <String> [-AuthenticationType <String> ] [-Credential <PSCredential> ] [-Force] [-Port <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Set-SmaConnectionFieldValue cmdlet modifies a connection field value for a connection object in Service Management Automation.

Parameters

-AuthenticationType<String>

Specifies the authentication type. Valid values are: Basic, Windows.

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

Aliases	none
Required?	false
Position?	named
Default Value	Windows
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-ConnectionFieldName<String>

Specifies the name of a connection field.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-ConnectionName<String>

Specifies the name of a connection.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Credential<PSCredential>

Specifies user credentials, as a PSCredential object, to use for the connection to the Service Management Automation web service. To obtain a credential object, use the Get-Credential cmdlet. For more information, type Get-Help Get-Credential.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Force

Modifies the connection field value without prompting you for confirmation. The cmdlet prompts you for confirmation before it proceeds if you attempt to pass a SecureString as the value for the Value parameter.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Port<Int32>

Specifies the port number of the Service Management Automation web service.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Value<Object>

Specifies a value for the connection field.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WebServiceEndpoint<String>

Specifies the endpoint, as a URL, of the Service Management Automation web service. Include the protocol, for example, http:// or https://.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Confirm

Prompts you for confirmation before executing the command.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WhatIf

Describes what would happen if you executed the command without actually executing the command.

Required?	false
Position?	named
Default Value	false
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

Example 1: Modify a connection field value

The first command converts the string provided into a secure string, and then stores the SecureString object in the $Password variable.

The second command modifies the connection field value named Password.

PS C:\> $Password = ConvertTo-SecureString -String "PassWord01!" -Force
PS C:\> Set-SmaConnectionFieldValue -WebServiceEndpoint "https://contoso.com/app01" -ConnectionName "MyConnection" -ConnectionFieldName "Password" -Value $Password