az functionapp keys

Manage function app keys.

Commands

Name	Description	Type	Status
az functionapp keys delete	Delete a function app key.	Core	GA
az functionapp keys list	List all function app keys.	Core	GA
az functionapp keys set	Create or update a function app key.	Core	GA

az functionapp keys delete

Delete a function app key.

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

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

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

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

List all function app keys.

az functionapp keys list --name
                         --resource-group
                         [--slot]

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

--slot -s

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

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

Create or update a function app key.

Note that key values are now redacted in the result. Please use the az functionapp keys list command to view the key values.

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

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

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

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.