Share via


Get-SmaVariable

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

Get-SmaVariable

Gets a Service Management Automation variable.

Syntax

Parameter Set: Default
Get-SmaVariable -WebServiceEndpoint <String> [-AuthenticationType <String> ] [-Credential <PSCredential> ] [-Name <String[]> ] [-Port <Int32> ] [ <CommonParameters>]

Detailed Description

The Get-SmaVariable cmdlet gets one or more Service Management Automation variables. Specify the web service endpoint and, if necessary, a port number. By default, all variables are returned. To get a specific variable, specify its name.

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

-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

-Name<String[]>

Specifies the name of a variable.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

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

-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

<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: Get a variable

This command gets the variable named Variable83 from the specified web service endpoint.

PS C:\> Get-SmaVariable -WebServiceEndpoint "https://contoso.com/app01" -Name "Variable83"

Remove-SmaVariable

Set-SmaVariable