az devcenter admin project-policy

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-policy command. Learn more about extensions.

Manage project policies.

Commands

Name	Description	Type	Status
az devcenter admin project-policy create	Create a project policy.	Extension	GA
az devcenter admin project-policy delete	Delete an project policy.	Extension	GA
az devcenter admin project-policy list	List all project policies in the dev center.	Extension	GA
az devcenter admin project-policy show	Get a specific project policy.	Extension	GA
az devcenter admin project-policy update	Update an project policy.	Extension	GA
az devcenter admin project-policy wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az devcenter admin project-policy create

Create a project policy.

az devcenter admin project-policy create --dev-center --dev-center-name
                                         --name --project-policy-name
                                         --resource-group
                                         --resource-policies
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--scopes]

Examples

Create

az devcenter admin project-policy create --dev-center-name "Contoso" --project-policy-name "DevOnlyResources" --resource-group "rg1" --resource-policies [{"resources": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff1/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/attachednetworks/network-westus3"] --scopes ["/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff1/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject"]

Required Parameters

--dev-center --dev-center-name -d

The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.

--name --project-policy-name -n

The name of the project policy.

--resource-group -g

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

--resource-policies

Resource policies that are a part of this project policy. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

Optional Parameters

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

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--scopes

Resources that have access to the shared resources that are a part of this project policy. 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-policy delete

Delete an project policy.

az devcenter admin project-policy delete [--dev-center --dev-center-name]
                                         [--ids]
                                         [--name --project-policy-name]
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--resource-group]
                                         [--subscription]
                                         [--yes]

Examples

Delete

az devcenter admin project-policy delete --dev-center-name "Contoso" --project-policy-name "DevOnlyResources" --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.

--dev-center --dev-center-name -d

The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.

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

--name --project-policy-name -n

The name of the project policy.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--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-policy list

List all project policies in the dev center.

az devcenter admin project-policy list --dev-center --dev-center-name
                                       --resource-group
                                       [--max-items]
                                       [--next-token]

Examples

List

az devcenter admin project-policy list --dev-center-name "Contoso" --resource-group "rg1"

Required Parameters

--dev-center --dev-center-name -d

The name of the dev center. Use az configure -d dev-center=<dev_center_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-policy show

Get a specific project policy.

az devcenter admin project-policy show [--dev-center --dev-center-name]
                                       [--ids]
                                       [--name --project-policy-name]
                                       [--resource-group]
                                       [--subscription]

Examples

Get

az devcenter admin project-policy show --dev-center-name "Contoso" --project-policy-name "DevOnlyResources" --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.

--dev-center --dev-center-name -d

The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.

Property	Value
Parameter group:	Resource Id Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--name --project-policy-name -n

The name of the project policy.

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-policy update

Update an project policy.

az devcenter admin project-policy update [--add]
                                         [--dev-center --dev-center-name]
                                         [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--ids]
                                         [--name --project-policy-name]
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--remove]
                                         [--resource-group]
                                         [--resource-policies]
                                         [--scopes]
                                         [--set]
                                         [--subscription]

Examples

Update

az devcenter admin project-policy update --dev-center-name "Contoso" --project-policy-name "DevOnlyResources" --resource-group "rg1" --resource-policies [{"resources": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff1/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/attachednetworks/network-westus3"] --scopes ["/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff1/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject"]

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

--dev-center --dev-center-name -d

The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.

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

--ids

Property	Value
Parameter group:	Resource Id Arguments

--name --project-policy-name -n

The name of the project policy.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--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

--resource-policies

Resource policies that are a part of this project policy. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--scopes

Resources that have access to the shared resources that are a part of this project policy. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties 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

--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-policy wait

Place the CLI in a waiting state until a condition is met.

az devcenter admin project-policy wait [--created]
                                       [--custom]
                                       [--deleted]
                                       [--dev-center --dev-center-name]
                                       [--exists]
                                       [--ids]
                                       [--interval]
                                       [--name --project-policy-name]
                                       [--resource-group]
                                       [--subscription]
                                       [--timeout]
                                       [--updated]

Optional Parameters

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

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--dev-center --dev-center-name -d

The name of the dev center. Use az configure -d dev-center=<dev_center_name> to configure a default.

Property	Value
Parameter group:	Resource Id Arguments

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--ids

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--name --project-policy-name -n

The name of the project policy.

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

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
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

Feedback

Was this page helpful?

Share via

az devcenter admin project-policy

Commands

az devcenter admin project-policy create

Examples

Required Parameters

Optional Parameters

az devcenter admin project-policy delete

Examples

Optional Parameters

az devcenter admin project-policy list

Examples

Required Parameters

Optional Parameters

az devcenter admin project-policy show

Examples

Optional Parameters

az devcenter admin project-policy update

Examples

Optional Parameters

az devcenter admin project-policy wait

Optional Parameters

Feedback