az functionapp identity

  • Reference

Manage web app's managed identity.

Commands

Name Description Type Status
az functionapp identity assign

Assign managed identity to the web app.

 Core GA
az functionapp identity remove

Disable web app's managed identity.

 Core GA
az functionapp identity show

Display web app's managed identity.

 Core GA

az functionapp identity assign

Edit

Assign managed identity to the web app.

az functionapp identity assign [--identities]
                               [--ids]
                               [--name]
                               [--resource-group]
                               [--role]
                               [--scope]
                               [--slot]
                               [--subscription]

Examples

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

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

enable identity for the web app.

az functionapp identity assign -g MyResourceGroup -n MyUniqueApp

assign local identity and a user assigned identity to a function app.

az functionapp identity assign -g MyResourceGroup -n MyUniqueApp --identities [system] myAssignedId

Optional Parameters

--identities

Space-separated identities to assign. Use '[system]' to refer to the system assigned identity. Default: '[system]'.

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

--role

Role name or id the managed identity will be assigned.

Default value: Contributor
--scope

The scope the managed identity has access to.

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

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

Edit

Disable web app's managed identity.

az functionapp identity remove [--identities]
                               [--ids]
                               [--name]
                               [--resource-group]
                               [--slot]
                               [--subscription]

Examples

Disable web app's system managed identity

az functionapp identity remove --name MyFunctionApp --resource-group MyResourceGroup

Disable web app's system managed identity and a user managed identity

az functionapp identity remove --name MyFunctionApp --resource-group MyResourceGroup --identities [system] myAssignedId

Optional Parameters

--identities

Space-separated identities to assign. Use '[system]' to refer to the system assigned identity. Default: '[system]'.

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

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

Edit

Display web app's managed identity.

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

Examples

display functionapp's managed identity (autogenerated)

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

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.