Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. automation
  5. getConnection
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.automation.getConnection

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

Retrieve the connection identified by connection name.

Uses Azure REST API version 2023-11-01.

Other available API versions: 2015-10-31, 2019-06-01, 2020-01-13-preview, 2022-08-08, 2023-05-15-preview, 2024-10-23. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native automation [ApiVersion]. See the version guide for details.

Using getConnection

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getConnection(args: GetConnectionArgs, opts?: InvokeOptions): Promise<GetConnectionResult>
function getConnectionOutput(args: GetConnectionOutputArgs, opts?: InvokeOptions): Output<GetConnectionResult>
Copy
def get_connection(automation_account_name: Optional[str] = None,
                   connection_name: Optional[str] = None,
                   resource_group_name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetConnectionResult
def get_connection_output(automation_account_name: Optional[pulumi.Input[str]] = None,
                   connection_name: Optional[pulumi.Input[str]] = None,
                   resource_group_name: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetConnectionResult]
Copy
func LookupConnection(ctx *Context, args *LookupConnectionArgs, opts ...InvokeOption) (*LookupConnectionResult, error)
func LookupConnectionOutput(ctx *Context, args *LookupConnectionOutputArgs, opts ...InvokeOption) LookupConnectionResultOutput
Copy

> Note: This function is named LookupConnection in the Go SDK.

public static class GetConnection 
{
    public static Task<GetConnectionResult> InvokeAsync(GetConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetConnectionResult> Invoke(GetConnectionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetConnectionResult> getConnection(GetConnectionArgs args, InvokeOptions options)
public static Output<GetConnectionResult> getConnection(GetConnectionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:automation:getConnection
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AutomationAccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the automation account.
ConnectionName
This property is required.
Changes to this property will trigger replacement.
string
The name of connection.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of an Azure Resource group.
AutomationAccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the automation account.
ConnectionName
This property is required.
Changes to this property will trigger replacement.
string
The name of connection.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of an Azure Resource group.
automationAccountName
This property is required.
Changes to this property will trigger replacement.
String
The name of the automation account.
connectionName
This property is required.
Changes to this property will trigger replacement.
String
The name of connection.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of an Azure Resource group.
automationAccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the automation account.
connectionName
This property is required.
Changes to this property will trigger replacement.
string
The name of connection.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of an Azure Resource group.
automation_account_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the automation account.
connection_name
This property is required.
Changes to this property will trigger replacement.
str
The name of connection.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of an Azure Resource group.
automationAccountName
This property is required.
Changes to this property will trigger replacement.
String
The name of the automation account.
connectionName
This property is required.
Changes to this property will trigger replacement.
String
The name of connection.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of an Azure Resource group.

getConnection Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
CreationTime string
Gets the creation time.
FieldDefinitionValues Dictionary<string, string>
Gets the field definition values of the connection.
Id string
Fully qualified resource Id for the resource
LastModifiedTime string
Gets the last modified time.
Name string
The name of the resource
Type string
The type of the resource.
ConnectionType Pulumi.AzureNative.Automation.Outputs.ConnectionTypeAssociationPropertyResponse
Gets or sets the connectionType of the connection.
Description string
Gets or sets the description.
AzureApiVersion string
The Azure API version of the resource.
CreationTime string
Gets the creation time.
FieldDefinitionValues map[string]string
Gets the field definition values of the connection.
Id string
Fully qualified resource Id for the resource
LastModifiedTime string
Gets the last modified time.
Name string
The name of the resource
Type string
The type of the resource.
ConnectionType ConnectionTypeAssociationPropertyResponse
Gets or sets the connectionType of the connection.
Description string
Gets or sets the description.
azureApiVersion String
The Azure API version of the resource.
creationTime String
Gets the creation time.
fieldDefinitionValues Map<String,String>
Gets the field definition values of the connection.
id String
Fully qualified resource Id for the resource
lastModifiedTime String
Gets the last modified time.
name String
The name of the resource
type String
The type of the resource.
connectionType ConnectionTypeAssociationPropertyResponse
Gets or sets the connectionType of the connection.
description String
Gets or sets the description.
azureApiVersion string
The Azure API version of the resource.
creationTime string
Gets the creation time.
fieldDefinitionValues {[key: string]: string}
Gets the field definition values of the connection.
id string
Fully qualified resource Id for the resource
lastModifiedTime string
Gets the last modified time.
name string
The name of the resource
type string
The type of the resource.
connectionType ConnectionTypeAssociationPropertyResponse
Gets or sets the connectionType of the connection.
description string
Gets or sets the description.
azure_api_version str
The Azure API version of the resource.
creation_time str
Gets the creation time.
field_definition_values Mapping[str, str]
Gets the field definition values of the connection.
id str
Fully qualified resource Id for the resource
last_modified_time str
Gets the last modified time.
name str
The name of the resource
type str
The type of the resource.
connection_type ConnectionTypeAssociationPropertyResponse
Gets or sets the connectionType of the connection.
description str
Gets or sets the description.
azureApiVersion String
The Azure API version of the resource.
creationTime String
Gets the creation time.
fieldDefinitionValues Map<String>
Gets the field definition values of the connection.
id String
Fully qualified resource Id for the resource
lastModifiedTime String
Gets the last modified time.
name String
The name of the resource
type String
The type of the resource.
connectionType Property Map
Gets or sets the connectionType of the connection.
description String
Gets or sets the description.

Supporting Types

ConnectionTypeAssociationPropertyResponse

Name string
Gets or sets the name of the connection type.
Name string
Gets or sets the name of the connection type.
name String
Gets or sets the name of the connection type.
name string
Gets or sets the name of the connection type.
name str
Gets or sets the name of the connection type.
name String
Gets or sets the name of the connection type.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native