ARM template resource definition
The dataBoxEdgeDevices/roles/monitoringConfig resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/monitoringConfig resource, add the following JSON to your template.
{
"type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/monitoringConfig",
"apiVersion": "2023-12-01",
"name": "default",
"properties": {
"metricConfigurations": [
{
"counterSets": [
{
"counters": [
{
"additionalDimensions": [
{
"sourceName": "string",
"sourceType": "string"
}
],
"dimensionFilter": [
{
"sourceName": "string",
"sourceType": "string"
}
],
"instance": "string",
"name": "string"
}
]
}
],
"mdmAccount": "string",
"metricNameSpace": "string",
"resourceId": "string"
}
]
}
}
Property values
dataBoxEdgeDevices/roles/monitoringConfig
Name |
Description |
Value |
type |
The resource type |
'Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/monitoringConfig' |
apiVersion |
The resource api version |
'2023-12-01' |
name |
The resource name
See how to set names and types for child resources in JSON ARM templates. |
'default' |
properties |
The metric setting properties. |
MonitoringMetricConfigurationProperties (required) |
MonitoringMetricConfigurationProperties
Name |
Description |
Value |
metricConfigurations |
The metrics configuration details |
MetricConfiguration[] (required) |
MetricConfiguration
Name |
Description |
Value |
counterSets |
Host name for the IoT hub associated to the device. |
MetricCounterSet[] (required) |
mdmAccount |
The MDM account to which the counters should be pushed. |
string |
metricNameSpace |
The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified |
string |
resourceId |
The Resource ID on which the metrics should be pushed. |
string (required) |
MetricCounterSet
Name |
Description |
Value |
counters |
The counters that should be collected in this set. |
MetricCounter[] (required) |
MetricCounter
Name |
Description |
Value |
additionalDimensions |
The additional dimensions to be added to metric. |
MetricDimension[] |
dimensionFilter |
The dimension filter. |
MetricDimension[] |
instance |
The instance from which counter should be collected. |
string |
name |
The counter name. |
string (required) |
MetricDimension
Name |
Description |
Value |
sourceName |
The dimension value. |
string (required) |
sourceType |
The dimension type. |
string (required) |