addDeviceMetricsIntegrations

The addDeviceMetricsIntegrations operation handles configuration related to DeviceMetricsIntegrations model. 

Data Parameters

Parameter Required Type Description
name True string
Field level constraints: cannot be null, cannot be blank or empty, length must be between 0 and 128 (inclusive). (Note: Additional constraints might exist)
description False string
Field level constraints: length must be between 0 and 200 (inclusive). (Note: Additional constraints might exist)
integrationTargets True [object] An object of type Azure Application Insights that represents the targeted application to which the metrics will be emitted.
Field level constraints: cannot be null. (Note: Additional constraints might exist)
Allowed types are: [AwsCloudWatch, AzureApplicationInsights]
deviceIdentifier True string A String object used to differentiate statistics from this device and other devices emitting telemetry to Azure Application
Field level constraints: cannot be null, cannot be blank or empty, length must be between 0 and 64 (inclusive), must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
metricSettings True [object] An object of type Metric Settings to configure the metrics that needs to be emitted.
Field level constraints: cannot be null. (Note: Additional constraints might exist)
type True string A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name.

Example

- name: Execute 'addDeviceMetricsIntegrations' operation
  ftd_configuration:
    operation: "addDeviceMetricsIntegrations"
    data:
        name: "{{ name }}"
        description: "{{ description }}"
        integrationTargets: "{{ integration_targets }}"
        deviceIdentifier: "{{ device_identifier }}"
        metricSettings: "{{ metric_settings }}"
        type: "{{ type }}"