Azure Classic v5.43.0, May 6 23

azure.automation.Connection

Explore with Pulumi AI

Manages an Automation Connection.

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
    {
        Location = "West Europe",
    });

    var exampleClientConfig = Azure.Core.GetClientConfig.Invoke();

    var exampleAccount = new Azure.Automation.Account("exampleAccount", new()
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        SkuName = "Basic",
    });

    var exampleConnection = new Azure.Automation.Connection("exampleConnection", new()
    {
        ResourceGroupName = exampleResourceGroup.Name,
        AutomationAccountName = exampleAccount.Name,
        Type = "AzureServicePrincipal",
        Values = 
        {
            { "ApplicationId", "00000000-0000-0000-0000-000000000000" },
            { "TenantId", exampleClientConfig.Apply(getClientConfigResult => getClientConfigResult.TenantId) },
            { "SubscriptionId", exampleClientConfig.Apply(getClientConfigResult => getClientConfigResult.SubscriptionId) },
            { "CertificateThumbprint", "sample-certificate-thumbprint" },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/automation"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleClientConfig, err := core.GetClientConfig(ctx, nil, nil)
		if err != nil {
			return err
		}
		exampleAccount, err := automation.NewAccount(ctx, "exampleAccount", &automation.AccountArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
			SkuName:           pulumi.String("Basic"),
		})
		if err != nil {
			return err
		}
		_, err = automation.NewConnection(ctx, "exampleConnection", &automation.ConnectionArgs{
			ResourceGroupName:     exampleResourceGroup.Name,
			AutomationAccountName: exampleAccount.Name,
			Type:                  pulumi.String("AzureServicePrincipal"),
			Values: pulumi.StringMap{
				"ApplicationId":         pulumi.String("00000000-0000-0000-0000-000000000000"),
				"TenantId":              *pulumi.String(exampleClientConfig.TenantId),
				"SubscriptionId":        *pulumi.String(exampleClientConfig.SubscriptionId),
				"CertificateThumbprint": pulumi.String("sample-certificate-thumbprint"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.core.CoreFunctions;
import com.pulumi.azure.automation.Account;
import com.pulumi.azure.automation.AccountArgs;
import com.pulumi.azure.automation.Connection;
import com.pulumi.azure.automation.ConnectionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

        final var exampleClientConfig = CoreFunctions.getClientConfig();

        var exampleAccount = new Account("exampleAccount", AccountArgs.builder()        
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .skuName("Basic")
            .build());

        var exampleConnection = new Connection("exampleConnection", ConnectionArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .automationAccountName(exampleAccount.name())
            .type("AzureServicePrincipal")
            .values(Map.ofEntries(
                Map.entry("ApplicationId", "00000000-0000-0000-0000-000000000000"),
                Map.entry("TenantId", exampleClientConfig.applyValue(getClientConfigResult -> getClientConfigResult.tenantId())),
                Map.entry("SubscriptionId", exampleClientConfig.applyValue(getClientConfigResult -> getClientConfigResult.subscriptionId())),
                Map.entry("CertificateThumbprint", "sample-certificate-thumbprint")
            ))
            .build());

    }
}

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_client_config = azure.core.get_client_config()
example_account = azure.automation.Account("exampleAccount",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku_name="Basic")
example_connection = azure.automation.Connection("exampleConnection",
    resource_group_name=example_resource_group.name,
    automation_account_name=example_account.name,
    type="AzureServicePrincipal",
    values={
        "ApplicationId": "00000000-0000-0000-0000-000000000000",
        "TenantId": example_client_config.tenant_id,
        "SubscriptionId": example_client_config.subscription_id,
        "CertificateThumbprint": "sample-certificate-thumbprint",
    })

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleClientConfig = azure.core.getClientConfig({});
const exampleAccount = new azure.automation.Account("exampleAccount", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    skuName: "Basic",
});
const exampleConnection = new azure.automation.Connection("exampleConnection", {
    resourceGroupName: exampleResourceGroup.name,
    automationAccountName: exampleAccount.name,
    type: "AzureServicePrincipal",
    values: {
        ApplicationId: "00000000-0000-0000-0000-000000000000",
        TenantId: exampleClientConfig.then(exampleClientConfig => exampleClientConfig.tenantId),
        SubscriptionId: exampleClientConfig.then(exampleClientConfig => exampleClientConfig.subscriptionId),
        CertificateThumbprint: "sample-certificate-thumbprint",
    },
});

resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleAccount:
    type: azure:automation:Account
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
      skuName: Basic
  exampleConnection:
    type: azure:automation:Connection
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      automationAccountName: ${exampleAccount.name}
      type: AzureServicePrincipal
      values:
        ApplicationId: 00000000-0000-0000-0000-000000000000
        TenantId: ${exampleClientConfig.tenantId}
        SubscriptionId: ${exampleClientConfig.subscriptionId}
        CertificateThumbprint: sample-certificate-thumbprint
variables:
  exampleClientConfig:
    fn::invoke:
      Function: azure:core:getClientConfig
      Arguments: {}

Create Connection Resource

new Connection(name: string, args: ConnectionArgs, opts?: CustomResourceOptions);

@overload
def Connection(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               automation_account_name: Optional[str] = None,
               description: Optional[str] = None,
               name: Optional[str] = None,
               resource_group_name: Optional[str] = None,
               type: Optional[str] = None,
               values: Optional[Mapping[str, str]] = None)
@overload
def Connection(resource_name: str,
               args: ConnectionArgs,
               opts: Optional[ResourceOptions] = None)

func NewConnection(ctx *Context, name string, args ConnectionArgs, opts ...ResourceOption) (*Connection, error)

public Connection(string name, ConnectionArgs args, CustomResourceOptions? opts = null)

public Connection(String name, ConnectionArgs args)
public Connection(String name, ConnectionArgs args, CustomResourceOptions options)

type: azure:automation:Connection
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ConnectionArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args ConnectionArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ConnectionArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ConnectionArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ConnectionArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Connection Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Connection resource accepts the following input properties:

AutomationAccountName string: The name of the automation account in which the Connection is created. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which the Connection is created. Changing this forces a new resource to be created.
Type string: The type of the Connection - can be either builtin type such as Azure, AzureClassicCertificate, and AzureServicePrincipal, or a user defined types. Changing this forces a new resource to be created.
Values Dictionary<string, string>: A mapping of key value pairs passed to the connection. Different type needs different parameters in the values. Builtin types have required field values as below:
Description string: A description for this Connection.
Name string: Specifies the name of the Connection. Changing this forces a new resource to be created.

AutomationAccountName string: The name of the automation account in which the Connection is created. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which the Connection is created. Changing this forces a new resource to be created.
Type string: The type of the Connection - can be either builtin type such as Azure, AzureClassicCertificate, and AzureServicePrincipal, or a user defined types. Changing this forces a new resource to be created.
Values map[string]string: A mapping of key value pairs passed to the connection. Different type needs different parameters in the values. Builtin types have required field values as below:
Description string: A description for this Connection.
Name string: Specifies the name of the Connection. Changing this forces a new resource to be created.

automationAccountName String: The name of the automation account in which the Connection is created. Changing this forces a new resource to be created.
resourceGroupName String: The name of the resource group in which the Connection is created. Changing this forces a new resource to be created.
type String: The type of the Connection - can be either builtin type such as Azure, AzureClassicCertificate, and AzureServicePrincipal, or a user defined types. Changing this forces a new resource to be created.
values Map<String,String>: A mapping of key value pairs passed to the connection. Different type needs different parameters in the values. Builtin types have required field values as below:
description String: A description for this Connection.
name String: Specifies the name of the Connection. Changing this forces a new resource to be created.

automationAccountName string: The name of the automation account in which the Connection is created. Changing this forces a new resource to be created.
resourceGroupName string: The name of the resource group in which the Connection is created. Changing this forces a new resource to be created.
type string: The type of the Connection - can be either builtin type such as Azure, AzureClassicCertificate, and AzureServicePrincipal, or a user defined types. Changing this forces a new resource to be created.
values {[key: string]: string}: A mapping of key value pairs passed to the connection. Different type needs different parameters in the values. Builtin types have required field values as below:
description string: A description for this Connection.
name string: Specifies the name of the Connection. Changing this forces a new resource to be created.

automation_account_name str: The name of the automation account in which the Connection is created. Changing this forces a new resource to be created.
resource_group_name str: The name of the resource group in which the Connection is created. Changing this forces a new resource to be created.
type str: The type of the Connection - can be either builtin type such as Azure, AzureClassicCertificate, and AzureServicePrincipal, or a user defined types. Changing this forces a new resource to be created.
values Mapping[str, str]: A mapping of key value pairs passed to the connection. Different type needs different parameters in the values. Builtin types have required field values as below:
description str: A description for this Connection.
name str: Specifies the name of the Connection. Changing this forces a new resource to be created.

automationAccountName String: The name of the automation account in which the Connection is created. Changing this forces a new resource to be created.
resourceGroupName String: The name of the resource group in which the Connection is created. Changing this forces a new resource to be created.
type String: The type of the Connection - can be either builtin type such as Azure, AzureClassicCertificate, and AzureServicePrincipal, or a user defined types. Changing this forces a new resource to be created.
values Map<String>: A mapping of key value pairs passed to the connection. Different type needs different parameters in the values. Builtin types have required field values as below:
description String: A description for this Connection.
name String: Specifies the name of the Connection. Changing this forces a new resource to be created.

Outputs

All input properties are implicitly available as output properties. Additionally, the Connection resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing Connection Resource

Get an existing Connection resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ConnectionState, opts?: CustomResourceOptions): Connection

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        automation_account_name: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        type: Optional[str] = None,
        values: Optional[Mapping[str, str]] = None) -> Connection

func GetConnection(ctx *Context, name string, id IDInput, state *ConnectionState, opts ...ResourceOption) (*Connection, error)

public static Connection Get(string name, Input<string> id, ConnectionState? state, CustomResourceOptions? opts = null)

public static Connection get(String name, Output<String> id, ConnectionState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AutomationAccountName string: The name of the automation account in which the Connection is created. Changing this forces a new resource to be created.
Description string: A description for this Connection.
Name string: Specifies the name of the Connection. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which the Connection is created. Changing this forces a new resource to be created.
Type string: The type of the Connection - can be either builtin type such as Azure, AzureClassicCertificate, and AzureServicePrincipal, or a user defined types. Changing this forces a new resource to be created.
Values Dictionary<string, string>: A mapping of key value pairs passed to the connection. Different type needs different parameters in the values. Builtin types have required field values as below:

AutomationAccountName string: The name of the automation account in which the Connection is created. Changing this forces a new resource to be created.
Description string: A description for this Connection.
Name string: Specifies the name of the Connection. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which the Connection is created. Changing this forces a new resource to be created.
Type string: The type of the Connection - can be either builtin type such as Azure, AzureClassicCertificate, and AzureServicePrincipal, or a user defined types. Changing this forces a new resource to be created.
Values map[string]string: A mapping of key value pairs passed to the connection. Different type needs different parameters in the values. Builtin types have required field values as below:

automationAccountName String: The name of the automation account in which the Connection is created. Changing this forces a new resource to be created.
description String: A description for this Connection.
name String: Specifies the name of the Connection. Changing this forces a new resource to be created.
resourceGroupName String: The name of the resource group in which the Connection is created. Changing this forces a new resource to be created.
type String: The type of the Connection - can be either builtin type such as Azure, AzureClassicCertificate, and AzureServicePrincipal, or a user defined types. Changing this forces a new resource to be created.
values Map<String,String>: A mapping of key value pairs passed to the connection. Different type needs different parameters in the values. Builtin types have required field values as below:

automationAccountName string: The name of the automation account in which the Connection is created. Changing this forces a new resource to be created.
description string: A description for this Connection.
name string: Specifies the name of the Connection. Changing this forces a new resource to be created.
resourceGroupName string: The name of the resource group in which the Connection is created. Changing this forces a new resource to be created.
type string: The type of the Connection - can be either builtin type such as Azure, AzureClassicCertificate, and AzureServicePrincipal, or a user defined types. Changing this forces a new resource to be created.
values {[key: string]: string}: A mapping of key value pairs passed to the connection. Different type needs different parameters in the values. Builtin types have required field values as below:

automation_account_name str: The name of the automation account in which the Connection is created. Changing this forces a new resource to be created.
description str: A description for this Connection.
name str: Specifies the name of the Connection. Changing this forces a new resource to be created.
resource_group_name str: The name of the resource group in which the Connection is created. Changing this forces a new resource to be created.
type str: The type of the Connection - can be either builtin type such as Azure, AzureClassicCertificate, and AzureServicePrincipal, or a user defined types. Changing this forces a new resource to be created.
values Mapping[str, str]: A mapping of key value pairs passed to the connection. Different type needs different parameters in the values. Builtin types have required field values as below:

automationAccountName String: The name of the automation account in which the Connection is created. Changing this forces a new resource to be created.
description String: A description for this Connection.
name String: Specifies the name of the Connection. Changing this forces a new resource to be created.
resourceGroupName String: The name of the resource group in which the Connection is created. Changing this forces a new resource to be created.
type String: The type of the Connection - can be either builtin type such as Azure, AzureClassicCertificate, and AzureServicePrincipal, or a user defined types. Changing this forces a new resource to be created.
values Map<String>: A mapping of key value pairs passed to the connection. Different type needs different parameters in the values. Builtin types have required field values as below:

Import

Automation Connection can be imported using the resource id, e.g.

 $ pulumi import azure:automation/connection:Connection example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Automation/automationAccounts/account1/connections/conn1

Package Details

Repository: Azure Classic pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.