Microsoft.DevCenter projects/environmentTypes 2024-08-01-preview

• Latest
• 2024-10-01-preview
• 2024-08-01-preview
• 2024-07-01-preview
• 2024-06-01-preview
• 2024-05-01-preview
• 2024-02-01
• 2023-10-01-preview
• 2023-08-01-preview
• 2023-04-01
• 2023-01-01-preview
• 2022-11-11-preview
• 2022-10-12-preview
• 2022-09-01-preview
• 2022-08-01-preview

Bicep resource definition

The projects/environmentTypes resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DevCenter/projects/environmentTypes resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DevCenter/projects/environmentTypes@2024-08-01-preview' = {
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    creatorRoleAssignment: {
      roles: {
        {customized property}: {}
      }
    }
    deploymentTargetId: 'string'
    displayName: 'string'
    status: 'string'
    userRoleAssignments: {
      {customized property}: {
        roles: {
          {customized property}: {}
        }
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

EnvironmentRole

Name	Description	Value

ManagedServiceIdentity

Name	Description	Value
type	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).	'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' (required)
userAssignedIdentities	The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.	UserAssignedIdentities

Microsoft.DevCenter/projects/environmentTypes

Name	Description	Value
identity	Managed identity properties	ManagedServiceIdentity
location	The geo-location for the environment type	string
name	The resource name	string Constraints: Min length = 3 Max length = 3 Pattern = ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$ (required)
parent	In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource.	Symbolic name for resource of type: projects
properties	Properties of an environment type.	ProjectEnvironmentTypeProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

ProjectEnvironmentTypeProperties

Name	Description	Value
creatorRoleAssignment	The role definition assigned to the environment creator on backing resources.	ProjectEnvironmentTypeUpdatePropertiesCreatorRoleAssignment
deploymentTargetId	Id of a subscription that the environment type will be mapped to. The environment's resources will be deployed into this subscription.	string
displayName	The display name of the project environment type.	string
status	Defines whether this Environment Type can be used in this Project.	'Disabled' 'Enabled'
userRoleAssignments	Role Assignments created on environment backing resources. This is a mapping from a user object ID to an object of role definition IDs.	ProjectEnvironmentTypeUpdatePropertiesUserRoleAssignments

ProjectEnvironmentTypeUpdatePropertiesCreatorRoleAssignment

Name	Description	Value
roles	A map of roles to assign to the environment creator.	ProjectEnvironmentTypeUpdatePropertiesCreatorRoleAssignmentRoles

ProjectEnvironmentTypeUpdatePropertiesCreatorRoleAssignmentRoles

Name	Description	Value

ProjectEnvironmentTypeUpdatePropertiesUserRoleAssignments

Name	Description	Value

Tags

Name	Description	Value

UserAssignedIdentities

Name	Description	Value

UserAssignedIdentity

Name	Description	Value

UserRoleAssignmentRoles

Name	Description	Value

UserRoleAssignmentValue

Name	Description	Value
roles	A map of roles to assign to the parent user.	UserRoleAssignmentRoles

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File	Description
Configure Deployment Environments service	This template provides a way to configure Deployment Environments.

ARM template resource definition

The projects/environmentTypes resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DevCenter/projects/environmentTypes resource, add the following JSON to your template.

{
  "type": "Microsoft.DevCenter/projects/environmentTypes",
  "apiVersion": "2024-08-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "creatorRoleAssignment": {
      "roles": {
        "{customized property}": {
        }
      }
    },
    "deploymentTargetId": "string",
    "displayName": "string",
    "status": "string",
    "userRoleAssignments": {
      "{customized property}": {
        "roles": {
          "{customized property}": {
          }
        }
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

EnvironmentRole

Name	Description	Value

ManagedServiceIdentity

Name	Description	Value
type	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).	'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' (required)
userAssignedIdentities	The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.	UserAssignedIdentities

Microsoft.DevCenter/projects/environmentTypes

Name	Description	Value
apiVersion	The api version	'2024-08-01-preview'
identity	Managed identity properties	ManagedServiceIdentity
location	The geo-location for the environment type	string
name	The resource name	string Constraints: Min length = 3 Max length = 3 Pattern = ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$ (required)
properties	Properties of an environment type.	ProjectEnvironmentTypeProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.DevCenter/projects/environmentTypes'

ProjectEnvironmentTypeProperties

Name	Description	Value
creatorRoleAssignment	The role definition assigned to the environment creator on backing resources.	ProjectEnvironmentTypeUpdatePropertiesCreatorRoleAssignment
deploymentTargetId	Id of a subscription that the environment type will be mapped to. The environment's resources will be deployed into this subscription.	string
displayName	The display name of the project environment type.	string
status	Defines whether this Environment Type can be used in this Project.	'Disabled' 'Enabled'
userRoleAssignments	Role Assignments created on environment backing resources. This is a mapping from a user object ID to an object of role definition IDs.	ProjectEnvironmentTypeUpdatePropertiesUserRoleAssignments

ProjectEnvironmentTypeUpdatePropertiesCreatorRoleAssignment

Name	Description	Value
roles	A map of roles to assign to the environment creator.	ProjectEnvironmentTypeUpdatePropertiesCreatorRoleAssignmentRoles

ProjectEnvironmentTypeUpdatePropertiesCreatorRoleAssignmentRoles

Name	Description	Value

ProjectEnvironmentTypeUpdatePropertiesUserRoleAssignments

Name	Description	Value

Tags

Name	Description	Value

UserAssignedIdentities

Name	Description	Value

UserAssignedIdentity

Name	Description	Value

UserRoleAssignmentRoles

Name	Description	Value

UserRoleAssignmentValue

Name	Description	Value
roles	A map of roles to assign to the parent user.	UserRoleAssignmentRoles

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Configure Deployment Environments service	This template provides a way to configure Deployment Environments.

Terraform (AzAPI provider) resource definition

The projects/environmentTypes resource type can be deployed with operations that target:

• Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DevCenter/projects/environmentTypes resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DevCenter/projects/environmentTypes@2024-08-01-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      creatorRoleAssignment = {
        roles = {
          {customized property} = {
          }
        }
      }
      deploymentTargetId = "string"
      displayName = "string"
      status = "string"
      userRoleAssignments = {
        {customized property} = {
          roles = {
            {customized property} = {
            }
          }
        }
      }
    }
  })
}

Property values

EnvironmentRole

Name	Description	Value

ManagedServiceIdentity

Name	Description	Value
type	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).	'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' (required)
userAssignedIdentities	The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.	UserAssignedIdentities

Microsoft.DevCenter/projects/environmentTypes

Name	Description	Value
identity	Managed identity properties	ManagedServiceIdentity
location	The geo-location for the environment type	string
name	The resource name	string Constraints: Min length = 3 Max length = 3 Pattern = ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$ (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: projects
properties	Properties of an environment type.	ProjectEnvironmentTypeProperties
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.DevCenter/projects/environmentTypes@2024-08-01-preview"

ProjectEnvironmentTypeProperties

Name	Description	Value
creatorRoleAssignment	The role definition assigned to the environment creator on backing resources.	ProjectEnvironmentTypeUpdatePropertiesCreatorRoleAssignment
deploymentTargetId	Id of a subscription that the environment type will be mapped to. The environment's resources will be deployed into this subscription.	string
displayName	The display name of the project environment type.	string
status	Defines whether this Environment Type can be used in this Project.	'Disabled' 'Enabled'
userRoleAssignments	Role Assignments created on environment backing resources. This is a mapping from a user object ID to an object of role definition IDs.	ProjectEnvironmentTypeUpdatePropertiesUserRoleAssignments

ProjectEnvironmentTypeUpdatePropertiesCreatorRoleAssignment

Name	Description	Value
roles	A map of roles to assign to the environment creator.	ProjectEnvironmentTypeUpdatePropertiesCreatorRoleAssignmentRoles

ProjectEnvironmentTypeUpdatePropertiesCreatorRoleAssignmentRoles

Name	Description	Value

ProjectEnvironmentTypeUpdatePropertiesUserRoleAssignments

Name	Description	Value

Tags

Name	Description	Value

UserAssignedIdentities

Name	Description	Value

UserAssignedIdentity

Name	Description	Value

UserRoleAssignmentRoles

Name	Description	Value

UserRoleAssignmentValue

Name	Description	Value
roles	A map of roles to assign to the parent user.	UserRoleAssignmentRoles