Configuration - Test Queries
Validates target condition and custom metric queries for a configuration on the IoT Hub.
POST https://fully-qualified-iothubname.azure-devices.net/configurations/testQueries?api-version=2021-04-12URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Version of the Api. |
Request Body
| Name | Type | Description |
|---|---|---|
| customMetricQueries |
object |
The key-value pairs with queries and their identifier. |
| targetCondition |
string |
The query used to define targeted devices or modules. The query is based on twin tags and/or reported properties. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
OK. |
Definitions
| Name | Description |
|---|---|
|
Configuration |
|
|
Configuration |
ConfigurationQueriesTestInput
| Name | Type | Description |
|---|---|---|
| customMetricQueries |
object |
The key-value pairs with queries and their identifier. |
| targetCondition |
string |
The query used to define targeted devices or modules. The query is based on twin tags and/or reported properties. |
ConfigurationQueriesTestResponse
| Name | Type | Description |
|---|---|---|
| customMetricQueryErrors |
object |
The errors from running the custom metric query. |
| targetConditionError |
string |
The errors from running the target condition query. |