ランタイム環境と関連する Runbook を管理する

ランタイム環境を作成するには、次の手順に従います。

1. Azure portal にサインインし、Automation アカウントを選択します。

2. [ 概要 ] ページで、新しいエクスペリエンスにまだ含まれていない場合は、[ ランタイム環境エクスペリエンスを試す] を選択します。

3. [プロセス自動化] で、[ランタイム環境] を選択し、[作成] を選択します。

4. 基本 タブで、次の詳細情報を入力します。

   1. ランタイム環境の [名前]。 アルファベットで始まっている必要があり、アルファベット、数字、アンダースコア、ダッシュのみを使用できます。

   2. [言語] ドロップダウンから、ランタイム環境のスクリプト言語を選びます。

      • PowerShell スクリプト言語の場合は [PowerShell] を選び、Python スクリプト言語の場合は [Python] を選びます。

   3. スクリプト言語の [ランタイム バージョン] を選びます。

      • PowerShell の場合 - 5.1、7.4 を選択します
      • Python の場合 - 3.10 を選択する

   4. 適切な 説明を入力します。

      

5. [次へ] を選び、[パッケージ] タブで Runbook の実行中に必要なパッケージをアップロードします。 "Az PowerShell パッケージ" は、すべての PowerShell ランタイム環境に対して既定でアップロードされ、Azure リソースを管理するためのすべてのコマンドレットを含みます。

   注

   Azure CLI コマンドは、PowerShell 7.4 ランタイム環境に関連付けられている Runbook でサポートされています。 Azure CLI コマンド バージョン 2.64.0 は、PowerShell 7.4 ランタイム環境で既定のパッケージとして使用できます。

6. Runbook の実行中に必要なパッケージをさらにアップロードするには。 [ファイルの追加] を選んで、お使いのコンピューターにローカルに格納されているファイルを追加するか、[ギャラリーから追加] を選んで PowerShell ギャラリーからパッケージをアップロードします。

   注

   • パッケージのインポートには、数分かかる場合があります。 インポートできるファイルの最大合計サイズは 100 MB です。
   • .zipファイルをPowerShellランブックタイプに使用し、詳しくはこちらをご参照ください。
   • Python 3.10 パッケージの場合は、cp310 Linux OS を対象とする .whl ファイルを使用します。

7. [次へ] を選び、[確認と作成] タブで設定が正しいことを確認します。 [作成] を選ぶと、Azure はユーザーが選んだランタイム環境の設定に対して検証を実行します。 検証が合格した場合はランタイム環境の作成に進むことができ、そうでない場合は、変更する必要がある設定がポータルで示されます。

[ ランタイム環境] ページでは、Automation アカウント用に新しく作成されたランタイム環境を表示できます。 新しく作成されたランタイム環境が一覧に見つからない場合は、[最新の情報に更新] を選びます。

Automation で Az PowerShell モジュールを使用して、PowerShell 7.4 用の新しいランタイム環境を作成できます。

PUT 
https://management.azure.com/subscriptions/<subscriptionId>/resourceGroups/<resourceGroup>/providers/Microsoft.Automation/automationAccounts/<accountName>/runtimeEnvironments/<runtimeEnvironmentName>?api-version=2024-10-23 

{ 
  "properties": { 
    "runtime": { 
        "language": "PowerShell",  
        "version": "7.4" 
        }, 
        "defaultPackages": { 
            "Az": "12.3.0" 
        } 
     }, 
    "name": "<runtimeEnvironmentName>" 
} 

パッケージ Az.Accounts をランタイム環境にアップロードします。

PUT 
https://management.azure.com/subscriptions/<subscriptionId>/resourceGroups/<resourceGroup>/providers/Microsoft.Automation/automationAccounts/<accountName>/runtimeEnvironments/<runtimeEnvironmentName>/packages/Az.Accounts?api-version=2024-10-23

{ 
  "properties": { 
    "contentLink": { 
        "uri": "https://psg-prod-eastus.azureedge.net/packages/az.accounts.2.12.4.nupkg" 
    } 
  } 
} 

Automation アカウントからすべてのランタイム環境を一覧表示するには、次の手順に従います。

1. Automation アカウントの [プロセス オートメーション] で、[ ランタイム環境] を選択します。

   

GET 
https://management.azure.com/subscriptions/<subscriptionId>/resourceGroups/<resourceGroup>/providers/Microsoft.Automation/automationAccounts/<accountName>/runtimeEnvironments?api-version=2024-10-23

Automation アカウントからランタイム環境を削除するには、次の手順のようにします。

1. Automation アカウントの [プロセス オートメーション] で、[ ランタイム環境] を選択します。

2. 削除するランタイム環境を選びます。

3. [削除] を選んでランタイム環境を削除します。

   

DELETE  
https://management.azure.com/subscriptions/<subscriptionId>/resourceGroups/<resourceGroup>/providers/Microsoft.Automation/automationAccounts/<accountName>/runtimeEnvironments/<runtimeEnvironmentName>?api-version=2024-10-23

ランタイム環境を更新するには、次の手順に従います。

1. Automation アカウントの [プロセス オートメーション] で、[ ランタイム環境] を選択します。

2. 更新するランタイム環境を選びます。

3. 既存のパッケージのバージョンを更新するには、ドロップダウンからバージョンを選びます。

4. [保存] を選択します。

   

5. [ファイルの追加] を選んで、ローカル コンピューターからパッケージをアップロードするか、[ギャラリーから追加] を選んで PowerShell ギャラリーからパッケージをアップロードします。

   注

   一度に最大 10 個のパッケージをランタイム環境に追加できます。 10 個のパッケージを追加した後で、必ず保存してください。

既存のランタイム環境の Az モジュール バージョンを更新します。

PATCH 
https://management.azure.com/subscriptions/<subscriptionId>/resourceGroups/<resourceGroup>/providers/Microsoft.Automation/automationAccounts/<accountName>/runtimeEnvironments/<runtimeEnvironmentName>?api-version=2024-10-23
{ 

  "properties": { 

        "defaultPackages": { 

            "Az": "12.3.0" 

        } 

     } 

} 

前提条件

• 必ず、Runbook を作成する前にランタイム環境を作成します。

ランタイム環境にリンクされた Runbook を新しく作成するには、次の手順のようにします。

1. お使いの Automation アカウントから、[プロセスの自動化] の [Runbook] を選択します。

2. ［作成］ を選択します

3. [ 基本 ] タブでは、新しい Runbook を作成するか、ローカル コンピューターまたは PowerShell ギャラリーからファイルをアップロードできます。

   1. Runbook の 名前 を入力します。 文字で始まっている必要があり、文字、数字、アンダースコア、ダッシュのみを使用できます。

   2. [Runbook の種類] ドロップダウンから、作成する Runbook の種類を選びます。

   3. Runbook 用に構成する [ランタイム環境] を選びます。 ランタイム環境を既存のものから選択するか、ランタイム環境を新しく作成して Runbook にリンクすることができます。 ランタイム環境の一覧は、ステップ b で選んだ Runbook の種類に基づいて設定されます。

   4. 適切な 説明を入力します。

      

   注

   PowerShell Runbook の種類の場合は、PowerShell ランタイム環境のみが選択肢の一覧に表示されます。 Python Runbook の種類の場合は、Python ランタイム環境のみが選択肢の一覧に表示されます。

4. タグを Runbook に追加して、設定を確認したら、[作成] を選んで新しい Runbook を作成します。

この Runbook は、選んだランタイム環境にリンクされます。 選んだランタイム環境内のすべてのパッケージを、Runbook の実行中に使用できます。

前提条件

• PowerShell ランタイム環境を構成し、Runbook 作成の入力としてそれを提供します。

PUT 
https://management.azure.com/subscriptions/<subscriptionId>/resourceGroups/<resourceGroup>/providers/Microsoft.Automation/automationAccounts/<accountName>/runbooks/<runbookName>?api-version=2024-10-23

{ 
  "properties": { 
        "runbookType": "PowerShell", 
        "runtimeEnvironment": <runtimeEnvironmentName>, 
        "publishContentLink": { 
            "uri": "https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-automation-runbook-getvms/Runbooks/Get-AzureVMTutorial.ps1" 
        } 
    }, 
   "___location": "East US"
} 

Runbook を更新するには、次の手順に従います。

1. お使いの Automation アカウントから、[プロセスの自動化] の [Runbook] を選択します。

2. 更新する Runbook のチェックボックスをオンにします。

3. [ ランタイム環境の更新] を選択します。

   

4. Runbook をリンクするランタイム環境をドロップダウンから選びます。

5. [更新] を選び、選んだ Runbook を新しいランタイム環境で更新します。

更新した後で、Runbook が意図したとおりに実行しているかどうかを調べます。 Runbook で想定される結果が得られない場合は、ステップ 1 から 4 のようにして、ランタイム環境を古いエクスペリエンスに再び更新できます。

Runbook にリンクされているランタイム環境を更新します。

PATCH 
https://management.azure.com/subscriptions/<subscriptionId>/resourceGroups/<resourceGroup>/providers/Microsoft.Automation/automationAccounts/<accountName>/runbooks/<runbookName>?api-version=2024-10-23
{ 
  "properties": { 
    "type": "PowerShell",
    "runtimeEnvironment": "<runtimeEnvironmentName>" 
  } 
} 

Runbook にリンクされているランタイム環境を変更して、Runbook を更新できます。 変更を発行する前に、Runbook の実行をテストすることをお勧めします。 これは、Runbook が想定どおりに動作することを確認するためです。

ランタイム環境の変更を発行する前に Runbook の実行をテストするには、次の手順のようにします。

1. Runbook ページに移動し、更新したいランタイム環境の Runbook を選択します。

   

2. [Runbook の編集] ページで、[ポータルで編集] を選んでテキスト エディターを開きます。

3. [ランタイム環境] フィールドに、既存の構成が表示されます。 ドロップダウン リストから新しいランタイム環境を選びます。

4. [テスト ウィンドウ] を選び、更新されたランタイム環境で Runbook の実行をテストします。 [開始] を選んでテスト実行を始めます。

5. テスト ウィンドウを閉じ、必要に応じて、Runbook コードまたはランタイム環境で必要な変更を行います。

6. [発行] を選んで、Runbook にリンクされたランタイム環境を更新します。

7. [はい] を選んで、以前に発行したバージョンをオーバーライドし、変更を確認します。

異なるランタイム環境で Runbook のテスト ジョブを実行します。 このシナリオは、更新前のランタイム環境で Runbook をテストする必要がある場合に役立ちます。

PUT 
https://management.azure.com/subscriptions/<subscriptionId>/resourceGroups/<resourceGroup>/providers/Microsoft.Automation/automationAccounts/<accountName>/runbooks/<runbookName>/draft/testJob?api-version=2024-10-23
{ 
  "properties": { 
    "runtimeEnvironment": "<runtimeEnvironmentName>" 
    "runOn": "" 
  } 
} 

ランタイム環境にリンクされた Runbook は、Azure と Hybrid Worker の両方で実行できます。

ジョブは Runbook からランタイム環境を継承します。 発行されたランブックのクラウドジョブを実行します。

PUT
https://management.azure.com/subscriptions/<subscriptionId>/resourceGroups/<resourceGroup>/providers/Microsoft.Automation/automationAccounts/<accountName>/jobs/<jobName>?api-version=2024-10-23
{
  "properties": {
    "runbook": {
      "name": "<runbookName>" 
    }, 
    "runOn": "" 
  } 
}