Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. automation
  5. DscConfiguration

We recommend using Azure Native.

Azure Classic v6.2.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-azure

azure.automation.DscConfiguration

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v6.2.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-azure

    Manages a Automation DSC Configuration.

    Example Usage

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

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleAccount = new azure.automation.Account("example", {
    name: "account1",
    location: example.location,
    resourceGroupName: example.name,
    skuName: "Basic",
});
const exampleDscConfiguration = new azure.automation.DscConfiguration("example", {
    name: "test",
    resourceGroupName: example.name,
    automationAccountName: exampleAccount.name,
    location: example.location,
    contentEmbedded: "configuration test {}",
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_account = azure.automation.Account("example",
    name="account1",
    location=example.location,
    resource_group_name=example.name,
    sku_name="Basic")
example_dsc_configuration = azure.automation.DscConfiguration("example",
    name="test",
    resource_group_name=example.name,
    automation_account_name=example_account.name,
    location=example.location,
    content_embedded="configuration test {}")

    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 {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleAccount, err := automation.NewAccount(ctx, "example", &automation.AccountArgs{
			Name:              pulumi.String("account1"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			SkuName:           pulumi.String("Basic"),
		})
		if err != nil {
			return err
		}
		_, err = automation.NewDscConfiguration(ctx, "example", &automation.DscConfigurationArgs{
			Name:                  pulumi.String("test"),
			ResourceGroupName:     example.Name,
			AutomationAccountName: exampleAccount.Name,
			Location:              example.Location,
			ContentEmbedded:       pulumi.String("configuration test {}"),
		})
		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 example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

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

    var exampleDscConfiguration = new Azure.Automation.DscConfiguration("example", new()
    {
        Name = "test",
        ResourceGroupName = example.Name,
        AutomationAccountName = exampleAccount.Name,
        Location = example.Location,
        ContentEmbedded = "configuration test {}",
    });

});

    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.automation.Account;
import com.pulumi.azure.automation.AccountArgs;
import com.pulumi.azure.automation.DscConfiguration;
import com.pulumi.azure.automation.DscConfigurationArgs;
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

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

        var exampleDscConfiguration = new DscConfiguration("exampleDscConfiguration", DscConfigurationArgs.builder()
            .name("test")
            .resourceGroupName(example.name())
            .automationAccountName(exampleAccount.name())
            .location(example.location())
            .contentEmbedded("configuration test {}")
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleAccount:
    type: azure:automation:Account
    name: example
    properties:
      name: account1
      location: ${example.location}
      resourceGroupName: ${example.name}
      skuName: Basic
  exampleDscConfiguration:
    type: azure:automation:DscConfiguration
    name: example
    properties:
      name: test
      resourceGroupName: ${example.name}
      automationAccountName: ${exampleAccount.name}
      location: ${example.location}
      contentEmbedded: configuration test {}

    Create DscConfiguration Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DscConfiguration(name: string, args: DscConfigurationArgs, opts?: CustomResourceOptions);
    @overload
def DscConfiguration(resource_name: str,
                     args: DscConfigurationArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def DscConfiguration(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     automation_account_name: Optional[str] = None,
                     content_embedded: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     description: Optional[str] = None,
                     location: Optional[str] = None,
                     log_verbose: Optional[bool] = None,
                     name: Optional[str] = None,
                     tags: Optional[Mapping[str, str]] = None)
    func NewDscConfiguration(ctx *Context, name string, args DscConfigurationArgs, opts ...ResourceOption) (*DscConfiguration, error)
    public DscConfiguration(string name, DscConfigurationArgs args, CustomResourceOptions? opts = null)
    public DscConfiguration(String name, DscConfigurationArgs args)
public DscConfiguration(String name, DscConfigurationArgs args, CustomResourceOptions options)

    type: azure:automation:DscConfiguration
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 DscConfigurationArgs
    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 DscConfigurationArgs
    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 DscConfigurationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DscConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DscConfigurationArgs
    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 dscConfigurationResource = new Azure.Automation.DscConfiguration("dscConfigurationResource", new()
{
    AutomationAccountName = "string",
    ContentEmbedded = "string",
    ResourceGroupName = "string",
    Description = "string",
    Location = "string",
    LogVerbose = false,
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := automation.NewDscConfiguration(ctx, "dscConfigurationResource", &automation.DscConfigurationArgs{
	AutomationAccountName: pulumi.String("string"),
	ContentEmbedded:       pulumi.String("string"),
	ResourceGroupName:     pulumi.String("string"),
	Description:           pulumi.String("string"),
	Location:              pulumi.String("string"),
	LogVerbose:            pulumi.Bool(false),
	Name:                  pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var dscConfigurationResource = new DscConfiguration("dscConfigurationResource", DscConfigurationArgs.builder()
    .automationAccountName("string")
    .contentEmbedded("string")
    .resourceGroupName("string")
    .description("string")
    .location("string")
    .logVerbose(false)
    .name("string")
    .tags(Map.of("string", "string"))
    .build());

    dsc_configuration_resource = azure.automation.DscConfiguration("dscConfigurationResource",
    automation_account_name="string",
    content_embedded="string",
    resource_group_name="string",
    description="string",
    location="string",
    log_verbose=False,
    name="string",
    tags={
        "string": "string",
    })

    const dscConfigurationResource = new azure.automation.DscConfiguration("dscConfigurationResource", {
    automationAccountName: "string",
    contentEmbedded: "string",
    resourceGroupName: "string",
    description: "string",
    location: "string",
    logVerbose: false,
    name: "string",
    tags: {
        string: "string",
    },
});

    type: azure:automation:DscConfiguration
properties:
    automationAccountName: string
    contentEmbedded: string
    description: string
    location: string
    logVerbose: false
    name: string
    resourceGroupName: string
    tags:
        string: string

    DscConfiguration 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 DscConfiguration resource accepts the following input properties:

    AutomationAccountName string
    The name of the automation account in which the DSC Configuration is created. Changing this forces a new resource to be created.
    ContentEmbedded string
    The PowerShell DSC Configuration script.
    ResourceGroupName string
    The name of the resource group in which the DSC Configuration is created. Changing this forces a new resource to be created.
    Description string
    Description to go with DSC Configuration.
    Location string
    Must be the same location as the Automation Account. Changing this forces a new resource to be created.
    LogVerbose bool
    Verbose log option.
    Name string
    Specifies the name of the DSC Configuration. Changing this forces a new resource to be created.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    AutomationAccountName string
    The name of the automation account in which the DSC Configuration is created. Changing this forces a new resource to be created.
    ContentEmbedded string
    The PowerShell DSC Configuration script.
    ResourceGroupName string
    The name of the resource group in which the DSC Configuration is created. Changing this forces a new resource to be created.
    Description string
    Description to go with DSC Configuration.
    Location string
    Must be the same location as the Automation Account. Changing this forces a new resource to be created.
    LogVerbose bool
    Verbose log option.
    Name string
    Specifies the name of the DSC Configuration. Changing this forces a new resource to be created.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    automationAccountName String
    The name of the automation account in which the DSC Configuration is created. Changing this forces a new resource to be created.
    contentEmbedded String
    The PowerShell DSC Configuration script.
    resourceGroupName String
    The name of the resource group in which the DSC Configuration is created. Changing this forces a new resource to be created.
    description String
    Description to go with DSC Configuration.
    location String
    Must be the same location as the Automation Account. Changing this forces a new resource to be created.
    logVerbose Boolean
    Verbose log option.
    name String
    Specifies the name of the DSC Configuration. Changing this forces a new resource to be created.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    automationAccountName string
    The name of the automation account in which the DSC Configuration is created. Changing this forces a new resource to be created.
    contentEmbedded string
    The PowerShell DSC Configuration script.
    resourceGroupName string
    The name of the resource group in which the DSC Configuration is created. Changing this forces a new resource to be created.
    description string
    Description to go with DSC Configuration.
    location string
    Must be the same location as the Automation Account. Changing this forces a new resource to be created.
    logVerbose boolean
    Verbose log option.
    name string
    Specifies the name of the DSC Configuration. Changing this forces a new resource to be created.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    automation_account_name str
    The name of the automation account in which the DSC Configuration is created. Changing this forces a new resource to be created.
    content_embedded str
    The PowerShell DSC Configuration script.
    resource_group_name str
    The name of the resource group in which the DSC Configuration is created. Changing this forces a new resource to be created.
    description str
    Description to go with DSC Configuration.
    location str
    Must be the same location as the Automation Account. Changing this forces a new resource to be created.
    log_verbose bool
    Verbose log option.
    name str
    Specifies the name of the DSC Configuration. Changing this forces a new resource to be created.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    automationAccountName String
    The name of the automation account in which the DSC Configuration is created. Changing this forces a new resource to be created.
    contentEmbedded String
    The PowerShell DSC Configuration script.
    resourceGroupName String
    The name of the resource group in which the DSC Configuration is created. Changing this forces a new resource to be created.
    description String
    Description to go with DSC Configuration.
    location String
    Must be the same location as the Automation Account. Changing this forces a new resource to be created.
    logVerbose Boolean
    Verbose log option.
    name String
    Specifies the name of the DSC Configuration. Changing this forces a new resource to be created.
    tags Map<String>
    A mapping of tags to assign to the resource.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    id str
    The provider-assigned unique ID for this managed resource.
    state str
    id String
    The provider-assigned unique ID for this managed resource.
    state String

    Look up Existing DscConfiguration Resource

    Get an existing DscConfiguration 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?: DscConfigurationState, opts?: CustomResourceOptions): DscConfiguration
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        automation_account_name: Optional[str] = None,
        content_embedded: Optional[str] = None,
        description: Optional[str] = None,
        location: Optional[str] = None,
        log_verbose: Optional[bool] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        state: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None) -> DscConfiguration
    func GetDscConfiguration(ctx *Context, name string, id IDInput, state *DscConfigurationState, opts ...ResourceOption) (*DscConfiguration, error)
    public static DscConfiguration Get(string name, Input<string> id, DscConfigurationState? state, CustomResourceOptions? opts = null)
    public static DscConfiguration get(String name, Output<String> id, DscConfigurationState 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 DSC Configuration is created. Changing this forces a new resource to be created.
    ContentEmbedded string
    The PowerShell DSC Configuration script.
    Description string
    Description to go with DSC Configuration.
    Location string
    Must be the same location as the Automation Account. Changing this forces a new resource to be created.
    LogVerbose bool
    Verbose log option.
    Name string
    Specifies the name of the DSC Configuration. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which the DSC Configuration is created. Changing this forces a new resource to be created.
    State string
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    AutomationAccountName string
    The name of the automation account in which the DSC Configuration is created. Changing this forces a new resource to be created.
    ContentEmbedded string
    The PowerShell DSC Configuration script.
    Description string
    Description to go with DSC Configuration.
    Location string
    Must be the same location as the Automation Account. Changing this forces a new resource to be created.
    LogVerbose bool
    Verbose log option.
    Name string
    Specifies the name of the DSC Configuration. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which the DSC Configuration is created. Changing this forces a new resource to be created.
    State string
    Tags map[string]string
    A mapping of tags to assign to the resource.
    automationAccountName String
    The name of the automation account in which the DSC Configuration is created. Changing this forces a new resource to be created.
    contentEmbedded String
    The PowerShell DSC Configuration script.
    description String
    Description to go with DSC Configuration.
    location String
    Must be the same location as the Automation Account. Changing this forces a new resource to be created.
    logVerbose Boolean
    Verbose log option.
    name String
    Specifies the name of the DSC Configuration. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which the DSC Configuration is created. Changing this forces a new resource to be created.
    state String
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    automationAccountName string
    The name of the automation account in which the DSC Configuration is created. Changing this forces a new resource to be created.
    contentEmbedded string
    The PowerShell DSC Configuration script.
    description string
    Description to go with DSC Configuration.
    location string
    Must be the same location as the Automation Account. Changing this forces a new resource to be created.
    logVerbose boolean
    Verbose log option.
    name string
    Specifies the name of the DSC Configuration. Changing this forces a new resource to be created.
    resourceGroupName string
    The name of the resource group in which the DSC Configuration is created. Changing this forces a new resource to be created.
    state string
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    automation_account_name str
    The name of the automation account in which the DSC Configuration is created. Changing this forces a new resource to be created.
    content_embedded str
    The PowerShell DSC Configuration script.
    description str
    Description to go with DSC Configuration.
    location str
    Must be the same location as the Automation Account. Changing this forces a new resource to be created.
    log_verbose bool
    Verbose log option.
    name str
    Specifies the name of the DSC Configuration. Changing this forces a new resource to be created.
    resource_group_name str
    The name of the resource group in which the DSC Configuration is created. Changing this forces a new resource to be created.
    state str
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    automationAccountName String
    The name of the automation account in which the DSC Configuration is created. Changing this forces a new resource to be created.
    contentEmbedded String
    The PowerShell DSC Configuration script.
    description String
    Description to go with DSC Configuration.
    location String
    Must be the same location as the Automation Account. Changing this forces a new resource to be created.
    logVerbose Boolean
    Verbose log option.
    name String
    Specifies the name of the DSC Configuration. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which the DSC Configuration is created. Changing this forces a new resource to be created.
    state String
    tags Map<String>
    A mapping of tags to assign to the resource.

    Import

    Automation DSC Configuration’s can be imported using the resource id, e.g.

    $ pulumi import azure:automation/dscConfiguration:DscConfiguration configuration1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Automation/automationAccounts/account1/configurations/configuration1

    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.
    azure logo

    We recommend using Azure Native.

    Azure Classic v6.2.0 published on Friday, Sep 27, 2024 by Pulumi
    pulumi/pulumi-azure