Warning
You are currently viewing v2.2 of the documentation and it is not the latest. For the most recent documentation, kindly click here.
Trigger Specification
This specification describes the azure-queue trigger for Azure Storage Queue.
triggers:
- type: azure-queue
metadata:
queueName: orders
queueLength: '5'
connectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
accountName: storage-account-name
Parameter list:
queueName- Name of the queue.queueLength- Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual number of messages in the queue is 30, the scaler scales to 3 pods. (Default:5, Optional)connectionFromEnv- Name of the environment variable your deployment uses to get the connection string.accountName- Name of the storage account that the queue belongs to.
Authentication Parameters
You can authenticate by using pod identity or connection string authentication.
Connection String Authentication:
connection- Connection string for Azure Storage Account.
Example
apiVersion: keda.sh/v1alpha1
kind: TriggerAuthentication
metadata:
name: azure-queue-auth
spec:
podIdentity:
provider: azure
---
apiVersion: keda.sh/v1alpha1
kind: ScaledObject
metadata:
name: azure-queue-scaledobject
namespace: default
spec:
scaleTargetRef:
name: azurequeue-function
triggers:
- type: azure-queue
metadata:
# Required
queueName: functionsqueue
# Optional, required when pod identity is used
accountName: storage-account-name
# Optional: connection OR authenticationRef that defines connection
connectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME # Default: AzureWebJobsStorage. Reference to a connection string in deployment
# or authenticationRef as defined below
#
# Optional
queueLength: "5" # default 5
authenticationRef:
name: azure-queue-auth # authenticationRef would need either podIdentity or define a connection parameter