az functionapp plan

  • Reference

Manage App Service Plans for an Azure Function.

Commands

Name Description Type Status
az functionapp plan create

Create an App Service Plan for an Azure Function.

 Core GA
az functionapp plan delete

Delete an App Service Plan.

 Core GA
az functionapp plan list

List App Service Plans.

 Core GA
az functionapp plan show

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

 Core GA
az functionapp plan update

Update an App Service plan for an Azure Function.

 Core GA

az functionapp plan create

Edit

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]
                           [--tags]
                           [--zone-redundant]

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. e.g., F1(Free), D1(Shared), B1(Basic Small), B2(Basic Medium), B3(Basic Large), S1(Standard Small), P1V2(Premium V2 Small), I1 (Isolated Small), I2 (Isolated Medium), I3 (Isolated Large), K1 (Kubernetes).

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.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--zone-redundant -z

Enable zone redundancy for high availability. Cannot be changed after plan creation. Minimum instance count is 3.

default value: False
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 functionapp plan delete

Edit

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). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

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

default value: False
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 functionapp plan list

Edit

List App Service Plans.

az functionapp plan list [--resource-group]

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

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 functionapp plan show

Edit

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). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

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

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 functionapp plan update

Edit

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

default value: []
--force-string

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

default value: False
--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.

--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 <indexToRemove> OR --remove propertyToRemove.

default value: []
--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=<value>.

default value: []
--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.

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.