This documentation is archived and is not being maintained.

ITeamProjectCollectionServicing::QueueCreateCollection Method (String, String, Boolean, String, TeamFoundationServiceHostStatus, IDictionary<String, String>, String, String, IDictionary<String, String>)

Queues creation of a new team project collection on the server.

Namespace:  Microsoft.TeamFoundation.Framework.Client
Assembly:  Microsoft.TeamFoundation.Client (in Microsoft.TeamFoundation.Client.dll)

ServicingJobDetail^ QueueCreateCollection(
	String^ name, 
	String^ description, 
	bool isDefault, 
	String^ virtualDirectory, 
	TeamFoundationServiceHostStatus state, 
	IDictionary<String^, String^>^ servicingTokens, 
	String^ dataTierConnectionString, 
	String^ defaultConnectionString, 
	IDictionary<String^, String^>^ databaseCategoryConnectionStrings
)

Parameters

name
Type: System::String

The name of the collection

description
Type: System::String

A description of the collection.

isDefault
Type: System::Boolean

If true, the collection is made the default for older clients not explicitly specifying a collection.

virtualDirectory
Type: System::String

The public url virtual path associated with the collection

state
Type: Microsoft.TeamFoundation.Framework.Common::TeamFoundationServiceHostStatus

the initial state of the collection.

servicingTokens
Type: System.Collections.Generic::IDictionary<String, String>

Replacement strings for tokens in collection creation servicing steps.

dataTierConnectionString
Type: System::String

A connection String to the SQL instance to create new collection database(s) on. Optional.

defaultConnectionString
Type: System::String

A connection String to an existing empty database to be populated by CreateCollection. Database categories not associated with another connection String will default to this connection String. Optional.

databaseCategoryConnectionStrings
Type: System.Collections.Generic::IDictionary<String, String>

A dictionary mapping database categories to connection strings for existing empty databases to be populated by CreateCollection. Values here override the default connection String, if supplied. Optional.

Return Value

Type: Microsoft.TeamFoundation.Framework.Client::ServicingJobDetail
Returns the servicing job result which contains the job and host Id

Show: