Get-SmaConnection

Gets an SMA connection.

Syntax

Get-SmaConnection [-AuthenticationType <String>] -ConnectionTypeName <String[]> [-Credential <PSCredential>]
 [-Port <Int32>] -WebServiceEndpoint <String> [<CommonParameters>]
Get-SmaConnection [-AuthenticationType <String>] [-Credential <PSCredential>] [-Name <String[]>]
 [-Port <Int32>] -WebServiceEndpoint <String> [<CommonParameters>]

Description

The Get-SmaConnection cmdlet gets one or more Service Management Automation (SMA) connections.

Examples

Example 1: Get a connection

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

This command gets the connection named MyConnection.

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
-ConnectionTypeName

Specifies an array of connection types.

Type:String[]
Required:True
Position:Named
Default value:None
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
-Name

Specifies an array of connection names.

Type:String[]
Aliases:ConnectionName
Required:False
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
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
-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