az functionapp function keys

Manage function keys.

Commands

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

az functionapp function keys delete

Edit

Delete a function key.

az functionapp function keys delete --key-name
                                    --name
                                    --resource-group
                                    [--function-name]
                                    [--slot]

Examples

Delete a function key.

az functionapp function keys delete -g MyResourceGroup -n MyFunctionAppName --function-name MyFunctionName --key-name MyKeyName

Required Parameters

--key-name

Name of the key to set.

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--function-name

Name of the Function.

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

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az functionapp function keys list

Edit

List all function keys.

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

Examples

List all function keys.

az functionapp function keys list -g MyResourceGroup -n MyFunctionAppName --function-name MyFunctionName

Required Parameters

--function-name

Name of the Function.

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az functionapp function keys set

Edit

Create or update a function key.

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

az functionapp function keys set --function-name
                                 --key-name
                                 --name
                                 --resource-group
                                 [--key-value]
                                 [--slot]

Examples

Create a function key.

az functionapp function keys set -g MyResourceGroup -n MyFunctionAppName --function-name MyFunctionName --key-name MyKeyName --key-value MyKeyValue

Required Parameters

--function-name

Name of the Function.

--key-name

Name of the key to set.

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False