az providerhub custom-rollout

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 --rollout-name
                                     --provider-namespace
                                     [--auto-provision-config]
                                     [--canary]
                                     [--manifest-checkin-spec --manifest-checkin-specification]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--provider-registration]
                                     [--refresh-sub-reg --refresh-subscription-registration {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--release-scopes]
                                     [--resource-type-registrations --rt-regs]
                                     [--skip-release-scope-validation --skip-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

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

--auto-provision-config

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

Property	Value
Parameter group:	Specification Arguments

--canary

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

Property	Value
Parameter group:	Specification Arguments

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

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

Property	Value
Parameter group:	Specification Arguments

--no-wait

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

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

Property	Value
Parameter group:	Specification Arguments

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

Determines if subscription registration should be refreshed.

Property	Value
Parameter group:	Specification Arguments
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.

Property	Value
Parameter group:	Specification Arguments

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

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

Property	Value
Parameter group:	Specification Arguments

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

Determines if release scope validation should be skipped.

Property	Value
Parameter group:	Specification Arguments
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.

Property	Value
Parameter group:	Properties 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 providerhub custom-rollout delete

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

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

Examples

custom-rollout delete

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

Optional Parameters

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

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

--name --rollout-name -n

The rollout name.

Property	Value
Parameter group:	Resource Id Arguments

--provider-namespace

The name of the resource provider hosted within ProviderHub.

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

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

Get the custom rollout details.

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

Examples

custom-rollout show

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

Optional Parameters

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

--ids

Property	Value
Parameter group:	Resource Id Arguments

--name --rollout-name -n

The rollout name.

Property	Value
Parameter group:	Resource Id Arguments

--provider-namespace

The name of the resource provider hosted within ProviderHub.

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

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

--ids

Property	Value
Parameter group:	Resource Id Arguments

--provider-namespace

The name of the resource provider hosted within ProviderHub.

Property	Value
Parameter group:	Resource Id Arguments

--rollout-name

The rollout 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 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 --manifest-checkin-specification]
                                     [--name --rollout-name]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--provider-namespace]
                                     [--provider-registration]
                                     [--refresh-sub-reg --refresh-subscription-registration {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--release-scopes]
                                     [--remove]
                                     [--resource-type-registrations --rt-regs]
                                     [--set]
                                     [--skip-release-scope-validation --skip-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

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

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

Property	Value
Parameter group:	Generic Update Arguments

--auto-provision-config

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

Property	Value
Parameter group:	Specification Arguments

--canary

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

Property	Value
Parameter group:	Specification Arguments

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property	Value
Parameter group:	Generic Update Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--ids

Property	Value
Parameter group:	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.

Property	Value
Parameter group:	Specification Arguments

--name --rollout-name -n

The rollout name.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--provider-namespace

The name of the resource provider hosted within ProviderHub.

Property	Value
Parameter group:	Resource Id Arguments

--provider-registration

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

Property	Value
Parameter group:	Specification Arguments

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

Determines if subscription registration should be refreshed.

Property	Value
Parameter group:	Specification Arguments
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.

Property	Value
Parameter group:	Specification Arguments

--remove

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

Property	Value
Parameter group:	Generic Update Arguments

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

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

Property	Value
Parameter group:	Specification Arguments

--set

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

Property	Value
Parameter group:	Generic Update Arguments

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

Determines if release scope validation should be skipped.

Property	Value
Parameter group:	Specification Arguments
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.

Property	Value
Parameter group:	Properties 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 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 --rollout-name]
                                   [--provider-namespace]
                                   [--subscription]
                                   [--timeout]
                                   [--updated]

Optional Parameters

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

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--ids

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--name --rollout-name -n

The rollout name.

Property	Value
Parameter group:	Resource Id Arguments

--provider-namespace

The name of the resource provider hosted within ProviderHub.

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

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
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

Feedback

Was this page helpful?

Share via

az providerhub custom-rollout

Commands

az providerhub custom-rollout create

Examples

Required Parameters

Optional Parameters

az providerhub custom-rollout delete

Examples

Optional Parameters

az providerhub custom-rollout list

Examples

Required Parameters

Optional Parameters

az providerhub custom-rollout show

Examples

Optional Parameters

az providerhub custom-rollout stop

Examples

Optional Parameters

az providerhub custom-rollout update

Examples

Optional Parameters

az providerhub custom-rollout wait

Optional Parameters

Feedback