チュートリアル: Automation で PowerShell ワークフロー Runbook を作成する

[アーティクル]
05/11/2023

このチュートリアルでは、Azure Automation で PowerShell Workflow Runbook を作成します。 PowerShell ワークフロー Runbook は、Windows PowerShell ワークフローに基づくテキスト Runbook です。 Azure portal のテキストエディターを使用して、Runbook のコードを作成したり編集したりすることができます。

Note

この記事は PowerShell 5.1 に適用されます。PowerShell 7.1 (プレビュー) と PowerShell 7.2 ではワークフローはサポートされていません。

このチュートリアルでは、次の作業を行う方法について説明します。

PowerShell Workflow Runbook を作成する
Runbook をテストして発行する
Runbook ジョブの状態を実行、追跡する
Azure リソースを管理するための認証を追加する
Azure 仮想マシンを起動するように Runbook パラメーターを更新する

Azure サブスクリプションをお持ちでない場合は、開始する前に無料アカウントを作成してください。

前提条件

少なくとも 1 つのユーザー割り当てマネージド ID を持つ Azure Automation アカウント。詳細については、マネージド ID の有効化に関するページを参照してください。
Az モジュール: Az.Accounts および Az.Compute が Automation アカウントにインポートされている。詳細については、「Az モジュールをインポートする」を参照してください。
2 台以上の Azure 仮想マシン。これらのマシンを停止して起動するため、運用環境の VM にしないでください。
Azure Az PowerShell モジュールがマシンにインストールされている。インストールまたはアップグレードするには、Azure Az PowerShell モジュールをインストールする方法に関するページを参照してください。

マネージド ID にアクセス許可を割り当てる

適切なマネージド ID にアクセス許可を割り当てて、仮想マシンを停止できるようにします。 Runbook では、Automation アカウントのシステム割り当てマネージド ID またはユーザー割り当てマネージド ID のいずれかを使用できます。以下に、各 ID にアクセス許可を割り当てる手順を示します。以下の手順では、Azure portal を使用します。 PowerShell を使用する場合は、「Azure PowerShell を使用して Azure ロールを割り当てる」を参照してください。

Azure portal にサインインし、お使いの Automation アカウントに移動します。
[アカウント設定] で、 [ID (プレビュー)] を選択します。
[システム割り当て済み] タブの [アクセス許可] で、 [Azure ロールの割り当て] を選択して、 [Azure ロールの割り当て] ページを開きます。
[+ ロールの割り当ての追加 (プレビュー)] を選択して、 [ロールの割り当ての追加 (プレビュー)] ページを開きます。

適切な値を選択します。

プロパティ	Description
Scope	スコープは、ロールの割り当てが適用される一連のリソースです。ドロップダウンリストから、 [リソースグループ] を選択します。
サブスクリプション	このフィールドには、ご自分のサブスクリプションが自動的に設定されます。
リソースグループ	ドロップダウンリストから、ID のアクセス許可を付与するリソースグループを選択します。
ロール	ドロップダウンリストから、 [DevTest Labs ユーザー] を選択します。

[保存] を選択し、 [Azure ロールの割り当て] ページを閉じて、 [システム割り当て済み] タブに戻ります。
[ユーザー割り当て済み] タブを選択します。
一覧からお使いのユーザー割り当てマネージド ID を選択して、 [マネージド ID] ページを選択します。
後で使用できるように、クライアント ID をメモします。
左側のメニューから、 [Azure ロールの割り当て] を選択し、 [+ ロールの割り当ての追加 (プレビュー)] を選択して、 [ロールの割り当ての追加 (プレビュー)] ページを開きます。

適切な値を選択します。

プロパティ	Description
Scope	ドロップダウンリストから、 [リソースグループ] を選択します。
サブスクリプション	このフィールドには、ご自分のサブスクリプションが自動的に設定されます。
リソースグループ	ドロップダウンリストから、ID のアクセス許可を付与するリソースグループを選択します。
ロール	ドロップダウンリストから、 [DevTest Labs ユーザー] を選択します。

[保存] を選択し、 [Azure ロールの割り当て] ページを閉じて、 [ユーザー割り当て済み] タブに戻ります。

新しい Runbook を作成する

まず、単純な PowerShell ワークフロー Runbook を作成します。 Windows PowerShell ワークフローの利点の 1 つは、一般的なスクリプトのように順番に実行するのでなく、一連のコマンドを並行して実行できることです。

Note

このリリースでは、Azure portal での Runbook の作成エクスペリエンスが新しくなりました。 [Runbook] ブレード >[Runbook の作成] を選択すると、新しいページ [Runbook の作成] が開き、適用可能なオプションが表示されます。

開いている [Automation アカウント] ページの [プロセスオートメーション] で、 [Runbook] を選択します。
[+ Runbook の作成] を選択します。
1. Runbook に名前を付けます。例: test。
2. [Runbook の種類] ドロップダウンメニューから、 [PowerShell ワークフロー] を選択します。
3. [ランタイムバージョン] ドロップダウンから、[5.1] を選択します。
4. 該当する [説明] を入力します。
5. ［作成］ を選択します

Runbook にコードを追加する

Runbook に直接コードを入力するか、ライブラリコントロールからコマンドレット、Runbook、資産を選択し、関連するパラメーターを使って Runbook に追加できます。このチュートリアルでは、Runbook に直接コードを入力します。

Runbook はこの時点で空です (必要な Workflow キーワード、Runbook の名前、ワークフロー全体を囲む中かっこ以外)。

Workflow MyFirstRunbook-Workflow
{
}

Parallel キーワードを使用すると、複数のコマンドが同時に実行されるスクリプトブロックを作成できます。中かっこの "間" に次のコードを入力します。
```
Parallel {
     Write-Output "Parallel"
     Get-Date
     Start-Sleep -s 3
     Get-Date
 }

Write-Output " `r`n"
Write-Output "Non-Parallel"
Get-Date
Start-Sleep -s 3
Get-Date
```
[保存] を選択して Runbook を保存します。

Runbook をテストする

Runbook を発行して運用環境で使用できるようにする前に、テストして正常に動作することを確認します。 Runbook をテストすると、そのドラフトバージョンが実行され、その出力を対話形式で表示できます。

[テストウィンドウ] を選択して、 [テスト] ページを開きます。
[開始] を選択してテストを開始します。 Runbook ジョブが作成され、その状態がペインに表示されます。

ジョブの最初の状態は "キュー済み" であり、クラウドで runbook worker が使用可能になるのをジョブが待機していることを示します。 worker がジョブを要求すると、状態は "開始中" になります。最後に、Runbook が実際に実行を開始すると [実行中] になります。
Runbook ジョブが完了すると、 [テスト] ページにその出力が表示されます。出力は、次の画像のようになります。

出力結果を確認します。 Start-Sleep コマンドなど、Parallel ブロック内のコマンドはすべて同時に実行されました。同じコマンドでも、Parallel ブロック外にあるものは、異なる日時スタンプで示されているように、順次実行されました。
[テスト] ページを閉じて、キャンバスに戻ります。

Runbook を発行して開始する

作成した Runbook は、まだドラフトモードです。運用環境で実行できるようにするには、発行する必要があります。 Runbook を発行するときは、既存の発行済みバージョンをドラフトバージョンで上書きします。この例では、Runbook を作成したばかりなので、発行済みバージョンはまだありません。

[発行] を選択して Runbook を発行し、確認を要求されたら [はい] をクリックします。
以上で、 [状態] フィールドに、 [発行済み] と表示されます。 Runbook の即時開始、将来の開始スケジュールの設定、または Runbook を HTTP 呼び出しで開始できるようにする Webhook の作成を行うために使用できる上部のオプションが表示されています。 [開始] を選択し、確認を求められたら [はい] をクリックして、Runbook を開始します。
作成した Runbook ジョブのジョブ ページが開きます。この場合、ジョブの進行状況を確認できるように、このページを開いたままにしておきます。 [状態] フィールドは、Runbook のテスト時に確認した状態と一致します。
Runbook の状態が [完了] になったら、 [出力] を選択します。出力は、テスト出力と同じようになります。
[ジョブ] ページを閉じて、Runbook の [概要] ページに戻ります。
[リソース] で、 [ジョブ] を選択します。このページには、お使いの Runbook によって作成されたすべてのジョブの一覧が表示されます。ジョブを 1 回実行しただけであるため、一覧に表示されるジョブは 1 つだけです。
このジョブを選択すると、Runbook を開始したときに表示されたものと同じ [ジョブ] ページが開きます。 Runbook に対して作成されたジョブの詳細を表示するには、このページを使用します。 [ジョブ] ページを閉じて、Runbook の [概要] ページに戻ります。

Azure リソースを管理するための認証を追加する

Runbook をテストして発行しましたが、これまでのところ役に立つことは何もしていません。 Azure リソースを管理させることにします。サブスクリプションの資格情報を使用して認証を行わないかぎり、これを行うことはできません。 Runbook では、VM に対する管理アクションの実行を Azure で認証するために、Automation アカウントのシステム割り当てマネージド ID が使用されます。 Runbook は、ユーザー割り当てマネージド ID を使用するように簡単に変更することができます。

[概要] 、 [編集] の順に選択して、テキストエディターを開きます。

既存のコードを次のコードに置き換えます。

workflow MyFirstRunbook-Workflow
{
$resourceGroup = "resourceGroupName"

# Ensures you do not inherit an AzContext in your runbook
Disable-AzContextAutosave -Scope Process

# Connect to Azure with system-assigned managed identity
Connect-AzAccount -Identity

# set and store context
$AzureContext = Set-AzContext –SubscriptionId "<SubscriptionID>"
}

リソースグループを表す有効な値を使用して、$resourceGroup 変数を編集します。

Runbook をシステム割り当てマネージド ID で実行する場合は、コードをそのままにしておきます。ユーザー割り当てマネージド ID を使用する場合は、次のようにします。
1. 行 9 から Connect-AzAccount -Identity を削除します。
2. それを Connect-AzAccount -Identity -AccountId <ClientId> に置き換えた後、
3. 前に取得したクライアント ID を入力します。
[保存] 、 [テスト] ペインの順に選択します。
[開始] を選択してテストを開始します。完了すると、次のような出力が表示され、アカウントの基本情報が表示されます。このアクションにより、資格情報が有効であることを確認できます。
[テスト] ページを閉じて、キャンバスに戻ります。

仮想マシンを開始するコードを追加する

これで、Runbook で Azure サブスクリプションに対する認証が行われ、リソースを管理できるようになります。仮想マシンを起動するコマンドを追加します。 Azure サブスクリプション内の任意の VM を選択し、ここではその名前を Runbook にハードコーディングします。

右中かっこの直前に、最後の行として次のコードを追加します。 VMName は、VM の実際の名前に置き換えてください。
```
Start-AzVM -Name "VMName" -ResourceGroupName $resourceGroup -DefaultProfile $AzureContext
```
Runbook をテストして、VM が起動したことを確認します。キャンバスに戻ります。

入力パラメーターを Runbook に追加する

Runbook では現在、Runbook にハードコードされている VM を起動しています。 Runbook の開始時に VM を指定できるとより便利です。その機能を備えるために、Runbook に入力パラメーターを追加します。

行 3 $resourceGroup = "resourceGroupName" を次のコードに置き換えます。
```
Param(
    [string]$resourceGroup,
    [string]$VMName
)
```

前の Start-AzVM コマンドを次のコマンドに置き換えます。

Start-AzVM -Name $VMName -ResourceGroupName $resourceGroup -DefaultProfile $AzureContext

Runbook をテストして、VM が起動したことを確認します。キャンバスに戻ります。

複数の VM を同時に管理する

ForEach -Parallel の構文を使用することにより、コレクション内の各項目のコマンドを同時に処理できます。 Runbook で次のことが実行されるようにコードを修正します。

仮想マシン名のコレクションを受け入れる
仮想マシンを停止または起動するパラメーターを受け入れる
すべての仮想マシンに対してアクションを並行して実行する

すべての既存のコードを次のコードに置き換えます。

workflow MyFirstRunbook-Workflow
{
   Param(
       [string]$resourceGroup,
       [string[]]$VMs,
       [string]$action
   )

   # Ensures you do not inherit an AzContext in your runbook
   Disable-AzContextAutosave -Scope Process

   # Connect to Azure with system-assigned managed identity
   Connect-AzAccount -Identity

   # set and store context
   $AzureContext = Set-AzContext –SubscriptionId "<SubscriptionID>"

   # Start or stop VMs in parallel
   if ($action -eq "Start") {
       ForEach -Parallel ($vm in $VMs)
       {
           Start-AzVM -Name $vm -ResourceGroupName $resourceGroup -DefaultProfile $AzureContext
       }
   }
   elseif ($action -eq "Stop") {
       ForEach -Parallel ($vm in $VMs)
       {
           Stop-AzVM -Name $vm -ResourceGroupName $resourceGroup -DefaultProfile $AzureContext -Force
       }
   }
   else {
       Write-Output "`r`n Action not allowed. Please enter 'stop' or 'start'."
   }
   }

Runbook をシステム割り当てマネージド ID で実行する場合は、コードをそのままにしておきます。ユーザー割り当てマネージド ID を使用する場合は、次のようにします。
1. 行 9 から Connect-AzAccount -Identity を削除します。
2. それを Connect-AzAccount -Identity -AccountId <ClientId> に置き換えた後、
3. 前に取得したクライアント ID を入力します。
[保存] 、 [発行] の順に選択して、確認を求められたら [はい] を選択します。
[概要] ページで [開始] を選択します。

パラメーターを設定して、 [OK] を選択します。

パラメーター	説明
RESOURCEGROUP	VM のリソースグループの名前を入力します。
VM	構文 `["VM1","VM2","VM3"]` を使用して、仮想マシンの名前を入力します。
アクション	`stop` または `start` を入力します。

仮想マシンの一覧に移動し、ページが数秒ごとに最新の情報に更新されます。各 VM に対するアクションが並行して実行されていることを確認します。 -Parallel キーワードがない場合、アクションは順番に実行されています。 VM は順番に起動しますが、各 VM が実行フェーズに到達する時間は、各 VM の特性に基づいて、わずかに異なる可能性があります。

リソースをクリーンアップする

この Runbook を引き続き使用しない場合は、次の手順を使用して削除します。

お使いの Automation アカウントに移動します。
[プロセスオートメーション] の [Runbook] を選択します。
Runbook を選択します。
Runbook の [概要] ページで、 [削除] を選択します。

次のステップ

このチュートリアルでは、PowerShell ワークフロー Runbook を作成しました。 Python 3 Runbook については、次を参照してください。

チュートリアル: Python 3 Runbook を作成する