Get-SmaRunbook

获取 SMA Runbook。

语法

Get-SmaRunbook
   -WebServiceEndpoint <String>
   [-Port <Int32>]
   [-AuthenticationType <String>]
   [-Credential <PSCredential>]
   [<CommonParameters>]
Get-SmaRunbook
   [-Id <String[]>]
   -WebServiceEndpoint <String>
   [-Port <Int32>]
   [-AuthenticationType <String>]
   [-Credential <PSCredential>]
   [<CommonParameters>]
Get-SmaRunbook
   [-Name <String[]>]
   -WebServiceEndpoint <String>
   [-Port <Int32>]
   [-AuthenticationType <String>]
   [-Credential <PSCredential>]
   [<CommonParameters>]

说明

Get-SmaRunbook cmdlet 获取一个或多个 Service Management Automation (SMA) Runbook。 默认情况下,将返回所有 Runbook。 若要获取特定的 Runbook,请指定其名称或 ID。

示例

示例 1:按其名称获取 Runbook

PS C:\> Get-SmaRunbook -Name "Runbk01" -WebServiceEndpoint "https://contoso.com/app01"

此命令从具有终结点 URL https://contoso.com/app01的 SMA Web 服务获取名为 Runbk01 的 Runbook。

参数

-AuthenticationType

指定身份验证类型。 有效值为:

  • 基本
  • Windows

默认值为 Windows。 如果使用基本身份验证,则必须使用 Credential 参数提供 凭据

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

-Credential

指定连接到 SMA Web 服务的 PSCredential 对象。 若要获取凭据对象,请使用 Get-Credential cmdlet。 要了解详情,请键入 Get-Help Get-Credential

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

-Id

指定此 cmdlet 获取的 Runbook ID 数组。

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

-Name

指定此 cmdlet 获取的 Runbook 名称数组。

Type:String[]
Aliases:RunbookName
Position:Named
Default value:None
Required:False
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