az fleet autoupgradeprofile

Note

This reference is part of the fleet extension for the Azure CLI (version 2.61.0 or higher). The extension will automatically install the first time you run an az fleet autoupgradeprofile command. Learn more about extensions.

Commands to manage auto upgrade profiles.

Commands

Name	Description	Type	Status
az fleet autoupgradeprofile create	Creates or updates an auto upgrade profile.	Extension	GA
az fleet autoupgradeprofile delete	Deletes an auto upgrade profile.	Extension	GA
az fleet autoupgradeprofile generate-update-run	Generates an update run for a given auto upgrade profile.	Extension	GA
az fleet autoupgradeprofile list	Lists all auto upgrade profiles for a given fleet.	Extension	GA
az fleet autoupgradeprofile show	Shows an auto upgrade profile.	Extension	GA
az fleet autoupgradeprofile wait	Wait for an auto upgrade resource to reach a desired state.	Extension	GA

az fleet autoupgradeprofile create

Creates or updates an auto upgrade profile.

az fleet autoupgradeprofile create --channel {NodeImage, Rapid, Stable}
                                   --fleet-name
                                   --name
                                   --resource-group
                                   [--disabled]
                                   [--no-wait]
                                   [--node-image-selection {Consistent, Latest}]
                                   [--update-strategy-id]

Examples

Create an auto upgrade profile with channel 'Rapid' and disabled by default.

az fleet autoupgradeprofile create -g MyFleetResourceGroup -f MyFleetName -n MyAutoUpgradeProfileName -c Rapid --disabled

Create an auto upgrade profile with channel 'NodeImage'.

az fleet autoupgradeprofile create -g MyFleetResourceGroup -f MyFleetName -n MyAutoUpgradeProfileName -c NodeImage

Required Parameters

--channel -c

The auto upgrade channel type.

Property	Value
Accepted values:	NodeImage, Rapid, Stable

--fleet-name -f

Specify the fleet name.

--name -n

Specify name for the auto upgrade profile.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<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.

--disabled

The disabled flag ensures auto upgrade profile does not run by default.

Property	Value
Default value:	False

--no-wait

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

Property	Value
Default value:	False

--node-image-selection

Node Image Selection is an option that lets you choose how your clusters' nodes are upgraded.

Property	Value
Accepted values:	Consistent, Latest

--update-strategy-id

The resource ID of the update strategy that the auto upgrade profile should follow.

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 fleet autoupgradeprofile delete

Deletes an auto upgrade profile.

az fleet autoupgradeprofile delete --fleet-name
                                   --name
                                   --resource-group
                                   [--no-wait]
                                   [--yes]

Examples

Delete an auto upgrade profile.

az fleet autoupgradeprofile delete -g MyFleetResourceGroup -f MyFleetName -n MyAutoUpgradeProfileName

Required Parameters

--fleet-name -f

Specify the fleet name.

--name -n

Specify name for the auto upgrade profile.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<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.

--no-wait

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

Property	Value
Default value:	False

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

--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 fleet autoupgradeprofile generate-update-run

Generates an update run for a given auto upgrade profile.

az fleet autoupgradeprofile generate-update-run --auto-upgrade-profile-name --name --profile-name
                                                --fleet-name
                                                --resource-group
                                                [--no-wait]

Examples

Generates an update run for a given auto upgrade profile.

az fleet autoupgradeprofile generate-update-run -g MyFleetResourceGroup -f MyFleetName --auto-upgrade-profile-name MyAutoUpgradeProfileName

Required Parameters

--auto-upgrade-profile-name --name --profile-name -n

Name of the auto upgrade profile.

--fleet-name -f

Name of the fleet.

--resource-group -g

Name of the resource group.

Optional Parameters

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

--no-wait

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

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.

--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 fleet autoupgradeprofile list

Lists all auto upgrade profiles for a given fleet.

az fleet autoupgradeprofile list --fleet-name
                                 --resource-group

Examples

List auto upgrade profiles of a fleet.

az fleet autoupgradeprofile list -g MyFleetResourceGroup -f MyFleetName

Required Parameters

--fleet-name -f

Specify the fleet name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

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 fleet autoupgradeprofile show

Shows an auto upgrade profile.

az fleet autoupgradeprofile show --fleet-name
                                 --name
                                 --resource-group

Examples

Show the details of an auto upgrade profile.

az fleet autoupgradeprofile show -g MyFleetResourceGroup -f MyFleetName -n MyAutoUpgradeProfileName

Required Parameters

--fleet-name -f

Specify the fleet name.

--name -n

Specify name for the auto upgrade profile.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

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 fleet autoupgradeprofile wait

Wait for an auto upgrade resource to reach a desired state.

If an operation on an auto upgrade profile was interrupted or was started with --no-wait, use this command to wait for it to complete.

az fleet autoupgradeprofile wait --auto-upgrade-profile-name --profile-name
                                 --fleet-name
                                 --resource-group
                                 [--created]
                                 [--custom]
                                 [--deleted]
                                 [--exists]
                                 [--interval]
                                 [--timeout]
                                 [--updated]

Required Parameters

--auto-upgrade-profile-name --profile-name

Specify name for the auto upgrade profile.

--fleet-name -f

Specify the fleet name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<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.

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

--interval

Polling interval in seconds.

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

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

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

Share via

az fleet autoupgradeprofile

Commands

az fleet autoupgradeprofile create

Examples

Required Parameters

Optional Parameters

az fleet autoupgradeprofile delete

Examples

Required Parameters

Optional Parameters

az fleet autoupgradeprofile generate-update-run

Examples

Required Parameters

Optional Parameters

az fleet autoupgradeprofile list

Examples

Required Parameters

az fleet autoupgradeprofile show

Examples

Required Parameters

az fleet autoupgradeprofile wait

Required Parameters

Optional Parameters

Feedback