az eventhubs cluster upgrade-preference

Manage upgrade preferences of an Event Hubs Dedicated Cluster.

Commands

Name	Description	Type	Status
az eventhubs cluster upgrade-preference create	Create the upgrade preferences for an Event Hubs Dedicated cluster.	Core	GA
az eventhubs cluster upgrade-preference show	Get the upgrade preferences for an Event Hubs Dedicated cluster.	Core	GA
az eventhubs cluster upgrade-preference update	Update the upgrade preferences for an Event Hubs Dedicated cluster.	Core	GA
az eventhubs cluster upgrade-preference upgrade-now	Starts an immediate eight-hour upgrade override when an upgrade is pending.	Core	GA

az eventhubs cluster upgrade-preference create

Create the upgrade preferences for an Event Hubs Dedicated cluster.

az eventhubs cluster upgrade-preference create --cluster-name
                                               --resource-group
                                               [--acquire-policy-token]
                                               [--change-reference]
                                               [--exception-windows]
                                               [--maintenance-windows]

Examples

Create or update cluster upgrade preferences

az eventhubs cluster upgrade-preference create --resource-group contoso-rg --cluster-name contoso-cluster --exception-windows "[{action:Allow,date:2026-08-22,duration-minutes:480,start-time-of-day:PT4H}]" --maintenance-windows "[{day-of-week:Saturday,duration-minutes:480,start-time-of-day:PT2H},{day-of-week:Sunday,duration-minutes:480,start-time-of-day:PT2H}]"

Required Parameters

--cluster-name

The name of the Event Hubs Cluster.

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--exception-windows

Date-specific exceptions to the recurring maintenance windows. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--maintenance-windows

Recurring weekly maintenance windows in UTC. At least one window must be supplied when preferences are created or updated. A maximum of two windows can be configured, and their combined duration must be at least 16 hours per week. 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 eventhubs cluster upgrade-preference show

Get the upgrade preferences for an Event Hubs Dedicated cluster.

az eventhubs cluster upgrade-preference show [--cluster-name]
                                             [--ids]
                                             [--resource-group]
                                             [--subscription]

Examples

Get cluster upgrade preferences

az eventhubs cluster upgrade-preference show --resource-group contoso-rg --cluster-name contoso-cluster

Optional Parameters

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

--cluster-name

The name of the Event Hubs Cluster.

Property	Value
Parameter group:	Resource Id Arguments

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

--resource-group -g

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

Update the upgrade preferences for an Event Hubs Dedicated cluster.

az eventhubs cluster upgrade-preference update [--acquire-policy-token]
                                               [--add]
                                               [--change-reference]
                                               [--cluster-name]
                                               [--exception-windows]
                                               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                               [--ids]
                                               [--maintenance-windows]
                                               [--remove]
                                               [--resource-group]
                                               [--set]
                                               [--subscription]

Examples

Create or update cluster upgrade preferences

az eventhubs cluster upgrade-preference update --resource-group contoso-rg --cluster-name contoso-cluster

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

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

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--cluster-name

The name of the Event Hubs Cluster.

Property	Value
Parameter group:	Resource Id Arguments

--exception-windows

Date-specific exceptions to the recurring maintenance windows. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

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

--maintenance-windows

Recurring weekly maintenance windows in UTC. At least one window must be supplied when preferences are created or updated. A maximum of two windows can be configured, and their combined duration must be at least 16 hours per week. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

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

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

--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 eventhubs cluster upgrade-preference upgrade-now

Starts an immediate eight-hour upgrade override when an upgrade is pending.

az eventhubs cluster upgrade-preference upgrade-now [--acquire-policy-token]
                                                    [--change-reference]
                                                    [--cluster-name]
                                                    [--ids]
                                                    [--resource-group]
                                                    [--subscription]

Examples

Start an upgrade immediately

az eventhubs cluster upgrade-preference upgrade-now --resource-group contoso-rg --cluster-name contoso-cluster

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--cluster-name

The name of the Event Hubs Cluster.

Property	Value
Parameter group:	Resource Id Arguments

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

--resource-group -g

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