az functionapp deployment slot

  • Reference

Manage function app deployment slots.

Commands

Name Description Type Status
az functionapp deployment slot auto-swap

Configure deployment slot auto swap.

 Core GA
az functionapp deployment slot create

Create a deployment slot.

 Core GA
az functionapp deployment slot delete

Delete a deployment slot.

 Core GA
az functionapp deployment slot list

List all deployment slots.

 Core GA
az functionapp deployment slot swap

Swap deployment slots for a function app.

 Core GA

az functionapp deployment slot auto-swap

Edit

Configure deployment slot auto swap.

az functionapp deployment slot auto-swap --slot
                                         [--auto-swap-slot]
                                         [--disable]
                                         [--ids]
                                         [--name]
                                         [--resource-group]
                                         [--subscription]

Required Parameters

--slot -s

The name of the slot.

Optional Parameters

--auto-swap-slot

Target slot to auto swap.

default value: production
--disable

Disable auto swap.

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

Name of the function app.

--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 deployment slot create

Edit

Create a deployment slot.

az functionapp deployment slot create --name
                                      --resource-group
                                      --slot
                                      [--configuration-source]
                                      [--deployment-container-image-name]
                                      [--docker-registry-server-password]
                                      [--docker-registry-server-user]
                                      [--image]
                                      [--registry-password]
                                      [--registry-username]

Examples

Create a deployment slot. (autogenerated)

az functionapp deployment slot create --name MyFunctionapp --resource-group MyResourceGroup --slot staging

Required Parameters

--name -n

Name of the function app.

--resource-group -g

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

--slot -s

The name of the slot.

Optional Parameters

--configuration-source

Source slot to clone configurations from. Use function app's name to refer to the production slot.

--deployment-container-image-name
Deprecated

Option '--deployment-container-image-name' has been deprecated and will be removed in a future release. Use '--image' instead.

Container image, e.g. publisher/image-name:tag.

--docker-registry-server-password
Deprecated

Option '--docker-registry-server-password' has been deprecated and will be removed in a future release. Use '--registry-password' instead.

The container registry server password.

--docker-registry-server-user
Deprecated

Option '--docker-registry-server-user' has been deprecated and will be removed in a future release. Use '--registry-username' instead.

The container registry server username.

--image -i

Container image, e.g. publisher/image-name:tag.

--registry-password -d

The container registry server password.

--registry-username -u

The container registry server username.

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 deployment slot delete

Edit

Delete a deployment slot.

az functionapp deployment slot delete --slot
                                      [--ids]
                                      [--name]
                                      [--resource-group]
                                      [--subscription]

Examples

Delete a deployment slot. (autogenerated)

az functionapp deployment slot delete --name MyFunctionapp --resource-group MyResourceGroup --slot staging

Required Parameters

--slot -s

The name of the slot.

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

Name of the function app.

--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 deployment slot list

Edit

List all deployment slots.

az functionapp deployment slot list [--ids]
                                    [--name]
                                    [--resource-group]
                                    [--subscription]

Examples

List all deployment slots. (autogenerated)

az functionapp deployment slot list --name MyFunctionapp --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

Name of the function app.

--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 deployment slot swap

Edit

Swap deployment slots for a function app.

az functionapp deployment slot swap --slot
                                    [--action {preview, reset, swap}]
                                    [--ids]
                                    [--name]
                                    [--preserve-vnet {false, true}]
                                    [--resource-group]
                                    [--subscription]
                                    [--target-slot]

Examples

Swap a staging slot into production for the MyUniqueApp function app.

az functionapp deployment slot swap  -g MyResourceGroup -n MyUniqueApp --slot staging \
    --target-slot production

Required Parameters

--slot -s

The name of the slot.

Optional Parameters

--action

Swap types. use 'preview' to apply target slot's settings on the source slot first; use 'swap' to complete it; use 'reset' to reset the swap.

accepted values: preview, reset, swap
default value: swap
--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

Name of the function app.

--preserve-vnet

Preserve Virtual Network to the slot during swap, default to 'true'.

accepted values: false, true
--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.

--target-slot

Target slot to swap, default to 'production'.

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.