project_environment_types

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

Overview

Name	project_environment_types
Type	Resource
Id	azure.devcenter.project_environment_types

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.
creatorRoleAssignment	object	The role definition assigned to the environment creator on backing resources.
deploymentTargetId	string	Id of a subscription that the environment type will be mapped to. The environment's resources will be deployed into this subscription.
displayName	string	The display name of the project environment type.
environmentCount	integer	The number of environments of this type.
identity	object	Managed identity properties.
location	string	The geo-location for the environment type.
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".
status	string	Defines whether this Environment Type can be used in this Project. Known values are: "Enabled" and "Disabled".
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".
userRoleAssignments	object	Role Assignments created on environment backing resources. This is a mapping from a user object ID to an object of role definition IDs.

list

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.
creatorRoleAssignment	object	The role definition assigned to the environment creator on backing resources.
deploymentTargetId	string	Id of a subscription that the environment type will be mapped to. The environment's resources will be deployed into this subscription.
displayName	string	The display name of the project environment type.
environmentCount	integer	The number of environments of this type.
identity	object	Managed identity properties.
location	string	The geo-location for the environment type.
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".
status	string	Defines whether this Environment Type can be used in this Project. Known values are: "Enabled" and "Disabled".
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".
userRoleAssignments	object	Role Assignments created on environment backing resources. This is a mapping from a user object ID to an object of role definition IDs.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, project_name, environment_type_name, subscription_id		Gets a project environment type.
list	select	resource_group_name, project_name, subscription_id	$top	Lists environment types for a project.
create_or_update	insert	resource_group_name, project_name, environment_type_name, subscription_id		Creates or updates a project environment type.
update	update	resource_group_name, project_name, environment_type_name, subscription_id		Partially updates a project environment type.
create_or_update	replace	resource_group_name, project_name, environment_type_name, subscription_id		Creates or updates a project environment type.
delete	delete	resource_group_name, project_name, environment_type_name, subscription_id		Deletes a project environment type.

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
environment_type_name	string	The name of the environment type. Required.
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 project environment type.

SELECT
id,
name,
creatorRoleAssignment,
deploymentTargetId,
displayName,
environmentCount,
identity,
location,
provisioningState,
status,
systemData,
tags,
type,
userRoleAssignments
FROM azure.devcenter.project_environment_types
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND project_name = '{{ project_name }}' -- required
AND environment_type_name = '{{ environment_type_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists environment types for a project.

SELECT
id,
name,
creatorRoleAssignment,
deploymentTargetId,
displayName,
environmentCount,
identity,
location,
provisioningState,
status,
systemData,
tags,
type,
userRoleAssignments
FROM azure.devcenter.project_environment_types
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND project_name = '{{ project_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Creates or updates a project environment type.

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

Manifest

# Description fields are for documentation purposes
- name: project_environment_types
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the project_environment_types resource.
  - name: project_name
    value: "{{ project_name }}"
    description: Required parameter for the project_environment_types resource.
  - name: environment_type_name
    value: "{{ environment_type_name }}"
    description: Required parameter for the project_environment_types resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the project_environment_types resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: identity
    description: |
      Managed identity properties.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location for the environment type.
  - name: properties
    value:
      deploymentTargetId: "{{ deploymentTargetId }}"
      displayName: "{{ displayName }}"
      status: "{{ status }}"
      creatorRoleAssignment:
        roles: "{{ roles }}"
      userRoleAssignments: "{{ userRoleAssignments }}"

UPDATE examples

update

Partially updates a project environment type.

UPDATE azure.devcenter.project_environment_types
SET 
tags = '{{ tags }}',
identity = '{{ identity }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND project_name = '{{ project_name }}' --required
AND environment_type_name = '{{ environment_type_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 environment type.

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

DELETE examples

delete

Deletes a project environment type.

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