Share via

az devcenter admin plan-member

  • Preview
  • Reference

Note

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

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage plan members.

Commands

Name Description Type Status
az devcenter admin plan-member create

Create a dev center plan member resource.

 Extension Preview
az devcenter admin plan-member delete

Delete a dev center plan member.

 Extension Preview
az devcenter admin plan-member list

List all of the members assigned to a devcenter plan.

 Extension Preview
az devcenter admin plan-member show

Get a devcenter plan member.

 Extension Preview
az devcenter admin plan-member update

Update a devcenter plan member resource.

 Extension Preview
az devcenter admin plan-member wait

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

 Extension Preview

az devcenter admin plan-member create

Preview

Command group 'az devcenter admin plan-member' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a dev center plan member resource.

az devcenter admin plan-member create --member-id
                                      --member-name
                                      --member-type {Group, User}
                                      --plan-name
                                      --resource-group
                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--tags]
                                      [--tier]

Examples

Create user plan member

az devcenter admin plan-member create --name "d702f662-b3f2-4796-9e8c-13c22378ced3" --plan-name "ContosoPlan" --resource-group "rg1" --tags CostCode="12345" --member-id "d702f662-b3f2-4796-9e8c-13c22378ced3" --member-type "User"

Create group plan member

az devcenter admin plan-member create --name "d702f662-b3f2-4796-9e8c-13c22378ced3" --plan-name "ContosoPlan" --resource-group "rg1" --tags CostCode="12345" --member-id "d702f662-b3f2-4796-9e8c-13c22378ced3" --member-type "Group"

Required Parameters

--member-id

The unique id of the member.

--member-name --name -n

The name of a devcenter plan member.

--member-type

The type of the member (user, group).

Accepted values: Group, User
--plan-name

The name of the devcenter plan.

--resource-group -g

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

Optional Parameters

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--tags

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

--tier

The tier of the member.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az devcenter admin plan-member delete

Preview

Command group 'az devcenter admin plan-member' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a dev center plan member.

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

Examples

Delete

az devcenter admin plan-member delete --name "d702f662-b3f2-4796-9e8c-13c22378ced3" --plan-name "ContosoPlan" --resource-group "rg1"

Optional Parameters

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

--member-name --name -n

The name of a devcenter plan member.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--plan-name

The name of the devcenter plan.

--resource-group -g

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

--subscription

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

--yes -y

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az devcenter admin plan-member list

Preview

Command group 'az devcenter admin plan-member' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List all of the members assigned to a devcenter plan.

az devcenter admin plan-member list --plan-name
                                    --resource-group
                                    [--max-items]
                                    [--next-token]

Examples

List by plan

az devcenter admin plan-member list  --plan-name "ContosoPlan" --resource-group "rg1"

Required Parameters

--plan-name

The name of the devcenter plan.

--resource-group -g

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

Optional Parameters

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

--next-token

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az devcenter admin plan-member show

Preview

Command group 'az devcenter admin plan-member' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get a devcenter plan member.

az devcenter admin plan-member show [--ids]
                                    [--member-name]
                                    [--plan-name]
                                    [--resource-group]
                                    [--subscription]

Examples

Get

az devcenter admin plan-member show --name "d702f662-b3f2-4796-9e8c-13c22378ced3" --plan-name "ContosoPlan" --resource-group "rg1"

Optional Parameters

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

--member-name --name -n

The name of a devcenter plan member.

--plan-name

The name of the devcenter plan.

--resource-group -g

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

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az devcenter admin plan-member update

Preview

Command group 'az devcenter admin plan-member' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a devcenter plan member resource.

az devcenter admin plan-member update [--add]
                                      [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--ids]
                                      [--member-id]
                                      [--member-name]
                                      [--member-type {Group, User}]
                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--plan-name]
                                      [--remove]
                                      [--resource-group]
                                      [--set]
                                      [--subscription]
                                      [--tags]
                                      [--tier]

Examples

Update

az devcenter admin plan-member update --name "d702f662-b3f2-4796-9e8c-13c22378ced3" --plan-name "ContosoPlan" --resource-group "rg1" --tags CostCode="12345"

Optional Parameters

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

--force-string

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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.

--member-id

The unique id of the member.

--member-name --name -n

The name of a devcenter plan member.

--member-type

The type of the member (user, group).

Accepted values: Group, User
--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--plan-name

The name of the devcenter plan.

--remove

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

--resource-group -g

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

--set

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

--subscription

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

--tags

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

--tier

The tier of the member.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az devcenter admin plan-member wait

Preview

Command group 'az devcenter admin plan-member' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

az devcenter admin plan-member wait [--created]
                                    [--custom]
                                    [--deleted]
                                    [--exists]
                                    [--ids]
                                    [--interval]
                                    [--member-name]
                                    [--plan-name]
                                    [--resource-group]
                                    [--subscription]
                                    [--timeout]
                                    [--updated]

Optional Parameters

--created

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

Default value: False
--custom

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

--deleted

Wait until deleted.

Default value: False
--exists

Wait until the resource exists.

Default value: False
--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.

--interval

Polling interval in seconds.

Default value: 30
--member-name --name -n

The name of a devcenter plan member.

--plan-name

The name of the devcenter plan.

--resource-group -g

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

--subscription

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

--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.