Import-SmaRunbook

  • リファレンス
モジュール:
Microsoft.SystemCenter.ServiceManagementAutomation

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: Runbook を Service Management Automation にインポートする

PS C:\> Import-SmaRunbook -Path "./Runbook01.ps1" -WebServiceEndpoint "https://contoso.com/app01"

このコマンドは、Runbook01.ps1という名前の Runbook ファイルを、エンドポイント URL https://contoso.com/app01を持つ SMA Web サービスにインポートします。

パラメーター

-AuthenticationType

認証の種類を指定します。 有効な値は次のとおりです。

  • Basic
  • Windows

このパラメーターの既定値は Windows です。 基本認証を使用する場合は、Credential パラメーターを使用して 資格情報 を指定する必要があります。

Type:String
Accepted values:Basic, Windows
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Credential

SMA Web サービスへの接続の PSCredential オブジェクトを指定します。 資格情報オブジェクトを取得するには、Get-Credential コマンドレットを使用します。 詳細を表示するには「Get-Help Get-Credential」を入力します。

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Path

Runbook へのパスを指定します。

Type:String
Aliases:RunbookPath
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Port

SMA Web サービスのポート番号を指定します。

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Tags

1 つ以上の Runbook タグを指定します。 1 つの文字列内のすべてのタグをコンマで区切って指定する必要があります。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WebServiceEndpoint

SMA Web サービスのエンドポイントを URL として指定します。 プロトコル (http:// や https:// など) を含める必要があります。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False