az containerapp env maintenance-config

Note

This reference is part of the containerapp extension for the Azure CLI (version 2.62.0 or higher). The extension will automatically install the first time you run an az containerapp env maintenance-config 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 Planned Maintenance for Container Apps.

Commands

Name	Description	Type	Status
az containerapp env maintenance-config add	Add Planned Maintenance to a Container App Environment.	Extension	Preview
az containerapp env maintenance-config list	List Planned Maintenance in a Container App Environment.	Extension	Preview
az containerapp env maintenance-config remove	Remove Planned Maintenance in a Container App Environment.	Extension	Preview
az containerapp env maintenance-config update	Update Planned Maintenance in a Container App Environment.	Extension	Preview

az containerapp env maintenance-config add

Preview

Command group 'containerapp env maintenance-config' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Add Planned Maintenance to a Container App Environment.

az containerapp env maintenance-config add --duration
                                           --environment
                                           --resource-group
                                           --start-hour-utc
                                           --weekday {Friday, Monday, Saturday, Sunday, Thursday, Tuesday, Wednesday}

Examples

Configure a Container App Environment to use a Planned Maintenance

az containerapp env maintenance-config add --environment myEnv -g MyResourceGroup \
    --duration 10 --start-hour-utc 11 --weekday Sunday

Required Parameters

--duration -d

The duration in hours of the maintenance configuration. Minimum value: 8. Maximum value: 24.

--environment

The environment name.

--resource-group -g

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

--start-hour-utc -s

The hour to start the maintenance configuration. Valid value from 0 to 23.

--weekday -w

The weekday to schedule the maintenance configuration.

Property	Value
Accepted values:	Friday, Monday, Saturday, Sunday, Thursday, Tuesday, Wednesday

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 containerapp env maintenance-config list

Preview

Command group 'containerapp env maintenance-config' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List Planned Maintenance in a Container App Environment.

az containerapp env maintenance-config list --environment
                                            --resource-group

Examples

List Planned Maintenance

az containerapp env maintenance-config list --environment myEnv -g MyResourceGroup

Required Parameters

--environment

The environment 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 containerapp env maintenance-config remove

Preview

Command group 'containerapp env maintenance-config' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Remove Planned Maintenance in a Container App Environment.

az containerapp env maintenance-config remove --environment
                                              --resource-group
                                              [--yes]

Examples

Remove Planned Maintenance

az containerapp env maintenance-config remove --environment myEnv -g MyResourceGroup

Required Parameters

--environment

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

--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 containerapp env maintenance-config update

Preview

Command group 'containerapp env maintenance-config' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update Planned Maintenance in a Container App Environment.

az containerapp env maintenance-config update --environment
                                              --resource-group
                                              [--duration]
                                              [--start-hour-utc]
                                              [--weekday {Friday, Monday, Saturday, Sunday, Thursday, Tuesday, Wednesday}]

Examples

Update the Planned Maintenance in a Container App Environment

az containerapp env maintenance-config update --environment myEnv -g MyResourceGroup \
    --duration 8 --start-hour-utc 12 --weekday Thursday

Required Parameters

--environment

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

--duration -d

The duration in hours of the maintenance configuration. Minimum value: 8. Maximum value: 24.

--start-hour-utc -s

The hour to start the maintenance configuration. Valid value from 0 to 23.

--weekday -w

The weekday to schedule the maintenance configuration.

Property	Value
Accepted values:	Friday, Monday, Saturday, Sunday, Thursday, Tuesday, Wednesday

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