Share via

az managedservices assignment

  • Reference

Manage the registration assignments in Azure.

Commands

Name Description Type Status
az managedservices assignment create

Create a registration assignment.

 Core GA
az managedservices assignment delete

Delete a registration assignment.

 Core GA
az managedservices assignment list

List all the registration assignments.

 Core GA
az managedservices assignment show

Show registration assignment.

 Core GA
az managedservices assignment wait

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

 Core GA

az managedservices assignment create

Edit

Create a registration assignment.

az managedservices assignment create --definition
                                     [--assignment-id]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--resource-group]

Examples

Create an assignment under the default subscription scope.

az managedservices assignment create --definition "/subscriptions/a62076fa-768a-403c-9d9d-6a9919aae441/providers/Microsoft.ManagedServices/registrationDefinitions/0c3e9687-b461-4615-b6e4-74d54998d6e4"

Create an assignment under a given resource group scope.

az managedservices assignment create --definition "/subscriptions/a62076fa-768a-403c-9d9d-6a9919aae441/providers/Microsoft.ManagedServices/registrationDefinitions/0c3e9687-b461-4615-b6e4-74d54998d6e4" --resource-group mygroup

Required Parameters

--definition

Fully qualified path of the registration definition.

Optional Parameters

--assignment-id

Can be used to override the generated registration assignment id.

--no-wait

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

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

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 managedservices assignment delete

Edit

Delete a registration assignment.

az managedservices assignment delete --assignment
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--resource-group]
                                     [--yes]

Examples

Delete an assignment given its identifier under the default subscription scope.

az managedservices assignment delete --assignment d3087cf0-e180-4cca-b147-54ae00c7b504

Delete an assignment given its fully qualified resource id

az managedservices assignment delete --assignment /subscriptions/a62076fa-768a-403c-9d9d-6a9919aae441/providers/Microsoft.ManagedServices/registrationAssignments/0c3e9687-b461-4615-b6e4-74d54998d6e4

Required Parameters

--assignment

The identifier (guid) or the fully qualified resource id of the registration assignment. When resource id is used, subscription id and resource group parameters are ignored.

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
--resource-group -g

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

--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 managedservices assignment list

Edit

List all the registration assignments.

az managedservices assignment list [--include-definition {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--max-items]
                                   [--next-token]
                                   [--resource-group]

Examples

Lists all the registration assignments under the default scope.

az managedservices assignment list

Lists all the registration assignments under the given resource group.

az managedservices assignment list --resource-group mygroup

Lists all the registration assignments under the default scope along with the associated registration definition details.

az managedservices assignment list --include-definition true

Optional Parameters

--include-definition

Tells whether to return registration definition details also along with registration assignment details.

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

--resource-group -g

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

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 managedservices assignment show

Edit

Show registration assignment.

az managedservices assignment show --assignment
                                   [--include-definition {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--resource-group]

Examples

Show an assignment given its identifier under the default subscription scope.

az managedservices assignment show --assignment d3087cf0-e180-4cca-b147-54ae00c7b504

Show an assignment given its fully qualified resource id.

az managedservices assignment show --assignment /subscriptions/a62076fa-768a-403c-9d9d-6a9919aae441/providers/Microsoft.ManagedServices/registrationAssignments/0c3e9687-b461-4615-b6e4-74d54998d6e4

Show an assignment given its identifier under the default subscription scope with the registration definition details.

az managedservices assignment show --assignment d3087cf0-e180-4cca-b147-54ae00c7b504 --include-definition true

Required Parameters

--assignment

The identifier (guid) or the fully qualified resource id of the registration assignment. When resource id is used, subscription id and resource group parameters are ignored.

Optional Parameters

--include-definition

Tells whether to return registration definition details also along with registration assignment details.

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

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 managedservices assignment wait

Edit

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

az managedservices assignment wait --assignment
                                   --scope
                                   [--created]
                                   [--custom]
                                   [--deleted]
                                   [--exists]
                                   [--include-definition {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--interval]
                                   [--timeout]
                                   [--updated]

Required Parameters

--assignment

The identifier (guid) or the fully qualified resource id of the registration assignment. When resource id is used, subscription id and resource group parameters are ignored.

--scope

Scope of the resource.

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

Tells whether to return registration definition details also along with registration assignment details.

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

Polling interval in seconds.

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