az devcenter admin plan-member
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 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
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 --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
The unique id of the member.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The name of a devcenter plan member.
The type of the member (user, group).
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | Group, User |
The name of the devcenter plan.
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.
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 tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Body Arguments |
The tier of the member.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az devcenter admin plan-member delete
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 --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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 |
The name of a devcenter plan member.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Do not wait for the long-running operation to finish.
Property | Value |
---|---|
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
The name of the devcenter plan.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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 |
Do not prompt for confirmation.
Property | Value |
---|---|
Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az devcenter admin plan-member list
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
The name of the devcenter plan.
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.
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 |
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
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az devcenter admin plan-member show
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 --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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 |
The name of a devcenter plan member.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
The name of the devcenter plan.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az devcenter admin plan-member update
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 --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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 |
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 |
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 |
The unique id of the member.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The name of a devcenter plan member.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
The type of the member (user, group).
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | Group, User |
Do not wait for the long-running operation to finish.
Property | Value |
---|---|
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
The name of the devcenter plan.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>
.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
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 |
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Body Arguments |
The tier of the member.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az devcenter admin plan-member wait
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 --name]
[--plan-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.
Wait until created with 'provisioningState' at 'Succeeded'.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
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 |
Wait until deleted.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
Wait until the resource exists.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
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 |
Polling interval in seconds.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | 30 |
The name of a devcenter plan member.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
The name of the devcenter plan.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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 |
Maximum wait in seconds.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | 3600 |
Wait until updated with provisioningState at 'Succeeded'.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |