1. Pulumi Registry
  2. Azure Classic
  3. API Docs
  4. automation
  5. DscNodeConfiguration
azure logo
Azure Classic v5.37.0, Mar 15 23

azure.automation.DscNodeConfiguration

Manages a Automation DSC Node Configuration.

Example Usage

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

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

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

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

    var exampleDscNodeConfiguration = new Azure.Automation.DscNodeConfiguration("exampleDscNodeConfiguration", new()
    {
        ResourceGroupName = exampleResourceGroup.Name,
        AutomationAccountName = exampleAccount.Name,
        ContentEmbedded = @"instance of MSFT_FileDirectoryConfiguration as $MSFT_FileDirectoryConfiguration1ref
{
  ResourceID = ""[File]bla"";
  Ensure = ""Present"";
  Contents = ""bogus Content"";
  DestinationPath = ""c:\\bogus.txt"";
  ModuleName = ""PSDesiredStateConfiguration"";
  SourceInfo = ""::3::9::file"";
  ModuleVersion = ""1.0"";
  ConfigurationName = ""bla"";
};
instance of OMI_ConfigurationDocument
{
  Version=""2.0.0"";
  MinimumCompatibleVersion = ""1.0.0"";
  CompatibleVersionAdditionalProperties= {""Omi_BaseResource:ConfigurationName""};
  Author=""bogusAuthor"";
  GenerationDate=""06/15/2018 14:06:24"";
  GenerationHost=""bogusComputer"";
  Name=""test"";
};
",
    }, new CustomResourceOptions
    {
        DependsOn = new[]
        {
            exampleDscConfiguration,
        },
    });

});

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
		}
		exampleAccount, err := automation.NewAccount(ctx, "exampleAccount", &automation.AccountArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
			SkuName:           pulumi.String("Basic"),
		})
		if err != nil {
			return err
		}
		exampleDscConfiguration, err := automation.NewDscConfiguration(ctx, "exampleDscConfiguration", &automation.DscConfigurationArgs{
			ResourceGroupName:     exampleResourceGroup.Name,
			AutomationAccountName: exampleAccount.Name,
			Location:              exampleResourceGroup.Location,
			ContentEmbedded:       pulumi.String("configuration test {}"),
		})
		if err != nil {
			return err
		}
		_, err = automation.NewDscNodeConfiguration(ctx, "exampleDscNodeConfiguration", &automation.DscNodeConfigurationArgs{
			ResourceGroupName:     exampleResourceGroup.Name,
			AutomationAccountName: exampleAccount.Name,
			ContentEmbedded:       pulumi.String("instance of MSFT_FileDirectoryConfiguration as $MSFT_FileDirectoryConfiguration1ref\n{\n  ResourceID = \"[File]bla\";\n  Ensure = \"Present\";\n  Contents = \"bogus Content\";\n  DestinationPath = \"c:\\\\bogus.txt\";\n  ModuleName = \"PSDesiredStateConfiguration\";\n  SourceInfo = \"::3::9::file\";\n  ModuleVersion = \"1.0\";\n  ConfigurationName = \"bla\";\n};\ninstance of OMI_ConfigurationDocument\n{\n  Version=\"2.0.0\";\n  MinimumCompatibleVersion = \"1.0.0\";\n  CompatibleVersionAdditionalProperties= {\"Omi_BaseResource:ConfigurationName\"};\n  Author=\"bogusAuthor\";\n  GenerationDate=\"06/15/2018 14:06:24\";\n  GenerationHost=\"bogusComputer\";\n  Name=\"test\";\n};\n"),
		}, pulumi.DependsOn([]pulumi.Resource{
			exampleDscConfiguration,
		}))
		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.automation.Account;
import com.pulumi.azure.automation.AccountArgs;
import com.pulumi.azure.automation.DscConfiguration;
import com.pulumi.azure.automation.DscConfigurationArgs;
import com.pulumi.azure.automation.DscNodeConfiguration;
import com.pulumi.azure.automation.DscNodeConfigurationArgs;
import com.pulumi.resources.CustomResourceOptions;
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());

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

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

        var exampleDscNodeConfiguration = new DscNodeConfiguration("exampleDscNodeConfiguration", DscNodeConfigurationArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .automationAccountName(exampleAccount.name())
            .contentEmbedded("""
instance of MSFT_FileDirectoryConfiguration as $MSFT_FileDirectoryConfiguration1ref
{
  ResourceID = "[File]bla";
  Ensure = "Present";
  Contents = "bogus Content";
  DestinationPath = "c:\\bogus.txt";
  ModuleName = "PSDesiredStateConfiguration";
  SourceInfo = "::3::9::file";
  ModuleVersion = "1.0";
  ConfigurationName = "bla";
};
instance of OMI_ConfigurationDocument
{
  Version="2.0.0";
  MinimumCompatibleVersion = "1.0.0";
  CompatibleVersionAdditionalProperties= {"Omi_BaseResource:ConfigurationName"};
  Author="bogusAuthor";
  GenerationDate="06/15/2018 14:06:24";
  GenerationHost="bogusComputer";
  Name="test";
};
            """)
            .build(), CustomResourceOptions.builder()
                .dependsOn(exampleDscConfiguration)
                .build());

    }
}

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_account = azure.automation.Account("exampleAccount",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku_name="Basic")
example_dsc_configuration = azure.automation.DscConfiguration("exampleDscConfiguration",
    resource_group_name=example_resource_group.name,
    automation_account_name=example_account.name,
    location=example_resource_group.location,
    content_embedded="configuration test {}")
example_dsc_node_configuration = azure.automation.DscNodeConfiguration("exampleDscNodeConfiguration",
    resource_group_name=example_resource_group.name,
    automation_account_name=example_account.name,
    content_embedded="""instance of MSFT_FileDirectoryConfiguration as $MSFT_FileDirectoryConfiguration1ref
{
  ResourceID = "[File]bla";
  Ensure = "Present";
  Contents = "bogus Content";
  DestinationPath = "c:\\bogus.txt";
  ModuleName = "PSDesiredStateConfiguration";
  SourceInfo = "::3::9::file";
  ModuleVersion = "1.0";
  ConfigurationName = "bla";
};
instance of OMI_ConfigurationDocument
{
  Version="2.0.0";
  MinimumCompatibleVersion = "1.0.0";
  CompatibleVersionAdditionalProperties= {"Omi_BaseResource:ConfigurationName"};
  Author="bogusAuthor";
  GenerationDate="06/15/2018 14:06:24";
  GenerationHost="bogusComputer";
  Name="test";
};
""",
    opts=pulumi.ResourceOptions(depends_on=[example_dsc_configuration]))

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleAccount = new azure.automation.Account("exampleAccount", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    skuName: "Basic",
});
const exampleDscConfiguration = new azure.automation.DscConfiguration("exampleDscConfiguration", {
    resourceGroupName: exampleResourceGroup.name,
    automationAccountName: exampleAccount.name,
    location: exampleResourceGroup.location,
    contentEmbedded: "configuration test {}",
});
const exampleDscNodeConfiguration = new azure.automation.DscNodeConfiguration("exampleDscNodeConfiguration", {
    resourceGroupName: exampleResourceGroup.name,
    automationAccountName: exampleAccount.name,
    contentEmbedded: `instance of MSFT_FileDirectoryConfiguration as $MSFT_FileDirectoryConfiguration1ref
{
  ResourceID = "[File]bla";
  Ensure = "Present";
  Contents = "bogus Content";
  DestinationPath = "c:\\\\bogus.txt";
  ModuleName = "PSDesiredStateConfiguration";
  SourceInfo = "::3::9::file";
  ModuleVersion = "1.0";
  ConfigurationName = "bla";
};
instance of OMI_ConfigurationDocument
{
  Version="2.0.0";
  MinimumCompatibleVersion = "1.0.0";
  CompatibleVersionAdditionalProperties= {"Omi_BaseResource:ConfigurationName"};
  Author="bogusAuthor";
  GenerationDate="06/15/2018 14:06:24";
  GenerationHost="bogusComputer";
  Name="test";
};
`,
}, {
    dependsOn: [exampleDscConfiguration],
});

resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleAccount:
    type: azure:automation:Account
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
      skuName: Basic
  exampleDscConfiguration:
    type: azure:automation:DscConfiguration
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      automationAccountName: ${exampleAccount.name}
      location: ${exampleResourceGroup.location}
      contentEmbedded: configuration test {}
  exampleDscNodeConfiguration:
    type: azure:automation:DscNodeConfiguration
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      automationAccountName: ${exampleAccount.name}
      contentEmbedded: |
        instance of MSFT_FileDirectoryConfiguration as $MSFT_FileDirectoryConfiguration1ref
        {
          ResourceID = "[File]bla";
          Ensure = "Present";
          Contents = "bogus Content";
          DestinationPath = "c:\\bogus.txt";
          ModuleName = "PSDesiredStateConfiguration";
          SourceInfo = "::3::9::file";
          ModuleVersion = "1.0";
          ConfigurationName = "bla";
        };
        instance of OMI_ConfigurationDocument
        {
          Version="2.0.0";
          MinimumCompatibleVersion = "1.0.0";
          CompatibleVersionAdditionalProperties= {"Omi_BaseResource:ConfigurationName"};
          Author="bogusAuthor";
          GenerationDate="06/15/2018 14:06:24";
          GenerationHost="bogusComputer";
          Name="test";
        };        
    options:
      dependson:
        - ${exampleDscConfiguration}

Create DscNodeConfiguration Resource

new DscNodeConfiguration(name: string, args: DscNodeConfigurationArgs, opts?: CustomResourceOptions);
@overload
def DscNodeConfiguration(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         automation_account_name: Optional[str] = None,
                         content_embedded: Optional[str] = None,
                         name: Optional[str] = None,
                         resource_group_name: Optional[str] = None)
@overload
def DscNodeConfiguration(resource_name: str,
                         args: DscNodeConfigurationArgs,
                         opts: Optional[ResourceOptions] = None)
func NewDscNodeConfiguration(ctx *Context, name string, args DscNodeConfigurationArgs, opts ...ResourceOption) (*DscNodeConfiguration, error)
public DscNodeConfiguration(string name, DscNodeConfigurationArgs args, CustomResourceOptions? opts = null)
public DscNodeConfiguration(String name, DscNodeConfigurationArgs args)
public DscNodeConfiguration(String name, DscNodeConfigurationArgs args, CustomResourceOptions options)

type: azure:automation:DscNodeConfiguration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DscNodeConfigurationArgs
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 DscNodeConfigurationArgs
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 DscNodeConfigurationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DscNodeConfigurationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args DscNodeConfigurationArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

AutomationAccountName string

The name of the automation account in which the DSC Node Configuration is created. Changing this forces a new resource to be created.

ContentEmbedded string

The PowerShell DSC Node Configuration (mof content).

ResourceGroupName string

The name of the resource group in which the DSC Node Configuration is created. Changing this forces a new resource to be created.

Name string

Specifies the name of the DSC Node Configuration. Changing this forces a new resource to be created.

AutomationAccountName string

The name of the automation account in which the DSC Node Configuration is created. Changing this forces a new resource to be created.

ContentEmbedded string

The PowerShell DSC Node Configuration (mof content).

ResourceGroupName string

The name of the resource group in which the DSC Node Configuration is created. Changing this forces a new resource to be created.

Name string

Specifies the name of the DSC Node Configuration. Changing this forces a new resource to be created.

automationAccountName String

The name of the automation account in which the DSC Node Configuration is created. Changing this forces a new resource to be created.

contentEmbedded String

The PowerShell DSC Node Configuration (mof content).

resourceGroupName String

The name of the resource group in which the DSC Node Configuration is created. Changing this forces a new resource to be created.

name String

Specifies the name of the DSC Node Configuration. Changing this forces a new resource to be created.

automationAccountName string

The name of the automation account in which the DSC Node Configuration is created. Changing this forces a new resource to be created.

contentEmbedded string

The PowerShell DSC Node Configuration (mof content).

resourceGroupName string

The name of the resource group in which the DSC Node Configuration is created. Changing this forces a new resource to be created.

name string

Specifies the name of the DSC Node Configuration. Changing this forces a new resource to be created.

automation_account_name str

The name of the automation account in which the DSC Node Configuration is created. Changing this forces a new resource to be created.

content_embedded str

The PowerShell DSC Node Configuration (mof content).

resource_group_name str

The name of the resource group in which the DSC Node Configuration is created. Changing this forces a new resource to be created.

name str

Specifies the name of the DSC Node Configuration. Changing this forces a new resource to be created.

automationAccountName String

The name of the automation account in which the DSC Node Configuration is created. Changing this forces a new resource to be created.

contentEmbedded String

The PowerShell DSC Node Configuration (mof content).

resourceGroupName String

The name of the resource group in which the DSC Node Configuration is created. Changing this forces a new resource to be created.

name String

Specifies the name of the DSC Node Configuration. Changing this forces a new resource to be created.

Outputs

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

ConfigurationName string
Id string

The provider-assigned unique ID for this managed resource.

ConfigurationName string
Id string

The provider-assigned unique ID for this managed resource.

configurationName String
id String

The provider-assigned unique ID for this managed resource.

configurationName string
id string

The provider-assigned unique ID for this managed resource.

configuration_name str
id str

The provider-assigned unique ID for this managed resource.

configurationName String
id String

The provider-assigned unique ID for this managed resource.

Look up Existing DscNodeConfiguration Resource

Get an existing DscNodeConfiguration 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?: DscNodeConfigurationState, opts?: CustomResourceOptions): DscNodeConfiguration
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        automation_account_name: Optional[str] = None,
        configuration_name: Optional[str] = None,
        content_embedded: Optional[str] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None) -> DscNodeConfiguration
func GetDscNodeConfiguration(ctx *Context, name string, id IDInput, state *DscNodeConfigurationState, opts ...ResourceOption) (*DscNodeConfiguration, error)
public static DscNodeConfiguration Get(string name, Input<string> id, DscNodeConfigurationState? state, CustomResourceOptions? opts = null)
public static DscNodeConfiguration get(String name, Output<String> id, DscNodeConfigurationState 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 Node Configuration is created. Changing this forces a new resource to be created.

ConfigurationName string
ContentEmbedded string

The PowerShell DSC Node Configuration (mof content).

Name string

Specifies the name of the DSC Node Configuration. Changing this forces a new resource to be created.

ResourceGroupName string

The name of the resource group in which the DSC Node Configuration is created. Changing this forces a new resource to be created.

AutomationAccountName string

The name of the automation account in which the DSC Node Configuration is created. Changing this forces a new resource to be created.

ConfigurationName string
ContentEmbedded string

The PowerShell DSC Node Configuration (mof content).

Name string

Specifies the name of the DSC Node Configuration. Changing this forces a new resource to be created.

ResourceGroupName string

The name of the resource group in which the DSC Node Configuration is created. Changing this forces a new resource to be created.

automationAccountName String

The name of the automation account in which the DSC Node Configuration is created. Changing this forces a new resource to be created.

configurationName String
contentEmbedded String

The PowerShell DSC Node Configuration (mof content).

name String

Specifies the name of the DSC Node Configuration. Changing this forces a new resource to be created.

resourceGroupName String

The name of the resource group in which the DSC Node Configuration is created. Changing this forces a new resource to be created.

automationAccountName string

The name of the automation account in which the DSC Node Configuration is created. Changing this forces a new resource to be created.

configurationName string
contentEmbedded string

The PowerShell DSC Node Configuration (mof content).

name string

Specifies the name of the DSC Node Configuration. Changing this forces a new resource to be created.

resourceGroupName string

The name of the resource group in which the DSC Node Configuration is created. Changing this forces a new resource to be created.

automation_account_name str

The name of the automation account in which the DSC Node Configuration is created. Changing this forces a new resource to be created.

configuration_name str
content_embedded str

The PowerShell DSC Node Configuration (mof content).

name str

Specifies the name of the DSC Node Configuration. Changing this forces a new resource to be created.

resource_group_name str

The name of the resource group in which the DSC Node Configuration is created. Changing this forces a new resource to be created.

automationAccountName String

The name of the automation account in which the DSC Node Configuration is created. Changing this forces a new resource to be created.

configurationName String
contentEmbedded String

The PowerShell DSC Node Configuration (mof content).

name String

Specifies the name of the DSC Node Configuration. Changing this forces a new resource to be created.

resourceGroupName String

The name of the resource group in which the DSC Node Configuration is created. Changing this forces a new resource to be created.

Import

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

 $ pulumi import azure:automation/dscNodeConfiguration:DscNodeConfiguration configuration1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Automation/automationAccounts/account1/nodeConfigurations/configuration1

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.