Edit

Share via

Get-AzureAutomationConnection

  • Reference
Module:
Azure

Gets an Azure Automation connection.

Note

The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.

The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.

Syntax

Get-AzureAutomationConnection
   -AutomationAccountName <String>
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]
Get-AzureAutomationConnection
   -Name <String>
   -AutomationAccountName <String>
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]
Get-AzureAutomationConnection
   -ConnectionTypeName <String>
   -AutomationAccountName <String>
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]

Description

Important

This PowerShell command for Azure Automation is longer supported as of 01/23/2020. The Azure Service Management model is deprecated for Azure Automation and was disabled on that date. Please use the commands which support the Azure Resource Management model in Az.Automation.

The Get-AzureAutomationConnection cmdlet gets one or more Microsoft Azure Automation connections. By default, all connections are returned. To get a specific connection, specify its name. To get all connections of a certain type, specify the connection type name.

Examples

Example 1: Get all connections

PS C:\> Get-AzureAutomationConnection -AutomationAccountName "Contoso17"

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

Example 2: Get all connections of a type

PS C:\> Get-AzureAutomationConnection -AutomationAccountName "Contoso17" -ConnectionTypeName "Azure"

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

Example 3: Get a connection

PS C:\> Get-AzureAutomationConnection -AutomationAccountName "Contoso17" -Name "Azure"

This command gets the connection named MyConnection.

Parameters

-AutomationAccountName

Specifies the name of the automation account with the connection to retrieve.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ConnectionTypeName

Specifies the name of a connection type for the connections to retrieve.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Specifies the name of a connection to retrieve.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Profile

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

Type:AzureSMProfile
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

Connection