統合モジュールを操作する

[アーティクル]
04/03/2024

重要

このバージョンの Service Management Automation (SMA) はサポート終了に達しました。 SMA 2022 にアップグレードすることをお勧めします。

統合モジュールは、Windows PowerShell モジュールを含むパッケージです。 Windows PowerShell モジュールを作成する方法の詳細については、「 Writing a Windows PowerShell Module (Windows PowerShell モジュールの作成)」をご覧ください。統合モジュールには、 Windows PowerShell モジュールで指定された有効なモジュール型のいずれかを含めることができます。これには、スクリプトモジュール (.psm1)、バイナリモジュール (.dll)、マニフェストモジュール (.psd1) が含まれます。統合モジュールパッケージは、モジュールと zip 拡張子と同じ名前の圧縮ファイルです。これには、モジュールの名前と 1 つのフォルダーが含まれます。 Windows PowerShell モジュールと、モジュールに存在する場合はマニフェストファイル (.psd1) を含むいずれかのサポートされるファイルは、このフォルダに含まれる必要があります。

モジュールに Connection 型が含まれている必要がある場合は、接続の種類のプロパティを指定する ModuleName>-Automation.json という名前<のファイルも含まれている必要があります。これは、次の形式の json ファイルです。

{
   "ConnectionFields": [
   {
      "IsEncrypted":  false,
      "IsOptional":  false,
      "Name":  "ComputerName",
      "TypeName":  "System.String"
   },
   {
      "IsEncrypted":  false,
      "IsOptional":  true,
      "Name":  "Username",
      "TypeName":  "System.String"
   },
   {
      "IsEncrypted":  true,
      "IsOptional":  false,
      "Name":  "Password",
   "TypeName":  "System.String"
   }],
   "ConnectionTypeName":  "DataProtectionManager",
   "IntegrationModuleName":  "DataProtectionManager"
}

Automation Runbook を作成して操作する手順は、管理ポータルとWindows PowerShellのどちらを使用しているかによって異なります。両方のメソッドを使用するさまざまな一般的な操作の基本的な手順については、次のセクションで説明します。

インストールされているモジュールを列挙する

管理ポータルで、インストールされているモジュールの一覧を取得する

Automation ワークスペースを選択します。
Azure を使用している場合は、Automation アカウントを選択します。
ウィンドウの上部にある [アセット] を選択 します。
[モジュール] の種類を使用して一覧の資産を確認します。

Windows PowerShell を使用して、インストールされているモジュールの一覧を取得する

次のサンプルコマンドでは、Automation にインストールされているすべてのモジュールを取得します。

$webServer = 'https://MyWebServer'
$port = 9090
Get-SmaModule -WebServiceEndpoint $webServer -Port $port

モジュールをインポートする

モジュールは、次のいずれかのファイルの種類を含むフォルダーを含む .zip 拡張子を持つ圧縮ファイルです。

モジュール (psm1 ファイル)
モジュールマニフェスト (psd1 ファイル)

管理ポータルを使用してモジュールをインポートする

Automation ワークスペースを選択します。
ウィンドウの下部にある [ モジュールのインポート] を選択します。
[ ファイルの参照] を選択します。
モジュールファイルを選択し、[ OK] を選択します。
ダイアログのチェックマークボタンを選択します。

Windows PowerShell を使用してモジュールをインポートする

次のサンプルコマンドは、モジュールをインポートする方法を示しています。

$webServer = 'https://MyWebServer'
$port = 9090
$modulePath = 'C:\Modules\MyModule.psm1'
Import-SmaModule -WebServiceEndpoint $webServer -Port $port -Path $modulePath

amModule 内での活動を列挙する

管理ポータルでモジュール内の活動の一覧を取得する

Automation ワークスペースを選択します。
Azure を使用している場合は、Automation アカウントを選択します。
ウィンドウの上部にある [アセット] を選択 します。
モジュールを探して選択します。
[モジュールの詳細] 画面の下部までスクロールし、活動を確認します。
必要に応じて、虫眼鏡アイコンを選択して、特定のアクティビティをフィルター処理します。

Windows PowerShell を使用してモジュール内の活動の一覧を取得する

次のサンプルコマンドは、特定のモジュール内の活動を取得する方法を示しています。

$webServer = 'https://MyWebServer'
$port = 9090
$moduleName = 'MyModule'
$module = Get-SmaModule -WebServiceEndpoint $webServer -Port $port -Name $moduleName
$module.Activities

Windows PowerShell を使用してすべてのモジュール内の活動の一覧を取得する

次のサンプルコマンドは、Automation にインストールされているすべてのモジュールのアクティビティを取得する方法を示しています。

$webServer = 'https://MyWebServer'
$port = 9090
$modules = Get-SmaModule -WebServiceEndpoint $webServer -Port $port
$modules | foreach {$_.Activities} | sort Name,ModuleName | ft Name,ModuleName,Description

次の手順

Service Management Automation の詳細を確認します。
Runbook 操作の詳細を確認します。