Edit-SmaRunbook

Runbook の下書きフィールドを更新します。

構文

Edit-SmaRunbook
    [-Name <String>]
    -Path <String>
    [-Overwrite]
    -WebServiceEndpoint <String>
    [-Port <Int32>]
    [-AuthenticationType <String>]
    [-Credential <PSCredential>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Edit-SmaRunbook
    [-Id <String>]
    -Path <String>
    [-Overwrite]
    -WebServiceEndpoint <String>
    [-Port <Int32>]
    [-AuthenticationType <String>]
    [-Credential <PSCredential>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

説明

Edit-SmaRunbook では、Runbook の下書きフィールドが更新されます。 下書き Runbook になる Runbook を含むWindows PowerShell スクリプト (.ps1) ファイルを指定します。 ドラフトが既に存在する場合は、 Overwrite パラメーターを使用して、コマンドレットで既存の下書きを強制的に上書きします。

特定の種類の Runbook (スクリプトまたはワークフロー Windows PowerShell) を編集するには、その種類の新しい Runbook を作成する必要があります。

例 1: 既存のドラフト Runbook を上書きする

PS C:\> Edit-SmaRunbook -Name "Runbk01" -WebServiceEndpoint "https://contoso.com" -Path "App01.ps1" -Overwrite

このコマンドは、既存のドラフト Runbook を上書きします。

パラメーター

-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

-Id

Runbook の ID を指定します。

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

-Name

Runbook の名前を指定します。

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

-Overwrite

既存の下書きが存在する場合は、新しい下書き Runbook によって上書きされることを示します。

Type:SwitchParameter
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

-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