Import-SmaRunbook
RUNBOOK を SMA にインポートします。
構文
Import-SmaRunbook
-Path <String>
[-Tags <String>]
-WebServiceEndpoint <String>
[-Port <Int32>]
[-AuthenticationType <String>]
[-Credential <PSCredential>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Import-SmaRunbook コマンドレットは、Runbook を Service Management Automation (SMA) にインポートします。 Runbook は、Windows PowerShell スクリプト (.ps1) ファイルである必要があります。 Runbook と Web サービス エンドポイントのパスを指定します。 必要に応じて、SMA Web サービスのポートを指定します。 Runbook には、PowerShell スクリプトまたはワークフローの種類を指定できます。
例
例 1: Service Management Automation に Runbook をインポートする
PS C:\> Import-SmaRunbook -Path "./Runbook01.ps1" -WebServiceEndpoint "https://contoso.com/app01"
このコマンドは、エンドポイント URL が https://contoso.com/app01されている SMA Web サービスに、Runbook01.ps1 という名前の Runbook ファイルをインポートします。
パラメーター
-AuthenticationType
認証の種類を指定します。 有効な値は次のとおりです。
- 基本的な
- ウィンドウズ
このパラメーターの既定値は Windows です。 基本認証を使用する場合は、Credential パラメーターを使用して資格情報を指定する必要があります。
型: | String |
指定可能な値: | Basic, Windows |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
型: | SwitchParameter |
Aliases: | cf |
配置: | Named |
規定値: | False |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Credential
SMA Web サービスへの接続 PSCredential オブジェクトを指定します。
資格情報オブジェクトを取得するには、Get-Credential コマンドレットを使用します。
詳細については、「Get-Help Get-Credential
」と入力します。
型: | PSCredential |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Path
Runbook へのパスを指定します。
型: | String |
Aliases: | RunbookPath |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Port
SMA Web サービスのポート番号を指定します。
型: | Int32 |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Tags
1 つ以上の Runbook タグを指定します。 1 つの文字列内のすべてのタグをコンマで区切って指定する必要があります。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-WebServiceEndpoint
SMA Web サービスのエンドポイントを URL として指定します。 プロトコル (http:// や https:// など) を含める必要があります。
型: | String |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。
型: | SwitchParameter |
Aliases: | wi |
配置: | Named |
規定値: | False |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |