az functionapp function keys

Manage function keys.

Commands

az functionapp function keys delete

Delete a function key.

az functionapp function keys list

List all function keys.

az functionapp function keys set

Create or update a function key.

az functionapp function keys delete

Delete a function key.

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

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

--function-name

Name of the Function.

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

List all function keys.

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

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

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

Create or update a function key.

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

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

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