实验室管理工具版工作流活动
在自定义 Lab Management 工作流模板 (LabDefaultTemplate.11.xaml) 时,你可以使用一个或多个预定义的 Lab Management 活动。 也可以访问通过 Lab Management 向导创建的对象。 本主题介绍在你自定义工作流模板以生成、部署和测试应用程序时,可用的 Team Foundation Lab Management 活动和对象。 有关如何在自定义工作流中使用这些活动的信息,请参阅自定义 Lab Management 工作流。
要求
- Visual Studio Enterprise、Visual Studio 专业测试工具版
本主题包含以下各节:
Lab Management 活动
Lab Management 类
Lab Management 活动
下表介绍了各个 Lab Management 工作流活动。
Activity |
说明 |
---|---|
CreateLabEnvironment |
从存储模板中创建一个新环境,然后将该环境部署到指定的主机组上。 |
DeleteLabEnvironment |
删除环境。 |
DeleteSnapshot |
删除环境快照。 |
ExecuteRemoteTestRun |
在环境中创建一个测试运行,并等待该测试运行完成。 |
GenerateEnvironmentViewerFile |
生成具有快照链接 ID 的环境查看器。 它用于连接到环境快照。 |
GetBuildLocationAndBuildNumber |
返回生成、部署和测试方案的生成位置与生成号。 |
GetLabEnvironmentInUseMarker |
返回环境的“正在使用”标记。 |
GetLabEnvironmentSnapshotId |
获取环境快照的 ID。 |
GetLabEnvironmentStatus |
获取环境状态。 |
GetLabEnvironmentUri |
获取给定环境名称和实验室位置名称的环境 URI。 |
InitializeAgentSpecAndEnvironmentVariables |
分析属性指定的部署脚本详细信息 |
ResetLabEnvironmentInuseMarker |
重置环境的“正在使用”标记。 |
RestoreLabEnvironment |
将环境还原为指定快照。 |
RunDeploymentScript |
运行部署脚本。 在失败时,会引发或写入 ThrowOnError 属性中指定的一个生成警告。 |
RunWorkflow |
在生成服务器的生成控制器上,对新工作流进行排队。 |
SaveLabEnvironment |
创建一个新环境,然后将该环境存储到团队项目库共享中。 |
SetLabEnvironmentInuseMarker |
设置环境的“正在使用”标记。 |
SnapshotLabEnvironment |
拍摄环境的快照。 |
StartLabEnvironment |
启动环境。 |
StopLabEnvironment |
停止环境。 |
WaitForTestCapabilityServices |
等待环境的测试功能准备就绪所需的指定最长时间。 在到达该等待时间时,如果测试功能未就绪,则会引发超时异常。 |
WaitForWorkflow |
工作流的类型。 |
WaitForWorkflowCapabilityServices |
等待完成排队生成所需的给定最长时间。 如果生成工作流在给定的最长时间内未完成,则会引发 TimeOutException。 活动会定期检查排队生成的状态以确定已完成哪些生成。 通过使用 RefreshInterval 属性配置此时间间隔。 |
WriteDeploymentInformation |
写入包含在生成摘要中的部署信息。 |
CreateLabEnvironment
从存储模板中创建一个新环境,然后将该环境部署到指定的主机组上。 此活动会运行较长时间,并会一直等到创建新的环境。 如果无法创建新的实验室环境,则此活动会引发 LabDeploymentProcessException 异常。
属性
LabEnvironmentName |
新环境的名称。 如果此属性为 null 或为空,则将使用环境模板名称。 |
LabEnvironmentTemplateUri |
存储环境模板的 URI。 可使用 GetLabEnvironmentUri 活动获取该实验室环境模板 URI。 必需。 |
TeamProjectHostGroupName |
新环境将部署到的主机组。 如果未找到指定的主机组,则会引发 NoTeamProjectHostGroupFoundException 异常。 必需。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
DeleteLabEnvironment
删除环境。 此活动会运行较长时间,并会一直等到删除该环境。 如果删除环境失败,则此活动会引发 LabDeploymentProcessException 异常。
属性
LabEnvironmentUri |
要删除的环境的 URI。 可使用 GetLabEnvironmentUri 活动获取该实验室环境 URI。 必需。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
DeleteSnapshot
删除环境快照。 此活动会运行较长时间,并会一直等到删除该快照。 如果删除快照失败,则此活动会引发 LabDeploymentProcessException 异常。
属性
LabEnvironmentUri |
将删除其快照的实验室环境的 URI。 可使用 GetLabEnvironmentUri 活动获取该实验室环境 URI。 必需。 |
SnapshotId |
要删除的快照的 ID。 可使用 GetLabEnvironmentSnapshotId 活动获取该快照 ID。 必需。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
ExecuteRemoteTestRun
在环境中创建一个测试运行,并等待该测试运行完成。 此活动会运行较长时间,并会一直等到测试运行完成或发生超时。 可以使用 MaxWaitTime 属性设置超时。 此活动会定期检查测试运行状态以确定已完成哪些测试运行。 通过使用 RefreshInterval 属性配置此时间间隔。 MaxConsecutiveFailuresToIgnoreDuringWaitForCompletion 属性可在检查测试运行的状态时用于指定要忽略 Team Foundation Server 错误的连续次数。
返回值
一个 TestRunStatistics 对象,它存储测试运行的详细信息。
属性
BuildNumber |
对其运行测试的生成号。 |
LabEnvironmentUri |
在其上执行测试用例的环境的 URI。 可使用 GetLabEnvironmentUri 活动获取该环境 URI。 |
MaxConsecutiveFailuresToIgnoreDuringWaitForCompletion |
在活动等待测试运行时,应忽略的最大连续失败次数。 此属性的默认值为 3。 |
MaxWaitTime |
TimeSpan,指定等待测试运行完成的最长时间。 在到达指定持续时间时会引发超时异常。 默认值为 0(零),这意味着活动会无限期地等待。 |
RefreshInterval |
TimeSpan,指定刷新测试运行状态的时间间隔。 此时间间隔的默认值为 60 秒。 |
TestDirectory |
测试可执行文件的路径。 |
TestEnvironment |
将在其中执行测试用例的测试环境的名称。 |
TestParameters |
一个 RunTestDetails 对象,它指定测试参数,如测试计划、测试套件、测试设置和测试配置。 必需。 |
标题 |
测试运行的名称。 必需。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
GenerateEnvironmentViewerFile
生成包含快照链接 ID 的环境查看器文件。 此活动用于连接到环境快照。 环境查看器文件的名称是不包含以下任一特殊字符的快照名称:@"[`~!@#$%^&*()+=[{\]}|\\;:',/?]" + "\""。
属性
文件路径 |
存储环境查看器文件的 UNC 路径。 生成服务帐户必须具有路径的写入权限。 必需。 |
LabEnvironmentUri |
环境的 URI。 可使用 GetLabEnvironmentUri 活动获取该环境 URI。 必需。 |
SnapshotId |
快照的 ID。 可使用 GetLabEnvironmentSnapshotId 活动获取快照 ID。 如果快照无效,则会引发 InvalidSnapshotException 异常。 必需。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
GetBuildLocationAndBuildNumber
返回生成、部署和测试方案的生成位置与生成号。 如果选择了“团队生成”,并且生成的 URI 为 null,则会选择上一个好生成并返回详细信息。 如果未找到上一个好生成,则会引发 System.ArgumentException。 如果未选择“团队生成”,则仅返回用户指定的生成位置。
返回值
指定生成位置的 String。
属性
BuildDetails |
一个 Microsoft.TeamFoundation.Lab.Workflow.Activities.BuildDetails 对象,它包括生成、部署和测试方案中与生成相关的信息。 |
BuildNumber |
选定生成的生成号。 这是一个 outArgument。 对于非“团队生成”生成,为 null。 |
SelectedBuild |
有关生成服务器的生成信息。 这是一个 outArgument。 对于非“团队生成”生成,为 null。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
GetLabEnvironmentInUseMarker
获取环境的“正在使用”标记。
返回值
一个 LabEnvironmentInUseMarker,它指定环境标记的详细信息。
属性
LabEnvironmentUri |
环境的 URI。 使用 GetLabEnvironmentUri 活动可获取环境 URI。 必需。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
GetLabEnvironmentSnapshotId
获取环境快照的快照 ID。 如果未找到具有指定名称的快照,则此活动会引发 NoSnapshotFoundException 异常。
返回值
指定快照的标识符的 Int64。
属性
LabEnvironmentUri |
环境的 URI。 使用 GetLabEnvironmentUri 活动可获取环境 URI。 必需。 |
SnapshotName |
快照名称。 必需。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
GetLabEnvironmentStatus
获取环境的状态。
返回值
一个 LabEnvironmentState 枚举值,它指示环境的当前状态。
属性
LabEnvironmentUri |
环境的 URI。 使用 GetLabEnvironmentUri 活动可获取环境 URI。 必需。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
GetLabEnvironmentUri
获取给定环境名称和实验室位置名称的环境 URI。 实验室位置可以是主机组或库共享。 如果未找到环境,则此活动会引发 LabEnvironmentNotFoundException 异常。
返回值
指定环境的 URI 的 String。
属性
LabEnvironmentName |
环境名称。 必需。 |
ProjectName |
团队项目的名称。 如果此属性值未指定或为 null,则使用生成的当前项目。 |
TeamProjectLabLocationName |
实验室位置名称。 可以是主机组名称或库共享名称。 如果未找到实验室位置,则会引发 NoLabLocationFoundException 异常。 必需。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
InitializeAgentSpecAndEnvironmentVariables
初始化 RunDeploymentScript 活动所需的参数。 InitializeAgentSpecAndEnvironmentVariables 会提取环境中虚拟机的属性,这些属性是面向计算机上的部署脚本所必需的。
返回值
一个 ScriptDetails 对象,它存储部署所需的脚本详细信息。
属性
BuildLocation |
生成位置路径。 此路径用于扩展宏 $(BuildLocation)。 必需。 |
DeploymentScriptDetails |
部署详细信息的格式为“labsystemname | script arguments | working directory”。 必需。 |
LabEnvironmentUri |
环境的 URI。 使用 GetLabEnvironmentUri 活动可获取环境 URI。 必需。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
ResetLabEnvironmentInuseMarker
重置环境的“正在使用”标记。
属性
LabEnvironmentUri |
环境的 URI。 使用 GetLabEnvironmentUri 活动可获取环境 URI。 必需。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
RestoreLabEnvironment
将环境还原为指定快照。 如果快照无效,则此活动会引发 InvalidSnapshotException 异常。
属性
LabEnvironmentUri |
环境的 URI。 使用 GetLabEnvironmentUri 活动可获取环境 URI。 必需。 |
SnapshotId |
要将环境还原到的快照的 ID。 可使用 GetLabEnvironmentSnapshotId 活动获取该快照 ID。 必需。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
RunDeploymentScript
运行部署脚本。 如果脚本失败,则会引发或写入 ThrowOnError 属性中指定的一个生成警告。
返回值
一个 BuildStatus 枚举值,它指定部署操作的状态。
属性
MaximumAttemptsForNetUse |
尝试添加 net use 的最大次数。 |
ScriptDetails |
实验室系统的“脚本详细信息”对象。 必需。 |
SharedLocationForNetUse |
实验室服务帐户应可访问的位置。 |
ThrowOnError |
用于指示是否应在出错时引发异常的标记。 默认值为 True。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
RunWorkflow
在生成服务器的生成控制器上,对新工作流进行排队。 可通过两种方式指定必须在哪个生成控制器上对生成进行排队:
使用 LabEnvironmentUri 属性。 如果为工作流集成配置此环境,则将使用环境的生成控制器对工作流进行排队。 否则,会引发 LabDeploymentProcessException。
使用 BuildControler 属性来指定生成控制器。
返回值
一个 Int32,指定已排队生成的 ID。
属性
BuildController |
生成控制器名称。 如果此属性和 LabEnvironmentUri 属性值为 null 或未指定,则使用当前生成控制器对生成进行排队。 |
BuildDefinition |
要排队的生成定义。 必需。 |
LabEnvironmentUri |
包含工作流功能的环境的 URI。 使用 GetLabEnvironmentUri 活动可获取环境 URI。 必需。 |
ProjectName |
团队项目的名称。 如果此属性为 null 或未指定,则使用生成的当前项目。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
SaveLabEnvironment
创建一个新环境,然后将该环境存储到团队项目库共享中。 此活动会运行较长时间,并会一直等到保存该环境。 如果创建新环境失败,则会引发 LabDeploymentProcessException 异常。
返回值
指定新环境的 URL 的 String。
属性
LabEnvironmentName |
已保存环境的名称。 如果此属性为 null 或为空,则将使用环境名称。 |
LabEnvironmentUri |
要保存的环境的 URI。 使用 GetLabEnvironmentUri 活动可获取该环境 URI。 必需。 |
TeamProjectLibraryShareName |
存储环境的库共享。 如果未找到指定的库共享,则会引发 NoTeamProjectLibraryShareFoundException 异常。 必需。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
SetLabEnvironmentInuseMarker
设置环境的“正在使用”标记。
属性
注释 |
设置标记时写入的注释。 |
LabEnvironmentUri |
环境的 URI。 使用 GetLabEnvironmentUri 活动可获取环境 URI。 必需。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
SnapshotLabEnvironment
拍摄环境的快照。 此活动会运行较长时间,并会一直等到创建环境快照。 如果创建快照失败,则此活动会引发 LabDeploymentProcessException 异常。
返回值
指定快照 ID 的 Int64。
属性
LabEnvironmentUri |
必须为其拍摄快照的环境的 URI。 使用 GetLabEnvironmentUri 活动可获取环境 URI。 必需。 |
SnapshotChainId |
返回快照链 ID。 |
SnapshotName |
要拍摄的快照的名称。 如果此属性为 null,则将当前 DateTime 值用作快照名称。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
StartLabEnvironment
启动环境。 此活动会运行较长时间,并会一直等到启动该环境。 如果启动环境失败,则此活动会引发 LabDeploymentProcessException 异常。
属性
LabEnvironmentUri |
环境的 URI。 使用 GetLabEnvironmentUri 活动可获取环境 URI。 必需。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
StopLabEnvironment
停止环境。 此活动会运行较长时间,并会一直等到停止该环境。 如果停止环境失败,则此活动会引发 LabDeploymentProcessException 异常。
属性
LabEnvironmentUri |
环境的 URI。 使用 GetLabEnvironmentUri 活动可获取环境 URI。 必需。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
WaitForTestCapabilityServices
等待环境的测试功能准备就绪所需的指定最长时间。 如果测试功能在到达等待时间时未就绪,则会引发超时异常。 如果设置 RepairCapabilityBeforeWaitBegins 属性,则会先调用修复功能,然后等待该功能准备就绪。 可使用 MaxWaitTime 属性来配置最长等待时间。
属性
LabEnvironmentUri |
环境的 URI。 使用 GetLabEnvironmentUri 活动可获取环境 URI。 必需。 |
MaxWaitTime |
一个 System.TimeSpan 对象,它指定等待功能就绪的最长时间。 在到达指定持续时间时会引发超时异常。 默认值为 0(零),即表示无限期地等待。 |
RepairCapabilityBeforeWaitBegins |
如果此值为 true,则会先尝试执行修复功能,然后等待。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
WaitForWorkflow
等待完成排队生成所需的给定最长时间。 如果生成工作流在给定的最长时间内未完成,则会引发超时异常。 活动会定期检查排队生成的状态以确定已完成哪些生成。 通过使用 RefreshInterval 属性配置此时间间隔。
返回值
一个 T: Microsoft.TeamFoundation.Build.Client.BuildStatus 枚举值,它指示工作流的状态。
属性
AllowPartiallySucceededBuild |
如果为 true,则将部分成功视为成功。 |
BuildDetails |
一个 Microsoft.TeamFoundation.Build.Client.IBuildDetail 对象,它包含生成服务器上已排队生成的详细信息。 这是一个 out 参数。 |
LabWorkflowType |
工作流的类型。 |
MaxConsecutiveFailuresToIgnoreDuringWaitForCompletion |
在等待工作流完成时,应忽略的最大连续失败次数。 其默认值为 3。 可使用此属性增加工作流的可靠性。 |
MaxWaitTime |
一个 System.TimeSpan 对象,它指定等待工作流完成的最长时间。 在到达指定持续时间时会引发超时异常。 默认值为 0(零),即表示无限期地等待。 |
QueueBuildId |
已排队生成的 ID。 必需。 |
RefreshInterval |
一个 System.TimeSpan 对象,它指定刷新工作流状态的时间间隔。 此时间间隔的默认值为 60 秒。 |
ThrowOnError |
如果为 true,则在生成失败时会引发异常。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
WaitForWorkflowCapabilityServices
等待环境的工作流功能就绪的指定时间。 如果工作流功能在等待时间结束时未就绪,则会引发超时异常。 如果设置 RepairCapabilityBeforeWaitBegins 属性,则会先调用修复功能,然后等待功能准备就绪。 可使用 MaxWaitTime 属性来配置最长等待时间。
属性
LabEnvironmentUri |
环境的 URI。 使用 GetLabEnvironmentUri 活动可获取环境 URI。 必需。 |
MaxWaitTime |
一个 System.TimeSpan 对象,它指定等待功能就绪的最长时间。 在到达指定持续时间时会引发超时异常。 默认值为 0(零),即表示无限期地等待。 |
RepairCapabilityBeforeWaitBegins |
如果此值为 true,则会先尝试执行修复功能,然后等待。 |
WaitForComputerNames |
如果此值为 true,则一直等到环境的所有虚拟机的计算机名称可用。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
WriteDeploymentInformation
写入包含在生成摘要中的部署信息。 部署信息部分包含三个子部分:生成、部署和测试。 可使用 DeploymentInformationType 属性将部署信息添加到特定的子部分中。 可使用 Url 属性将链接添加到部署信息中。
属性
消息 |
要在摘要中显示的消息。 必需。 |
URL |
要向消息中添加的可选 URL 或链接。 |
DeploymentInformationType |
为此信息性消息指定部署信息的子部分。 使用下列值之一:
|
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
Lab Management 类
下表总结了可在工作流设计器中用来自定义生成、部署和测试过程的 Lab Management 类。 这些类是 Microsoft.TeamFoundation.Lab.Workflow.Activities 命名空间的一部分。
对象 |
说明 |
---|---|
LabWorkflowDetails |
LabWorkflowDetails 类包含实验室工作流参数向导中的配置数据。 LabWorkflowDetails 对象包含 BuildDetails、RunTestDetails 和 ScriptDetails 对象。 |
BuildDetails |
存储生成、部署和测试方案的生成详细信息。 |
DeploymentDetails |
存储在生成、部署和测试工作流中创建自动测试运行所需的测试参数详细信息 |
LabEnvironmentDetails |
存储在生成、部署和测试方案中标识实验室环境所需的信息 |
LabEnvironmentInUseMarker |
存储环境的“正在使用”标记的详细信息。 |
LabEnvironmentState |
指定环境的当前状态。 |
RunTestDetails |
存储创建自动测试运行所需的测试参数详细信息。 |
ScriptDetails |
存储生成、部署和测试方案所需的部署脚本详细信息。 |
ScriptDetails |
存储测试运行的详细信息。 |
LabWorkflowDetails
LabWorkflowDetails 类包含实验室工作流参数向导中的配置数据。 在 LabDefaultTemplate 中,工作流的 LabWorkflowDetails 对象包含在 LabWorkflowParameters 参数中。 LabWorkflowDetails 类包含以下属性:
BuildDetails |
一个 BuildDetails 对象,它由工作流向导创建,且存储了生成、部署和测试方案的生成详细信息。 |
DeploymentDetails |
一个 LabEnvironmentDetails 对象,它由工作流向导创建,且存储了在生成、部署和测试方案中部署生成所需的信息。 |
EnvironmentDetails |
一个 LabEnvironmentDetails 对象,它由工作流向导创建,且存储了标识用于生成、部署和测试方案的环境的信息。 |
TestParameters |
一个 RunTestDetails 对象,它由工作流向导创建,且存储了创建自动测试运行所需的测试参数详细信息。 |
BuildDetails
BuildDetails 存储生成、部署和测试方案的生成详细信息。
属性
IsTeamSystemBuild |
一个 Boolean,它指示使用的生成是否是“团队生成”类型。 |
BuildDefinitionUri |
指定生成定义的 URI 的 Uri。 |
BuildDefinitionName |
指定生成定义的名称的 String。 |
QueueNewBuild |
一个 Boolean,它指示是否必须对新生成进行排队。 |
BuildUri |
一个 Uri,它指定生成的 URI(如果该生成是“团队生成”类型)。 |
CustomBuildPath |
一个 String,它指定生成的路径(如果该生成不是“团队生成”类型)。 |
配置 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
DeploymentDetails
DeploymentDetails 存储在生成、部署和测试工作流中创建自动测试运行所需的测试参数详细信息。 可使用 LabWorkflowParameters 参数的 DeploymentDetails 属性访问由 Lab Management 向导创建的 DeploymentDetails 对象。
属性
PostDeploymentSnapshotPath |
一个 String,包含存储后期部署快照的路径。 |
PostDeploymentSnapshotName |
一个 String,它指定部署后拍摄的快照的名称。 |
TakePostDeploymentSnapshot |
一个 Boolean,它指定是否需要后期部署快照。 |
脚本 |
一个 StringList 对象,它包含虚拟机及其相应部署脚本的列表。 |
DeploymentNeeded |
一个 Boolean,它指定是否需要执行部署。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
LabEnvironmentDetails
一个 LabEnvironmentDetails,它存储在生成、部署和测试方案中标识实验室环境所需的信息。 可使用 LabWorkflowParameters 参数的 EnvironmentDetails 属性访问由 Lab Management 工作流向导创建的 LabEnvironmentDetails 对象。
属性
ProjectName |
一个 String,它指定团队项目的名称 |
LabEnvironmentName |
一个 String,它指定实验室环境的名称 |
NewLabEnvironmentName |
一个 String,它指定要创建的实验室环境的名称。 |
HostGroupName |
一个 String,它指定要将环境部署到的主机组的名称。 |
LabLibraryShareName |
一个 String,它指定包含存储的实验室环境模板的库共享的名称。 |
RevertToSnapshot |
一个 Boolean,指示是否应将环境回滚到快照。 |
SnapshotName |
一个 String,它指定要回滚到的环境快照的名称。 |
TfsUrl |
一个 String,它指定 Team Foundation Server 的 URL。 |
LabEnvironmentUri |
一个 Uri,它指定选定环境的 URI。 |
Disposition |
一个 LabEnvironmentDisposition 枚举值,它指示环境的状态。 该属性的值有: 未知 - 环境的状态未知。 活动 - 已在主机上部署环境,并且可启动并运行环境。 已存储 - 已将环境存储到库共享中,并且在部署前无法使用环境。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
RunTestDetails
RunTestDetails 存储在生成、部署和测试工作流中创建自动测试运行所需的测试参数详细信息。 可使用 LabWorkflowParameters 参数的 TestParameters 属性访问由 Lab Management 向导创建的 RunTestDetails 对象。
属性
TfsUrl |
一个 String,它指定 Team Foundation Server 的 URL。 |
项目名称 |
一个 String,它指定团队项目的名称。 |
TestConfigurationId |
一个 Int32,它指定测试运行的测试配置的 ID。 |
TestPlanId |
一个 Int32,它指定测试计划的 ID。 |
TestSuiteIdList |
一个 Systems.Collections.Generic.List<int>,它包含要运行的测试套件的数字 ID。 |
TestSettingsId |
一个 Int32,它指定测试运行的测试设置的 ID。 |
RunTest |
一个 Boolean,它指定是否运行测试。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
ScriptDetails
提供脚本部署的详细信息。 在将 RunDeploymentScript 活动添加到工作流设计器中时,需要 ScriptDetails 对象。 InitializeAgentSpecAndEnvironmentVariables 将返回一个 ScriptDetails 对象。
属性
LabSystemName |
一个 String,它指定实验室环境的名称。 |
AgentSpec |
一个 AgentReservationSpec 对象,它包含与实验室系统中的生成代理关联的标记。 |
FileName |
一个 String,它指定部署脚本文件的名称。 |
参数 |
一个 String,它指定要传递到部署脚本的参数。 |
WorkingDirectory |
一个 String,它指定实验室系统上的部署脚本的工作目录。 |
EnvironmentVariables |
一个 System.Collection.Generic.IDictionary<String,String>,它包含环境变量名称/值对。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
TestRunStatistics
存储测试运行的详细信息。 TestRunStatistics 对象由 ExecuteRemoteTestRun 活动返回。
属性
TotalTests |
一个 Int32,它指定测试运行中测试的总数。 |
PassedTests |
一个 Int32,它指定传入测试运行中的测试的数量。 |
FailedTests |
一个 Int32,它指定测试运行中失败的测试的数量。 |
InconclusiveTests |
一个 Int32,它指定测试运行中无结论的测试的数量。 |
PendingTests |
一个 Int32,它指定测试运行中尚未运行的测试的数量。 |
AbortedTests |
一个 Int32,它指定测试运行中已中止的测试的数量。 |
InProgressTests |
一个 Int32,它指定测试运行中当前正在运行的测试的数量。 |
TestRunStatus |
一个 TestRunState 枚举值,它指定测试运行的状态。 |
TestRunId |
一个 Int32,它指定测试运行的标识符。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
LabEnvironmentInUseMarker
存储环境的“正在使用”标记的详细信息。 使用 GetLabEnvironmentInUseMarker 活动可返回一个 LabEnvironmentInUseMarker 对象。
属性
用户 |
一个 String,它指定标记环境的用户。 |
时间戳 |
一个 DateTime,它指定用户标记环境的时间。 |
注释 |
一个由标记环境的用户指定的 String。 |
No text is specified for bookmark or legacy link 'b3f645d4-2db0-40e7-b8bf-eedca5d82ba8#BKMK_Top'.
LabEnvironmentState
指定环境的当前状态的枚举。 实验室环境的状态大多数由其包含的虚拟机的状态确定。 如果所有虚拟机都处于一致的稳定状态,则 LabEnvironmentState 值会与该状态匹配。 否则,此值为 Mixed 或 Failed。 当对环境执行的操作正在进行时,实验室环境处于转换状态,指示正在进行的操作。
LabEnvironmentState 包含以下值:
未知
正在创建
CreateFailed
CreateCancelling
Updating
已存储
正在启动
正在运行
正在暂停
已暂停
正在停止
已停止
CreatingSnapshot
DeletingSnapshot
RestoringSnapshot
正在删除
DeleteFailed
Deleted
混合
未通过
UnderMigration