Share via

az devcenter admin project-environment-type

Note

This reference is part of the devcenter extension for the Azure CLI (version 2.67.0 or higher). The extension will automatically install the first time you run an az devcenter admin project-environment-type command. Learn more about extensions.

Manage project environment types.

Commands

Name Description Type Status
az devcenter admin project-environment-type create

Create a project environment type.

 Extension GA
az devcenter admin project-environment-type delete

Delete a project environment type.

 Extension GA
az devcenter admin project-environment-type list

List environment types for a project.

 Extension GA
az devcenter admin project-environment-type show

Get a project environment type.

 Extension GA
az devcenter admin project-environment-type update

Update a project environment type.

 Extension GA

az devcenter admin project-environment-type create

Create a project environment type.

az devcenter admin project-environment-type create --deployment-target-id
                                                   --environment-type-name --name
                                                   --identity-type {None, SystemAssigned, SystemAssigned, UserAssigned, UserAssigned}
                                                   --project --project-name
                                                   --resource-group
                                                   --roles
                                                   --status {Disabled, Enabled}
                                                   [--display-name]
                                                   [--location]
                                                   [--tags]
                                                   [--user-assigned-identities]
                                                   [--user-role-assignments]

Examples

Create

az devcenter admin project-environment-type create --identity-type "UserAssigned" --user-assigned-identities "{\\"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1\\":{}}" --roles "{\\"4cbf0b6c-e750-441c-98a7-10da8387e4d6\\":{}}" --deployment-target-id "/subscriptions/00000000-0000-0000-0000-000000000000" --status "Enabled" --user-role-assignments "{\\"e45e3m7c-176e-416a-b466-0c5ec8298f8a\\":{\\"roles\\":{\\"4cbf0b6c-e750-441c-98a7-10da8387e4d6\\":{}}}}" --tags CostCenter="RnD" --environment-type-name "DevTest" --project-name "ContosoProj" --resource-group "rg1"

Required Parameters

--deployment-target-id

ID of a subscription that the environment type will be mapped to. The environment's resources will be deployed into this subscription.

Property Value
Parameter group: Properties Arguments
--environment-type-name --name -n

The name of the environment type.

--identity-type

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

Property Value
Parameter group: Identity Arguments
Accepted values: None, SystemAssigned, SystemAssigned, UserAssigned, UserAssigned
--project --project-name

The name of the project. Use az configure -d project=<project_name> to configure a default.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--roles

A map of roles to assign to the environment creator. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: CreatorRoleAssignment Arguments
--status

Defines whether this environment type can be used in this project.

Property Value
Parameter group: Properties Arguments
Accepted values: Disabled, Enabled

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--display-name

The display name of the project environment type.

Property Value
Parameter group: Properties Arguments
--location -l

The geo-location where the resource lives. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

Property Value
Parameter group: Body Arguments
--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Body Arguments
--user-assigned-identities -u

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. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Identity Arguments
--user-role-assignments

Role assignments created on environment backing resources. This is a mapping from a user object ID to an object of role definition IDs. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az devcenter admin project-environment-type delete

Delete a project environment type.

az devcenter admin project-environment-type delete [--environment-type-name --name]
                                                   [--ids]
                                                   [--project --project-name]
                                                   [--resource-group]
                                                   [--subscription]
                                                   [--yes]

Examples

Delete

az devcenter admin project-environment-type delete --environment-type-name "DevTest" --project-name "ContosoProj" --resource-group "rg1"

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--environment-type-name --name -n

The name of the environment type.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--project --project-name

The name of the project. Use az configure -d project=<project_name> to configure a default.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az devcenter admin project-environment-type list

List environment types for a project.

az devcenter admin project-environment-type list --project --project-name
                                                 --resource-group
                                                 [--max-items]
                                                 [--next-token]

Examples

List

az devcenter admin project-environment-type list --project-name "ContosoProj" --resource-group "rg1"

Required Parameters

--project --project-name

The name of the project. Use az configure -d project=<project_name> to configure a default.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property Value
Parameter group: Pagination Arguments
--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property Value
Parameter group: Pagination Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az devcenter admin project-environment-type show

Get a project environment type.

az devcenter admin project-environment-type show [--environment-type-name --name]
                                                 [--ids]
                                                 [--project --project-name]
                                                 [--resource-group]
                                                 [--subscription]

Examples

Get

az devcenter admin project-environment-type show --environment-type-name "DevTest" --project-name "ContosoProj" --resource-group "rg1"

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--environment-type-name --name -n

The name of the environment type.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--project --project-name

The name of the project. Use az configure -d project=<project_name> to configure a default.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az devcenter admin project-environment-type update

Update a project environment type.

az devcenter admin project-environment-type update [--add]
                                                   [--deployment-target-id]
                                                   [--display-name]
                                                   [--environment-type-name --name]
                                                   [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--identity-type {None, SystemAssigned, SystemAssigned, UserAssigned, UserAssigned}]
                                                   [--ids]
                                                   [--project --project-name]
                                                   [--remove]
                                                   [--resource-group]
                                                   [--roles]
                                                   [--set]
                                                   [--status {Disabled, Enabled}]
                                                   [--subscription]
                                                   [--tags]
                                                   [--user-assigned-identities]
                                                   [--user-role-assignments]

Examples

Update

az devcenter admin project-environment-type update --identity-type "UserAssigned" --user-assigned-identities "{\"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1\":{}}" --deployment-target-id "/subscriptions/00000000-0000-0000-0000-000000000000" --status "Enabled" --user-role-assignments "{\"e45e3m7c-176e-416a-b466-0c5ec8298f8a\":{\"roles\":{\"4cbf0b6c-e750-441c-98a7-10da8387e4d6\":{}}}}" --tags CostCenter="RnD" --environment-type-name "DevTest" --project-name "ContosoProj" --resource-group "rg1"

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property Value
Parameter group: Generic Update Arguments
--deployment-target-id

ID of a subscription that the environment type will be mapped to. The environment's resources will be deployed into this subscription.

Property Value
Parameter group: Properties Arguments
--display-name

The display name of the project environment type.

Property Value
Parameter group: Properties Arguments
--environment-type-name --name -n

The name of the environment type.

Property Value
Parameter group: Resource Id Arguments
--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property Value
Parameter group: Generic Update Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--identity-type

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

Property Value
Parameter group: Identity Arguments
Accepted values: None, SystemAssigned, SystemAssigned, UserAssigned, UserAssigned
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--project --project-name

The name of the project. Use az configure -d project=<project_name> to configure a default.

Property Value
Parameter group: Resource Id Arguments
--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property Value
Parameter group: Generic Update Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--roles

A map of roles to assign to the environment creator. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: CreatorRoleAssignment Arguments
--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property Value
Parameter group: Generic Update Arguments
--status

Defines whether this environment type can be used in this project.

Property Value
Parameter group: Properties Arguments
Accepted values: Disabled, Enabled
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Body Arguments
--user-assigned-identities -u

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. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Identity Arguments
--user-role-assignments

Role assignments created on environment backing resources. This is a mapping from a user object ID to an object of role definition IDs. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False