az functionapp deployment slot
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
Configure deployment slot auto swap.
az functionapp deployment slot auto-swap --slot
[--auto-swap-slot]
[--disable]
[--ids]
[--name]
[--resource-group]
[--subscription]
Required Parameters
The name of the slot.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Target slot to auto swap.
Property | Value |
---|---|
Default value: | production |
Disable auto swap.
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.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of the function app.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az functionapp deployment slot create
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]
[--https-only {false, true}]
[--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 of the function app.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the slot.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Source slot to clone configurations from. Use function app's name to refer to the production slot.
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.
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.
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.
Redirect all traffic made to an app using HTTP to HTTPS.
Property | Value |
---|---|
Default value: | True |
Accepted values: | false, true |
Container image, e.g. publisher/image-name:tag.
The container registry server password.
The container registry server username.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az functionapp deployment slot delete
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
The name of the slot.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of the function app.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az functionapp deployment slot list
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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of the function app.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az functionapp deployment slot swap
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
The name of the slot.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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.
Property | Value |
---|---|
Default value: | swap |
Accepted values: | preview, reset, swap |
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.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of the function app.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Preserve Virtual Network to the slot during swap, default to 'true'.
Property | Value |
---|---|
Accepted values: | false, true |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Target slot to swap, default to 'production'.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |