Skip to content

azurermAutomationDscConfiguration

Manages a Automation DSC Configuration.

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as azurerm from "./.gen/providers/azurerm";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: azurerm.
For a more precise conversion please use the --provider flag in convert.*/
const azurermResourceGroupExample = new azurerm.resourceGroup.ResourceGroup(
  this,
  "example",
  {
    location: "West Europe",
    name: "example-resources",
  }
);
const azurermAutomationAccountExample =
  new azurerm.automationAccount.AutomationAccount(this, "example_1", {
    location: azurermResourceGroupExample.location,
    name: "account1",
    resource_group_name: azurermResourceGroupExample.name,
    sku_name: "Basic",
  });
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermAutomationAccountExample.overrideLogicalId("example");
const azurermAutomationDscConfigurationExample =
  new azurerm.automationDscConfiguration.AutomationDscConfiguration(
    this,
    "example_2",
    {
      automation_account_name: azurermAutomationAccountExample.name,
      content_embedded: "configuration test {}",
      location: azurermResourceGroupExample.location,
      name: "test",
      resource_group_name: azurermResourceGroupExample.name,
    }
  );
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermAutomationDscConfigurationExample.overrideLogicalId("example");

Argument Reference

The following arguments are supported:

  • name - (Required) Specifies the name of the DSC Configuration. Changing this forces a new resource to be created.

  • resourceGroupName - (Required) The name of the resource group in which the DSC Configuration is created. Changing this forces a new resource to be created.

  • automationAccountName - (Required) The name of the automation account in which the DSC Configuration is created. Changing this forces a new resource to be created.

  • contentEmbedded - (Required) The PowerShell DSC Configuration script.

  • location - (Required) Must be the same location as the Automation Account. Changing this forces a new resource to be created.

  • logVerbose - (Optional) Verbose log option.

  • description - (Optional) Description to go with DSC Configuration.

  • tags - (Optional) A mapping of tags to assign to the resource.

Attributes Reference

The following attributes are exported:

  • id - The ID of the Automation DSC Configuration.

Timeouts

The timeouts block allows you to specify timeouts for certain actions:

  • create - (Defaults to 30 minutes) Used when creating the Automation DSC Configuration.
  • update - (Defaults to 30 minutes) Used when updating the Automation DSC Configuration.
  • read - (Defaults to 5 minutes) Used when retrieving the Automation DSC Configuration.
  • delete - (Defaults to 30 minutes) Used when deleting the Automation DSC Configuration.

Import

Automation DSC Configuration's can be imported using the resourceId, e.g.

terraform import azurerm_automation_dsc_configuration.configuration1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Automation/automationAccounts/account1/configurations/configuration1