Azure Automation State Configuration の使用開始Getting started with Azure Automation State Configuration

この記事では、Azure Automation State Configuration を使用して最も一般的なタスク (構成の作成、インポート、コンパイル、管理するマシンのオンボード、レポートの表示など) を実行する方法について説明します。This article explains how to do the most common tasks with Azure Automation State Configuration, such as creating, importing, and compiling configurations, onboarding machines to manage, and viewing reports. Azure Automation State Configuration の概要については、Azure Automation State Configuration の概要に関するページをご覧ください。For an overview of what Azure Automation State Configuration is, see Azure Automation State Configuration Overview. Desired State Configuration (DSC) のドキュメントについては、「Windows PowerShell Desired State Configuration の概要」を参照してください。For Desired State Configuration (DSC) documentation, see Windows PowerShell Desired State Configuration Overview.

この記事は、Azure Automation State Configuration を使用するための詳しい手順を示しています。This article provides a step-by-step guide to using Azure Automation State Configuration. この記事で説明されている手順を実行せずに、既に設定されているサンプル環境を使用する場合は、Resource Manager テンプレート (Azure Automation マネージド ノード テンプレート) を使用できます。If you want a sample environment that is already set up without following the steps described in this article, you can use the following Resource Manager template: Azure Automation Managed Node template. このテンプレートを使用すると、Azure Automation State Configuration で管理される Azure VM を含む、完成した Azure Automation State Configuration 環境が設定されます。This template sets up a completed Azure Automation State Configuration environment, including an Azure VM that is managed by Azure Automation State Configuration.

前提条件Prerequisites

この記事の例を完了するには、次のものが必要です。To complete the examples in this article, the following are required:

DSC 構成を作成するCreating a DSC configuration

ここでは、ノードの割り当て方法に応じて、Web-Server Windows 機能 (IIS) が存在するかどうかを確認する、簡単な DSC 構成を作成します。You create a simple DSC configuration that ensures either the presence or absence of the Web-Server Windows Feature (IIS), depending on how you assign nodes.

  1. VSCode (または任意のテキスト エディター) を開始します。Start VSCode (or any text editor).

  2. 次のテキストを入力します。Type the following text:

    configuration TestConfig
    {
        Node IsWebServer
        {
            WindowsFeature IIS
            {
                Ensure               = 'Present'
                Name                 = 'Web-Server'
                IncludeAllSubFeature = $true
            }
        }
    
        Node NotWebServer
        {
            WindowsFeature IIS
            {
                Ensure               = 'Absent'
                Name                 = 'Web-Server'
            }
        }
    }
    
  3. ファイルを TestConfig.ps1という名前で保存します。Save the file as TestConfig.ps1.

この構成は、各ノード ブロックで 1 つのリソース (WindowsFeature リソース) を呼び出します。このリソースが、Web-Server 機能が存在するかどうかを確認します。This configuration calls one resource in each node block, the WindowsFeature resource, that ensures either the presence or absence of the Web-Server feature.

Azure Automation に構成をインポートするImporting a configuration into Azure Automation

次に、この構成を Automation アカウントにインポートします。Next, you import the configuration into the Automation account.

  1. Azure Portal にサインインします。Sign in to the Azure portal.

  2. 左側の [すべてのリソース] をクリックし、使用している Automation アカウントの名前をクリックします。On the left, click All resources and then the name of your Automation account.

  3. [Automation アカウント] ページで、 [構成管理][状態の構成 (DSC)] を選択します。On the Automation account page, select State configuration (DSC) under Configuration Management.

  4. [状態の構成 (DSC)] ページで [構成] タブをクリックし、 [+ 追加] をクリックします。On the State configuration (DSC) page, click the Configurations tab, then click + Add.

  5. [構成のインポート] ページで、コンピューター上の TestConfig.ps1 ファイルを参照します。On the Import Configuration page, browse to the TestConfig.ps1 file on your computer.

    [構成のインポート] ブレードのスクリーンショット

  6. Click OK.Click OK.

Azure Automation で構成を表示するViewing a configuration in Azure Automation

インポートした構成は、Azure ポータルで表示できます。After you have imported a configuration, you can view it in the Azure portal.

  1. Azure Portal にサインインします。Sign in to the Azure portal.

  2. 左側の [すべてのリソース] をクリックし、使用している Automation アカウントの名前をクリックします。On the left, click All resources and then the name of your Automation account.

  3. [Automation アカウント] ページで、 [構成管理][状態の構成 (DSC)] を選択します。On the Automation account page, select State configuration (DSC) under Configuration Management.

  4. [状態の構成 (DSC)] ページで、 [構成] タブをクリックし、 [TestConfig] (前の手順でインポートした構成の名前) をクリックします。On the State configuration (DSC) page, click the Configurations tab, then click TestConfig (this is the name of the configuration you imported in the previous procedure).

  5. [TestConfig の構成] ページで、 [構成ソースの表示] をクリックします。On the TestConfig Configuration page, click View configuration source.

    Screenshot of the TestConfig configuration blade

    [TestConfig Configuration source (TestConfig の構成ソース)] ページが開き、構成の PowerShell コードが表示されます。A TestConfig Configuration source page opens, displaying the PowerShell code for the configuration.

Azure Automation で構成をコンパイルするCompiling a configuration in Azure Automation

目的の状態をノードに適用する前に、その状態を定義する DSC 構成を 1 つ以上のノード構成 (MOF ドキュメント) にコンパイルし、Automation DSC プル サーバーに配置する必要があります。Before you can apply a desired state to a node, a DSC configuration defining that state must be compiled into one or more node configurations (MOF document), and placed on the Automation DSC Pull Server. Azure Automation State Configuration での構成のコンパイルの詳細については、Azure Automation State Configuration での構成のコンパイルに関するページをご覧ください。For a more detailed description of compiling configurations in Azure Automation State Configuration, see Compiling configurations in Azure Automation State Configuration. 構成のコンパイルの詳細については、「 DSC 構成」を参照してください。For more information about compiling configurations, see DSC Configurations.

  1. Azure Portal にサインインします。Sign in to the Azure portal.

  2. 左側の [すべてのリソース] をクリックし、使用している Automation アカウントの名前をクリックします。On the left, click All resources and then the name of your Automation account.

  3. [Automation アカウント] ページで、 [構成管理][状態の構成 (DSC)] をクリックします。On the Automation account page, click State configuration (DSC) under Configuration Management.

  4. [状態の構成 (DSC)] ページで、 [構成] タブをクリックし、 [TestConfig] (前にインポートした構成の名前) をクリックします。On the State configuration (DSC) page, click the Configurations tab, then click TestConfig (the name of the previously imported configuration).

  5. [TestConfig の構成] ページで [コンパイル] をクリックし、 [はい] をクリックします。On the TestConfig Configuration page, click Compile, and then click Yes. これにより、コンパイル ジョブが開始されます。This starts a compilation job.

    [コンパイル] ボタンが強調表示されている [TestConfig の構成] ページのスクリーンショット

注意

Azure Automation で構成をコンパイルすると、作成されたノード構成 MOF すべてが自動的にプル サーバーにデプロイされます。When you compile a configuration in Azure Automation, it automatically deploys any created node configuration MOFs to the pull server.

コンパイル ジョブを表示するViewing a compilation job

コンパイルを開始すると、 [構成] ページの [コンパイル ジョブ] タイルでコンパイル ジョブを確認できます。After you start a compilation, you can view it in the Compilation Jobs tile in the Configuration page. [コンパイル ジョブ] タイルには、現在実行中のジョブ、完了したジョブ、失敗したジョブが表示されます。The Compilation Jobs tile shows currently running, completed, and failed jobs. コンパイル ジョブのページを開くと、ジョブに関する情報が表示されます。これには、発生したエラーと警告、構成で使用されている入力パラメーター、コンパイル ログが含まれています。When you open a compilation job page, it shows information about that job including any errors or warnings encountered, input parameters used in the configuration, and compilation logs.

  1. Azure Portal にサインインします。Sign in to the Azure portal.

  2. 左側の [すべてのリソース] をクリックし、使用している Automation アカウントの名前をクリックします。On the left, click All resources and then the name of your Automation account.

  3. [Automation アカウント] ページで、 [構成管理][状態の構成 (DSC)] をクリックします。On the Automation account page, click State configuration (DSC) under Configuration Management.

  4. [状態の構成 (DSC)] ページで、 [構成] タブをクリックし、 [TestConfig] (前にインポートした構成の名前) をクリックします。On the State configuration (DSC) page, click the Configurations tab, then click TestConfig (the name of the previously imported configuration).

  5. [コンパイル ジョブ] で、表示するコンパイル ジョブを選択します。Under Compilation jobs, select the compilation job you want to view. コンパイル ジョブの開始日付のラベルが付いた [コンパイル ジョブ] ページが開きます。A Compilation Job page opens labeled with the date that the compilation job was started.

    [コンパイル ジョブ] ページのスクリーンショット

  6. [コンパイル ジョブ] ページで任意のタイルをクリックすると、そのジョブの詳細が表示されます。Click on any tile in the Compilation Job page to see further details about the job.

ノード構成を表示するViewing node configurations

コンパイル ジョブが正常に完了すると、1 つ以上の新しいノード構成が作成されます。Successful completion of a compilation job creates one or more new node configurations. ノード構成とは、プル サーバーにデプロイされ、1 つ以上のノードがプルして適用できるようになる MOF ドキュメントです。A node configuration is a MOF document that is deployed to the pull server and ready to be pulled and applied by one or more nodes. [状態の構成 (DSC)] ページでは、Automation アカウントのノード構成を確認できます。You can view the node configurations in your Automation account in the State configuration (DSC) page. ノード構成の名前は、ConfigurationName.NodeName という形式です。A node configuration has a name with the form ConfigurationName.NodeName.

  1. Azure Portal にサインインします。Sign in to the Azure portal.

  2. 左側の [すべてのリソース] をクリックし、使用している Automation アカウントの名前をクリックします。On the left, click All resources and then the name of your Automation account.

  3. [Automation アカウント] ブレードで、 [構成管理][状態の構成 (DSC)] をクリックします。On the Automation account blade, click State configuration (DSC) under Configuration Management.

  4. [状態の構成 (DSC)] ページで [コンパイル済み構成] タブをクリックします。On the State configuration (DSC) page, click the Compiled configurations tab.

    [コンパイル済み構成] タブのスクリーンショット

Azure Automation State Configuration を使用して管理のために Azure VM をオンボードするOnboarding an Azure VM for management with Azure Automation State Configuration

Azure Automation State Configuration を使用すると、Azure VM (クラシックと Resource Manager の両方)、オンプレミスの VM、Linux マシン、AWS VM、オンプレミスの物理マシンを管理できます。You can use Azure Automation State Configuration to manage Azure VMs (both Classic and Resource Manager), on-premises VMs, Linux machines, AWS VMs, and on-premises physical machines. この記事では、Azure Resource Manager VM をオンボードする方法のみを説明します。In this article, you learn how to onboard only Azure Resource Manager VMs. 他の種類のマシンのオンボードの詳細については、Azure Automation State Configuration による管理のためのマシンのオンボードに関するページをご覧ください。For information about onboarding other types of machines, see Onboarding machines for management by Azure Automation State Configuration.

Azure Automation State Configuration を使用して管理のために Azure Resource Manager VM をオンボードするにはTo onboard an Azure Resource Manager VM for management by Azure Automation State Configuration

  1. Azure Portal にサインインします。Sign in to the Azure portal.

  2. 左側の [すべてのリソース] をクリックし、使用している Automation アカウントの名前をクリックします。On the left, click All resources and then the name of your Automation account.

  3. [Automation アカウント] ブレードで、 [構成管理][状態の構成 (DSC)] をクリックします。On the Automation account blade, click State configuration (DSC) under Configuration Management.

  4. [状態の構成 (DSC)] ページで、 [ノード] タブの [+ 追加] をクリックします。On the State configuration (DSC) page, while on the Nodes tab, click + Add.

    [Azure VM の追加] ボタンが強調表示された [DSC ノード] ページのスクリーンショット

  5. [仮想マシン] ページで、自分の VM を選択します。On the Virtual Machines page, select your VM.

  6. [仮想マシン] 詳細ページで、 [+ 接続] をクリックします。On the Virtual machine detail page, click + Connect.

    重要

    サポートされているオペレーティング システムを実行している Azure Resource Manager VM である必要があります。This must be an Azure Resource Manager VM running a supported operating system.

  7. [登録] ページの [ノード構成名] ボックスで、VM に適用するノード構成の名前を選択します。In the Registration page, select the name of the node configuration you want to apply to the VM in the Node configuration name box. この時点では、名前の入力は省略可能です。Providing a name at this point is optional. ノードのオンボード後に、割り当てられたノード構成を変更できます。You can change the assigned node configuration after onboarding the node. [必要に応じてノードを再起動する] チェック ボックスをオンにし、 [OK] をクリックします。Check Reboot Node if Needed, then click OK.

    Screenshot of the Registration blade

    指定したノード構成は、 [構成モードの頻度] に指定された間隔で VM に適用されます。また、VM は、 [更新頻度] に指定された間隔でノード構成に対する更新をチェックします。The node configuration you specified are applied to the VM at intervals specified by the Configuration Mode Frequency, and the VM checks for updates to the node configuration at intervals specified by the Refresh Frequency. これらの値の使用方法の詳細については、「ローカル構成マネージャーの構成」を参照してください。For more information about how these values are used, see Configuring the Local Configuration Manager.

Azure によって VM のオンボード処理が開始されます。Azure starts the process of onboarding the VM. 処理が完了すると、Automation アカウントの [状態の構成 (DSC)] ページの [ノード] タブに VM が表示されます。When it is complete, the VM shows up in the Nodes tab of the State configuration (DSC) page in the Automation account.

マネージド ノードの一覧を表示するViewing the list of managed nodes

Automation アカウントの [状態の構成 (DSC)] ページの [ノード] タブで、管理のためにオンボードされたマシンの一覧を表示できます。You can view the list of all machines that have been onboarded for management in your Automation account in the Nodes tab of the State configuration (DSC) page.

  1. Azure Portal にサインインします。Sign in to the Azure portal.
  2. 左側の [すべてのリソース] をクリックし、使用している Automation アカウントの名前をクリックします。On the left, click All resources and then the name of your Automation account.
  3. [Automation アカウント] ブレードで、 [構成管理][状態の構成 (DSC)] をクリックします。On the Automation account blade, click State configuration (DSC) under Configuration Management.
  4. [状態の構成 (DSC)] ページで、 [ノード] タブをクリックします。On the State configuration (DSC) page, click the Nodes tab.

マネージド ノードのレポートを表示するViewing reports for managed nodes

Azure Automation State Configuration でマネージド ノードの整合性チェックが実行されるたびに、そのノードから状態レポートがプル サーバーに送信されます。Each time Azure Automation State Configuration performs a consistency check on a managed node, the node sends a status report back to the pull server. これらのレポートは、そのノードのページに表示できます。You can view these reports on the page for that node.

  1. Azure Portal にサインインします。Sign in to the Azure portal.

  2. 左側の [すべてのリソース] をクリックし、使用している Automation アカウントの名前をクリックします。On the left, click All resources and then the name of your Automation account.

  3. [Automation アカウント] ブレードで、 [構成管理][状態の構成 (DSC)] をクリックします。On the Automation account blade, click State configuration (DSC) under Configuration Management.

  4. [状態の構成 (DSC)] ページで、 [ノード] タブをクリックします。ここでは、構成の状態の概要と各ノードの詳細を確認できます。On the State configuration (DSC) page, click the Nodes tab. Here, you can see the overview of Configuration state and the details for each node.

    ノード ページのスクリーンショット

  5. [ノード] タブで、ノード レコードをクリックしてレポートを開きます。While on the Nodes tab, click the node record to open the reporting. レポートの詳細を表示するレポートをクリックします。Click the report you want to view additional reporting details.

    Screenshot of the Report blade

各レポートのブレードでは、対応する整合性チェックについて次の状態情報を表示できます。On the blade for an individual report, you can see the following status information for the corresponding consistency check:

  • レポートの状態。ノードが "準拠" かどうか、構成が "失敗" かどうか、ノードが "非準拠" (ノードが ApplyandMonitor モードでも、マシンが望ましい状態でない場合) かどうか。The report status — whether the node is "Compliant", the configuration "Failed", or the node is "Not Compliant" (when the node is in ApplyandMonitor mode and the machine is not in the desired state).
  • 整合性チェックの開始時刻。The start time for the consistency check.
  • 整合性チェックの合計実行時間。The total runtime for the consistency check.
  • 整合性チェックの種類。The type of consistency check.
  • エラー コードやエラー メッセージを含むすべてのエラー。Any errors, including the error code and error message.
  • 構成で使用されているすべての DSC リソースと各リソースの状態 (ノードがそのリソースの望ましい状態であるかどうか)。各リソースをクリックすると、そのリソースの詳細情報を表示できます。Any DSC resources used in the configuration, and the state of each resource (whether the node is in the desired state for that resource) — you can click on each resource to get more detailed information for that resource.
  • ノードの名前、IP アドレス、構成モード。The name, IP address, and configuration mode of the node.

また、 [生レポートの表示] をクリックすると、ノードがサーバーに送信する実際のデータを表示することもできます。You can also click View raw report to see the actual data that the node sends to the server. このデータの使用方法の詳細については、「 DSC レポート サーバーの使用」を参照してください。For more information about using that data, see Using a DSC report server.

ノードがオンボードされてから、最初のレポートが使用可能になるまで、しばらく時間がかかることがあります。It can take some time after a node is onboarded before the first report is available. ノードのオンボードから最初のレポートが表示されるまで、最大で 30 分の待つことが必要になる場合があります。You might need to wait up to 30 minutes for the first report after you onboard a node.

別のノード構成にノードを再割り当てするReassigning a node to a different node configuration

最初に割り当てたものとは別のノード構成を使用するようにノードを割り当てることができます。You can assign a node to use a different node configuration than the one you initially assigned.

  1. Azure Portal にサインインします。Sign in to the Azure portal.

  2. 左側の [すべてのリソース] をクリックし、使用している Automation アカウントの名前をクリックします。On the left, click All resources and then the name of your Automation account.

  3. [Automation アカウント] ブレードで、 [構成管理][状態の構成 (DSC)] をクリックします。On the Automation account blade, click State configuration (DSC) under Configuration Management.

  4. [状態の構成 (DSC)] ページで、 [ノード] タブをクリックします。On the State configuration (DSC) page, click the Nodes tab.

  5. [ノード] タブで、再割り当てするノードの名前をクリックします。On the Nodes tab, click on the name of the node you want to reassign.

  6. そのノードのページで、 [ノード構成の割り当て] をクリックします。On the page for that node, click Assign node configuration.

    [ノード構成の割り当て] ボタンが強調表示されている [ノード] 詳細ページのスクリーンショット

  7. [ノード構成の割り当て] ページで、ノードの割り当て先となるノード構成を選択し、 [OK] をクリックします。On the Assign Node Configuration page, select the node configuration to which you want to assign the node, and then click OK.

    [ノード構成の割り当て] ページのスクリーンショット

ノードの登録を解除するUnregistering a node

ノードを Azure Automation DSC で管理する必要がなくなった場合は、ノードの登録を解除することができます。If you no longer want a node to be managed by Azure Automation DSC, you can unregister it.

  1. Azure Portal にサインインします。Sign in to the Azure portal.

  2. 左側の [すべてのリソース] をクリックし、使用している Automation アカウントの名前をクリックします。On the left, click All resources and then the name of your Automation account.

  3. [Automation アカウント] ブレードで、 [構成管理][状態の構成 (DSC)] をクリックします。On the Automation account blade, click State configuration (DSC) under Configuration Management.

  4. [状態の構成 (DSC)] ページで、 [ノード] タブをクリックします。On the State configuration (DSC) page, click the Nodes tab.

  5. [ノード] ページで、登録解除するノードの名前をクリックします。On the Nodes tab, click on the name of the node you want to unregister.

  6. そのノードのページで、 [登録解除] をクリックします。On the page for that node, click Unregister.

    [登録解除] ボタンが強調表示されている [ノード] 詳細ページのスクリーンショット