az functionapp

Manage function apps.

Commands

az functionapp assign-identity (PREVIEW) assign managed service identity to the functionapp.
az functionapp config Configure a function app.
az functionapp config appsettings Configure function app settings.
az functionapp config appsettings delete
az functionapp config appsettings list
az functionapp config appsettings set Update a function app's 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 ssl Configure SSL certificates.
az functionapp config ssl bind Bind an SSL certificate to a function app.
az functionapp config ssl delete Delete an SSL certificate from a function app.
az functionapp config ssl list List SSL certificates 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 create Create a function app.
az functionapp delete Delete a function app.
az functionapp deployment Manage function app deployments.
az functionapp deployment list-publishing-profiles
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 list List function apps.
az functionapp list-consumption-locations List available locations for running function apps.
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 assign-identity

(PREVIEW) assign managed service identity to the functionapp.

az functionapp assign-identity --name
--resource-group
[--disable-msi]
[--role]
[--scope]

Examples

assign local identity and assign a reader role to the current resource group.

az functionapp assign-identity -g MyResourceGroup -n MyUniqueApp --role reader --scope /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/MyResourceGroup

disable the identity when there is need.

az functionapp config appsettings set -g MyResourceGroup -n MyUniqueApp --settings WEBSITE_DISABLE_MSI=true

Required Parameters

--name -n

Name of the function.

--resource-group -g

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

Optional Parameters

--disable-msi

Disable the identity.

--role

Role name or id the managed identity will be assigned.

default value: Contributor
--scope

The scope the managed identity has access to.

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
[--consumption-plan-location]
[--deployment-container-image-name]
[--deployment-local-git]
[--deployment-source-branch]
[--deployment-source-url]
[--plan]

Examples

Create a basic function app.

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

Required Parameters

--name -n

Name of the function.

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

--consumption-plan-location -c

Geographic location where Function App will be hosted. Use 'functionapp list-consumption-locations' to view available locations.

--deployment-container-image-name -i

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

--plan -p

Name or resource id of the function app service plan. Use 'appservice plan create' to get one.

az functionapp delete

Delete a function app.

az functionapp delete --name
--resource-group

Required Parameters

--name -n

Name of the function.

--resource-group -g

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

az functionapp list

List function apps.

az functionapp list [--resource-group]

Examples

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

az functionapp list-consumption-locations

List available locations for running function apps.

az functionapp list-consumption-locations

az functionapp restart

Restart a function app.

az functionapp restart --name
--resource-group

Required Parameters

--name -n

Name of the function.

--resource-group -g

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

az functionapp show

Get the details of a function app.

az functionapp show --name
--resource-group

Required Parameters

--name -n

Name of the function.

--resource-group -g

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

az functionapp start

Start a function app.

az functionapp start --name
--resource-group

Required Parameters

--name -n

Name of the function.

--resource-group -g

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

az functionapp stop

Stop a function app.

az functionapp stop --name
--resource-group

Required Parameters

--name -n

Name of the function.

--resource-group -g

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