< Back
Get-AzureRmAutomationConnection
Post
NAME Get-AzureRmAutomationConnection
SYNOPSIS
Gets an Automation connection.
SYNTAX
Get-AzureRmAutomationConnection [-ResourceGroupName] <String> [-AutomationAccountName] <String> [-ConnectionTypeName] <String> [-DefaultProfile
<IAzureContextContainer>] [<CommonParameters>]
Get-AzureRmAutomationConnection [-ResourceGroupName] <String> [-AutomationAccountName] <String> [-Name] <String> [-DefaultProfile
<IAzureContextContainer>] [<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.
PARAMETERS
-AutomationAccountName <String>
Specifies the name of the Automation account for which this cmdlet gets connections.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ConnectionTypeName <String>
Specifies the name of a connection type for which this cmdlet retrieves connections.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of a connection that this cmdlet retrieves.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of a resource group for which this cmdlet gets connections.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commands.Automation.Model.Connection
NOTES
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... connection
New-AzureRmAutomationConnection
Remove-AzureRmAutomationConnection
SYNOPSIS
Gets an Automation connection.
SYNTAX
Get-AzureRmAutomationConnection [-ResourceGroupName] <String> [-AutomationAccountName] <String> [-ConnectionTypeName] <String> [-DefaultProfile
<IAzureContextContainer>] [<CommonParameters>]
Get-AzureRmAutomationConnection [-ResourceGroupName] <String> [-AutomationAccountName] <String> [-Name] <String> [-DefaultProfile
<IAzureContextContainer>] [<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.
PARAMETERS
-AutomationAccountName <String>
Specifies the name of the Automation account for which this cmdlet gets connections.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ConnectionTypeName <String>
Specifies the name of a connection type for which this cmdlet retrieves connections.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of a connection that this cmdlet retrieves.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of a resource group for which this cmdlet gets connections.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commands.Automation.Model.Connection
NOTES
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... connection
New-AzureRmAutomationConnection
Remove-AzureRmAutomationConnection