az computelimit guest-subscription

  • Preview

Note

This reference is part of the computelimit extension for the Azure CLI (version 2.75.0 or higher). The extension will automatically install the first time you run an az computelimit guest-subscription command. Learn more about extensions.

Command group 'az computelimit' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage Guest Subscription.

Commands

Name Description Type Status
az computelimit guest-subscription add

Add a subscription as a guest to consume the compute limits shared by the host subscription.

 Extension Preview
az computelimit guest-subscription list

List all guest subscriptions added to the host subscription in a location.

 Extension Preview
az computelimit guest-subscription remove

Remove a subscription as a guest to stop consuming the compute limits shared by the host subscription.

 Extension Preview
az computelimit guest-subscription show

Get a guest subscription added to the host subscription.

 Extension Preview

az computelimit guest-subscription add

Preview

Command group 'az computelimit guest-subscription' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Add a subscription as a guest to consume the compute limits shared by the host subscription.

az computelimit guest-subscription add [--acquire-policy-token]
                                       [--change-reference]
                                       [--guest-subscription-id --id]
                                       [--ids]
                                       [--location]
                                       [--subscription]

Examples

Add a guest subscription

az computelimit guest-subscription add --location eastus --guest-subscription-id 11111111-1111-1111-1111-111111111111

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--guest-subscription-id --id

The guest subscription id.

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

The Azure location 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 computelimit guest-subscription list

Preview

Command group 'az computelimit guest-subscription' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List all guest subscriptions added to the host subscription in a location.

az computelimit guest-subscription list --location
                                        [--max-items]
                                        [--next-token]

Examples

List all guest subscriptions

az computelimit guest-subscription list --location eastus

Required Parameters

--location -l

The Azure location 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 computelimit guest-subscription remove

Preview

Command group 'az computelimit guest-subscription' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Remove a subscription as a guest to stop consuming the compute limits shared by the host subscription.

az computelimit guest-subscription remove [--acquire-policy-token]
                                          [--change-reference]
                                          [--guest-subscription-id --id]
                                          [--ids]
                                          [--location]
                                          [--subscription]
                                          [--yes]

Examples

Remove a guest subscription

az computelimit guest-subscription remove --location eastus --guest-subscription-id 11111111-1111-1111-1111-111111111111

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--guest-subscription-id --id

The guest subscription id.

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

The Azure location 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 computelimit guest-subscription show

Preview

Command group 'az computelimit guest-subscription' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get a guest subscription added to the host subscription.

az computelimit guest-subscription show [--guest-subscription-id --id]
                                        [--ids]
                                        [--location]
                                        [--subscription]

Examples

Get a guest subscription

az computelimit guest-subscription show --location eastus --guest-subscription-id 11111111-1111-1111-1111-111111111111

Optional Parameters

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

--guest-subscription-id --id

The guest subscription id.

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

The Azure location 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