Get-SmaRunbookDefinition

项目
11/17/2015

Get-SmaRunbookDefinition

Gets a runbook definition.

语法

Parameter Set: All
Get-SmaRunbookDefinition -Type <RunbookVersionType> -WebServiceEndpoint <String> [-AuthenticationType <String> ] [-Credential <PSCredential> ] [-Port <Int32> ] [ <CommonParameters>]

Parameter Set: ByRunbookId
Get-SmaRunbookDefinition -Id <String[]> -Type <RunbookVersionType> -WebServiceEndpoint <String> [-AuthenticationType <String> ] [-Credential <PSCredential> ] [-Port <Int32> ] [ <CommonParameters>]

Parameter Set: ByRunbookName
Get-SmaRunbookDefinition [-Name] <String[]> -Type <RunbookVersionType> -WebServiceEndpoint <String> [-AuthenticationType <String> ] [-Credential <PSCredential> ] [-Port <Int32> ] [ <CommonParameters>]

Parameter Set: ByVersionId
Get-SmaRunbookDefinition -VersionId <String[]> -WebServiceEndpoint <String> [-AuthenticationType <String> ] [-Credential <PSCredential> ] [-Port <Int32> ] [ <CommonParameters>]

详细说明

The Get-SmaRunbookDefinition cmdlet gets one or more runbooks. By default, all runbook definitions of the specifies version type are returned. To get a specific runbook, specify its name or ID.

参数

-AuthenticationType<String>

Specifies the authentication type. Valid values are: Basic, Windows.

Windows is the default value. If you use Basic authentication, you must provide credentials by using the Credential parameter.

别名	无
是否为必需？	false
位置？	named
默认值	Windows
是否接受管道输入？	false
是否接受通配符？	false

-Credential<PSCredential>

Specifies user credentials, as a PSCredential object, to use for the connection to the web service. To obtain a credential object, use the Get-Credential cmdlet. For more information, type Get-Help Get-Credential.

别名	无
是否为必需？	false
位置？	named
默认值	无
是否接受管道输入？	false
是否接受通配符？	false

-Id<String[]>

Specifies an array of runbook IDs.

别名	RunbookId
是否为必需？	true
位置？	named
默认值	无
是否接受管道输入？	True (ByValue)
是否接受通配符？	false

-Name<String[]>

Specifies an array of runbook names.

别名	RunbookName
是否为必需？	true
位置？	1
默认值	无
是否接受管道输入？	false
是否接受通配符？	false

-Port<Int32>

Specifies the port number of the web service.

别名	无
是否为必需？	false
位置？	named
默认值	无
是否接受管道输入？	false
是否接受通配符？	false

-Type<RunbookVersionType>

Specifies a runbook version type. Valid values are: Published, Draft.

别名	无
是否为必需？	true
位置？	named
默认值	无
是否接受管道输入？	false
是否接受通配符？	false

-VersionId<String[]>

Specifies an array of runbook version IDs.

别名	无
是否为必需？	true
位置？	named
默认值	无
是否接受管道输入？	false
是否接受通配符？	false

-WebServiceEndpoint<String>

Specifies the endpoint, as a URL, of the web service. Include the protocol, for example, http:// or https://.

别名	无
是否为必需？	true
位置？	named
默认值	无
是否接受管道输入？	false
是否接受通配符？	false

<CommonParameters>

此 cmdlet 支持通用参数：-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer 和 -OutVariable。有关详细信息，请参阅 about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

输入

输入类型是指可通过管道传送给 cmdlet 的对象的类型。

输出

输出类型是 cmdlet 所发出对象的类型。

示例

Example 1: Get a runbook definition by Name

This command gets the draft runbook definition of the runbook with the name RunbookDef01.

PS C:\> Get-SmaRunbookDefinition -WebServiceEndpoint "https://localhost" -Name "RunbookDef01" -Type "Draft"

Get-SmaRunbookDefinition