az functionapp

Manage function apps. To install the Azure Functions Core tools see https://github.com/Azure/azure-functions-core-tools.

Commands

az functionapp app	Commands to manage Azure Functions app.
az functionapp app up	Deploy to Azure Functions via GitHub actions.
az functionapp config	Configure a function app.
az functionapp config access-restriction	Methods that show, set, add, and remove access restrictions on a functionapp.
az functionapp config access-restriction add	Adds an Access Restriction to the function app.
az functionapp config access-restriction remove	Removes an Access Restriction from the functionapp.
az functionapp config access-restriction set	Sets if SCM site is using the same restrictions as the main site.
az functionapp config access-restriction show	Show Access Restriction settings for functionapp.
az functionapp config appsettings	Configure function app settings.
az functionapp config appsettings delete	Delete a function app's settings.
az functionapp config appsettings list	Show settings for a function app.
az functionapp config appsettings set	Update a function app's settings.
az functionapp config container	Manage an existing function app's container settings.
az functionapp config container delete	Delete an existing function app's container settings.
az functionapp config container set	Set an existing function app's container settings.
az functionapp config container show	Get details of a function app's container settings.
az functionapp config hostname	Configure hostnames for a function app.
az functionapp config hostname add	Bind a hostname to a function app.
az functionapp config hostname delete	Unbind a hostname from a function app.
az functionapp config hostname get-external-ip	Get the external-facing IP address for a function app.
az functionapp config hostname list	List all hostname bindings for a function app.
az functionapp config set	Set an existing function app's configuration.
az functionapp config show	Get the details of an existing function app's configuration.
az functionapp config ssl	Configure SSL certificates.
az functionapp config ssl bind	Bind an SSL certificate to a function app.
az functionapp config ssl create	Create a Managed Certificate for a hostname in a function app.
az functionapp config ssl delete	Delete an SSL certificate from a function app.
az functionapp config ssl import	Import an SSL certificate to a function app from Key Vault.
az functionapp config ssl list	List SSL certificates for a function app.
az functionapp config ssl show	Show the details of an SSL certificate for a function app.
az functionapp config ssl unbind	Unbind an SSL certificate from a function app.
az functionapp config ssl upload	Upload an SSL certificate to a function app.
az functionapp cors	Manage Cross-Origin Resource Sharing (CORS).
az functionapp cors add	Add allowed origins.
az functionapp cors credentials	Enable or disable access-control-allow-credentials.
az functionapp cors remove	Remove allowed origins.
az functionapp cors show	Show allowed origins.
az functionapp create	Create a function app.
az functionapp delete	Delete a function app.
az functionapp deploy	Deploys a provided artifact to Azure functionapp.
az functionapp deployment	Manage function app deployments.
az functionapp deployment container	Manage container-based continuous deployment.
az functionapp deployment container config	Configure continuous deployment via containers.
az functionapp deployment container show-cd-url	Get the URL which can be used to configure webhooks for continuous deployment.
az functionapp deployment github-actions	Configure GitHub Actions for a functionapp.
az functionapp deployment github-actions add	Add a GitHub Actions workflow file to the specified repository. The workflow will build and deploy your app to the specified functionapp.
az functionapp deployment github-actions remove	Remove and disconnect the GitHub Actions workflow file from the specified repository.
az functionapp deployment list-publishing-credentials	Get the details for available function app publishing credentials.
az functionapp deployment list-publishing-profiles	Get the details for available function app deployment profiles.
az functionapp deployment slot	Manage function app deployment slots.
az functionapp deployment slot auto-swap	Configure deployment slot auto swap.
az functionapp deployment slot create	Create a deployment slot.
az functionapp deployment slot delete	Delete a deployment slot.
az functionapp deployment slot list	List all deployment slots.
az functionapp deployment slot swap	Swap deployment slots for a function app.
az functionapp deployment source	Manage function app deployment via source control.
az functionapp deployment source config	Manage deployment from git or Mercurial repositories.
az functionapp deployment source config-local-git	Get a URL for a git repository endpoint to clone and push to for function app deployment.
az functionapp deployment source config-zip	Perform deployment using the kudu zip push deployment for a function app.
az functionapp deployment source delete	Delete a source control deployment configuration.
az functionapp deployment source show	Get the details of a source control deployment configuration.
az functionapp deployment source sync	Synchronize from the repository. Only needed under manual integration mode.
az functionapp deployment source update-token	Update source control token cached in Azure app service.
az functionapp deployment user	Manage user credentials for deployment.
az functionapp deployment user set	Update deployment credentials.
az functionapp deployment user show	Gets publishing user.
az functionapp devops-pipeline	Azure Function specific integration with Azure DevOps. Please visit https://aka.ms/functions-azure-devops for more information.
az functionapp devops-pipeline create	Create an Azure DevOps pipeline for a function app.
az functionapp function	Manage function app functions.
az functionapp function delete	Delete a function.
az functionapp function keys	Manage function keys.
az functionapp function keys delete	Delete a function key.
az functionapp function keys list	List all function keys.
az functionapp function keys set	Create or update a function key.
az functionapp function show	Get the details of a function.
az functionapp hybrid-connection	Methods that list, add and remove hybrid-connections from functionapp.
az functionapp hybrid-connection add	Add an existing hybrid-connection to a functionapp.
az functionapp hybrid-connection list	List the hybrid-connections on a functionapp.
az functionapp hybrid-connection remove	Remove a hybrid-connection from a functionapp.
az functionapp identity	Manage web app's managed identity.
az functionapp identity assign	Assign managed identity to the web app.
az functionapp identity remove	Disable web app's managed identity.
az functionapp identity show	Display web app's managed identity.
az functionapp keys	Manage function app keys.
az functionapp keys delete	Delete a function app key.
az functionapp keys list	List all function app keys.
az functionapp keys set	Create or update a function app key.
az functionapp list	List function apps.
az functionapp list-consumption-locations	List available locations for running function apps.
az functionapp list-runtimes	List available built-in stacks which can be used for function apps.
az functionapp log	Manage function app logs.
az functionapp log deployment	Manage function app deployment logs.
az functionapp log deployment list	List deployment logs of the deployments associated with function app.
az functionapp log deployment show	Show deployment logs of the latest deployment, or a specific deployment if deployment-id is specified.
az functionapp plan	Manage App Service Plans for an Azure Function.
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 restart	Restart a function app.
az functionapp show	Get the details of a function app.
az functionapp start	Start a function app.
az functionapp stop	Stop a function app.
az functionapp update	Update a function app.
az functionapp vnet-integration	Methods that list, add, and remove virtual networks integrations from a functionapp.
az functionapp vnet-integration add	Add a regional virtual network integration to a functionapp.
az functionapp vnet-integration list	List the virtual network integrations on a functionapp.
az functionapp vnet-integration remove	Remove a regional virtual network integration from functionapp.

az functionapp create

Create a function app.

The function app's name must be able to produce a unique FQDN as AppName.azurewebsites.net.

az functionapp create --name
                      --resource-group
                      --storage-account
                      [--app-insights]
                      [--app-insights-key]
                      [--assign-identity]
                      [--consumption-plan-location]
                      [--deployment-container-image-name]
                      [--deployment-local-git]
                      [--deployment-source-branch]
                      [--deployment-source-url]
                      [--disable-app-insights {false, true}]
                      [--docker-registry-server-password]
                      [--docker-registry-server-user]
                      [--functions-version {2, 3, 4}]
                      [--https-only {false, true}]
                      [--os-type {Linux, Windows}]
                      [--plan]
                      [--role]
                      [--runtime]
                      [--runtime-version]
                      [--scope]
                      [--subnet]
                      [--tags]
                      [--vnet]

Examples

Create a basic function app.

az functionapp create -g MyResourceGroup  -p MyPlan -n MyUniqueAppName -s MyStorageAccount

Create a function app. (autogenerated)

az functionapp create --consumption-plan-location westus --name MyUniqueAppName --os-type Windows --resource-group MyResourceGroup --runtime dotnet --storage-account MyStorageAccount

Create a function app using a private ACR image.

az functionapp create -g MyResourceGroup -p MyPlan -n MyUniqueAppName --runtime node --storage-account MyStorageAccount --deployment-container-image-name myacr.azurecr.io/myimage:tag --docker-registry-server-password passw0rd --docker-registry-server-user MyUser

Required Parameters

--name -n

Name of the new function app.

--resource-group -g

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

--storage-account -s

Provide a string value of a Storage Account in the provided Resource Group. Or Resource ID of a Storage Account in a different Resource Group.

Optional Parameters

--app-insights

Name of the existing App Insights project to be added to the function app. Must be in the same resource group.

--app-insights-key

Instrumentation key of App Insights to be added.

--assign-identity

Accept system or user assigned identities separated by spaces. Use '[system]' to refer system assigned identity, or a resource id to refer user assigned identity. Check out help for more examples.

--consumption-plan-location -c

Geographic location where function app will be hosted. Use az functionapp list-consumption-locations to view available locations.

--deployment-container-image-name -i

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

--deployment-local-git -l

Enable local git.

--deployment-source-branch -b

The branch to deploy.

default value: master

--deployment-source-url -u

Git repository URL to link with manual integration.

--disable-app-insights

Disable creating application insights resource during functionapp create. No logs will be available.

accepted values: false, true

--docker-registry-server-password -w

The container registry server password. Required for private registries.

--docker-registry-server-user -d

The container registry server username.

--functions-version

The functions app version. NOTE: This will be required starting the next release cycle.

accepted values: 2, 3, 4

--https-only

Redirect all traffic made to an app using HTTP to HTTPS.

accepted values: false, true

default value: False

--os-type

Set the OS type for the app to be created.

accepted values: Linux, Windows

--plan -p

Name or resource id of the functionapp app service plan. Use 'appservice plan create' to get one. If using an App Service plan from a different resource group, the full resource id must be used and not the plan name.

--role

Role name or id the system assigned identity will have.

default value: Contributor

--runtime

The functions runtime stack. Use "az functionapp list-runtimes" to check supported runtimes and versions.

--runtime-version

The version of the functions runtime stack. The functions runtime stack. Use "az functionapp list-runtimes" to check supported runtimes and versions.

--scope

Scope that the system assigned identity can access.

--subnet

Name or resource ID of the pre-existing subnet to have the webapp join. The --vnet is argument also needed if specifying subnet by name.

--tags

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

--vnet

Name or resource ID of the regional virtual network. If there are multiple vnets of the same name across different resource groups, use vnet resource id to specify which vnet to use. If vnet name is used, by default, the vnet in the same resource group as the webapp will be used. Must be used with --subnet argument.

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.

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

Delete a function app.

az functionapp delete [--ids]
                      [--keep-empty-plan]
                      [--name]
                      [--resource-group]
                      [--slot]
                      [--subscription]

Examples

Delete a function app. (autogenerated)

az functionapp delete --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.

--keep-empty-plan

Keep empty app service plan.

--name -n

The name of the functionapp.

--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. Default to the productions slot if not specified.

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

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

Deploys a provided artifact to Azure functionapp.

az functionapp deploy [--async {false, true}]
                      [--clean {false, true}]
                      [--ids]
                      [--ignore-stack {false, true}]
                      [--name]
                      [--resource-group]
                      [--restart {false, true}]
                      [--slot]
                      [--src-path]
                      [--src-url]
                      [--subscription]
                      [--target-path]
                      [--timeout]
                      [--type {ear, jar, lib, startup, static, war, zip}]

Examples

Deploy a war file asynchronously.

az functionapp deploy --resource-group ResourceGroup --name AppName --src-path SourcePath --type war --async true

Deploy a static text file to wwwroot/staticfiles/test.txt

az functionapp deploy --resource-group ResourceGroup --name AppName --src-path SourcePath --type static --target-path staticfiles/test.txt

Optional Parameters

--async

Asynchronous deployment.

accepted values: false, true

--clean

If true, cleans the target directory prior to deploying the file(s). Default value is determined based on artifact type.

accepted values: false, true

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

--ignore-stack

If true, any stack-specific defaults are ignored.

accepted values: false, true

--name -n

Name of the function app to deploy to.

--resource-group -g

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

--restart

If true, the web app will be restarted following the deployment, default value is true. Set this to false if you are deploying multiple artifacts and do not want to restart the site on the earlier deployments.

accepted values: false, true

--slot -s

The name of the slot. Default to the productions slot if not specified.

--src-path

Path of the artifact to be deployed. Ex: "myapp.zip" or "/myworkspace/apps/myapp.war".

--src-url

URL of the artifact. The webapp will pull the artifact from this URL. Ex: "http://mysite.com/files/myapp.war?key=123".

--subscription

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

--target-path

Absolute path that the artifact should be deployed to. Defaults to "home/site/wwwroot/". Ex: "/home/site/deployments/tools/", "/home/site/scripts/startup-script.sh".

--timeout

Timeout for the deployment operation in milliseconds.

--type

Used to override the type of artifact being deployed.

accepted values: ear, jar, lib, startup, static, war, zip

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.

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

List function apps.

az functionapp list [--resource-group]

Examples

List all function apps in MyResourceGroup.

az functionapp list --resource-group MyResourceGroup

List default host name and state for all function apps.

az functionapp list --query "[].{hostName: defaultHostName, state: state}"

List all running function apps.

az functionapp list --query "[?state=='Running']"

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.

--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 list-consumption-locations

List available locations for running function apps.

az functionapp list-consumption-locations

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.

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

List available built-in stacks which can be used for function apps.

az functionapp list-runtimes [--os {linux, windows}]

Optional Parameters

--os --os-type

Limit the output to just windows or linux runtimes.

accepted values: linux, windows

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.

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

Restart a function app.

az functionapp restart [--ids]
                       [--name]
                       [--resource-group]
                       [--slot]
                       [--subscription]

Examples

Restart a function app. (autogenerated)

az functionapp restart --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>.

--slot -s

The name of the slot. Default to the productions slot if not specified.

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

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

Get the details of a function app.

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

Examples

Get the details of a function app. (autogenerated)

az functionapp show --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>.

--slot -s

The name of the slot. Default to the productions slot if not specified.

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

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

Start a function app.

az functionapp start [--ids]
                     [--name]
                     [--resource-group]
                     [--slot]
                     [--subscription]

Examples

Start a function app. (autogenerated)

az functionapp start --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>.

--slot -s

The name of the slot. Default to the productions slot if not specified.

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

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

Stop a function app.

az functionapp stop [--ids]
                    [--name]
                    [--resource-group]
                    [--slot]
                    [--subscription]

Examples

Stop a function app. (autogenerated)

az functionapp stop --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>.

--slot -s

The name of the slot. Default to the productions slot if not specified.

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

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

Update a function app.

az functionapp update [--add]
                      [--force]
                      [--force-string]
                      [--ids]
                      [--name]
                      [--plan]
                      [--remove]
                      [--resource-group]
                      [--set]
                      [--slot]
                      [--subscription]

Examples

Update a function app. (autogenerated)

az functionapp update --name MyFunctionApp --resource-group MyResourceGroup

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

Required if attempting to migrate functionapp from Premium to Consumption --plan.

default value: False

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

--name -n

Name of the function app.

--plan

The name or resource id of the plan to update the functionapp with.

--remove

Remove a property or an element from a list. Example: --remove property.list 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=.

default value: []

--slot -s

The name of the slot. Default to the productions slot if not specified.

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

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