published on Friday, Mar 20, 2026 by Pulumi
published on Friday, Mar 20, 2026 by Pulumi
Retrieve the connection identified by connection name.
Uses Azure REST API version 2024-10-23.
Other available API versions: 2015-10-31, 2019-06-01, 2020-01-13-preview, 2022-08-08, 2023-05-15-preview, 2023-11-01. 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>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]func LookupConnection(ctx *Context, args *LookupConnectionArgs, opts ...InvokeOption) (*LookupConnectionResult, error)
func LookupConnectionOutput(ctx *Context, args *LookupConnectionOutputArgs, opts ...InvokeOption) LookupConnectionResultOutput> 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)
}public static CompletableFuture<GetConnectionResult> getConnection(GetConnectionArgs args, InvokeOptions options)
public static Output<GetConnectionResult> getConnection(GetConnectionArgs args, InvokeOptions options)
fn::invoke:
function: azure-native:automation:getConnection
arguments:
# arguments dictionaryThe following arguments are supported:
- Automation
Account stringName - The name of the automation account.
- Connection
Name string - The name of connection.
- Resource
Group stringName - Name of an Azure Resource group.
- Automation
Account stringName - The name of the automation account.
- Connection
Name string - The name of connection.
- Resource
Group stringName - Name of an Azure Resource group.
- automation
Account StringName - The name of the automation account.
- connection
Name String - The name of connection.
- resource
Group StringName - Name of an Azure Resource group.
- automation
Account stringName - The name of the automation account.
- connection
Name string - The name of connection.
- resource
Group stringName - Name of an Azure Resource group.
- automation_
account_ strname - The name of the automation account.
- connection_
name str - The name of connection.
- resource_
group_ strname - Name of an Azure Resource group.
- automation
Account StringName - The name of the automation account.
- connection
Name String - The name of connection.
- resource
Group StringName - Name of an Azure Resource group.
getConnection Result
The following output properties are available:
- Azure
Api stringVersion - The Azure API version of the resource.
- Creation
Time string - Gets the creation time.
- Field
Definition Dictionary<string, string>Values - Gets the field definition values of the connection.
- Id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- Last
Modified stringTime - Gets the last modified time.
- Name string
- The name of the resource
- System
Data Pulumi.Azure Native. Automation. Outputs. System Data Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Connection
Type Pulumi.Azure Native. Automation. Outputs. Connection Type Association Property Response - Gets or sets the connectionType of the connection.
- Description string
- Gets or sets the description.
- Azure
Api stringVersion - The Azure API version of the resource.
- Creation
Time string - Gets the creation time.
- Field
Definition map[string]stringValues - Gets the field definition values of the connection.
- Id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- Last
Modified stringTime - Gets the last modified time.
- Name string
- The name of the resource
- System
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Connection
Type ConnectionType Association Property Response - Gets or sets the connectionType of the connection.
- Description string
- Gets or sets the description.
- azure
Api StringVersion - The Azure API version of the resource.
- creation
Time String - Gets the creation time.
- field
Definition Map<String,String>Values - Gets the field definition values of the connection.
- id String
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- last
Modified StringTime - Gets the last modified time.
- name String
- The name of the resource
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- connection
Type ConnectionType Association Property Response - Gets or sets the connectionType of the connection.
- description String
- Gets or sets the description.
- azure
Api stringVersion - The Azure API version of the resource.
- creation
Time string - Gets the creation time.
- field
Definition {[key: string]: string}Values - Gets the field definition values of the connection.
- id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- last
Modified stringTime - Gets the last modified time.
- name string
- The name of the resource
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- connection
Type ConnectionType Association Property Response - Gets or sets the connectionType of the connection.
- description string
- Gets or sets the description.
- azure_
api_ strversion - The Azure API version of the resource.
- creation_
time str - Gets the creation time.
- field_
definition_ Mapping[str, str]values - Gets the field definition values of the connection.
- id str
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- last_
modified_ strtime - Gets the last modified time.
- name str
- The name of the resource
- system_
data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- connection_
type ConnectionType Association Property Response - Gets or sets the connectionType of the connection.
- description str
- Gets or sets the description.
- azure
Api StringVersion - The Azure API version of the resource.
- creation
Time String - Gets the creation time.
- field
Definition Map<String>Values - Gets the field definition values of the connection.
- id String
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- last
Modified StringTime - Gets the last modified time.
- name String
- The name of the resource
- system
Data Property Map - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- connection
Type 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.
SystemDataResponse
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - The type of identity that last modified the resource.
- created_
at str - The timestamp of resource creation (UTC).
- created_
by str - The identity that created the resource.
- created_
by_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
published on Friday, Mar 20, 2026 by Pulumi
