function_secrets

Creates, updates, deletes, gets or lists a function_secrets resource.

Overview

Name	function_secrets
Type	Resource
Id	azure.app_service.function_secrets

Fields

The following fields are returned by SELECT queries:

list

Function secrets returned.

Name	Datatype	Description
key	string	Secret key.
trigger_url	string	Trigger URL.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	resourceGroupName, name, functionName, subscriptionId		Description for Get function secrets for a function in a web site, or a deployment slot.
create_or_update	insert	resourceGroupName, name, functionName, keyName, subscriptionId		Description for Add or update a function secret.
delete	delete	resourceGroupName, name, functionName, keyName, subscriptionId		Description for Delete a function secret.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
functionName	string	The name of the function.
keyName	string	The name of the key.
name	string	Site name.
resourceGroupName	string	Name of the resource group to which the resource belongs.
subscriptionId	string	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).

SELECT examples

list

Description for Get function secrets for a function in a web site, or a deployment slot.

SELECT
key,
trigger_url
FROM azure.app_service.function_secrets
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND name = '{{ name }}' -- required
AND functionName = '{{ functionName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Description for Add or update a function secret.

INSERT INTO azure.app_service.function_secrets (
data__name,
data__value,
resourceGroupName,
name,
functionName,
keyName,
subscriptionId
)
SELECT 
'{{ name }}',
'{{ value }}',
'{{ resourceGroupName }}',
'{{ name }}',
'{{ functionName }}',
'{{ keyName }}',
'{{ subscriptionId }}'
RETURNING
name,
value
;

Manifest

# Description fields are for documentation purposes
- name: function_secrets
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the function_secrets resource.
    - name: name
      value: string
      description: Required parameter for the function_secrets resource.
    - name: functionName
      value: string
      description: Required parameter for the function_secrets resource.
    - name: keyName
      value: string
      description: Required parameter for the function_secrets resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the function_secrets resource.
    - name: name
      value: string
      description: |
        Key name
    - name: value
      value: string
      description: |
        Key value

DELETE examples

delete

Description for Delete a function secret.

DELETE FROM azure.app_service.function_secrets
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND name = '{{ name }}' --required
AND functionName = '{{ functionName }}' --required
AND keyName = '{{ keyName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;