projects

Creates, updates, deletes, gets or lists a projects resource.

Overview

Name	projects
Type	Resource
Id	azure_extras.visual_studio.projects

Fields

The following fields are returned by SELECT queries:

get

The operation succeeded. The response contains the details of the updated team project resource.

Name	Datatype	Description
id	string	Unique identifier of the resource.
name	string	Resource name.
location	string	Resource location.
properties	object	Key/value pair of resource properties.
tags	object	Resource tags.
type	string	Resource type.

list_by_resource_group

The operation succeeded. The response contains the details of the Visual Studio Team Services project resources created in the specified Team Services account.

Name	Datatype	Description
id	string	Unique identifier of the resource.
name	string	Resource name.
location	string	Resource location.
properties	object	Key/value pair of resource properties.
tags	object	Resource tags.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, subscriptionId, rootResourceName, resourceName		Gets the details of a Team Services project resource.
list_by_resource_group	select	resourceGroupName, subscriptionId, rootResourceName		Gets all Visual Studio Team Services project resources created in the specified Team Services account.
create	insert	resourceGroupName, subscriptionId, rootResourceName, resourceName	validating	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).
update	update	resourceGroupName, subscriptionId, rootResourceName, resourceName		Updates the tags of the specified Team Services project.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
resourceGroupName	string	Name of the resource group within the Azure subscription.
resourceName	string	Name of the Team Services project.
rootResourceName	string	Name of the Team Services account.
subscriptionId	string	The Azure subscription identifier.
validating	string	This parameter is ignored and should be set to an empty string.

SELECT examples

get

Gets the details of a Team Services project resource.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure_extras.visual_studio.projects
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND rootResourceName = '{{ rootResourceName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
;

list_by_resource_group

Gets all Visual Studio Team Services project resources created in the specified Team Services account.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure_extras.visual_studio.projects
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND rootResourceName = '{{ rootResourceName }}' -- required
;

INSERT examples

create

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).

INSERT INTO azure_extras.visual_studio.projects (
data__location,
data__tags,
data__properties,
resourceGroupName,
subscriptionId,
rootResourceName,
resourceName,
validating
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ rootResourceName }}',
'{{ resourceName }}',
'{{ validating }}'
RETURNING
id,
name,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: projects
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the projects resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the projects resource.
    - name: rootResourceName
      value: string
      description: Required parameter for the projects resource.
    - name: resourceName
      value: string
      description: Required parameter for the projects resource.
    - name: location
      value: string
      description: |
        Resource location.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: properties
      value: object
      description: |
        Key/value pair of resource properties.
    - name: validating
      value: string
      description: This parameter is ignored and should be set to an empty string.

UPDATE examples

update

Updates the tags of the specified Team Services project.

UPDATE azure_extras.visual_studio.projects
SET 
data__location = '{{ location }}',
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND rootResourceName = '{{ rootResourceName }}' --required
AND resourceName = '{{ resourceName }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;