|
1 | 1 | ---
|
2 |
| -title: Composing DSC Configurations in Azure Automation State Configuration (DSC) using Composite Resources |
3 |
| -description: Learn how to compose configurations using composite resources in Azure Automation State Configuration (DSC) |
| 2 | +title: Composing DSC configurations in Azure Automation State Configuration using composite resources |
| 3 | +description: Learn how to compose configurations using composite resources in Azure Automation State Configuration. |
4 | 4 | keywords: powershell dsc, desired state configuration, powershell dsc azure, composite resources
|
5 | 5 | services: automation
|
6 | 6 | ms.subservice: dsc
|
7 | 7 | ms.date: 08/21/2018
|
8 | 8 | ms.topic: conceptual
|
9 | 9 | ---
|
10 |
| -# Composing DSC Configurations in Azure Automation State Configuration (DSC) using Composite Resources |
| 10 | +# Composing DSC configurations in Azure Automation State Configuration using composite resources |
11 | 11 |
|
12 |
| -When a resource needs to be managed with more than a single desired state configuration (DSC) |
13 |
| -configuration, the best path is to use [composite |
14 |
| -resources](/powershell/scripting/dsc/resources/authoringresourcecomposite). A composite resource is a nested and |
15 |
| -parameterized configuration being used as a DSC resource within another configuration. This allows |
16 |
| -the creation of complex configurations while allowing the underlying composite resources |
17 |
| -(parameterized configurations) to be individually managed and built. |
| 12 | +When you need to manage resource with more than a single desired state configuration (DSC), the best path is to use [composite resources](/powershell/scripting/dsc/resources/authoringresourcecomposite). A composite resource is a nested and parameterized configuration being used as a DSC resource within another configuration. Use of composite resources allows you to create complex configurations while allowing the underlying composite resources to be individually managed and built. |
18 | 13 |
|
19 |
| -Azure Automation enables the [import and compilation of composite |
20 |
| -resources](automation-dsc-compile.md). |
21 |
| -Once composite resources have been |
22 |
| -imported into your Automation account, you are able to use the **Compose configuration** experience |
23 |
| -in the **State Configuration (DSC)** page. |
| 14 | +Azure Automation enables the [import and compilation of composite resources](automation-dsc-compile.md). Once you've imported composite resources into your Automation account, you can use Azure Automation State Configuration through the **State Configuration (DSC** feature in the Azure portal. |
24 | 15 |
|
25 | 16 | ## Composing a configuration from composite resources
|
26 | 17 |
|
27 | 18 | Before you can assign a configuration made from composite resources in the Azure portal, you must
|
28 |
| -compose it. This can be done using **Compose configuration** on the **State Configuration (DSC)** |
29 |
| -page while on either the **Configurations** or **Compiled configurations** tabs. |
| 19 | +compose the configuration. Composition uses **Compose configuration** on the State Configuration (DSC) |
| 20 | +page while on either the **Configurations** or the **Compiled configurations** tab. |
30 | 21 |
|
31 | 22 | 1. Sign in to the [Azure portal](https://portal.azure.com).
|
32 | 23 | 1. On the left, click **All resources** and then the name of your Automation account.
|
33 |
| -1. On the **Automation account** page, select **State configuration (DSC)** under **Configuration Management**. |
34 |
| -1. On the **State configuration (DSC)** page, click either the **Configurations** or **Compiled configurations** tab, then click **Compose configuration** in the menu at the top of the page. |
35 |
| -1. On the **Basics** step, provide the new configuration name (required) and click anywhere on the row of each composite resource that you want to include in your new configuration, then click **Next** or click the **Source code** step. For the following steps, we selected **PSExecutionPolicy** and **RenameAndDomainJoin** composite resources. |
| 24 | +1. On the Automation account page, select **State configuration (DSC)** under **Configuration Management**. |
| 25 | +1. On the State configuration (DSC) page, click either the **Configurations** or the **Compiled configurations** tab, then click **Compose configuration** in the menu at the top of the page. |
| 26 | +1. On the **Basics** step, provide the new configuration name (required) and click anywhere on the row of each composite resource that you want to include in your new configuration, then click **Next** or click the **Source code** step. For the following steps, we selected `PSExecutionPolicy` and `RenameAndDomainJoin` composite resources. |
36 | 27 | 
|
37 | 28 | 1. The **Source code** step shows what the composed configuration of the selected composite resources looks like. You can see the merging of all parameters and how they are passed to the composite resource. When you are done reviewing the new source code, click **Next** or click the **Parameters** step.
|
38 | 29 | 
|
39 |
| -1. On the **Parameters** step, the parameter that each composite resource has is exposed so that they can be provided. If a parameter has a description, it is displayed next to the parameter field. If a field is a **PSCredential** type parameter, the drop-down to configure provides a list of **Credential** objects in the current Automation account. A **+ Add a credential** option is also available. Once all required parameters have been provided, click **Save and compile**. |
| 30 | +1. On the **Parameters** step, the parameter for each composite resource is exposed so that values can be provided. If a parameter has a description, it is displayed next to the parameter field. If a parameter is of `PSCredential` type, the dropdown provides a list of **Credential** objects in the current Automation account. A **+ Add a credential** option is also available. Once all required parameters have been provided, click **Save and compile**. |
40 | 31 | 
|
41 | 32 |
|
42 | 33 | Once the new configuration is saved, it is submitted for compilation. Status of the
|
43 | 34 | compilation job can be viewed like any imported configuration. For more information, see [Viewing a
|
44 | 35 | compilation job](automation-dsc-getting-started.md#viewing-a-compilation-job).
|
45 | 36 |
|
46 |
| -When compilation has completed successfully, the new configuration appears in the **Compiled |
47 |
| -configurations** tab. Once it is visible in this tab, it can be assigned to a managed node using |
48 |
| -the steps in [Reassigning a node to a different node |
49 |
| -configuration](automation-dsc-getting-started.md#reassigning-a-node-to-a-different-node-configuration). |
| 37 | +When compilation has completed successfully, the new configuration appears in the **Compiled configurations** tab. Then you can assign the configuration to a managed node, using the steps in [Reassigning a node to a different node configuration](automation-dsc-getting-started.md#reassigning-a-node-to-a-different-node-configuration). |
50 | 38 |
|
51 | 39 | ## Next steps
|
52 | 40 |
|
53 |
| -- To get started, see [Getting started with Azure Automation State Configuration](automation-dsc-getting-started.md) |
54 |
| -- To learn how to onboard nodes, see [Onboarding machines for management by Azure Automation State Configuration](automation-dsc-onboarding.md) |
55 |
| -- To learn about compiling DSC configurations so that you can assign them to target nodes, see [Compiling configurations in Azure Automation State Configuration](automation-dsc-compile.md) |
56 |
| -- For PowerShell cmdlet reference, see [Azure Automation State Configuration cmdlets](/powershell/module/azurerm.automation/#automation) |
57 |
| -- For pricing information, see [Azure Automation State Configuration pricing](https://azure.microsoft.com/pricing/details/automation/) |
58 |
| -- To see an example of using Azure Automation State Configuration in a continuous deployment pipeline, see [Continuous Deployment Using Azure Automation State Configuration and Chocolatey](automation-dsc-cd-chocolatey.md) |
| 41 | +- To get started, see [Getting started with Azure Automation State Configuration](automation-dsc-getting-started.md). |
| 42 | +- To learn how to onboard nodes, see [Onboarding machines for management by Azure Automation State Configuration](automation-dsc-onboarding.md). |
| 43 | +- To learn about compiling DSC configurations so that you can assign them to target nodes, see [Compiling configurations in Azure Automation State Configuration](automation-dsc-compile.md). |
| 44 | +- For PowerShell cmdlet reference, see [Azure Automation State Configuration cmdlets](/powershell/module/azurerm.automation/#automation). |
| 45 | +- For pricing information, see [Azure Automation State Configuration pricing](https://azure.microsoft.com/pricing/details/automation/). |
| 46 | +- To see an example of using Azure Automation State Configuration in a continuous deployment pipeline, see [Continuous Deployment Using Azure Automation State Configuration and Chocolatey](automation-dsc-cd-chocolatey.md). |
0 commit comments