Share via

az containerapp env workload-profile

  • Reference

Note

This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. Learn more about extensions.

Manage the workload profiles of a Container Apps environment.

Commands

Name Description Type Status
az containerapp env workload-profile add

Create a workload profile in a Container Apps environment.

 Core GA
az containerapp env workload-profile delete

Delete a workload profile from a Container Apps environment.

 Core GA
az containerapp env workload-profile list

List the workload profiles from a Container Apps environment.

 Core GA
az containerapp env workload-profile list-supported

List the supported workload profiles in a region.

 Core GA
az containerapp env workload-profile set

Create or update an existing workload profile in a Container Apps environment.

 Extension Deprecated
az containerapp env workload-profile show

Show a workload profile from a Container Apps environment.

 Core GA
az containerapp env workload-profile update

Update an existing workload profile in a Container Apps environment.

 Core GA

az containerapp env workload-profile add

Edit

Create a workload profile in a Container Apps environment.

az containerapp env workload-profile add --name
                                         --resource-group
                                         --workload-profile-name
                                         [--max-nodes]
                                         [--min-nodes]
                                         [--workload-profile-type]

Examples

Create a workload profile in a Container Apps environment

az containerapp env workload-profile add -g MyResourceGroup -n MyEnvironment --workload-profile-name my-wlp --workload-profile-type D4 --min-nodes 1 --max-nodes 2

Required Parameters

--name -n

The name of the Container App environment.

--resource-group -g

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

--workload-profile-name -w

The friendly name for the workload profile.

Optional Parameters

--max-nodes

The maximum node count for the workload profile.

--min-nodes

The minimum node count for the workload profile.

--workload-profile-type

The type of workload profile to add to this environment. Run 'az containerapp env workload-profile list-supported -l ' to check the options for your region.

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 containerapp env workload-profile delete

Edit

Delete a workload profile from a Container Apps environment.

az containerapp env workload-profile delete --name
                                            --resource-group
                                            --workload-profile-name

Examples

Delete a workload profile from a Container Apps environment

az containerapp env workload-profile delete -g MyResourceGroup -n MyEnvironment --workload-profile-name my-wlp

Required Parameters

--name -n

The name of the Container App environment.

--resource-group -g

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

--workload-profile-name -w

The friendly name for the workload profile.

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 containerapp env workload-profile list

Edit

List the workload profiles from a Container Apps environment.

az containerapp env workload-profile list --name
                                          --resource-group

Examples

List the workload profiles from a Container Apps environment

az containerapp env workload-profile list -g MyResourceGroup -n MyEnvironment

Required Parameters

--name -n

The name of the Container App environment.

--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 containerapp env workload-profile list-supported

Edit

List the supported workload profiles in a region.

az containerapp env workload-profile list-supported --location

Examples

List the supported workload profiles in a region

az containerapp env workload-profile list-supported -l region

Required Parameters

--location -l

Location of resource. Examples: eastus2, northeurope.

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 containerapp env workload-profile set

Deprecated

This command has been deprecated and will be removed in a future release. Use 'containerapp env workload-profile add/update' instead.

Create or update an existing workload profile in a Container Apps environment.

az containerapp env workload-profile set --name
                                         --resource-group
                                         --workload-profile-name
                                         [--max-nodes]
                                         [--min-nodes]
                                         [--workload-profile-type]

Examples

Create or update an existing workload profile in a Container Apps environment

az containerapp env workload-profile set -g MyResourceGroup -n MyEnvironment --workload-profile-name my-wlp --workload-profile-type D4 --min-nodes 1 --max-nodes 2

Required Parameters

--name -n

The name of the Container App environment.

--resource-group -g

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

--workload-profile-name -w

The friendly name for the workload profile.

Optional Parameters

--max-nodes

The maximum node count for the workload profile.

--min-nodes

The minimum node count for the workload profile.

--workload-profile-type

The type of workload profile to add or update. Run 'az containerapp env workload-profile list-supported -l ' to check the options for your region.

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 containerapp env workload-profile show

Edit

Show a workload profile from a Container Apps environment.

az containerapp env workload-profile show --name
                                          --resource-group
                                          --workload-profile-name

Examples

Show a workload profile from a Container Apps environment

az containerapp env workload-profile show -g MyResourceGroup -n MyEnvironment --workload-profile-name my-wlp

Required Parameters

--name -n

The name of the Container App environment.

--resource-group -g

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

--workload-profile-name -w

The friendly name for the workload profile.

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 containerapp env workload-profile update

Edit

Update an existing workload profile in a Container Apps environment.

az containerapp env workload-profile update --name
                                            --resource-group
                                            --workload-profile-name
                                            [--max-nodes]
                                            [--min-nodes]

Examples

Update an existing workload profile in a Container Apps environment

az containerapp env workload-profile update -g MyResourceGroup -n MyEnvironment --workload-profile-name my-wlp --min-nodes 1 --max-nodes 3

Required Parameters

--name -n

The name of the Container App environment.

--resource-group -g

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

--workload-profile-name -w

The friendly name for the workload profile.

Optional Parameters

--max-nodes

The maximum node count for the workload profile.

--min-nodes

The minimum node count for the workload profile.

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.