Contents
Cirrus Link Resources
Cirrus Link Website
Contact Us (Sales/Support)
Forum
Cirrus Link Modules Docs for Ignition 7.9.x
Inductive Resources
Ignition User Manual
Knowledge Base Articles
Inductive University
Forum
The following API calls are available for the Azure Injector Module and can be executed within any of the Ignition Designer Script Consoleavailable Ignition scopes.
...
AnchorcreateConfig createConfig
system.cirruslink.azure.createConfig(type, props) → void
Parameters
String type (str)
The type of configuration to create with valid options:
"Cert Files"
"IoT Hubs"
"IoT Edge"
"IoT Central"
"Event Hubs"
"Agents"
"Sets"
Map props
Dictionary of properties making up the configuration with the following keys and datatypes:
Cert Files
Name (str)
FileName (str)
FileContents (str)
Description (str)
IoT Hubs
Id (long)
Name (str)
Enabled (strbool)
Protocol (str) "MQTT"
AzureSetId (long)
CertAuthEnabled (bool)
ConnectionString (str)
MqttHostname (str)
DeviceId (str)
CaCertFileId (long)
ClientCertFileId (long)
ClientPrivateKeyFileId (long)
ClientKeyPassword (str)
HistoryEnabled (bool)
HistoryStoreType (str) "In_Memory"
MessageCapacity (int)
FlushPeriod (long)
KeepAlive (int)
MaxSize (int)
Expiration (long)
ContentType (str) "NONE" or "APPLICATION_JSON"
ContentEncoding (str) "NONE", "UTF_8", "UTF_16", or "UTF_32"
AzureDateTimeFormat (str) "LONG_MS_SINCE_EPOCH" or "STRING_AZURE_COMPAT"
CustomTopicExtension (str)
IoT Edge
Id (long)
Name (str)
Enabled (strbool)
Protocol (str) "MQTT"
AzureSetId (long)
MqttServerUrl (str)
CertAuthEnabled (bool)
ConnectionString (str)
CaCertFileId (long)
ClientCertFileId (long)
ClientPrivateKeyFileId (long)
ClientKeyPassword (str)
HostnameVerification (bool)
MqttHostname (str)
DeviceId (str)
ModuleIdOption (str) "NONE", "ENVIRONMENT_VARIABLE" or "IGNITION_CONFIG"
ModuleId (str)
HistoryEnabled (bool)
HistoryStoreType (str) "In_Memory"
MessageCapacity (int)
FlushPeriod (long)
KeepAlive (int)
MaxSize (int)
Expiration (long)
ContentType (str) "NONE" or "APPLICATION_JSON"
ContentEncoding (str) "NONE", "UTF_8", "UTF_16", or "UTF_32"
AzureDateTimeFormat (str) "LONG_MS_SINCE_EPOCH" or "STRING_AZURE_COMPAT"
CustomTopicExtension (str)
IoT Central
Id (Long)
Name (str)
Enabled (bool)
ScopeId (str)
EnrollmentGroupSymmetricKey (str)
GlobalEndpoint (str)
ProvisionedDeviceId (str)
ModelId (str)
AureSetId (long)
HistoryEnabled (bool)
HistoryStoreType (str) "In_Memory"
MessageCapacity (int)
FlushPeriod (long)
MaximumSize (int)
AzureDateTimeFormat (str) "LONG_MS_SINCE_EPCOH" or "STRING_AZURE_COMPAT"
Event Hubs
Id (long)
Name (str)
Enabled (strbool)
AzureSetAzureSetId(long) (This is the id for the set)
ConnectionString (str)
HistoryEnabled (bool)
HistoryStoreType (str) "In_Memory"
MessageCapacity (int)
FlushPeriod (long)
MaxSize (int)
AzureDateTimeFormat (str) "LONG_MS_SINCE_EPOCH" or "STRING_AZURE_COMPAT"
Agents
Id (long)
TagProvider (str)
TagPath (str)
PushTrigger (str) "EVENT_DRIVEN" or "PERIODIC"
TagPacingPeriod (long)
ConvertUdts (bool)
PublishUdtDefinitions (bool)
OptimizeUdts (bool)
AzureSetId (long)
AutoDiscover (bool)
GroupId (str)
EdgeNodeId (str)
DeviceId (str)
FilteredProperties (str)
Sets
Id (long)
Name (str)
Description (str)
PushPolicy (str) "PUSH_TO_ALL" or "PUSH_TO_ANY"
Return Value
None
AnchorreadConfig readConfig
system.cirruslink.azure.readConfig(type) → List
Parameters
String type (str)
The type of configuration to read with valid options:
"General"
"Cert Files"
"IoT Hubs"
"IoT Edge"
"IoT Central"
"Event Hubs"
"Agents"
"Sets"
Return Value
A List of Dictionaries of properties making up the configurations with the following keys and datatypes:
General
Id (long)
Enabled (bool)
Cert Files
Name (str)
FileName (str)
FileContents (str)
Description (str)
IoT Hubs
Id (long)
Name (str)
Enabled (str)
Protocol (str) "MQTT"
AzureSetId (long)
CertAuthEnabled (bool)
ConnectionString (str)
MqttHostname (str)
DeviceId (str)
CaCertFileId (long)
ClientCertFileId (long)
ClientPrivateKeyFileId (long)
ClientKeyPassword (str)
HistoryEnabled (bool)
HistoryStoreType (str) "In_Memory"
MessageCapacity (int)
FlushPeriod (long)
KeepAlive (int)
MaxSize (int)
Expiration (long)
ContentType (str) "NONE" or "APPLICATION_JSON"
ContentEncoding (str) "NONE", "UTF_8", "UTF_16", or "UTF_32"
AzureDateTimeFormat (str) "LONG_MS_SINCE_EPOCH" or "STRING_AZURE_COMPAT"
CustomTopicExtension (str)
IoT Edge
Id (long)
Name (str)
Enabled (str)
Protocol (str) "MQTT"
AzureSetId (long)
MqttServerUrl (str)
CertAuthEnabled (bool)
ConnectionString (str)
CaCertFileId (long)
ClientCertFileId (long)
ClientPrivateKeyFileId (long)
ClientKeyPassword (str)
HostnameVerification (bool)
MqttHostname (str)
DeviceId (str)
ModuleIdOption (str) "NONE", "ENVIRONMENT_VARIABLE" or "IGNITION_CONFIG"
ModuleId (str)
HistoryEnabled (bool)
HistoryStoreType (str) "In_Memory"
MessageCapacity (int)
FlushPeriod (long)
KeepAlive (int)
MaxSize (int)
Expiration (long)
ContentType (str) "NONE" or "APPLICATION_JSON"
ContentEncoding (str) "NONE", "UTF_8", "UTF_16", or "UTF_32"
AzureDateTimeFormat (str) "LONG_MS_SINCE_EPOCH" or "STRING_AZURE_COMPAT"
CustomTopicExtension (str)
IoT Central
Id (long)
Name (str)
Enabled (bool)
ScopeId (str)
EnrollmentGroupSymmetricKey (str)
GlobalEndpoint (str)
ProvisionedDeviceId (str)
ModelId (str)
AzureSetId (str)
HistoryEnabled (bool)
HistoryStoreType (str) "In_Memory"
MessageCapacity (int)
FlushPeriod (long)
MaximumSize (int)
AzureDateTimeFormat (str) "LONG_MS_SINCE_EPOCK" or "STRING_AZURE_COMPAT"
Event Hubs
Id (long)
Name (str)
Enabled (str)
ConnectionString (str)
HistoryEnabled (bool)
HistoryStoreType (str) "In_Memory"
MessageCapacity (int)
FlushPeriod (long)
MaxSize (int)
AzureDateTimeFormat (str) "LONG_MS_SINCE_EPOCH" or "STRING_AZURE_COMPAT"
Agents
Id (long)
TagProvider (str)
TagPath (str)
PushTrigger (str) "EVENT_DRIVEN" or "PERIODIC"
TagPacingPeriod (long)
ConvertUdts (bool)
PublishUdtDefinitions (bool)
OptimizeUdts (bool)
AzureSetId (long)
AutoDiscover (bool)
GroupId (str)
EdgeNodeId (str)
DeviceId (str)
FilteredProperties (str)
Sets
Id (long)
Name (str)
Description (str)
PushPolicy (str) "PUSH_TO_ALL" or "PUSH_TO_ANY"
AnchorupdateConfig updateConfig
system.cirruslink.azure.updateConfig(type, id, collisionPolicy, props) → void
Parameters
Type (str)
String type
The type of configuration to update with valid options:
"General"
"Cert Files"
"IoT Hubs"
"IoT Edge"
"IoT Central"
"Event Hubs"
"Agents"
"Sets
"
Id (long)
Long id
The ID of the record to update
String collisionPolicy(str)
"MergeOverwrite" or "Overwrite"
"MergeOverwrite" will replace the existing properties in the record ID with only those included in the call
"Overwrite" will replace all properties in the record ID with those in the call
Map props
Dictionary of properties making up the configuration with the following keys and datatypes:
General
Id (long)
Enabled (bool)
Cert Files
Name (str)
FileName (str)
FileContents (str)
Description (str)
IoT Hubs
Id (long)
Name (str)
Enabled (str)
Protocol (str) "MQTT"
AzureSetId (long)
CertAuthEnabled (bool)
ConnectionString (str)
MqttHostname (str)
DeviceId (str)
CaCertFileId (long)
ClientCertFileId (long)
ClientPrivateKeyFileId (long)
ClientKeyPassword (str)
HistoryEnabled (bool)
HistoryStoreType (str) "In_Memory"
MessageCapacity (int)
FlushPeriod (long)
KeepAlive (int)
MaxSize (int)
Expiration (long)
ContentType (str) "NONE" or "APPLICATION_JSON"
ContentEncoding (str) "NONE", "UTF_8", "UTF_16", or "UTF_32"
AzureDateTimeFormat (str) "LONG_MS_SINCE_EPOCH" or "STRING_AZURE_COMPAT"
CustomTopicExtension (str)
IoT Edge
Id (long)
Name (str)
Enabled (str)
Protocol (str) "MQTT"
AzureSetId (long)
MqttServerUrl (str)
CertAuthEnabled (bool)
ConnectionString (str)
CaCertFileId (long)
ClientCertFileId (long)
ClientPrivateKeyFileId (long)
ClientKeyPassword (str)
HostnameVerification (bool)
MqttHostname (str)
DeviceId (str)
ModuleIdOption (str) "NONE", "ENVIRONMENT_VARIABLE" or "IGNITION_CONFIG"
ModuleId (str)
HistoryEnabled (bool)
HistoryStoreType (str) "In_Memory"
MessageCapacity (int)
FlushPeriod (long)
KeepAlive (int)
MaxSize (int)
Expiration (long)
ContentType (str) "NONE" or "APPLICATION_JSON"
ContentEncoding (str) "NONE", "UTF_8", "UTF_16", or "UTF_32"
AzureDateTimeFormat (str) "LONG_MS_SINCE_EPOCH" or "STRING_AZURE_COMPAT"
CustomTopicExtension (str)
IoT Central
Id (long)
Name (str)
Enabled (bool)
ScopeId (str)
EnrollmentGroupSymmetricKey (str)
GlobalEndpoint (str)
ModelId (str)
AzureSetId (long)
HistoryEnabled (bool)
HistoryStoreType (str) "In_Memory"
MessageCapacity (int)
FlushPeriod (long)
MaximumSize (int)
AzureDateTimeFormat (str) "LONG_MS_SINCE_EPOCH" or "STRING_AZURE_COMPAT"
Event Hubs
Id (long)
Name (str)
Enabled (str)
ConnectionString (str)
HistoryEnabled (bool)
HistoryStoreType (str) "In_Memory"
MessageCapacity (int)
FlushPeriod (long)
MaxSize (int)
AzureDateTimeFormat (str) "LONG_MS_SINCE_EPOCH" or "STRING_AZURE_COMPAT"
Agents
Id (long)
TagProvider (str)
TagPath (str)
PushTrigger (str) "EVENT_DRIVEN" or "PERIODIC"
TagPacingPeriod (long)
ConvertUdts (bool)
PublishUdtDefinitions (bool)
OptimizeUdts (bool)
AzureSetId (long)
AutoDiscover (bool)
GroupId (str)
EdgeNodeId (str)
DeviceId (str)
FilteredProperties (str)
Sets
Id (long)
Name (str)
Description (str)
PushPolicy (str) "PUSH_TO_ALL" or "PUSH_TO_ANY"
Return Value
None
AnchordeleteConfig deleteConfig
system.cirruslink.azure.deleteConfig(type, id) → void
Parameters
Type (str)
String type
The type of configuration to delete with valid options:
"Cert Files"
"IoT Hubs"
"IoT Edge"
"IoT Central"
"Event Hubs"
"Agents"
"Sets
"
Id (long)
Long id
The ID of the record to delete
Return Value
None
...