Get-​Azure​Rm​Automation​Connection

Gets an Automation connection.

Syntax

Get-AzureRmAutomationConnection
   [-ResourceGroupName] <String>
   [-AutomationAccountName] <String>
   [-ConnectionTypeName] <String>
   [<CommonParameters>]
Get-AzureRmAutomationConnection
   [-ResourceGroupName] <String>
   [-AutomationAccountName] <String>
   [-Name] <String>
   [<CommonParameters>]

Description

The Get-AzureRmAutomationConnection cmdlet gets one or more Azure Automation connections. By default, this cmdlet retrieves all connections. Specify the name of a connection to get a specific connection. Specify the connection type name to get all connections of a specific type.

Examples

Example 1: Get all connections

PS C:\>Get-AzureRmAutomationConnection -ResourceGroupName "ResourceGroup01" -AutomationAccountName "Contoso17"

This command gets metadata for all connections in the Automation account named Contoso17.

Example 2: Get all connections of a type

PS C:\>Get-AzureRmAutomationConnection -ResourceGroupName "ResourceGroup01" -AutomationAccountName "Contoso17" -ConnectionTypeName "SqlServer"

This command gets metadata for connections in the Automation account named Contoso17. This command gets connections of the type SqlServer.

Example 3: Get a connection

PS C:\>Get-AzureRmAutomationConnection -ResourceGroupName "ResourceGroup01" -AutomationAccountName "Contoso17" -Name "ContosoConnection"

This command gets metadata for the connection named ContosoConnection.

Required Parameters

-AutomationAccountName

Specifies the name of the Automation account for which this cmdlet gets connections.

Type:String
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ConnectionTypeName

Specifies the name of a connection type for which this cmdlet retrieves connections.

Type:String
Position:3
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Name

Specifies the name of a connection that this cmdlet retrieves.

Type:String
Position:3
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceGroupName

Specifies the name of a resource group for which this cmdlet gets connections.

Type:String
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Outputs

Microsoft.Azure.Commands.Automation.Model.Connection