編譯 Azure 自動化狀態設定中的 DSC 組態

文章
10/05/2024

注意

Azure 自動化狀態設定將於 2027 年 9 月 30 日淘汰，請依該日期轉換至 Azure 機器組態。如需詳細資訊，請參閱部落格文章公告。 Azure Machine Configuration 服務結合 DSC 延伸模組、Azure 自動化狀態設定，以及客戶意見反應最常要求的功能。 Azure Machine Configuration 也包含混合機器支援 (透過已啟用 Arc 的伺服器提供)。

您可以透過下列方式，在 Azure 自動化狀態設定中編譯 Desired State Configuration (DSC) 組態：

Azure 狀態設定編譯服務
- 互動式使用者介面的初學者方法
- 輕鬆追蹤工作狀態
Windows PowerShell
- 在本機工作站或組建服務上從 Windows PowerShell 呼叫
- 與開發測試管線整合
- 提供複雜的參數值
- 使用大規模的節點和非節點資料
- 大幅改善效能

您也可以使用 Azure Resource Manager 範本搭配 Azure Desired State Configuration (DSC) 延伸模組，將組態推送至您的 Azure VM。 Azure DSC 延伸模組會使用「Azure VM 代理程式」架構來傳遞、套用在 Azure VM 上執行的 DSC 組態，並針對這些組態提出報告。如需使用 Azure Resource Manager 範本的編譯詳細資料，請參閱採用 Azure Resource Manager 範本的 Desired State Configuration 延伸模組。

在 Azure 狀態設定中編譯 DSC 組態

入口網站

在您的自動化帳戶中，選取 [狀態設定] [DSC]。
在 [ 組態] 索引標籤上選取，然後選取要編譯的組態名稱。
選取 [編譯]。
如果組態沒有參數，系統會提示您確認是否要加以編譯。如果組態具有參數，[ 編譯組態 ] 窗格隨即開啟，讓您可以提供參數值。
[編譯工作] 頁面隨即開啟，讓您可以追蹤編譯作業狀態。您也可以使用此頁面來追蹤放在 Azure 自動化狀態設定提取伺服器上的節點組態 (MOF 組態文件)。

Azure PowerShell

您可以使用 Start-AzAutomationDscCompilationJob，開始利用 Windows PowerShell 進行編譯。下列範例程式碼會啟動名為 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 參數，請參閱在 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 自動化狀態設定入口網站或 Azure PowerShell 中編譯使用基本參數的 DSC 組態。

入口網站

在入口網站中，您可以在按一下 [編譯] 後輸入參數值。

組態編譯參數

Azure PowerShell

PowerShell 會要求您將參數放入 hashtable 中，其中的索引鍵必須符合參數名稱，且值等於參數值。

$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 可讓您在使用 PowerShell DSC 時，將結構化組態與任何環境特定組態進行區隔。如需詳細資訊，請參閱分隔 PowerShell DSC 中的「結構組態」與「環境組態」。

注意

在 Azure 自動化狀態設定中進行編譯時，您可以使用 Azure PowerShell 中、而非 Azure 入口網站中的 ConfigurationData。

下列範例 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 自動化狀態設定提取服務：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 自動化狀態設定和 Runbook 中的資產參考是相同的。如需詳細資訊，請參閱下列文章：

認證資產

如果組態具有指定PSCredential對象的參數，請使用 Get-AutomationPSCredential 將 Azure 自動化認證資產的名稱傳遞至 Cmdlet 以擷取認證。 Azure 自動化將認證傳遞至組態。

若要在節點組態中保護認證安全，請將節點組態MOF檔案中的認證加密。您必須在節點設定MOF產生期間，授與PowerShell DSC以純文字輸出認證的許可權。 PowerShell DSC 不知道 Azure 自動化編譯作業所產生的整個MOF檔案之後，加密整個MOF檔案。

您可以告訴 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 自動化狀態設定提取伺服器：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 組態

PowerShell DSC 文件內包含在 Windows PowerShell 中編譯 DSC 組態的程序，寫入、編譯及套用組態。您可以從開發人員工作站或在組建服務內執行此程序，例如 Azure DevOps。接著，您可以將編譯組態所產生的 MOF 檔案匯入 Azure 狀態設定服務中。

在 Windows PowerShell 中進行編譯也提供簽署組態內容的選項。 DSC 代理程式會在受控節點上本機驗證已簽署的節點組態。驗證可確保套用至節點的組態來自已授權的來源。

您也可以匯入在 Azure 外部編譯的節點組態。匯入包含來自開發人員工作站或服務 (如 Azure DevOps) 的編譯。這個方法有多項優點，包括效能和可靠性。

注意

節點組態檔不得大於 1 MB，才能匯入 Azure 自動化中。

如需簽署節點組態的詳細資訊，請參閱 WMF 5.1 的改進 - 如何簽署組態和模組。

在 Azure 入口網站中匯入節點組態

在您的自動化帳戶中，選取 [組態管理] 底下的 [狀態設定] [DSC]。
在 [狀態設定 ][DSC] 頁面上，選取 [ 組態] 索引標籤上的 [ 新增]。
在 [匯入] 頁面上，選取 [節點組態檔] 字段旁的資料夾圖示，以瀏覽本機計算機上的節點組態MOF檔案。
在 [組態名稱] 欄位中輸入名稱。此名稱必須符合已編譯節點組態的組態名稱。
選取 [確定]。

使用 Azure PowerShell 匯入節點組態

您可以使用 Import-AzAutomationDscNodeConfiguration Cmdlet，將節點組態匯入您的自動化帳戶中。

$importAzAutomationDscNodeConfigurationSplat = @{
    AutomationAccountName = 'MyAutomationAccount'
    ResourceGroupName = 'MyResourceGroup'
    ConfigurationName = 'MyNodeConfiguration'
    Path = 'C:\MyConfigurations\TestVM1.mof'
}
Import-AzAutomationDscNodeConfiguration @importAzAutomationDscNodeConfigurationSplat

下一步

若要開始使用，請參閱開始使用 Azure 自動化狀態設定。
若要了解如何編譯 DSC 設定以指派給目標節點，請參閱在 Azure 自動化狀態設定中編譯 DSC 設定。
如需 PowerShell Cmdlet 參考，請參閱 Az.Automation。
如需價格資訊，請參閱 Azure 自動化狀態設定的價格。
如需在連續部署管線中使用狀態設定的範例，請參閱使用 Chocolatey 設定持續部署。

分享方式：

編譯 Azure 自動化狀態設定中的 DSC 組態

在 Azure 狀態設定中編譯 DSC 組態

入口網站

Azure PowerShell

宣告基本參數

入口網站

Azure PowerShell

Azure 自動化中包含複合資源的編譯組態

在編譯 Azure 自動化中的組態時管理 ConfigurationData

在編譯期間使用 Azure 自動化中的資產

認證資產

在 Windows PowerShell 中編譯 DSC 組態

在 Azure 入口網站中匯入節點組態

使用 Azure PowerShell 匯入節點組態

下一步

意見反映

更多資源