Get-SmaVariable
Gets an SMA variable.
Syntax
Get-SmaVariable
[-Name <String[]>]
-WebServiceEndpoint <String>
[-Port <Int32>]
[-AuthenticationType <String>]
[-Credential <PSCredential>]
[<CommonParameters>]
Description
The Get-SmaVariable cmdlet gets one or more Service Management Automation (SMA) 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.
Examples
Example 1: Get a variable
PS C:\> Get-SmaVariable -WebServiceEndpoint "https://contoso.com/app01" -Name "Variable83"
This command gets the variable named Variable83 from the specified web service endpoint.
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 |
Accepted values: | Basic, Windows |
Position: | Named |
Default value: | None |
Required: | 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 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
Specifies the name of a variable.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Port
Specifies the port number of the SMA web service.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
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 |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |