Share via

az fleet autoupgradeprofile

  • Preview
  • Reference

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.

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Commands to manage auto upgrade profiles.

Commands

Name Description Type Status
az fleet autoupgradeprofile create

Creates or updates an auto upgrade profile.

 Extension Preview
az fleet autoupgradeprofile delete

Deletes an auto upgrade profile.

 Extension Preview
az fleet autoupgradeprofile list

Lists all auto upgrade profiles for a given fleet.

 Extension Preview
az fleet autoupgradeprofile show

Shows an auto upgrade profile.

 Extension Preview
az fleet autoupgradeprofile wait

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

 Extension Preview

az fleet autoupgradeprofile create

Preview

Command group 'fleet autoupgradeprofile' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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.

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

--disabled

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

Default value: False
--no-wait

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

Default value: False
--node-image-selection

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

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.

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

Preview

Command group 'fleet autoupgradeprofile' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

--no-wait

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

Default value: False
--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 fleet autoupgradeprofile list

Preview

Command group 'fleet autoupgradeprofile' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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.

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

Preview

Command group 'fleet autoupgradeprofile' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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.

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

Preview

Command group 'fleet autoupgradeprofile' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

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

Polling interval in seconds.

Default value: 30
--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.