Configuration interface
The Configuration object represents the configuration of a single device or it can represent a deployment which can be applied as a configuration to devices based on the targetCondition.
Properties
content | Content of the configuration |
created |
Date time in ISO6801 of the creation of this configuration |
etag | A string used for protecting opportunistic concurrency updates by the caller. This gets updated when deployment is update |
id | Id of this configuration. |
labels | This is a dictionary<string, string> of labels. Labels are a set of case-sensitive string key value pairs that you can use to describe a deployment. Both keys and values are case-sensitive strings (up to 128 char long) of ASCII 7-bit alphanumeric chars + {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '''} (Note that $ is reserved) |
last |
Date time in ISO6801 of the last update of this configuration |
metrics | Custom Configuration Metrics |
priority | When two deployments target the same device, the deployment with higher priority gets applied. If two deployments have the same priority, the deployment with the later creation date gets applied. |
schema |
Version of the schema. |
system |
System Configuration Metrics |
target |
The target condition is continuously evaluated to include any new devices that meet the requirements or remove devices that no longer do through the life time of the deployment. Use any Boolean condition on device twins tags or deviceId to select the target devices, e.g. tags.environment='prod' or deviceId='linuxprod' or tags.environment = 'prod' AND tags.location = 'westus'. |
Property Details
content
createdTimeUtc
Date time in ISO6801 of the creation of this configuration
createdTimeUtc?: string
Property Value
string
etag
A string used for protecting opportunistic concurrency updates by the caller. This gets updated when deployment is update
etag?: string
Property Value
string
id
Id of this configuration.
id: string
Property Value
string
labels
This is a dictionary<string, string> of labels. Labels are a set of case-sensitive string key value pairs that you can use to describe a deployment. Both keys and values are case-sensitive strings (up to 128 char long) of ASCII 7-bit alphanumeric chars + {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '''} (Note that $ is reserved)
labels?: {[key: string]: string}
Property Value
{[key: string]: string}
lastUpdatedTimeUtc
Date time in ISO6801 of the last update of this configuration
lastUpdatedTimeUtc?: string
Property Value
string
metrics
priority
When two deployments target the same device, the deployment with higher priority gets applied. If two deployments have the same priority, the deployment with the later creation date gets applied.
priority?: number
Property Value
number
schemaVersion
Version of the schema.
schemaVersion: string
Property Value
string
systemMetrics
System Configuration Metrics
systemMetrics?: ConfigurationMetrics
Property Value
targetCondition
The target condition is continuously evaluated to include any new devices that meet the requirements or remove devices that no longer do through the life time of the deployment. Use any Boolean condition on device twins tags or deviceId to select the target devices, e.g. tags.environment='prod' or deviceId='linuxprod' or tags.environment = 'prod' AND tags.location = 'westus'.
targetCondition?: string
Property Value
string