Argo Workflows · Schema

github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.AzureQueueStorageEventSource

github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.AzureQueueStorageEventSource schema from Argo Workflows API

CNCFContainersData ProcessingKubernetesMachine LearningOpen SourceWorkflow Engine

Properties

Name Type Description
connectionString object
decodeMessage boolean
dlq boolean
filter object
jsonBody boolean
metadata object
queueName string
storageAccountName string
waitTimeInSeconds integer
View JSON Schema on GitHub

JSON Schema

argo-workflows-github-com-argoproj-argo-events-pkg-apis-events-v1alpha1-azure-queue-storage-event-source-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/argo-workflows/refs/heads/main/json-schema/argo-workflows-github-com-argoproj-argo-events-pkg-apis-events-v1alpha1-azure-queue-storage-event-source-schema.json",
  "title": "github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.AzureQueueStorageEventSource",
  "description": "github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.AzureQueueStorageEventSource schema from Argo Workflows API",
  "type": "object",
  "properties": {
    "connectionString": {
      "title": "ConnectionString is the connection string to access Azure Queue Storage. If this fields is not provided\nit will try to access via Azure AD with StorageAccountName.\n+optional",
      "$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector"
    },
    "decodeMessage": {
      "type": "boolean",
      "title": "DecodeMessage specifies if all the messages should be base64 decoded.\nIf set to true the decoding is done before the evaluation of JSONBody\n+optional"
    },
    "dlq": {
      "type": "boolean",
      "title": "DLQ specifies if a dead-letter queue is configured for messages that can't be processed successfully.\nIf set to true, messages with invalid payload won't be acknowledged to allow to forward them farther to the dead-letter queue.\nThe default value is false.\n+optional"
    },
    "filter": {
      "title": "Filter\n+optional",
      "$ref": "#/definitions/github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.EventSourceFilter"
    },
    "jsonBody": {
      "type": "boolean",
      "title": "JSONBody specifies that all event body payload coming from this\nsource will be JSON\n+optional"
    },
    "metadata": {
      "type": "object",
      "title": "Metadata holds the user defined metadata which will passed along the event payload.\n+optional",
      "additionalProperties": {
        "type": "string"
      }
    },
    "queueName": {
      "type": "string",
      "title": "QueueName is the name of the queue"
    },
    "storageAccountName": {
      "type": "string",
      "title": "StorageAccountName is the name of the storage account where the queue is. This field is necessary to\naccess via Azure AD (managed identity) and it is ignored if ConnectionString is set.\n+optional"
    },
    "waitTimeInSeconds": {
      "type": "integer",
      "title": "WaitTimeInSeconds is the duration (in seconds) for which the event source waits between empty results from the queue.\nThe default value is 3 seconds.\n+optional"
    }
  }
}