Share via

az providerhub default-rollout

  • Reference

Note

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

Manage default rollout with providerhub.

Commands

Name Description Type Status
az providerhub default-rollout create

Create the rollout details.

 Extension GA
az providerhub default-rollout delete

Delete the rollout resource. Rollout must be in terminal state.

 Extension GA
az providerhub default-rollout list

List the list of the rollouts for the given provider.

 Extension GA
az providerhub default-rollout show

Get the default rollout details.

 Extension GA
az providerhub default-rollout stop

Stops or cancels the rollout, if in progress.

 Extension GA
az providerhub default-rollout update

Update the rollout details.

 Extension GA
az providerhub default-rollout wait

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

 Extension GA

az providerhub default-rollout create

Create the rollout details.

az providerhub default-rollout create --name
                                      --provider-namespace
                                      [--auto-provision-config]
                                      [--canary]
                                      [--checkin-option {AttemptAutomaticManifestCheckin, DoNotAttemptAutomaticManifestCheckin}]
                                      [--checkin-params]
                                      [--expedited-rollout]
                                      [--high-traffic]
                                      [--low-traffic]
                                      [--medium-traffic]
                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--provider-registration]
                                      [--resource-type-registrations]
                                      [--rest-of-the-world-group-one]
                                      [--rest-of-the-world-group-two]
                                      [--status]

Examples

default-rollout create

az providerhub default-rollout create --provider-namespace "{providerNamespace}" --rollout-name "{defaultRolloutName}"

Required Parameters

--name --rollout-name -n

The rollout name.

--provider-namespace

The name of the resource provider hosted within ProviderHub.

Optional Parameters

--auto-provision-config

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

--canary

The canary regions to skip. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--checkin-option --manifest-checkin-option

The manifest checkin option.

Accepted values: AttemptAutomaticManifestCheckin, DoNotAttemptAutomaticManifestCheckin
Default value: DoNotAttemptAutomaticManifestCheckin
--checkin-params --manifest-checkin-params

The manifest checkin params. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--expedited-rollout

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

--high-traffic

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

--low-traffic

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

--medium-traffic

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

--no-wait

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

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

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

--resource-type-registrations --rt-regs

The resource type registrations. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--rest-of-the-world-group-one --row1

The rest of the world group one options. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--rest-of-the-world-group-two --row2

The rest of the world group two options. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--status

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

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 providerhub default-rollout delete

Delete the rollout resource. Rollout must be in terminal state.

az providerhub default-rollout delete [--ids]
                                      [--name]
                                      [--provider-namespace]
                                      [--subscription]
                                      [--yes]

Examples

default-rollout delete

az providerhub default-rollout delete -y --provider-namespace "{providerNamespace}" --rollout-name "{defaultRolloutName}"

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.

--name --rollout-name -n

The rollout name.

--provider-namespace

The name of the resource provider hosted within ProviderHub.

--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 providerhub default-rollout list

List the list of the rollouts for the given provider.

az providerhub default-rollout list --provider-namespace
                                    [--max-items]
                                    [--next-token]

Examples

default-rollout list

az providerhub default-rollout list --provider-namespace "{providerNamespace}"

Required Parameters

--provider-namespace

The name of the resource provider hosted within ProviderHub.

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 providerhub default-rollout show

Get the default rollout details.

az providerhub default-rollout show [--ids]
                                    [--name]
                                    [--provider-namespace]
                                    [--subscription]

Examples

default-rollout show

az providerhub default-rollout show --provider-namespace "{providerNamespace}" --rollout-name "{defaultRolloutName}"

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.

--name --rollout-name -n

The rollout name.

--provider-namespace

The name of the resource provider hosted within ProviderHub.

--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 providerhub default-rollout stop

Stops or cancels the rollout, if in progress.

az providerhub default-rollout stop [--ids]
                                    [--provider-namespace]
                                    [--rollout-name]
                                    [--subscription]

Examples

default-rollout stop

az providerhub default-rollout stop --provider-namespace "{providerNamespace}" --rollout-name "{defaultRolloutName}"

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.

--provider-namespace

The name of the resource provider hosted within ProviderHub.

--rollout-name

The rollout 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 providerhub default-rollout update

Update the rollout details.

az providerhub default-rollout update [--add]
                                      [--auto-provision-config]
                                      [--canary]
                                      [--expedited-rollout]
                                      [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--high-traffic]
                                      [--ids]
                                      [--low-traffic]
                                      [--manifest-checkin-spec]
                                      [--medium-traffic]
                                      [--name]
                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--provider-namespace]
                                      [--provider-registration]
                                      [--remove]
                                      [--resource-type-registrations]
                                      [--rest-of-the-world-group-one]
                                      [--rest-of-the-world-group-two]
                                      [--set]
                                      [--status]
                                      [--subscription]

Examples

default-rollout update

az providerhub default-rollout update --provider-namespace "{providerNamespace}" --rollout-name "{defaultRolloutName}"

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

--auto-provision-config

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

--canary

The canary regions to skip. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--expedited-rollout

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

--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
--high-traffic

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

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

--low-traffic

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

--manifest-checkin-spec --manifest-checkin-specification

The manifest checkin specification. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--medium-traffic

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

--name --rollout-name -n

The rollout name.

--no-wait

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

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

The name of the resource provider hosted within ProviderHub.

--provider-registration

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

--remove

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

--resource-type-registrations --rt-regs

The resource type registrations. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--rest-of-the-world-group-one --row1

The rest of the world group one options. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--rest-of-the-world-group-two --row2

The rest of the world group two options. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--set

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

--status

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

--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 providerhub default-rollout wait

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

az providerhub default-rollout wait [--created]
                                    [--custom]
                                    [--deleted]
                                    [--exists]
                                    [--ids]
                                    [--interval]
                                    [--name]
                                    [--provider-namespace]
                                    [--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
--name --rollout-name -n

The rollout name.

--provider-namespace

The name of the resource provider hosted within ProviderHub.

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