az functionapp plan

Manage App Service Plans for an Azure Function.

Commands

az functionapp plan create Create an App Service Plan for an Azure Function.
az functionapp plan delete Delete an App Service Plan.
az functionapp plan list List App Service Plans.
az functionapp plan show Get the App Service Plans for a resource group or a set of resource groups.
az functionapp plan update Update an App Service plan for an Azure Function.

az functionapp plan create

Create an App Service Plan for an Azure Function.

az functionapp plan create --name
--resource-group
--sku
[--is-linux {false, true}]
[--location]
[--max-burst]
[--min-instances]
[--subscription]
[--tags]

Examples

Create an elastic premium app service plan with burst out capability up to 10 instances.

az functionapp plan create -g MyResourceGroup -n MyPlan --min-instances 1 --max-burst 10 --sku EP1

Create a basic app service plan.

az functionapp plan create -g MyResourceGroup -n MyPlan --sku B1

Create an App Service Plan for an Azure Function. (autogenerated)

az functionapp plan create --location westus2 --name MyPlan --number-of-workers 1 --resource-group MyResourceGroup --sku B1

Required Parameters

--name -n

The name of the app service plan.

--resource-group -g

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

--sku

The SKU of the app service plan.

Optional Parameters

--is-linux

Host function app on Linux worker.

accepted values: false, true
--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--max-burst

The maximum number of elastic workers for the plan.

--min-instances --number-of-workers

The number of workers for the app service plan.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--tags

Space-separated tags in 'key[=value]' format. Use "" to clear existing tags.

az functionapp plan delete

Delete an App Service Plan.

az functionapp plan delete [--ids]
[--name]
[--resource-group]
[--subscription]
[--yes]

Optional Parameters

--ids

One or more resource IDs (space-delimited). If provided, no other 'Resource Id' arguments should be specified.

--name -n

The name of the app service plan.

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--yes -y

Do not prompt for confirmation.

az functionapp plan list

List App Service Plans.

az functionapp plan list [--resource-group]
[--subscription]

Examples

List all Elastic Premium 1 tier App Service plans.

az functionapp plan list --query "[?sku.tier=='EP1']"

Optional Parameters

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az functionapp plan show

Get the App Service Plans for a resource group or a set of resource groups.

az functionapp plan show [--ids]
[--name]
[--resource-group]
[--subscription]

Examples

Get the app service plans for a resource group or a set of resource groups. (autogenerated)

az functionapp plan show --name MyAppServicePlan --resource-group MyResourceGroup

Optional Parameters

--ids

One or more resource IDs (space-delimited). If provided, no other 'Resource Id' arguments should be specified.

--name -n

The name of the app service plan.

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az functionapp plan update

Update an App Service plan for an Azure Function.

az functionapp plan update [--add]
[--force-string]
[--ids]
[--max-burst]
[--min-instances]
[--name]
[--remove]
[--resource-group]
[--set]
[--sku]
[--subscription]

Examples

Update an app service plan to EP2 sku with twenty maximum workers.

az functionapp plan update -g MyResourceGroup -n MyPlan --max-burst 20 --sku EP2

Optional Parameters

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

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

--ids

One or more resource IDs (space-delimited). If provided, no other 'Resource Id' arguments should be specified.

--max-burst

The maximum number of elastic workers for the plan.

--min-instances --number-of-workers

The number of workers for the app service plan.

--name -n

The name of the app service plan.

--remove

Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.

--resource-group -g

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

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=.

--sku

The SKU of the app service plan.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.