Share via

az managedservices definition

  • Reference

Manage the registration definitions in Azure.

Commands

Name Description Type Status
az managedservices definition create

Create a registration definition.

 Core GA
az managedservices definition delete

Delete a registration definition.

 Core GA
az managedservices definition list

List all the registration definitions under the default scope or under the subscription provided.

 Core GA
az managedservices definition show

Show the registration definition details.

 Core GA
az managedservices definition wait

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

 Core GA

az managedservices definition create

Edit

Create a registration definition.

az managedservices definition create --name
                                     --principal-id
                                     --role-definition-id
                                     --tenant-id
                                     [--definition-id]
                                     [--description]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--plan-name]
                                     [--plan-product]
                                     [--plan-publisher]
                                     [--plan-version]

Examples

Create a registration definition under the default subscription scope with the required parameters.

az managedservices definition create --name mydef --tenant-id dab3375b-6197-4a15-a44b-16c41faa91d7 --principal-id b6f6c88a-5b7a-455e-ba40-ce146d4d3671 --role-definition-id ccdd72a7-3385-48ef-bd42-f606fba81ae7

Required Parameters

--name

Name of the registration definition.

--principal-id

The principal id.

--role-definition-id

The role definition id.

--tenant-id

Id of the managedBy tenant.

Optional Parameters

--definition-id

Guid of the registration definition.

--description

Description of the registration definition.

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

--plan-product

The product code.

--plan-publisher

The publisher ID.

--plan-version

The plan's version.

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

Edit

Delete a registration definition.

az managedservices definition delete --definition
                                     [--yes]

Examples

Delete the registration definition given its identifier under the default subscription scope.

az managedservices definition delete --definition af8772a0-fd9c-4ddc-8ad0-7d4b3913d7dd

Delete the registration definition given its fully qualified resource id.

az managedservices definition delete --definition /subscriptions/39033314-9b39-4c7b-84fd-0e26e55f15dc/providers/Microsoft.ManagedServices/registrationDefinitions/1d693e4f-9e79-433a-b3a2-afce1f8b61ec

Required Parameters

--definition

Guid of the registration definition.

Optional Parameters

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

Edit

List all the registration definitions under the default scope or under the subscription provided.

az managedservices definition list [--max-items]
                                   [--next-token]

Examples

List all the registration definitions under the default subscription scope.

az managedservices definition list

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

Edit

Show the registration definition details.

az managedservices definition show --definition

Examples

Show the registration definition given its identifier under the default subscription scope.

az managedservices definition show --definition af8772a0-fd9c-4ddc-8ad0-7d4b3913d7dd

Show the registration definition given its fully qualified resource id.

az managedservices definition show --definition /subscriptions/39033314-9b39-4c7b-84fd-0e26e55f15dc/providers/Microsoft.ManagedServices/registrationDefinitions/1d693e4f-9e79-433a-b3a2-afce1f8b61ec

Required Parameters

--definition

Guid of the registration definition.

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

Edit

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

az managedservices definition wait --definition
                                   --scope
                                   [--created]
                                   [--custom]
                                   [--deleted]
                                   [--exists]
                                   [--interval]
                                   [--timeout]
                                   [--updated]

Required Parameters

--definition

Guid of the registration definition.

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