We recommend using Azure Native.
azure.automation.Connection
Explore with Pulumi AI
Manages an Automation Connection.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const exampleResourceGroup = new azure.core.ResourceGroup("example", {
name: "resourceGroup-example",
location: "West Europe",
});
const example = azure.core.getClientConfig({});
const exampleAccount = new azure.automation.Account("example", {
name: "account-example",
location: exampleResourceGroup.location,
resourceGroupName: exampleResourceGroup.name,
skuName: "Basic",
});
const exampleConnection = new azure.automation.Connection("example", {
name: "connection-example",
resourceGroupName: exampleResourceGroup.name,
automationAccountName: exampleAccount.name,
type: "AzureServicePrincipal",
values: {
ApplicationId: "00000000-0000-0000-0000-000000000000",
TenantId: example.then(example => example.tenantId),
SubscriptionId: example.then(example => example.subscriptionId),
CertificateThumbprint: "sample-certificate-thumbprint",
},
});
import pulumi
import pulumi_azure as azure
example_resource_group = azure.core.ResourceGroup("example",
name="resourceGroup-example",
location="West Europe")
example = azure.core.get_client_config()
example_account = azure.automation.Account("example",
name="account-example",
location=example_resource_group.location,
resource_group_name=example_resource_group.name,
sku_name="Basic")
example_connection = azure.automation.Connection("example",
name="connection-example",
resource_group_name=example_resource_group.name,
automation_account_name=example_account.name,
type="AzureServicePrincipal",
values={
"ApplicationId": "00000000-0000-0000-0000-000000000000",
"TenantId": example.tenant_id,
"SubscriptionId": example.subscription_id,
"CertificateThumbprint": "sample-certificate-thumbprint",
})
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/automation"
"github.com/pulumi/pulumi-azure/sdk/v6/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, "example", &core.ResourceGroupArgs{
Name: pulumi.String("resourceGroup-example"),
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
example, err := core.GetClientConfig(ctx, nil, nil)
if err != nil {
return err
}
exampleAccount, err := automation.NewAccount(ctx, "example", &automation.AccountArgs{
Name: pulumi.String("account-example"),
Location: exampleResourceGroup.Location,
ResourceGroupName: exampleResourceGroup.Name,
SkuName: pulumi.String("Basic"),
})
if err != nil {
return err
}
_, err = automation.NewConnection(ctx, "example", &automation.ConnectionArgs{
Name: pulumi.String("connection-example"),
ResourceGroupName: exampleResourceGroup.Name,
AutomationAccountName: exampleAccount.Name,
Type: pulumi.String("AzureServicePrincipal"),
Values: pulumi.StringMap{
"ApplicationId": pulumi.String("00000000-0000-0000-0000-000000000000"),
"TenantId": pulumi.String(example.TenantId),
"SubscriptionId": pulumi.String(example.SubscriptionId),
"CertificateThumbprint": pulumi.String("sample-certificate-thumbprint"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var exampleResourceGroup = new Azure.Core.ResourceGroup("example", new()
{
Name = "resourceGroup-example",
Location = "West Europe",
});
var example = Azure.Core.GetClientConfig.Invoke();
var exampleAccount = new Azure.Automation.Account("example", new()
{
Name = "account-example",
Location = exampleResourceGroup.Location,
ResourceGroupName = exampleResourceGroup.Name,
SkuName = "Basic",
});
var exampleConnection = new Azure.Automation.Connection("example", new()
{
Name = "connection-example",
ResourceGroupName = exampleResourceGroup.Name,
AutomationAccountName = exampleAccount.Name,
Type = "AzureServicePrincipal",
Values =
{
{ "ApplicationId", "00000000-0000-0000-0000-000000000000" },
{ "TenantId", example.Apply(getClientConfigResult => getClientConfigResult.TenantId) },
{ "SubscriptionId", example.Apply(getClientConfigResult => getClientConfigResult.SubscriptionId) },
{ "CertificateThumbprint", "sample-certificate-thumbprint" },
},
});
});
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()
.name("resourceGroup-example")
.location("West Europe")
.build());
final var example = CoreFunctions.getClientConfig();
var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
.name("account-example")
.location(exampleResourceGroup.location())
.resourceGroupName(exampleResourceGroup.name())
.skuName("Basic")
.build());
var exampleConnection = new Connection("exampleConnection", ConnectionArgs.builder()
.name("connection-example")
.resourceGroupName(exampleResourceGroup.name())
.automationAccountName(exampleAccount.name())
.type("AzureServicePrincipal")
.values(Map.ofEntries(
Map.entry("ApplicationId", "00000000-0000-0000-0000-000000000000"),
Map.entry("TenantId", example.applyValue(getClientConfigResult -> getClientConfigResult.tenantId())),
Map.entry("SubscriptionId", example.applyValue(getClientConfigResult -> getClientConfigResult.subscriptionId())),
Map.entry("CertificateThumbprint", "sample-certificate-thumbprint")
))
.build());
}
}
resources:
exampleResourceGroup:
type: azure:core:ResourceGroup
name: example
properties:
name: resourceGroup-example
location: West Europe
exampleAccount:
type: azure:automation:Account
name: example
properties:
name: account-example
location: ${exampleResourceGroup.location}
resourceGroupName: ${exampleResourceGroup.name}
skuName: Basic
exampleConnection:
type: azure:automation:Connection
name: example
properties:
name: connection-example
resourceGroupName: ${exampleResourceGroup.name}
automationAccountName: ${exampleAccount.name}
type: AzureServicePrincipal
values:
ApplicationId: 00000000-0000-0000-0000-000000000000
TenantId: ${example.tenantId}
SubscriptionId: ${example.subscriptionId}
CertificateThumbprint: sample-certificate-thumbprint
variables:
example:
fn::invoke:
Function: azure:core:getClientConfig
Arguments: {}
Create Connection Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Connection(name: string, args: ConnectionArgs, opts?: CustomResourceOptions);
@overload
def Connection(resource_name: str,
args: ConnectionArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Connection(resource_name: str,
opts: Optional[ResourceOptions] = None,
automation_account_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
type: Optional[str] = None,
values: Optional[Mapping[str, str]] = None,
description: Optional[str] = None,
name: Optional[str] = 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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var azureConnectionResource = new Azure.Automation.Connection("azureConnectionResource", new()
{
AutomationAccountName = "string",
ResourceGroupName = "string",
Type = "string",
Values =
{
{ "string", "string" },
},
Description = "string",
Name = "string",
});
example, err := automation.NewConnection(ctx, "azureConnectionResource", &automation.ConnectionArgs{
AutomationAccountName: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
Type: pulumi.String("string"),
Values: pulumi.StringMap{
"string": pulumi.String("string"),
},
Description: pulumi.String("string"),
Name: pulumi.String("string"),
})
var azureConnectionResource = new Connection("azureConnectionResource", ConnectionArgs.builder()
.automationAccountName("string")
.resourceGroupName("string")
.type("string")
.values(Map.of("string", "string"))
.description("string")
.name("string")
.build());
azure_connection_resource = azure.automation.Connection("azureConnectionResource",
automation_account_name="string",
resource_group_name="string",
type="string",
values={
"string": "string",
},
description="string",
name="string")
const azureConnectionResource = new azure.automation.Connection("azureConnectionResource", {
automationAccountName: "string",
resourceGroupName: "string",
type: "string",
values: {
string: "string",
},
description: "string",
name: "string",
});
type: azure:automation:Connection
properties:
automationAccountName: string
description: string
name: string
resourceGroupName: string
type: string
values:
string: string
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:
- Automation
Account stringName - The name of the automation account in which the Connection is created. Changing this forces a new resource to be created.
- Resource
Group stringName - 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
, andAzureServicePrincipal
, 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 thevalues
. Builtin types have required field values as below:Azure
: parametersAutomationCertificateName
andSubscriptionID
.AzureClassicCertificate
: parametersSubscriptionName
,SubscriptionId
andCertificateAssetName
.AzureServicePrincipal
: parametersApplicationId
,CertificateThumbprint
,SubscriptionId
andTenantId
.
- 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 stringName - The name of the automation account in which the Connection is created. Changing this forces a new resource to be created.
- Resource
Group stringName - 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
, andAzureServicePrincipal
, 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 thevalues
. Builtin types have required field values as below:Azure
: parametersAutomationCertificateName
andSubscriptionID
.AzureClassicCertificate
: parametersSubscriptionName
,SubscriptionId
andCertificateAssetName
.AzureServicePrincipal
: parametersApplicationId
,CertificateThumbprint
,SubscriptionId
andTenantId
.
- 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 StringName - The name of the automation account in which the Connection is created. Changing this forces a new resource to be created.
- resource
Group StringName - 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
, andAzureServicePrincipal
, 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 thevalues
. Builtin types have required field values as below:Azure
: parametersAutomationCertificateName
andSubscriptionID
.AzureClassicCertificate
: parametersSubscriptionName
,SubscriptionId
andCertificateAssetName
.AzureServicePrincipal
: parametersApplicationId
,CertificateThumbprint
,SubscriptionId
andTenantId
.
- 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 stringName - The name of the automation account in which the Connection is created. Changing this forces a new resource to be created.
- resource
Group stringName - 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
, andAzureServicePrincipal
, 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 thevalues
. Builtin types have required field values as below:Azure
: parametersAutomationCertificateName
andSubscriptionID
.AzureClassicCertificate
: parametersSubscriptionName
,SubscriptionId
andCertificateAssetName
.AzureServicePrincipal
: parametersApplicationId
,CertificateThumbprint
,SubscriptionId
andTenantId
.
- 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_ strname - The name of the automation account in which the Connection is created. Changing this forces a new resource to be created.
- resource_
group_ strname - 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
, andAzureServicePrincipal
, 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 thevalues
. Builtin types have required field values as below:Azure
: parametersAutomationCertificateName
andSubscriptionID
.AzureClassicCertificate
: parametersSubscriptionName
,SubscriptionId
andCertificateAssetName
.AzureServicePrincipal
: parametersApplicationId
,CertificateThumbprint
,SubscriptionId
andTenantId
.
- description str
- A description for this Connection.
- name str
- Specifies the name of the Connection. Changing this forces a new resource to be created.
- automation
Account StringName - The name of the automation account in which the Connection is created. Changing this forces a new resource to be created.
- resource
Group StringName - 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
, andAzureServicePrincipal
, 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 thevalues
. Builtin types have required field values as below:Azure
: parametersAutomationCertificateName
andSubscriptionID
.AzureClassicCertificate
: parametersSubscriptionName
,SubscriptionId
andCertificateAssetName
.AzureServicePrincipal
: parametersApplicationId
,CertificateThumbprint
,SubscriptionId
andTenantId
.
- 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.
- Automation
Account stringName - 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.
- Resource
Group stringName - 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
, andAzureServicePrincipal
, 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 thevalues
. Builtin types have required field values as below:Azure
: parametersAutomationCertificateName
andSubscriptionID
.AzureClassicCertificate
: parametersSubscriptionName
,SubscriptionId
andCertificateAssetName
.AzureServicePrincipal
: parametersApplicationId
,CertificateThumbprint
,SubscriptionId
andTenantId
.
- Automation
Account stringName - 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.
- Resource
Group stringName - 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
, andAzureServicePrincipal
, 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 thevalues
. Builtin types have required field values as below:Azure
: parametersAutomationCertificateName
andSubscriptionID
.AzureClassicCertificate
: parametersSubscriptionName
,SubscriptionId
andCertificateAssetName
.AzureServicePrincipal
: parametersApplicationId
,CertificateThumbprint
,SubscriptionId
andTenantId
.
- automation
Account StringName - 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.
- resource
Group StringName - 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
, andAzureServicePrincipal
, 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 thevalues
. Builtin types have required field values as below:Azure
: parametersAutomationCertificateName
andSubscriptionID
.AzureClassicCertificate
: parametersSubscriptionName
,SubscriptionId
andCertificateAssetName
.AzureServicePrincipal
: parametersApplicationId
,CertificateThumbprint
,SubscriptionId
andTenantId
.
- automation
Account stringName - 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.
- resource
Group stringName - 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
, andAzureServicePrincipal
, 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 thevalues
. Builtin types have required field values as below:Azure
: parametersAutomationCertificateName
andSubscriptionID
.AzureClassicCertificate
: parametersSubscriptionName
,SubscriptionId
andCertificateAssetName
.AzureServicePrincipal
: parametersApplicationId
,CertificateThumbprint
,SubscriptionId
andTenantId
.
- automation_
account_ strname - 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_ strname - 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
, andAzureServicePrincipal
, 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 thevalues
. Builtin types have required field values as below:Azure
: parametersAutomationCertificateName
andSubscriptionID
.AzureClassicCertificate
: parametersSubscriptionName
,SubscriptionId
andCertificateAssetName
.AzureServicePrincipal
: parametersApplicationId
,CertificateThumbprint
,SubscriptionId
andTenantId
.
- automation
Account StringName - 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.
- resource
Group StringName - 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
, andAzureServicePrincipal
, 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 thevalues
. Builtin types have required field values as below:Azure
: parametersAutomationCertificateName
andSubscriptionID
.AzureClassicCertificate
: parametersSubscriptionName
,SubscriptionId
andCertificateAssetName
.AzureServicePrincipal
: parametersApplicationId
,CertificateThumbprint
,SubscriptionId
andTenantId
.
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
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurerm
Terraform Provider.