az functionapp keys

Manage function app keys.

Commands

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

Delete a function app key.

az functionapp keys delete --key-name
                           --key-type {functionKeys, masterKey, systemKey}
                           --name
                           --resource-group
                           [--slot]
                           [--subscription]

Examples

Delete a master key for an Azure Function app.

az functionapp keys delete -g MyResourceGroup -n MyFunctionAppName --key-type masterKey --key-name MyKeyName

Required Parameters

--key-name

Name of the key to set.

--key-type

Type of key.

accepted values: functionKeys, masterKey, systemKey
--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>.

Optional Parameters

--slot -s

The name of the slot. Defaults 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.

az functionapp keys list

List all function app keys.

az functionapp keys list --name
                         --resource-group
                         [--query-examples]
                         [--slot]
                         [--subscription]

Examples

List all keys for an Azure Function app.

az functionapp keys list -g MyResourceGroup -n MyFunctionAppName

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

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--slot -s

The name of the slot. Defaults 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.

az functionapp keys set

Create or update a function app key.

az functionapp keys set --key-name
                        --key-type {functionKeys, masterKey, systemKey}
                        --name
                        --resource-group
                        [--key-value]
                        [--slot]
                        [--subscription]

Examples

Create a function key for an Azure Function app.

az functionapp keys set -g MyResourceGroup -n MyFunctionAppName --key-type functionKeys --key-name MyKeyName --key-value MyKeyValue

Required Parameters

--key-name

Name of the key to set.

--key-type

Type of key.

accepted values: functionKeys, masterKey, systemKey
--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>.

Optional Parameters

--key-value

Value of the new key. If not provided, a value will be generated.

--slot -s

The name of the slot. Defaults 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.