projects

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

Overview

Name	projects
Type	Resource
Id	azure.devcenter.projects

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
catalogSettings	object	Settings to be used when associating a project with a catalog.
description	string	Description of the project.
devCenterId	string	Resource Id of an associated DevCenter.
devCenterUri	string	The URI of the Dev Center resource this project is associated with.
displayName	string	The display name of the project.
identity	object	Managed identity properties.
location	string	The geo-location where the resource lives. Required.
maxDevBoxesPerUser	integer	When specified, limits the maximum number of Dev Boxes a single user can create across all pools in the project. This will have no effect on existing Dev Boxes when reduced.
provisioningState	string	The provisioning state of the resource. Known values are: "NotSpecified", "Accepted", "Running", "Creating", "Created", "Updating", "Updated", "Deleting", "Deleted", "Succeeded", "Failed", "Canceled", "MovingResources", "TransientFailure", "RolloutInProgress", and "StorageProvisioningFailed".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
catalogSettings	object	Settings to be used when associating a project with a catalog.
description	string	Description of the project.
devCenterId	string	Resource Id of an associated DevCenter.
devCenterUri	string	The URI of the Dev Center resource this project is associated with.
displayName	string	The display name of the project.
identity	object	Managed identity properties.
location	string	The geo-location where the resource lives. Required.
maxDevBoxesPerUser	integer	When specified, limits the maximum number of Dev Boxes a single user can create across all pools in the project. This will have no effect on existing Dev Boxes when reduced.
provisioningState	string	The provisioning state of the resource. Known values are: "NotSpecified", "Accepted", "Running", "Creating", "Created", "Updating", "Updated", "Deleting", "Deleted", "Succeeded", "Failed", "Canceled", "MovingResources", "TransientFailure", "RolloutInProgress", and "StorageProvisioningFailed".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
catalogSettings	object	Settings to be used when associating a project with a catalog.
description	string	Description of the project.
devCenterId	string	Resource Id of an associated DevCenter.
devCenterUri	string	The URI of the Dev Center resource this project is associated with.
displayName	string	The display name of the project.
identity	object	Managed identity properties.
location	string	The geo-location where the resource lives. Required.
maxDevBoxesPerUser	integer	When specified, limits the maximum number of Dev Boxes a single user can create across all pools in the project. This will have no effect on existing Dev Boxes when reduced.
provisioningState	string	The provisioning state of the resource. Known values are: "NotSpecified", "Accepted", "Running", "Creating", "Created", "Updating", "Updated", "Deleting", "Deleted", "Succeeded", "Failed", "Canceled", "MovingResources", "TransientFailure", "RolloutInProgress", and "StorageProvisioningFailed".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, project_name, subscription_id		Gets a specific project.
list_by_resource_group	select	resource_group_name, subscription_id	$top	Lists all projects in the resource group.
list_by_subscription	select	subscription_id	$top	Lists all projects in the subscription.
create_or_update	insert	resource_group_name, project_name, subscription_id, location		Creates or updates a project.
update	update	resource_group_name, project_name, subscription_id		Partially updates a project.
create_or_update	replace	resource_group_name, project_name, subscription_id, location		Creates or updates a project.
delete	delete	resource_group_name, project_name, subscription_id		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
project_name	string	The name of the project. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$top	integer	The maximum number of resources to return from the operation. Example: '$top=10'. Default value is None.

SELECT examples

get

Gets a specific project.

SELECT
id,
name,
catalogSettings,
description,
devCenterId,
devCenterUri,
displayName,
identity,
location,
maxDevBoxesPerUser,
provisioningState,
systemData,
tags,
type
FROM azure.devcenter.projects
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND project_name = '{{ project_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists all projects in the resource group.

SELECT
id,
name,
catalogSettings,
description,
devCenterId,
devCenterUri,
displayName,
identity,
location,
maxDevBoxesPerUser,
provisioningState,
systemData,
tags,
type
FROM azure.devcenter.projects
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
;

list_by_subscription

Lists all projects in the subscription.

SELECT
id,
name,
catalogSettings,
description,
devCenterId,
devCenterUri,
displayName,
identity,
location,
maxDevBoxesPerUser,
provisioningState,
systemData,
tags,
type
FROM azure.devcenter.projects
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Creates or updates a project.

INSERT INTO azure.devcenter.projects (
tags,
location,
identity,
properties,
resource_group_name,
project_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ identity }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ project_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: projects
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the projects resource.
  - name: project_name
    value: "{{ project_name }}"
    description: Required parameter for the projects resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the projects resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: identity
    description: |
      Managed identity properties.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"
  - name: properties
    value:
      devCenterId: "{{ devCenterId }}"
      description: "{{ description }}"
      maxDevBoxesPerUser: {{ maxDevBoxesPerUser }}
      displayName: "{{ displayName }}"
      catalogSettings:
        catalogItemSyncTypes:
          - "{{ catalogItemSyncTypes }}"

UPDATE examples

update

Partially updates a project.

UPDATE azure.devcenter.projects
SET 
tags = '{{ tags }}',
location = '{{ location }}',
identity = '{{ identity }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND project_name = '{{ project_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates or updates a project.

REPLACE azure.devcenter.projects
SET 
tags = '{{ tags }}',
location = '{{ location }}',
identity = '{{ identity }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND project_name = '{{ project_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a project resource.

DELETE FROM azure.devcenter.projects
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND project_name = '{{ project_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;