Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

az containerapp env workload-profile

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

Create a workload profile in a Container Apps environment.

az containerapp env workload-profile add --name
 --resource-group
 [--acquire-policy-token]
 [--change-reference]
 [--max-nodes]
 [--min-nodes]
 [--workload-profile-name]
 [--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>.

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

The maximum node count for the workload profile.

--min-nodes

The minimum node count for the workload profile.

--workload-profile-name -w

The friendly name 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 <region> to check the options for your region.

az containerapp env workload-profile delete

Delete a workload profile from a Container Apps environment.

az containerapp env workload-profile delete --name
 --resource-group
 --workload-profile-name
 [--acquire-policy-token]
 [--change-reference]

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.

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

az containerapp env workload-profile list

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

az containerapp env workload-profile list-supported

List the supported workload profiles in a region.

az containerapp env workload-profile list-supported --location
 [--acquire-policy-token]
 [--change-reference]

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.

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

az containerapp env workload-profile show

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.

az containerapp env workload-profile update

Update an existing workload profile in a Container Apps environment.

az containerapp env workload-profile update --name
 --resource-group
 --workload-profile-name
 [--acquire-policy-token]
 [--change-reference]
 [--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

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

The maximum node count for the workload profile.

--min-nodes

The minimum node count for the workload profile.

Feedback

Was this page helpful?