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

この記事では、Azure portal と REST API を使用してランタイム環境を作成し、さまざまな操作を実行する方法について説明します。

前提条件

サポートされているパブリック リージョンの Azure Automation アカウント (インド中部、ドイツ北部、イタリア北部、イスラエル中部、ポーランド中部、アラブ首長国連邦中部、政府クラウドを除く)。

ランタイム環境と古いエクスペリエンスを切り替える

ランタイム環境エクスペリエンス

1. [概要] を選択し、[ランタイム環境エクスペリエンスを試す] を選択します。

   

2. プロセス自動化では、ランタイム環境 (プレビュー)があり、共有リソースのモジュールと Python パッケージは削除されます。ランタイム環境では、Runbook の実行中に必要なパッケージを管理できます。

   

3. モジュールとパッケージを管理するための以前のエクスペリエンスに戻すには、左側のウィンドウで [概要] を選択し、[古いエクスペリエンスに切り替える] を選択します。

   

古いエクスペリエンス

1. Automation アカウントに移動し、[プロセス オートメーション] でランタイム環境 (プレビュー) が削除され、[共有リソース] の下にモジュールと Python パッケージが表示されます。

   

Note

Runbook の更新は、新しいランタイム環境エクスペリエンスと古いエクスペリエンスの間で保持されます。 Runbook にリンクされたランタイム環境で行われた変更は、以前のエクスペリエンスで Runbook の実行中に保持されます。

ランタイム環境の管理

ランタイム環境を作成する

Azure Portal

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

2. [プロセス自動化] で、[ランタイム環境 (プレビュー)] を選択し、[作成] を選択します。

3. [基本] で、次の詳細を指定します。

   1. ランタイム環境の名前 。 アルファベットで始まる必要があり、アルファベット、数字、アンダースコア、ダッシュのみを含めることができます。

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

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

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

      • PowerShell の場合 - 5.1、7.2 を選択します
      • Python の場合 - 3.8、3.10 (プレビュー) を選択します

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

      

4. [次へ] を選択し、[パッケージ] タブで、Runbook の実行中に必要なパッケージをアップロードします。 Az PowerShell パッケージは、Azure リソースを管理するためのすべてのコマンドレットを含むすべての PowerShell ランタイム環境に対して、既定でアップロードされます。 ドロップダウンから Az パッケージのバージョンを選択できます。 Runbook の実行中にパッケージをアップロードしない場合は、[なし] を選択します。

   

   Note

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

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

   

   Note

   • パッケージをインポートする場合、数分かかる場合があります。 100 MB (メガバイト) は、インポートできるファイルの最大合計サイズです。
   • PowerShell Runbook の種類.zipファイルを使用します。
   • Python 3.8 パッケージの場合は、cp38-amd64 をターゲットとする .tar.gz または .whl ファイルを使用します。
   • Python 3.10 (プレビュー) パッケージの場合は、cp310 Linux OS をターゲットとする .whl ファイルを使用します。

6. [次へ] を選択し、[確認と作成] タブで、設定が正しいことを確認します。 [作成] を選択すると、選択したランタイム環境設定で検証が実行されます。 検証に合格した場合は、ランタイム環境の作成に進むことができます。ポータルには、変更する必要がある設定が示されます。

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

REST API

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

PUT 
https://management.azure.com/subscriptions/<subscriptionId>/resourceGroups/<resourceGroup>/providers/Microsoft.Automation/automationAccounts/<accountName>/runtimeEnvironments/<runtimeEnvironmentName>?api-version=2023-05-15-preview 

{ 
  "properties": { 
    "runtime": { 
        "language": "PowerShell",  
        "version": "7.2" 
        }, 
        "defaultPackages": { 
            "Az": "7.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=2023-05-15-preview 
{ 
  "properties": { 
    "contentLink": { 
        "uri": "https://psg-prod-eastus.azureedge.net/packages/az.accounts.2.12.4.nupkg" 
    } 
  } 
} 

ランタイム環境の表示

Automation アカウントからランタイム環境のプロパティを取得します。

GET 
https://management.azure.com/subscriptions/<subscriptionId>/resourceGroups/<resourceGroup>/providers/Microsoft.Automation/automationAccounts/<accountName>/runtimeEnvironments/<runtimeEnvironmentName>?api-version=2023-05-15-preview 

ランタイム環境を一覧表示する

Automation アカウントからすべてのランタイム環境を一覧表示するには:

Azure Portal

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

   

REST API

GET 
https://management.azure.com/subscriptions/<subscriptionId>/resourceGroups/<resourceGroup>/providers/Microsoft.Automation/automationAccounts/<accountName>/runtimeEnvironments?api-version=2023-05-15-preview 

Az PowerShell パッケージのコンポーネントを表示する

Az PowerShell パッケージのすべてのコンポーネント パッケージを表示するには、PowerShell Runbook でコマンドレットを実行Get-Module -ListAvailableします。

ジョブ出力には、すべてのコンポーネント パッケージとそのバージョンが表示されます。

ランタイム環境の削除

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

Azure Portal

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

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

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

   

REST API

DELETE  
https://management.azure.com/subscriptions/<subscriptionId>/resourceGroups/<resourceGroup>/providers/Microsoft.Automation/automationAccounts/<accountName>/runtimeEnvironments/<runtimeEnvironmentName>?api-version=2023-05-15-preview 

ランタイム環境の更新

ランタイム言語とランタイム バージョンは、変更できないプロパティです。 ただし、モジュールのバージョンを更新したり、ランタイム環境でパッケージを追加または削除したりできます。 ランタイム環境にリンクされている Runbook は、新しい設定で自動的に更新されます。

Azure Portal

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

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

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

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

   

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

   

   Note

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

REST API

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

PATCH 
https://management.azure.com/subscriptions/<subscriptionId>/resourceGroups/<resourceGroup>/providers/Microsoft.Automation/automationAccounts/<accountName>/runtimeEnvironments/<runtimeEnvironmentName>?api-version=2023-05-15-preview 
{ 

  "properties": { 

        "defaultPackages": { 

            "Az": "9.0.0" 

        } 

     } 

} 

ランタイム環境にリンクされている Runbook を管理する

Runbook を作成する

ランタイム環境で構成された新しい PowerShell Runbook を作成できます。

Azure Portal

前提条件

• Runbook を作成する前に、ランタイム環境が作成されていることを確認します。

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

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

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

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

   1. Runbook の 名前 を指定します。 文字で始まる必要があり、文字、数字、アンダースコア、ダッシュのみを含めることができます。

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

   3. Runbook 用に構成するランタイム環境を選択します。 既存のランタイム環境から選択するか、新しいランタイム環境を作成して Runbook にリンクすることができます。 ランタイム環境の一覧は、手順 b で選択した Runbook の 種類 に基づいて設定されます。

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

      

   Note

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

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

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

REST API

前提条件

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

PUT 
https://management.azure.com/subscriptions/<subscriptionId>/resourceGroups/<resourceGroup>/providers/Microsoft.Automation/automationAccounts/<accountName>/runbooks/<runbookName>?api-version=2023-05-15-preview 

{ 
  "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"
} 

Note

同様の API は、Python Runbook の種類でも機能します。

Runbook の更新

Runbook にリンクされているランタイム環境を変更することで、Runbook を更新できます。 更新用に 1 つまたは複数の Runbook を選択できます。 実行中の状態の Runbook は、その Runbook にリンクされているランタイム環境を変更することによって影響を受けません。

Azure Portal

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

2. 更新する Runbook の チェック ボックスを選択します。

3. [更新] を選択します。

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

5. 選択した Runbook を新しいランタイム環境で更新するには、[更新] を選択します。

更新後に Runbook が期待どおりに実行されるかどうかを確認します。 Runbook で期待される結果が得られない場合は、手順 1 から 4 に従ってランタイム環境を古いエクスペリエンスに再び更新できます。

Note

Runbook の更新は、新しいランタイム環境エクスペリエンスと古いエクスペリエンスの間で保持されます。 Runbook にリンクされたランタイム環境で行われた変更は、以前のエクスペリエンスで Runbook の実行中に保持されます。

REST API

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

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

Note

Runbook の View/Delete 呼び出しメイン同じであり、Runbook を参照できます - REST API Azure Automation |Microsoft Learn。

Runbook の更新をテストする

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

Azure Portal

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

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

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

   

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

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

   

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

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

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

7. 以前に公開されたバージョンをオーバーライドし、変更を確認するには、[はい] を選択します。

REST API

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

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

クラウド ジョブの作成

Azure Portal

現時点では、ランタイム環境にリンクされている Runbook は Azure で実行されます。

REST API

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

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

Note

ジョブの再呼び出しの作成/表示メイン同じであり、Job-REST API (Azure Automation) から参照できます |Microsoft Learn。

既存の Runbook をシステム生成ランタイム環境にリンクする

Azure Automation アカウント内のすべての既存の Runbook は、システム生成ランタイム環境に自動的にリンクされます。 これらのシステム生成ランタイム環境は、それぞれの Azure Automation アカウントに存在するランタイム言語、バージョン、およびモジュール/パッケージに基づいて作成されます。 詳細情報。 既存の Runbook を更新するには、ここでメンション手順に従ってランタイム環境を変更します。

次のステップ

• ランタイム環境の概要について説明します。
• Runbook の実行に関する問題のトラブルシューティングについては、Runbook の問題のトラブルシューティングに関するページを参照してください。