Projects class
Class representing a Projects.
Constructors
| Projects(Visual |
Create a Projects. |
Methods
| begin |
Creates a Team Services project in the collection with the specified name. 'VersionControlOption' and 'ProcessTemplateId' must be specified in the resource properties. Valid values for VersionControlOption: Git, Tfvc. Valid values for ProcessTemplateId: 6B724908-EF14-45CF-84F8-768B5384DA45, ADCC42AB-9882-485E-A3ED-7678F01F66BC, 27450541-8E31-4150-9947-DC59F998FC01 (these IDs correspond to Scrum, Agile, and CMMI process templates). |
| create(Project |
Creates a Team Services project in the collection with the specified name. 'VersionControlOption' and 'ProcessTemplateId' must be specified in the resource properties. Valid values for VersionControlOption: Git, Tfvc. Valid values for ProcessTemplateId: 6B724908-EF14-45CF-84F8-768B5384DA45, ADCC42AB-9882-485E-A3ED-7678F01F66BC, 27450541-8E31-4150-9947-DC59F998FC01 (these IDs correspond to Scrum, Agile, and CMMI process templates). |
| get(string, string, string, Request |
Gets the details of a Team Services project resource. |
| get(string, string, string, Request |
|
| get(string, string, string, Service |
|
| get |
Gets the status of the project resource creation job. |
| get |
|
| get |
|
| list |
Gets all Visual Studio Team Services project resources created in the specified Team Services account. |
| list |
|
| list |
|
| update(string, Project |
Updates the tags of the specified Team Services project. |
| update(string, Project |
|
| update(string, Project |
Constructor Details
Projects(VisualStudioResourceProviderClientContext)
Create a Projects.
new Projects(client: VisualStudioResourceProviderClientContext)Parameters
Reference to the service client.
Method Details
beginCreate(ProjectResource, string, string, string, ProjectsBeginCreateOptionalParams)
Creates a Team Services project in the collection with the specified name. 'VersionControlOption' and 'ProcessTemplateId' must be specified in the resource properties. Valid values for VersionControlOption: Git, Tfvc. Valid values for ProcessTemplateId: 6B724908-EF14-45CF-84F8-768B5384DA45, ADCC42AB-9882-485E-A3ED-7678F01F66BC, 27450541-8E31-4150-9947-DC59F998FC01 (these IDs correspond to Scrum, Agile, and CMMI process templates).
function beginCreate(body: ProjectResource, resourceGroupName: string, rootResourceName: string, resourceName: string, options?: ProjectsBeginCreateOptionalParams): Promise<LROPoller>Parameters
- body
- ProjectResource
The request data.
- resourceGroupName
-
string
Name of the resource group within the Azure subscription.
- rootResourceName
-
string
Name of the Team Services account.
- resourceName
-
string
Name of the Team Services project.
The optional parameters
Returns
Promise<@azure/ms-rest-azure-js.LROPoller>
Promise<msRestAzure.LROPoller>
create(ProjectResource, string, string, string, ProjectsCreateOptionalParams)
Creates a Team Services project in the collection with the specified name. 'VersionControlOption' and 'ProcessTemplateId' must be specified in the resource properties. Valid values for VersionControlOption: Git, Tfvc. Valid values for ProcessTemplateId: 6B724908-EF14-45CF-84F8-768B5384DA45, ADCC42AB-9882-485E-A3ED-7678F01F66BC, 27450541-8E31-4150-9947-DC59F998FC01 (these IDs correspond to Scrum, Agile, and CMMI process templates).
function create(body: ProjectResource, resourceGroupName: string, rootResourceName: string, resourceName: string, options?: ProjectsCreateOptionalParams): Promise<ProjectsCreateResponse>Parameters
- body
- ProjectResource
The request data.
- resourceGroupName
-
string
Name of the resource group within the Azure subscription.
- rootResourceName
-
string
Name of the Team Services account.
- resourceName
-
string
Name of the Team Services project.
- options
- ProjectsCreateOptionalParams
The optional parameters
Returns
Promise<ProjectsCreateResponse>
Promise<Models.ProjectsCreateResponse>
get(string, string, string, RequestOptionsBase)
Warning
This API is now deprecated.
This operation is deprecated. Please do not use it any longer.
Gets the details of a Team Services project resource.
function get(resourceGroupName: string, rootResourceName: string, resourceName: string, options?: RequestOptionsBase): Promise<ProjectsGetResponse>Parameters
- resourceGroupName
-
string
Name of the resource group within the Azure subscription.
- rootResourceName
-
string
Name of the Team Services account.
- resourceName
-
string
Name of the Team Services project.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<ProjectsGetResponse>
Promise<Models.ProjectsGetResponse>
get(string, string, string, RequestOptionsBase, ServiceCallback<ProjectResource>)
Warning
This API is now deprecated.
This operation is deprecated. Please do not use it any longer.
function get(resourceGroupName: string, rootResourceName: string, resourceName: string, options: RequestOptionsBase, callback: ServiceCallback<ProjectResource>)Parameters
- resourceGroupName
-
string
Name of the resource group within the Azure subscription.
- rootResourceName
-
string
Name of the Team Services account.
- resourceName
-
string
Name of the Team Services project.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
get(string, string, string, ServiceCallback<ProjectResource>)
Warning
This API is now deprecated.
This operation is deprecated. Please do not use it any longer.
function get(resourceGroupName: string, rootResourceName: string, resourceName: string, callback: ServiceCallback<ProjectResource>)Parameters
- resourceGroupName
-
string
Name of the resource group within the Azure subscription.
- rootResourceName
-
string
Name of the Team Services account.
- resourceName
-
string
Name of the Team Services project.
- callback
The callback
getJobStatus(string, string, string, string, string, ProjectsGetJobStatusOptionalParams)
Warning
This API is now deprecated.
This operation is deprecated. Please do not use it any longer.
Gets the status of the project resource creation job.
function getJobStatus(resourceGroupName: string, rootResourceName: string, resourceName: string, subContainerName: string, operation: string, options?: ProjectsGetJobStatusOptionalParams): Promise<ProjectsGetJobStatusResponse>Parameters
- resourceGroupName
-
string
Name of the resource group within the Azure subscription.
- rootResourceName
-
string
Name of the Team Services account.
- resourceName
-
string
Name of the Team Services project.
- subContainerName
-
string
This parameter should be set to the resourceName.
- operation
-
string
The operation type. The only supported value is 'put'.
The optional parameters
Returns
Promise<ProjectsGetJobStatusResponse>
Promise<Models.ProjectsGetJobStatusResponse>
getJobStatus(string, string, string, string, string, ProjectsGetJobStatusOptionalParams, ServiceCallback<ProjectResource>)
Warning
This API is now deprecated.
This operation is deprecated. Please do not use it any longer.
function getJobStatus(resourceGroupName: string, rootResourceName: string, resourceName: string, subContainerName: string, operation: string, options: ProjectsGetJobStatusOptionalParams, callback: ServiceCallback<ProjectResource>)Parameters
- resourceGroupName
-
string
Name of the resource group within the Azure subscription.
- rootResourceName
-
string
Name of the Team Services account.
- resourceName
-
string
Name of the Team Services project.
- subContainerName
-
string
This parameter should be set to the resourceName.
- operation
-
string
The operation type. The only supported value is 'put'.
The optional parameters
- callback
The callback
getJobStatus(string, string, string, string, string, ServiceCallback<ProjectResource>)
Warning
This API is now deprecated.
This operation is deprecated. Please do not use it any longer.
function getJobStatus(resourceGroupName: string, rootResourceName: string, resourceName: string, subContainerName: string, operation: string, callback: ServiceCallback<ProjectResource>)Parameters
- resourceGroupName
-
string
Name of the resource group within the Azure subscription.
- rootResourceName
-
string
Name of the Team Services account.
- resourceName
-
string
Name of the Team Services project.
- subContainerName
-
string
This parameter should be set to the resourceName.
- operation
-
string
The operation type. The only supported value is 'put'.
- callback
The callback
listByResourceGroup(string, string, RequestOptionsBase)
Warning
This API is now deprecated.
This operation is deprecated. Please do not use it any longer.
Gets all Visual Studio Team Services project resources created in the specified Team Services account.
function listByResourceGroup(resourceGroupName: string, rootResourceName: string, options?: RequestOptionsBase): Promise<ProjectsListByResourceGroupResponse>Parameters
- resourceGroupName
-
string
Name of the resource group within the Azure subscription.
- rootResourceName
-
string
Name of the Team Services account.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<ProjectsListByResourceGroupResponse>
Promise<Models.ProjectsListByResourceGroupResponse>
listByResourceGroup(string, string, RequestOptionsBase, ServiceCallback<ProjectResourceListResult>)
Warning
This API is now deprecated.
This operation is deprecated. Please do not use it any longer.
function listByResourceGroup(resourceGroupName: string, rootResourceName: string, options: RequestOptionsBase, callback: ServiceCallback<ProjectResourceListResult>)Parameters
- resourceGroupName
-
string
Name of the resource group within the Azure subscription.
- rootResourceName
-
string
Name of the Team Services account.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
listByResourceGroup(string, string, ServiceCallback<ProjectResourceListResult>)
Warning
This API is now deprecated.
This operation is deprecated. Please do not use it any longer.
function listByResourceGroup(resourceGroupName: string, rootResourceName: string, callback: ServiceCallback<ProjectResourceListResult>)Parameters
- resourceGroupName
-
string
Name of the resource group within the Azure subscription.
- rootResourceName
-
string
Name of the Team Services account.
- callback
The callback
update(string, ProjectResource, string, string, RequestOptionsBase)
Warning
This API is now deprecated.
This operation is deprecated. Please do not use it any longer.
Updates the tags of the specified Team Services project.
function update(resourceGroupName: string, body: ProjectResource, rootResourceName: string, resourceName: string, options?: RequestOptionsBase): Promise<ProjectsUpdateResponse>Parameters
- resourceGroupName
-
string
Name of the resource group within the Azure subscription.
- body
- ProjectResource
The request data.
- rootResourceName
-
string
Name of the Team Services account.
- resourceName
-
string
Name of the Team Services project.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<ProjectsUpdateResponse>
Promise<Models.ProjectsUpdateResponse>
update(string, ProjectResource, string, string, RequestOptionsBase, ServiceCallback<ProjectResource>)
Warning
This API is now deprecated.
This operation is deprecated. Please do not use it any longer.
function update(resourceGroupName: string, body: ProjectResource, rootResourceName: string, resourceName: string, options: RequestOptionsBase, callback: ServiceCallback<ProjectResource>)Parameters
- resourceGroupName
-
string
Name of the resource group within the Azure subscription.
- body
- ProjectResource
The request data.
- rootResourceName
-
string
Name of the Team Services account.
- resourceName
-
string
Name of the Team Services project.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
update(string, ProjectResource, string, string, ServiceCallback<ProjectResource>)
Warning
This API is now deprecated.
This operation is deprecated. Please do not use it any longer.
function update(resourceGroupName: string, body: ProjectResource, rootResourceName: string, resourceName: string, callback: ServiceCallback<ProjectResource>)Parameters
- resourceGroupName
-
string
Name of the resource group within the Azure subscription.
- body
- ProjectResource
The request data.
- rootResourceName
-
string
Name of the Team Services account.
- resourceName
-
string
Name of the Team Services project.
- callback
The callback