Share via

az providerhub default-rollout

  • Reference

Note

This reference is part of the providerhub extension for the Azure CLI (version 2.15.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

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

 Extension GA
az providerhub default-rollout list

Gets the list of the rollouts for the given provider.

 Extension GA
az providerhub default-rollout show

Gets 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 create

Create the rollout details.

az providerhub default-rollout create --provider-namespace
                                      --rollout-name
                                      [--canary]
                                      [--no-wait]
                                      [--rest-of-the-world-group-two]

Examples

DefaultRollouts_CreateOrUpdate

az providerhub default-rollout create                 --provider-namespace "Microsoft.Contoso" --rollout-name "2021week20"                 --canary skip-regions="eastus2euap"                 --rest-of-the-world-group-two wait-duration="PT2H"

Required Parameters

--provider-namespace

The name of the resource provider hosted within ProviderHub.

--rollout-name

The rollout name.

Optional Parameters

--canary

The canary regions to skip.

Usage: --canary skip-regions=XX

skip-regions: Required. The canary skip regions.

--no-wait

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

default value: False
--rest-of-the-world-group-two --row2

DefaultRollout rest of the world group two.

Usage: --rest-of-the-world-group-two wait-duration=XX

wait-duration: Required. The rest of the world group two wait duration.

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

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

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

Examples

DefaultRollouts_Delete

az providerhub default-rollout delete --provider-namespace "Microsoft.Contoso" --rollout-name "2021week20"

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.

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

Gets the list of the rollouts for the given provider.

az providerhub default-rollout list --provider-namespace

Examples

DefaultRollouts_ListByProviderRegistration

az providerhub default-rollout list --provider-namespace "Microsoft.Contoso"

Required Parameters

--provider-namespace

The name of the resource provider hosted within ProviderHub.

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

Gets the default rollout details.

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

Examples

DefaultRollouts_Get

az providerhub default-rollout show --provider-namespace "Microsoft.Contoso" --rollout-name "2021week20"

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 stop

Stops or cancels the rollout, if in progress.

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

Examples

DefaultRollouts_Stop

az providerhub default-rollout stop --provider-namespace "Microsoft.Contoso" --rollout-name "2021week20"

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.