在 Azure Automation State Configuration 中编译 DSC 配置

  • 项目

可通过以下方法在 Azure Automation State Configuration 中编译 Desired State Configuration (DSC) 配置：

  • Azure State Configuration 编译服务

    • 使用交互式用户界面的入门方法
    • 轻松跟踪作业状态

  • Windows PowerShell

    • 从本地工作站或生成服务上的 Windows PowerShell 调用
    • 与开发测试管道集成
    • 提供复杂的参数值
    • 大规模使用节点和非节点数据
    • 性能显著提高

还可以将 Azure 资源管理器模板与 Azure Desired State Configuration (DSC) 扩展结合使用，将配置推送到 Azure VM。 Azure DSC 扩展使用 Azure VM 代理框架来传送、启用和报告 Azure VM 上运行的 DSC 配置。 有关使用 Azure 资源管理器模板的编译详细信息，请参阅 Desired State Configuration 扩展与 Azure 资源管理器模板。

在 Azure State Configuration 中编译 DSC 配置

门户

  1. 在“自动化帐户”中，单击“State Configuration (DSC)”。
  2. 单击“配置”选项卡，然后单击要编译的配置名称。
  3. 单击“编译”。
  4. 如果该配置没有参数，系统会提示你确认是否要进行编译。 如果该配置有参数，则会打开“编译配置”边栏选项卡让用户提供参数值。
  5. 将打开“编译作业”页，以便你跟踪编译作业状态。 还可以使用此页跟踪放置在 Azure Automation State Configuration 拉取服务器上的节点配置（MOF 配置文档）。

Azure PowerShell

可以在 Windows PowerShell 中使用 Start-AzAutomationDscCompilationJob 开始编译。 以下示例代码将启动名为 SampleConfig 的 DSC 配置编译。

Start-AzAutomationDscCompilationJob -ResourceGroupName 'MyResourceGroup' -AutomationAccountName 'MyAutomationAccount' -ConfigurationName 'SampleConfig'

Start-AzAutomationDscCompilationJob 返回可用于跟踪作业状态的编译作业对象。 然后，可以将此编译作业对象与 Get-AzAutomationDscCompilationJob 一起使用来确定编译作业的状态，与 Get-AzAutomationDscCompilationJobOutput 一起使用来查看其流（输出）。 以下示例将启动 SampleConfig 配置的编译，并在编译完成后显示其流。

$CompilationJob = Start-AzAutomationDscCompilationJob -ResourceGroupName 'MyResourceGroup' -AutomationAccountName 'MyAutomationAccount' -ConfigurationName 'SampleConfig'

while($null -eq $CompilationJob.EndTime -and $null -eq $CompilationJob.Exception)
{
    $CompilationJob = $CompilationJob | Get-AzAutomationDscCompilationJob
    Start-Sleep -Seconds 3
}

$CompilationJob | Get-AzAutomationDscCompilationJobOutput -Stream Any

声明基本参数

DSC 配置中的参数声明（包括参数类型和属性）的工作方式与 Azure 自动化 Runbook 中相同。 若要了解有关 Runbook 参数的详细信息，请参阅 Starting a runbook in Azure Automation（在 Azure 自动化中启动 Runbook）。

以下示例使用 FeatureName 和 IsPresent 参数来确定编译期间在 ParametersExample.sample 节点配置中生成的属性值。

Configuration ParametersExample
{
    param(
        [Parameter(Mandatory=$true)]
        [string] $FeatureName,

        [Parameter(Mandatory=$true)]
        [boolean] $IsPresent
    )

    $EnsureString = 'Present'
    if($IsPresent -eq $false)
    {
        $EnsureString = 'Absent'
    }

    Node 'sample'
    {
        WindowsFeature ($FeatureName + 'Feature')
        {
            Ensure = $EnsureString
            Name   = $FeatureName
        }
    }
}

可以在 Azure Automation State Configuration 门户或 Azure PowerShell 中编译使用基本参数的 DSC 配置。

门户

在门户中，可在单击“编译”后输入参数值。

Configuration compile parameters

Azure PowerShell

PowerShell 需要哈希表中的参数，其中的键必须与参数名称匹配，值等于参数值。

$Parameters = @{
    'FeatureName' = 'Web-Server'
    'IsPresent' = $False
}

Start-AzAutomationDscCompilationJob -ResourceGroupName 'MyResourceGroup' -AutomationAccountName 'MyAutomationAccount' -ConfigurationName 'ParametersExample' -Parameters $Parameters

若要了解如何将 PSCredential 对象作为参数传递，请参阅凭据资产。

在 Azure 自动化中编译包含复合资源的配置

借助复合资源功能，可将 DSC 配置用作某个配置中的嵌套资源。 使用此功能可以将多个配置应用于单个资源。 请参阅复合资源：将 DSC 配置用作资源，了解有关复合资源的详细信息。

注意

为了正确编译包含复合资源的配置，必须先将复合所依赖的任何 DSC 资源导入到 Azure 自动化中。 添加 DSC 复合资源与将任何 PowerShell 模块添加到 Azure 自动化无差异。 管理 Azure 自动化中的模块一文中介绍了此过程。

在 Azure 自动化中编译配置的同时管理 ConfigurationData

ConfigurationData 是一个内置的 DSC 参数，可使你在使用 PowerShell DSC 时将结构化配置与任何环境特定配置分开。 有关详细信息，请参阅区分 PowerShell DSC 中的“What”与“Where”。

注意

在 Azure Automation State Configuration 中进行编译时，可以在 Azure PowerShell 中使用 ConfigurationData，但在 Azure 门户中却不行。

以下示例 DSC 配置通过 $ConfigurationData 和 $AllNodes 关键字来使用 ConfigurationData。 在本示例中还需要 xWebAdministration 模块。

Configuration ConfigurationDataSample
{
    Import-DscResource -ModuleName xWebAdministration -Name MSFT_xWebsite

    Write-Verbose $ConfigurationData.NonNodeData.SomeMessage

    Node $AllNodes.Where{$_.Role -eq 'WebServer'}.NodeName
    {
        xWebsite Site
        {
            Name         = $Node.SiteName
            PhysicalPath = $Node.SiteContents
            Ensure       = 'Present'
        }
    }
}

可以使用 Windows PowerShell 编译上述 DSC 配置。 以下脚本将两个节点配置添加到 Azure Automation State Configuration 拉取服务：ConfigurationDataSample.MyVM1 和 ConfigurationDataSample.MyVM3。

$ConfigData = @{
    AllNodes = @(
        @{
            NodeName = 'MyVM1'
            Role = 'WebServer'
        },
        @{
            NodeName = 'MyVM2'
            Role = 'SQLServer'
        },
        @{
            NodeName = 'MyVM3'
            Role = 'WebServer'
        }
    )

    NonNodeData = @{
        SomeMessage = 'I love Azure Automation State Configuration and DSC!'
    }
}

Start-AzAutomationDscCompilationJob -ResourceGroupName 'MyResourceGroup' -AutomationAccountName 'MyAutomationAccount' -ConfigurationName 'ConfigurationDataSample' -ConfigurationData $ConfigData

在编译期间使用 Azure 自动化中的资产

Azure Automation State Configuration 和 Runbook 中的资产引用是相同的。 有关详细信息，请参阅以下部分：

凭据资产

Azure 自动化中的 DSC 配置可以使用 Get-AutomationPSCredential cmdlet 引用自动化凭据资产。 如果配置具有用于指定 PSCredential 对象的参数，则可以通过将 Azure 自动化凭据资产的字符串名称传递给 cmdlet 来检索凭据，从而使用 Get-AutomationPSCredential。 然后将该对象用于需要 PSCredential 对象的参数。 在后台将检索具有该名称的 Azure 自动化凭据资产并将其传递给配置。 以下示例演示了此方案的实际应用。

要在节点配置（MOF 配置文档）中保持凭据的安全，需要在节点配置 MOF 文件中为凭据加密。 目前，必须授予 PowerShell DSC 权限以在节点配置 MOF 生成期间以纯文本形式输出凭据。 PowerShell DSC 并不知道在通过编译作业生成整个 MOF 文件后，Azure 自动化会对其进行加密。

可告知 PowerShell DSC，使用配置数据在生成的节点配置 MOF 中以纯文本形式输出凭据是可行的。 针对出现在 DSC 配置中且使用凭据的每个节点块名称，应通过 ConfigurationData 传递 PSDscAllowPlainTextPassword = $true。

以下示例演示使用自动化凭据资产的 DSC 配置。

Configuration CredentialSample
{
    Import-DscResource -ModuleName PSDesiredStateConfiguration
    $Cred = Get-AutomationPSCredential 'SomeCredentialAsset'

    Node $AllNodes.NodeName
    {
        File ExampleFile
        {
            SourcePath      = '\\Server\share\path\file.ext'
            DestinationPath = 'C:\destinationPath'
            Credential      = $Cred
        }
    }
}

可以使用 PowerShell 编译上述 DSC 配置。 以下 PowerShell 代码会将两个节点配置添加到 Azure Automation State Configuration 拉取服务器：CredentialSample.MyVM1 和 CredentialSample.MyVM2。

$ConfigData = @{
    AllNodes = @(
        @{
            NodeName = '*'
            PSDscAllowPlainTextPassword = $True
        },
        @{
            NodeName = 'MyVM1'
        },
        @{
            NodeName = 'MyVM2'
        }
    )
}

Start-AzAutomationDscCompilationJob -ResourceGroupName 'MyResourceGroup' -AutomationAccountName 'MyAutomationAccount' -ConfigurationName 'CredentialSample' -ConfigurationData $ConfigData

注意

编译完成后，可能会收到错误消息 The 'Microsoft.PowerShell.Management' module was not imported because the 'Microsoft.PowerShell.Management' snap-in was already imported.，你可以放心地忽略此消息。

在 Windows PowerShell 中编译 DSC 配置

在 Windows PowerShell 中编译 DSC 配置的过程包含在 PowerShell DSC 文档编写、编译和应用配置中。 可以从开发人员工作站或在生成服务（例如 Azure DevOps）中执行此过程。 然后，可以将通过编译配置生成的 MOF 文件导入到 Azure State Configuration 服务中。

在 Windows PowerShell 中编译还提供了对配置内容进行签名的选项。 DSC 代理会在托管节点上对已签名的节点配置进行本地验证。 验证可确保应用于节点的配置来自授权的源。

还可以导入已在 Azure 外部编译的节点配置（MOF 文件）。 导入包括从开发人员工作站或在服务（如 Azure DevOps）中进行的编译。 此方法具有多个优势，包括性能和可靠性方面的优势。

注意

节点配置文件不得大于 1 MB，以便 Azure 自动化将其导入。

若要详细了解如何为节点配置签名，请参阅 WMF 5.1 中的改进 - 如何为配置和模块签名。

在 Azure 门户中导入节点配置

  1. 在“自动化帐户”中的“配置管理”下，单击“State Configuration (DSC)”。

  2. 在“State Configuration (DSC)”页中，依次单击“配置”选项卡、“添加”。

  3. 在“导入”页中，单击“节点配置文件”字段旁边的文件夹图标，浏览到本地计算机上的节点配置 MOF 文件。

    Browse for local file

  4. 在“配置名称”字段中，输入名称。 此名称必须与编译节点配置的配置名称匹配。

  5. 单击 “确定” 。

使用 Azure PowerShell 导入节点配置

可以使用 Import-AzAutomationDscNodeConfiguration cmdlet 将节点配置导入自动化帐户。

Import-AzAutomationDscNodeConfiguration -AutomationAccountName 'MyAutomationAccount' -ResourceGroupName 'MyResourceGroup' -ConfigurationName 'MyNodeConfiguration' -Path 'C:\MyConfigurations\TestVM1.mof'

后续步骤