Share via

az providerhub custom-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 custom-rollout command. Learn more about extensions.

Manage custom rollout with providerhub.

Commands

Name Description Type Status
az providerhub custom-rollout create

Create the rollout details.

 Extension GA
az providerhub custom-rollout delete

Delete the custom rollout resource. Custom rollout must be in terminal state.

 Extension GA
az providerhub custom-rollout list

List the list of the custom rollouts for the given provider.

 Extension GA
az providerhub custom-rollout show

Get the custom rollout details.

 Extension GA
az providerhub custom-rollout stop

Stops or cancels the custom rollout, if in progress.

 Extension GA
az providerhub custom-rollout update

Update the rollout details.

 Extension GA
az providerhub custom-rollout wait

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

 Extension GA

az providerhub custom-rollout create

Create the rollout details.

az providerhub custom-rollout create --name
                                     --provider-namespace
                                     [--auto-provision-config]
                                     [--canary]
                                     [--manifest-checkin-spec]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--provider-registration]
                                     [--refresh-sub-reg {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--release-scopes]
                                     [--resource-type-registrations]
                                     [--skip-release-scope-validation {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--status]

Examples

custom-rollout create

az providerhub custom-rollout create --provider-namespace "{providerNamespace}" --rollout-name "{customRolloutName}" --canary region="EastUS2EUAP" region="centraluseuap"

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 apply the manifest. 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.

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

--refresh-sub-reg --refresh-subscription-registration

Determines if subscription registration should be refreshed.

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

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.

--skip-release-scope-validation --skip-validation

Determines if release scope validation should be skipped.

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

Delete the custom rollout resource. Custom rollout must be in terminal state.

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

Examples

custom-rollout delete

az providerhub custom-rollout delete --provider-namespace "{providerNamespace}" --rollout-name "{customRolloutName}"

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 custom-rollout list

List the list of the custom rollouts for the given provider.

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

Examples

custom-rollout list

az providerhub custom-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 custom-rollout show

Get the custom rollout details.

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

Examples

custom-rollout show

az providerhub custom-rollout show --provider-namespace "{providerNamespace}" --rollout-name "{customRolloutName}"

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 custom-rollout stop

Stops or cancels the custom rollout, if in progress.

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

Examples

custom-rollout stop

az providerhub custom-rollout stop --provider-namespace "{providerNamespace}" --rollout-name "{customRolloutName}"

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 custom-rollout update

Update the rollout details.

az providerhub custom-rollout update [--add]
                                     [--auto-provision-config]
                                     [--canary]
                                     [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--ids]
                                     [--manifest-checkin-spec]
                                     [--name]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--provider-namespace]
                                     [--provider-registration]
                                     [--refresh-sub-reg {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--release-scopes]
                                     [--remove]
                                     [--resource-type-registrations]
                                     [--set]
                                     [--skip-release-scope-validation {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--status]
                                     [--subscription]

Examples

custom-rollout update

az providerhub custom-rollout update --provider-namespace "{providerNamespace}" --rollout-name "{customRolloutName}" --canary region="EastUS2EUAP" region="centraluseuap"

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 apply the manifest. 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
--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.

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

The manifest checkin specification. 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.

--refresh-sub-reg --refresh-subscription-registration

Determines if subscription registration should be refreshed.

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

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.

--set

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

--skip-release-scope-validation --skip-validation

Determines if release scope validation should be skipped.

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

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

az providerhub custom-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.