Team Foundation LabManagement 活動

發行項
08/12/2011

更新：2010 年 8 月

當您自訂 Lab Management 工作流程範本 (LabDefaultTemplate.xaml) 時，可以使用其中一個或多個預先定義的 Lab Management 活動。您也可以存取 Lab Management 精靈所建立的物件。本主題描述自訂工作流程範本以建置、部署以及測試您應用程式時可用的 Team Foundation Lab Management 活動和物件。如需如何在自訂的工作流程中使用這些活動的詳細資訊，請參閱自訂 Lab Management 工作流程。

此主題包括下列章節：

Lab Management 活動

下表描述個別的 Lab Management 工作流程活動。

活動	描述
CreateLabEnvironment	從預存範本建立新環境，然後在指定的主機群組上進行部署。
DeleteLabEnvironment	刪除環境。
DeleteSnapshot	刪除環境的快照。
ExecuteRemoteTestRun	建立在環境上執行的測試，並等待其完成。
GenerateEnvironmentViewerFile	產生擁有快照連結 ID 的環境檢視器檔案。此檔案用來連接至環境的快照。
GetBuildLocationAndBuildNumber	傳回組建、部署與測試情節的組建位置和組建編號。
GetLabEnvironmentInUseMarker	傳回環境的使用中標記。
GetLabEnvironmentSnapshotId	取得環境快照的 ID。
GetLabEnvironmentStatus	取得環境狀態。
GetLabEnvironmentUri	取得指定環境名稱和實驗室位置名稱的環境 URI。
InitializeAgentSpecAndEnvironmentVariables	剖析屬性所指定的部署指令碼詳細資料
ResetLabEnvironmentInuseMarker	重設環境的使用中標記。
RestoreLabEnvironment	將環境還原至指定的快照。
RunDeploymentScript	執行部署指令碼。失敗時，擲回或寫入組建警告，如 ThrowOnError 屬性中所指定。
RunWorkflow	在組建伺服器的組建控制器上佇列新的工作流程。
SaveLabEnvironment	建立新環境，然後將其儲存在 Team 專案程式庫共用中。
SetLabEnvironmentInuseMarker	設定環境的使用中標記。
SnapshotLabEnvironment	拍攝環境的快照。
StartLabEnvironment	啟動環境。
StopLabEnvironment	停止環境。
WaitForTestCapabilityServices	等待指定的時間上限，讓環境的測試功能準備就緒。等待時間結束時，如果測試功能還未準備就緒，就會擲回逾時例外狀況。
WaitForWorkflow	工作流程的類型。
WaitForWorkflowCapabilityServices	等待指定的等待時間上限，讓佇列的組建完成。如果組建工作流程沒有在指定的時間上限內完成，就會擲回 TimeOutException。活動會定期檢查佇列的組建狀態以判斷完成的組建。您可以使用 RefreshInterval 屬性設定這個間隔。
WriteDeploymentInformation	寫入組建摘要中所包含的部署資訊。

CreateLabEnvironment

從預存範本建立新環境，然後在指定的主機群組上進行部署。這是長時間執行的活動，而且會等到建立新環境為止。如果無法建立新的實驗室環境，此活動會擲回一個 LabDeploymentProcessException 例外狀況。

屬性

LabEnvironmentName	新環境的名稱。如果此屬性為 null 或空白，將會使用環境範本名稱。
LabEnvironmentTemplateUri	預存環境範本的 URI。您可以使用 GetLabEnvironmentUri 活動取得實驗室環境範本 URI。必要項。
TeamProjectHostGroupName	將部署新環境所在的主機群組。如果找不到具指定的主機群組，則會擲回 NoTeamProjectHostGroupFoundException 例外狀況。必要項。

LabEnvironmentUri	更新其快照之實驗室環境的 URI。您可以使用 GetLabEnvironmentUri 活動取得實驗室環境 URI。必要項。
SnapshotId	要刪除之快照的 ID。您可以使用 GetLabEnvironmentSnapshotId 活動取得快照 ID。必要項。

BuildNumber	執行測試的組建編號。
LabEnvironmentUri	將執行測試案例之環境的 URI。您可以使用 GetLabEnvironmentUri 活動取得環境 URI。
MaxConsecutiveFailuresToIgnoreDuringWaitForCompletion	活動等待測試執行時，應該忽略的連續失敗次數上限。這個屬性的預設值為 3。
MaxWaitTime	TimeSpan 物件，這個物件會指定讓測試回合完成的等待時間上限。在指定的持續時間結束時，會擲回逾時例外狀況。預設值為 0 (零)，表示活動無限期等待。
RefreshInterval	指定間隔的 TimeSpan，在這個間隔之後會重新整理測試回合的狀態。此間隔的預設值為 60 秒。
TestDirectory	測試可執行檔的路徑。
TestEnvironment	將執行測試案例之測試環境的名稱。
TestParameters	RunTestDetails 物件，這個物件會指定測試參數，例如測試計劃、測試套件、測試設定，以及測試組態。必要項。
Title	測試回合的名稱。必要項。

FilePath	儲存環境檢視器檔案所在的 UNC 路徑。組建服務帳戶必須具有路徑的寫入權限。必要項。
LabEnvironmentUri	環境的 URI。您可以使用 GetLabEnvironmentUri 活動取得環境 URI。必要項。
SnapshotId	快照的 ID。您可以使用 GetLabEnvironmentSnapshotId 活動取得快照 ID。如果快照無效，則會擲回 InvalidSnapshotException 例外狀況。必要項。

BuildDetails	Microsoft.TeamFoundation.Lab.Workflow.Activities.BuildDetails 物件，其中包含組建、部署和測試情節中與組建相關的資訊。
BuildNumber	所選組建的組建編號。這是一個 outArgument。對於非 "Team Build" 組建而言，這是 null。
SelectedBuild	有關組建伺服器的組建資訊。這是一個 outArgument。對於非 "Team Build" 組建而言，這是 null。

LabEnvironmentUri	環境的 URI。使用 GetLabEnvironmentUri 活動取得環境 URI。必要項。
SnapshotName	快照名稱。必要項。

LabEnvironmentName	環境名稱。必要項。
ProjectName	Team 專案的名稱。如果此屬性值為 null 或未指定，則會使用組建的目前專案。
TeamProjectLabLocationName	實驗室名稱。可以是主機群組名稱或程式庫共用名稱。如果找不到實驗室位置，則會擲回一個 NoLabLocationFoundException 例外狀況。必要項。

BuildLocation	組建位置路徑。這用來擴充巨集 $(BuildLocation)。必要項。
DeploymentScriptDetails	「實驗室系統名稱 \| 指令碼引數 \|工作目錄」格式的部署詳細資料。必要項。
LabEnvironmentUri	環境的 URI。使用 GetLabEnvironmentUri 活動取得環境 URI。必要項。

MaximumAttemptsForNetUse	要加入網路使用的嘗試次數上限。
ScriptDetails	實驗室系統的 Script Details 物件。必要項。
SharedLocationForNetUse	應由實驗室服務帳戶所存取的位置。
ThrowOnError	表示是否為錯誤擲回例外狀況的旗標。預設值為 True。

BuildController	組建控制器名稱。如果此屬性和 LabEnvironmentUri 屬性值為 null 或未指定，就會使用目前的組建控制器來佇列組建。
BuildDefinition	要佇列的組建定義。必要項。
LabEnvironmentUri	具有工作流程功能之環境的 URI。使用 GetLabEnvironmentUri 活動取得環境 URI。必要項。
ProjectName	Team 專案的名稱。如果此屬性為 null 或未指定，則會使用組建的目前專案。

LabEnvironmentName	已儲存之環境的名稱。如果此屬性為 null 或空白，將會使用環境名稱。
LabEnvironmentUri	要儲存之環境的 URI。使用 GetLabEnvironmentUri 活動取得環境的 URI。必要項。
TeamProjectLibraryShareName	要將環境儲存在其中的程式庫共用。如果找不到具指定的程式庫共用，則會擲回 NoTeamProjectLibraryShareFoundException 例外狀況。必要項。

LabEnvironmentUri	必須拍攝其快照之環境的 URI。使用 GetLabEnvironmentUri 活動取得環境 URI。必要項。
SnapshotChainId	傳回快照鏈結 ID。
SnapshotName	要拍攝之快照的名稱。如果此屬性為 null，則會使用目前的 DateTime 值做為快照名稱。

AllowPartiallySucceededBuild	若為 true，會將部分成功視為成功。
BuildDetails	Microsoft.TeamFoundation.Build.Client.IBuildDetail 物件，其中包含組建伺服器上已佇列的組建詳細資料。這是一個 out 引數。
LabWorkflowType	工作流程的類型。
MaxConsecutiveFailuresToIgnoreDuringWaitForCompletion	活動等待工作流程完成時，應該忽略的連續失敗次數上限。此預設值為 3。這個屬性可用來提升工作流程的加強性。
MaxWaitTime	System.TimeSpan 物件，這個物件會指定等待工作流程完成的時間上限。在指定的逾時期間結束時，會擲回逾時例外狀況。預設值為 0 (零)，表示永遠等待。
QueueBuildId	已佇列組建的 ID。必要項。
RefreshInterval	指定間隔的 System.TimeSpan 物件，在這個間隔之後會重新整理工作流程的狀態。此間隔的預設值為 60 秒。
ThrowOnError	若為 true，則會在組建失敗時擲回例外狀況。

LabEnvironmentUri	環境的 URI。使用 GetLabEnvironmentUri 活動取得環境 URI。必要項。
MaxWaitTime	System.TimeSpan 物件，這個物件會指定等待功能準備就緒的時間上限。在指定的逾時期間結束時，會擲回逾時例外狀況。預設值為 0 (零)，表示永遠等待。
RepairCapabilityBeforeWaitBegins	如果此值為 true，就會在等待前完成修復功能的嘗試。
WaitForComputerNames	如果此值為 true，請等到環境之所有虛擬機器的電腦名稱可用為止。

物件	描述
LabWorkflowDetails	LabWorkflowDetails 類別包含來自「實驗室工作流程參數」精靈的組態資料。 LabWorkflowDetails 物件包含 BuildDetails、RunTestDetails 與 ScriptDetails 物件。
BuildDetails	儲存組建、部署與測試情節的組建詳細資料。
DeploymentDetails	儲存在組建、部署和測試工作流程中建立自動化的測試回合所需的測試參數詳細資料。
LabEnvironmentDetails	儲存在組建、部署和測試情節中識別實驗室環境所需的資訊
LabEnvironmentInUseMarker	儲存環境之使用中標記的詳細資料。
LabEnvironmentState	指定環境的目前狀態。
RunTestDetails	儲存建立自動化的測試回合所需的測試參數詳細資料。
ScriptDetails	儲存組建、部署和測試情節所需的部署指令碼詳細資料。
ScriptDetails	儲存測試回合的詳細資料。

Comment	設定標記時寫入的註解。
LabEnvironmentUri	環境的 URI。使用 GetLabEnvironmentUri 活動取得環境 URI。必要項。

BuildDetails	由工作流程精靈所建立，並儲存組建、部署和測試情節之組建詳細資料的 BuildDetails 物件。
DeploymentDetails	由工作流程精靈所建立，並儲存在組建、部署和測試情節中部署組建所需資訊的 LabEnvironmentDetails 物件。
EnvironmentDetails	由工作流程精靈所建立，並儲存識別環境以用於組建、部署和測試情節之資訊的 LabEnvironmentDetails 物件。
TestParameters	由工作流程精靈所建立，並儲存建立自動化的測試回合所需之測試參數詳細資料的 RunTestDetails 物件。

IsTeamSystemBuild	指出使用的組建是否為 Team Build 類型的 Boolean。
BuildDefinitionUri	指定組建定義 URI 的 Uri。
BuildDefinitionName	指定組建定義名稱的 String。
QueueNewBuild	指出是否必須佇列新組建的 Boolean。
BuildUri	指定組建為 Team Build 類型時，組建 URI 的 Uri。
CustomBuildPath	指定組建不是 Team Build 類型時，組建路徑的 String。
Configuration

PostDeploymentSnapshotPath	包含儲存部署後快照路徑的 String。
PostDeploymentSnapshotName	指定部署後拍攝之快照名稱的 String。
TakePostDeploymentSnapshot	指定是否需要部署後快照的 Boolean。
Scripts	包含虛擬機器及對應部署指令碼之清單的 StringList 物件。
DeploymentNeeded	指定是否需要完成部署的 Boolean。

ProjectName	指定 Team 專案名稱的 String
LabEnvironmentName	指定實驗室環境名稱的 String
NewLabEnvironmentName	指定要建立之實驗室環境名稱的 String。
HostGroupName	指定部署環境之主機群組名稱的 String。
LabLibraryShareName	指定包含預存實驗室環境範本之程式庫共用名稱的 String。
RevertToSnapshot	表示是否應該將環境復原至快照的 Boolean。
SnapshotName	指定要在其中復原之環境快照名稱的 String。
TfsUrl	指定 Team Foundation Server 之 URL 的 String。
LabEnvironmentUri	指定所選環境 URI 的 Uri。
Disposition	表示環境狀態的 LabEnvironmentDisposition 列舉值。這些值包括： Unknown - 環境的狀態未知。 Active - 環境部署在主機上，而且可以啟動並執行。 Stored - 環境已儲存在程式庫共用中，而且在進行部署前無法使用。

TfsUrl	指定 Team Foundation Server 之 URL 的 String。
Project name	指定 Team 專案名稱的 String。
TestConfigurationId	Int32 物件，這個物件會指定測試回合之測試組態的 ID。
TestPlanId	指定測試計劃 ID 的 Int32。
TestSuiteIdList	包含要執行之測試套件數字 ID 的 Systems.Collections.Generic.List<int>
TestSettingsId	Int32 物件，這個物件會指定測試回合之測試設定的 ID。
RunTest	指定是否要執行測試的 Boolean。

LabSystemName	指定實驗室環境名稱的 String。
AgentSpec	AgentReservationSpec 物件，其中包含與實驗室系統中組建代理程式相關聯的標記。
FileName	指定部署指令碼檔案名稱的 String。
Arguments	指定要傳遞到部署指令碼之引數的 String。
WorkingDirectory	指定實驗室系統上部署指令碼之工作目錄的 String。
EnvironmentVariables	包含環境變數名稱/值組的 System.Collection.Generic.IDictionary<String,String>。

TotalTests	在測試回合中指定測試總數的 Int32。
PassedTests	指定在測試回合中傳遞之測試數目的 Int32。
FailedTests	指定在測試回合中失敗之測試數目的 Int32。
InconclusiveTests	指定在測試回合中結果不明之測試數目的 Int32。
PendingTests	指定在測試回合中尚未執行之測試數目的 Int32。
AbortedTests	指定已在測試回合中止之測試數目的 Int32。
InProgressTests	指定所擁有之測試數目目前在測試回合中執行的 Int32。
TestRunStatus	指定測試回合狀態的 TestRunState 列舉值。
TestRunId	指定測試回合識別碼的 Int32。

User	指定標示環境之使用者的 String。
Timestamp	指定使用者標示環境之時間的 DateTime。
Comment	標示環境之使用者指定的 String。

共用方式為

Team Foundation LabManagement 活動

Lab Management 活動

CreateLabEnvironment

DeleteLabEnvironment

DeleteSnapshot

ExecuteRemoteTestRun

GenerateEnvironmentViewerFile

GetBuildLocationAndBuildNumber

GetLabEnvironmentInUseMarker

GetLabEnvironmentSnapshotId

GetLabEnvironmentStatus

GetLabEnvironmentUri

InitializeAgentSpecAndEnvironmentVariables

ResetLabEnvironmentInuseMarker

RestoreLabEnvironment

RunDeploymentScript

RunWorkflow

SaveLabEnvironment

SetLabEnvironmentInuseMarker

SnapshotLabEnvironment

StartLabEnvironment

StopLabEnvironment

WaitForTestCapabilityServices

WaitForWorkflow

WaitForWorkflowCapabilityServices

WriteDeploymentInformation

Lab Management 類別

LabWorkflowDetails

BuildDetails

DeploymentDetails

LabEnvironmentDetails

RunTestDetails

ScriptDetails

TestRunStatistics

LabEnvironmentInUseMarker

LabEnvironmentState

請參閱

其他資源

變更記錄

其他資源