Merge pull request #276016 from dominicbetts/aio-influxdb-updates

AIO: Update InfluxDB source stage

Author: v-dirichards

articles/iot-operations/process-data/howto-configure-datasource-influxdb.md

@@ -5,27 +5,27 @@ author: dominicbetts
 ms.author: dobett
 ms.subservice: data-processor
 ms.topic: how-to
-ms.date: 02/21/2024
+ms.date: 05/22/2024
 
 #CustomerIntent: As an operator, I want to configure an InfluxDB source stage so that I can read messages from an InfluxDB database for processing.
 ---
 
-# Configure an InfluxDB source stage
+# Configure an InfluxDB v2 source stage
 
 [!INCLUDE [public-preview-note](../includes/public-preview-note.md)]
 
-The source stage is the first and required stage in an Azure IoT Data Processor (preview) pipeline. The source stage gets data into the data processing pipeline and prepares it for further processing. The InfluxDB source stage lets you read data from an [InfluxDB](https://www.influxdata.com/) database at a user-defined interval.
+The source stage is the first and required stage in an Azure IoT Data Processor (preview) pipeline. The source stage gets data into the data processing pipeline and prepares it for further processing. The InfluxDB source stage lets you read data from an [InfluxDB v2](https://docs.influxdata.com/influxdb/v2/) database at a user-defined interval.
 
 In the source stage, you define:
 
-- Connection details for InfluxDB.
+- Connection details for InfluxDB v2.
 - The interval at which to query the InfluxDB database. The stage waits for a result before it resets the interval timer.
 - A partitioning configuration based on your specific data processing requirements.
 
 ## Prerequisites
 
 - A functioning instance of Data Processor is deployed.
-- An InfluxDB database with all necessary raw data available is operational and reachable.
+- An InfluxDB database with all necessary raw data is operational and reachable.
 
 ## Prepare the Influx database
 
@@ -39,22 +39,25 @@ To connect to the InfluxDB database, you need to:
 To configure the InfluxDB source:
 
 - Provide details of the InfluxDB database. This configuration includes the server name and a query to retrieve the data.
-- Specify the authentication method. Currently limited to access token authentication.
+- Specify the authentication method. Currently, you can only use access token authentication.
 
 The following table describes the InfluxDB source configuration parameters:
 
 The base schema of the input configuration is made up of:
 
 | Field | Type | Description | Required? | Default | Example |
 |--|--|--|--|--|--|
-| Data query | Object | The InfluxDB query configuration | Yes |  | `{"expression": 'from(bucket:"test-bucket")\|> range(start: -1h) \|> filter(fn: (r) => r._measurement == "stat")'}` |
-| Server URL | string | URL of the InfluxDB server | Yes |  | `https://contoso.com/some/url/path` |
+| Name | String | A customer-visible name for the source stage. | Required | NA | `erp-database` |
+| Description | String | A customer-visible description of the source stage. | Optional | NA | `Enterprise database` |
+| Database URL | String | URL of the InfluxDB database | Yes |  | `https://contoso.com/some/url/path` |
+| Database port | Integer | The InfluxDB database port | No | 443 | 443 |
+| Organization | String | The organization that holds the bucket to query from | Yes | `test-org` | `test-org` |
+| Authentication | Authentication type | The authentication method for connecting to the server. Supports `accessToken` type only. | Yes | `{"type": "accessToken"}` | `{"type": "accessToken"}` |
+| Secret | String | Reference to the token stored in Azure Key Vault. | Yes | Yes | `AKV_ACCESS_TOKEN` |
+| Flux query | String | The InfluxDB query | Yes |  | `{"expression": 'from(bucket:"test-bucket")\|> range(start: -1h) \|> filter(fn: (r) => r._measurement == "stat")'}` |
 | Query interval | [Duration](concept-configuration-patterns.md#duration) | String representation of the time to wait before the next API call. | Yes |  | `24h` |
-| Server port | integer | The InfluxDB server port | No | 443 | 443 |
-| Organization | string | The organization that holds the bucket to query from | Yes | `test-org` | `test-org` |
 | Data format | [Format](concept-supported-formats.md) | The stage applies the format to individual rows retrieved by the query. Only the `json` format is supported. The top-level `path` isn't supported. | Yes |  | `{"type": "json"}` |
 | Partitioning | [Partitioning](#configure-partitioning) | Partitioning configuration for the source stage. | Required | NA | See [partitioning](#configure-partitioning) |
-| Authentication | Authentication type | The authentication method for connecting to the server. Supports `accessToken` type only. | Yes | `{"type": "accessToken"}` | `{"type": "accessToken"}` |
 
 ## Configure partitioning
 
@@ -76,27 +79,28 @@ The following JSON example shows a complete InfluxDB source stage configuration:
 
 ```json
 {
-  "displayName": "influxdb-reader-1",
+  "displayName": "InfluxDB v2 - ec8750",
   "type": "input/influxdbv2@v1",
-  "next": ["next-stage-id"],
   "query": {
-    "expression": "from(bucket:\"test-bucket\") |> range(start: -1h) |> filter(fn: (r) => r._measurement == \"stat\")"
+    "expression": "from(bucket:\\\"test-bucket\\\") |> range(start: -1h) |> filter(fn: (r) => r._measurement == \\\"stat\\\")"
   },
-  "interval": "5s",
   "url": "https://contoso.com/some/url/path",
+  "interval": "5s",
+  "port": 443,
   "organization": "test-org",
+  "format": {
+    "type": "json"
+  },
   "partitionCount": 1,
   "partitionStrategy": {
     "type": "id",
     "expression": "0"
   },
-  "format": {
-    "type": "json"
-  },
   "authentication": {
     "type": "accessToken",
     "accessToken": "AKV_ACCESS_TOKEN"
-  }
+  },
+  "description": "Example InfluxDB source stage"
 }
 ```
 

articles/iot-operations/process-data/howto-configure-datasource-sql.md

@@ -100,7 +100,7 @@ The following table describes the SQL Server source configuration parameters:
 | Server port | Integer | The port number to connect to on the server.  | Required | `1433` | `1433` |
 | Authentication | Authentication type | The authentication method for connecting to the server. One of: `None`, `Username/Password`, `Managed identity`, or `Service principal`. | Optional | `NA` | `Username/Password` |
 | Username/Password > Username | String | The username for the username/password authentication | Yes | NA | `myuser` |
-| Username/Password > Secret | Reference to the password stored in Azure Key Vault. | Yes | Yes | `AKV_USERNAME_PASSWORD` |
+| Username/Password > Secret | String | Reference to the password stored in Azure Key Vault. | Yes | Yes | `AKV_USERNAME_PASSWORD` |
 | Service principal > Tenant ID | String | The Tenant ID of the service principal. | Yes | NA | `<Tenant ID>` |
 | Service principal > Client ID | String | The Client ID of the service principal. | Yes | NA | `<Client ID>` |
 | Service principal > Secret | String | Reference to the service principal client secret stored in Azure Key Vault. | Yes | NA | `AKV_SERVICE_PRINCIPAL` |