projects

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

Overview

Name	projects
Type	Resource
Id	azure.dev_center.projects

Fields

The following fields are returned by SELECT queries:

get

OK. The request has succeeded.

Name	Datatype	Description
identity	object	Managed identity properties
location	string	The geo-location where the resource lives
properties	object	Properties of a project.
tags	object	Resource tags.

get_inherited_settings

OK. The request has succeeded.

Name	Datatype	Description
networkSettings	object	Network settings that will be enforced on this project.
projectCatalogSettings	object	Dev Center settings to be used when associating a project with a catalog.

list_by_resource_group

OK. The request has succeeded.

Name	Datatype	Description
identity	object	Managed identity properties
location	string	The geo-location where the resource lives
properties	object	Properties of a project.
tags	object	Resource tags.

list_by_subscription

OK. The request has succeeded.

Name	Datatype	Description
identity	object	Managed identity properties
location	string	The geo-location where the resource lives
properties	object	Properties of a project.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, projectName		Gets a specific project.
get_inherited_settings	select	subscriptionId, resourceGroupName, projectName		Gets applicable inherited settings for this project.
list_by_resource_group	select	subscriptionId, resourceGroupName	$top	Lists all projects in the resource group.
list_by_subscription	select	subscriptionId	$top	Lists all projects in the subscription.
create_or_update	insert	subscriptionId, resourceGroupName, projectName		Creates or updates a project.
update	update	subscriptionId, resourceGroupName, projectName		Partially updates a project.
delete	delete	subscriptionId, resourceGroupName, projectName		Deletes a project resource.

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
projectName	string	The name of the project.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
$top	integer (int32)	The maximum number of resources to return from the operation. Example: '$top=10'.

SELECT examples

get

Gets a specific project.

SELECT
identity,
location,
properties,
tags
FROM azure.dev_center.projects
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND projectName = '{{ projectName }}' -- required
;

get_inherited_settings

Gets applicable inherited settings for this project.

SELECT
networkSettings,
projectCatalogSettings
FROM azure.dev_center.projects
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND projectName = '{{ projectName }}' -- required
;

list_by_resource_group

Lists all projects in the resource group.

SELECT
identity,
location,
properties,
tags
FROM azure.dev_center.projects
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND $top = '{{ $top }}'
;

list_by_subscription

Lists all projects in the subscription.

SELECT
identity,
location,
properties,
tags
FROM azure.dev_center.projects
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Creates or updates a project.

INSERT INTO azure.dev_center.projects (
data__tags,
data__location,
data__properties,
data__identity,
subscriptionId,
resourceGroupName,
projectName
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ properties }}',
'{{ identity }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ projectName }}'
RETURNING
identity,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: projects
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the projects resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the projects resource.
    - name: projectName
      value: string
      description: Required parameter for the projects resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: properties
      value: object
      description: |
        Properties of a project.
    - name: identity
      value: object
      description: |
        Managed identity properties

UPDATE examples

update

Partially updates a project.

UPDATE azure.dev_center.projects
SET 
data__tags = '{{ tags }}',
data__location = '{{ location }}',
data__properties = '{{ properties }}',
data__identity = '{{ identity }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND projectName = '{{ projectName }}' --required
RETURNING
identity,
location,
properties,
tags;

DELETE examples

delete

Deletes a project resource.

DELETE FROM azure.dev_center.projects
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND projectName = '{{ projectName }}' --required
;