github.com/Jeffail/benthos/v3@v3.65.0/website/docs/components/inputs/azure_queue_storage.md (about) 1 --- 2 title: azure_queue_storage 3 type: input 4 status: beta 5 categories: ["Services","Azure"] 6 --- 7 8 <!-- 9 THIS FILE IS AUTOGENERATED! 10 11 To make changes please edit the contents of: 12 lib/input/azure_queue_storage.go 13 --> 14 15 import Tabs from '@theme/Tabs'; 16 import TabItem from '@theme/TabItem'; 17 18 :::caution BETA 19 This component is mostly stable but breaking changes could still be made outside of major version releases if a fundamental problem with the component is found. 20 ::: 21 22 Dequeue objects from an Azure Storage Queue. 23 24 Introduced in version 3.42.0. 25 26 27 <Tabs defaultValue="common" values={[ 28 { label: 'Common', value: 'common', }, 29 { label: 'Advanced', value: 'advanced', }, 30 ]}> 31 32 <TabItem value="common"> 33 34 ```yaml 35 # Common config fields, showing default values 36 input: 37 label: "" 38 azure_queue_storage: 39 storage_account: "" 40 storage_access_key: "" 41 storage_sas_token: "" 42 storage_connection_string: "" 43 queue_name: "" 44 ``` 45 46 </TabItem> 47 <TabItem value="advanced"> 48 49 ```yaml 50 # All config fields, showing default values 51 input: 52 label: "" 53 azure_queue_storage: 54 storage_account: "" 55 storage_access_key: "" 56 storage_sas_token: "" 57 storage_connection_string: "" 58 queue_name: "" 59 dequeue_visibility_timeout: 30s 60 max_in_flight: 10 61 track_properties: false 62 ``` 63 64 </TabItem> 65 </Tabs> 66 67 Dequeue objects from an Azure Storage Queue. 68 69 This input adds the following metadata fields to each message: 70 71 ``` 72 - queue_storage_insertion_time 73 - queue_storage_queue_name 74 - queue_storage_message_lag (if 'track_properties' set to true) 75 - All user defined queue metadata 76 ``` 77 78 Only one authentication method is required, `storage_connection_string` or `storage_account` and `storage_access_key`. If both are set then the `storage_connection_string` is given priority. 79 80 ## Fields 81 82 ### `storage_account` 83 84 The storage account to dequeue messages from. This field is ignored if `storage_connection_string` is set. 85 86 87 Type: `string` 88 Default: `""` 89 90 ### `storage_access_key` 91 92 The storage account access key. This field is ignored if `storage_connection_string` is set. 93 94 95 Type: `string` 96 Default: `""` 97 98 ### `storage_sas_token` 99 100 The storage account SAS token. This field is ignored if `storage_connection_string` or `storage_access_key` are set. 101 102 103 Type: `string` 104 Default: `""` 105 106 ### `storage_connection_string` 107 108 A storage account connection string. This field is required if `storage_account` and `storage_access_key` / `storage_sas_token` are not set. 109 110 111 Type: `string` 112 Default: `""` 113 114 ### `queue_name` 115 116 The name of the source storage queue. 117 This field supports [interpolation functions](/docs/configuration/interpolation#bloblang-queries). 118 119 120 Type: `string` 121 Default: `""` 122 123 ```yaml 124 # Examples 125 126 queue_name: foo_queue 127 128 queue_name: ${! env("MESSAGE_TYPE").lowercase() } 129 ``` 130 131 ### `dequeue_visibility_timeout` 132 133 The timeout duration until a dequeued message gets visible again, 30s by default 134 135 136 Type: `string` 137 Default: `"30s"` 138 Requires version 3.45.0 or newer 139 140 ### `max_in_flight` 141 142 The maximum number of unprocessed messages to fetch at a given time. 143 144 145 Type: `int` 146 Default: `10` 147 148 ### `track_properties` 149 150 If set to `true` the queue is polled on each read request for information such as the queue message lag. These properties are added to consumed messages as metadata, but will also have a negative performance impact. 151 152 153 Type: `bool` 154 Default: `false` 155 156