Versions Compared

Old Version 16

changes.mady.by.user Gill Houghton

Saved on

compared with

New Version Current

changes.mady.by.user Gill Houghton

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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.

APIs


Warning

Configuration changes made through scripting do not have the same validation as when made through the UI. 

For example, deleting a Sets configuring that is being referenced by a Servers configuration will result in the UI showing an Internal Error. Follow the instructions here to recover the configuration.

APIs

  • Anchor
    createConfig
    createConfig
    system.cirruslink.azure.createConfig(type, props) → void
    • Parameters
      • type (str)
        AnchorcreateConfigcreateConfigsystem.cirruslink.azure.createConfig(type, props) → void
        • Parameters
          • String type

            • The type of configuration to create with valid options:

              • "Cert Files"
              • "IoT Hubs"
              • "IoT Edges"
              • "IoT EdgeCentrals"
              • "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)(cannot be null)

                • Name (str)

                • Enabled (strbool)

                • Protocol (str) "MQTT"

                • AzureSetId (long)(must be included)

                • CertAuthEnabled (bool)

                • ConnectionString (str)

                • MqttHostname (str)

                • DeviceId (str)

                • CaCertFileId (long)

                • ClientCertFileId (long)

                • ClientPrivateKeyFileId (long)

                • ClientKeyPassword (str)

                • HistoryEnabled (bool)

                • HistoryStoreType (str) "In_Memory" or "Disk_Backed" (added 4.0.17)

                • MessageCapacity (int)FlushPeriod (long(deprecated 4.0.19)KeepAlive

                • HistoryMaxSize (int)

                • MaxSize (int)

                • (added 4.0.22)
                • HistoryMaxAge (int)(added 4.0.19)

                • FlushPeriod (long)

                • H2dbDirectory (str)(added 4.0.25)
                • H2dbPort (int)(added 4.0.22)

                • 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 Edges IoT Edge

                • Id (long)(cannot be null)

                • Name (str)

                • Enabled (strbool)

                • Protocol (str) "MQTT"

                • AzureSetId (long)(must be included)

                • 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" or "Disk_Backed" (added 4.0.17)

                • MessageCapacity (int)FlushPeriod (long(deprecated 4.0.19)KeepAlive

                • HistoryMaxSize (int)(added 4.0.22)
                • HistoryMaxAge MaxSize (int)

                • Expiration (long)

                • (added 4.0.19)

                • FlushPeriod (long)

                • H2dbDirectory (str)(added 4.0.25)
                • H2dbPort (int)(added 4.0.22)

                • 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 CentralsEvent Hubs
                • Id (long(Long)(cannot be null)
                • Name (str)
                • Enabled (strbool)
                • AzureSetScopeId (longstr) (This is the id for the set
                • EnrollmentGroupSymmetricKey (str)
                • ConnectionString GlobalEndpoint (str)
                • HistoryEnabled ProvisionedDeviceId (boolstr)
                • HistoryStoreType ModelId (str) "In_Memory"
                • MessageCapacity AureSetId (intlong)FlushPeriod (longmust be included)MaxSize
                • HistoryEnabled (intbool)
                • AzureDateTimeFormat HistoryStoreType (str) "LONG_MS_SINCE_EPOCHIn_Memory" or "STRINGDisk_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
                • Backed" (added 4.0.17)
                • MessageCapacity (int)(deprecated 4.0.19)
                • HistoryMaxSize (int)(added 4.0.22)
                • HistoryMaxAge (int)(added 4.0.19)
                • FlushPeriod (long)
                • H2dbDirectory (str)(added 4.0.25)
                • H2dbPort (int)(added 4.0.22)
                • MaximumSize (int)
                • AzureDateTimeFormat (str) "LONG_MS_SINCE_EPCOH" or "STRING_AZURE_COMPAT"
              • Event Hubs

                • Id (long)(cannot be null)

                • Name (str)

                • Enabled (bool)

                • AzureSetId(long)(must be included)

                • CertAuthEnabled (bool)(added 4.0.26)
                • TenantId (str)(added 4.0.26)
                • AzureServicePrincipalClientId (str)(added 4.0.26)
                • EventHubNamespace (str)(added 4.0.26)
                • EventHubName (str)(added 4.0.26)
                • ClientCertFileId (long)(added 4.0.26)
                • ClientPrivateKeyFileId (long)(added 4.0.26)
                • ClientKeyPassword (str)(added 4.0.26)

                • ConnectionString (str)

                • HistoryEnabled (bool)

                • HistoryStoreType (str) "In_Memory" or "Disk_Backed" (added 4.0.17)

                • MessageCapacity (int)(deprecated 4.0.19)

                • HistoryMaxSize (int)(added 4.0.22)
                • HistoryMaxAge (int)(added 4.0.19)

                • FlushPeriod (long)

                • H2dbDirectory (str)(added 4.0.25)
                • H2dbPort (int)(added 4.0.22)

                • MaxSize (int)

                • ContentEncoding (str) "NONE", "UTF_8", "UTF_16", or "UTF_32"

                • AzureDateTimeFormat (str) "LONG_MS_SINCE_EPOCH" or "STRING_AZURE_COMPAT"

              • Agents

                • Id (long)(cannot be null)

                • Name (str) (added 4.0.17)
                • Enabled (bool) (added 4.0.17)

                • TagProvider (str)

                • TagPath (str)

                • PushTrigger (str) "EVENT_DRIVEN", "PERIODIC" or "HYBRID"

                • TagPacingPeriod (long)

                • ConvertUdts (bool)

                • PublishUdtDefinitions (bool)

                • OptimizeUdts (bool)

                • AzureSetId (long)(must be included)

                • GroupId (str)

                • EdgeNodeId (str)

                • DeviceId (str)

                • FilteredProperties (str)

                • SendAllProps (bool)(added 4.0.25)
                • IncludeInfoFolders (bool)(added 4.0.30)
              • Sets

                • Id (long)(cannot be null)

                • Name (str)

                • Description (str)

                • PushPolicy (str) "PUSH_TO_ALL" or "PUSH_TO_ANY"

        • Return Value
          • A map representing the newly created configuration after it has been written to the database. (added 4.0.16)
      • Anchor
        readConfig
        readConfig
        system.cirruslink.azure.readConfig(type) → List
        • Parameters
          • type (str)

            • The type of configuration to read with valid options:

              • "General"
              • "Cert Files"
              • "IoT Hubs"
              • "IoT Edges"
              • "IoT Centrals"
              • "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

        AnchorreadConfigreadConfigsystem.cirruslink.azure.readConfig(type) → List
        • Parameters
          • String type

            • The type of configuration to read with valid options:

              • General
              • Cert Files
              • IoT Hubs
              • IoT Edge
              • 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)

            • 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)

              • " or "Disk_Backed" (added 4.0.17)

              • MessageCapacity (int)(deprecated 4.0.19)

              • HistoryMaxSize (int)(added 4.0.22)
              • HistoryMaxAge (int)(added 4.0.19)

              • FlushPeriod (long)

              • H2dbDirectory (str)(added 4.0.25)
              • H2dbPort (int)(added 4.0.22)

              • 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 EdgesSets

              • Id (long)

              • Name (str)

              • Description Enabled (str)

              • PushPolicy Protocol (str) "PUSH_TO_ALL" or "PUSH_TO_ANY"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" or "Disk_Backed" (added 4.0.17)

              • MessageCapacity (int)(deprecated 4.0.19)

              • HistoryMaxSize (int)(added 4.0.22)
              • HistoryMaxAge (int)(added 4.0.19)

              • FlushPeriod (long)

              • H2dbDirectory (str)(added 4.0.25)
              • H2dbPort (int)(added 4.0.22)

              • 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 Centrals
              • Id (long)
              • Name (str)
              • Enabled (bool)
              • ScopeId (str)
              • EnrollmentGroupSymmetricKey (str)
              • GlobalEndpoint (str)
              • ProvisionedDeviceId (str)
              • ModelId (str)
              • AzureSetId (str)
              • HistoryEnabled (bool)
              • HistoryStoreType (str) "In_Memory" or "Disk_Backed" (added 4.0.17)
              • MessageCapacity (int)(deprecated 4.0.19)
              • HistoryMaxSize (int)(added 4.0.22)
              • HistoryMaxAge (int)(added 4.0.19)
              • FlushPeriod (long)
              • H2dbDirectory (str)(added 4.0.25)
              • H2dbPort (int)(added 4.0.22)
              • MaximumSize (int)
              • AzureDateTimeFormat (str) "LONG_MS_SINCE_EPOCK" or "STRING_AZURE_COMPAT"
            • Event Hubs

              • Id (long)

              • Name (str)

              • Enabled (str)

              • CertAuthEnabled (bool)(added 4.0.26)
              • TenantId (str)(added 4.0.26)
              • AzureServicePrincipalClientId (str)(added 4.0.26)
              • EventHubNamespace (str)(added 4.0.26)
              • EventHubName (str)(added 4.0.26)
              • ClientCertFileId (long)(added 4.0.26)
              • ClientPrivateKeyFileId (long)(added 4.0.26)
              • ClientKeyPassword (str)(added 4.0.26)

              • ConnectionString (str)

              • HistoryEnabled (bool)

              • HistoryStoreType (str) "In_Memory" or "Disk_Backed" (added 4.0.17)

              • MessageCapacity (int)(deprecated 4.0.19)

              • HistoryMaxSize (int)(added 4.0.22)
              • HistoryMaxAge (int)(added 4.0.19)

              • FlushPeriod (long)

              • H2dbDirectory (str)(added 4.0.25)
              • H2dbPort (int)(added 4.0.22)

              • MaxSize (int)

              • ContentEncoding (str) "NONE", "UTF_8", "UTF_16", or "UTF_32"

              • AzureDateTimeFormat (str) "LONG_MS_SINCE_EPOCH" or "STRING_AZURE_COMPAT"

            • Agents

              • Id (long)

              • Name (str) (added 4.0.17)
              • Enabled (bool) (added 4.0.17)

              • TagProvider (str)

              • TagPath (str)

              • PushTrigger (str) "EVENT_DRIVEN", "PERIODIC" or "HYBRID"

              • TagPacingPeriod (long)

              • ConvertUdts (bool)

              • PublishUdtDefinitions (bool)

              • OptimizeUdts (bool)

              • AzureSetId (long)

              • GroupId (str)

              • EdgeNodeId (str)

              • DeviceId (str)

              • FilteredProperties (str)

              • SendAllProps (bool)(added 4.0.25)
              • IncludeInfoFolders (bool)(added 4.0.30)
            • Sets

              • Id (long)

              • Name (str)

              • Description (str)

              • PushPolicy (str) "PUSH_TO_ALL" or "PUSH_TO_ANY"

      • Anchor
        updateConfig
        updateConfig
        system.cirruslink.azure.updateConfig(type, id, collisionPolicy, props) → void
        • Parameters
          • Type (str)

            • The type of configuration to update with valid options:

              • "General"
              • "Cert Files"
              • "IoT Hubs"
              • "IoT Edges"
              • "IoT Centrals"
              • "Event Hubs"
              • "Agents"
              • "Sets"
          • Id (long)
            • The ID of the record to update
          • 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" or "Disk_Backed" (added 4.0.17)

                • MessageCapacity (int)(deprecated 4.0.19)

                • HistoryMaxSize (int)(added 4.0.22)
                • HistoryMaxAge (int) (added 4.0.19)

                • FlushPeriod (long)

                • H2dbDirectory (str)(added 4.0.25)
                • H2dbPort (int)(added 4.0.22)

                • 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 Edges

                • 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" or "Disk_Backed" (added 4.0.17)

                • MessageCapacity (int)(deprecated 4.0.19)

                • HistoryMaxSize (int)(added 4.0.22)
                • HistoryMaxAge (int)(added 4.0.19)

                • FlushPeriod (long)

                • H2dbDirectory (str)(added 4.0.25)
                • H2dbPort (int)(added 4.0.22)

                • 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 Centrals
        AnchorupdateConfigupdateConfigsystem.cirruslink.azure.updateConfig(type, id, collisionPolicy, props) → void
        • Parameters
          • String type

            • The type of configuration to update with valid options:

              • General
              • Cert Files
              • IoT Hubs
              • IoT Edge
              • Event Hubs
              • Agents
              • Sets
          • Long id
            • The ID of the record to update
          • String collisionPolicy
            • "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 ScopeId (str)
                • MqttHostname EnrollmentGroupSymmetricKey (str)

                • DeviceId (str)

                • CaCertFileId (long)

                • ClientCertFileId (longGlobalEndpoint (str)ClientPrivateKeyFileId
                • ModelId (longstr)ClientKeyPassword
                • AzureSetId (strlong)
                • HistoryEnabled (bool)
                • HistoryStoreType (str) "In_Memory" or "Disk_Backed" (added 4.0.17)
                • MessageCapacity (intint)(depreacted 4.0.19)
                • HistoryMaxSize (int)(added 4.0.22)
                • HistoryMaxAge (int)(added 4.0.19)
                • FlushPeriod (long)KeepAlive
                • H2dbDirectory (intstr)MaxSize (int(added 4.0.25)
                • Expiration H2dbPort (longint)

                • ContentType (str) "NONE" or "APPLICATION_JSON"

                • (added 4.0.22)
                • MaximumSize (int)ContentEncoding (str) "NONE", "UTF_8", "UTF_16", or "UTF_32"
                • AzureDateTimeFormat (str) "LONG_MS_SINCE_EPOCH" or "STRING_AZURE_COMPAT"

                • CustomTopicExtension (str)

                 IoT Edge
              • Event Hubs

                • Id (long)

                • Name (str)

                • Enabled (str)

                • Protocol (str) "MQTT"

                • AzureSetId (long)

                • MqttServerUrl (str)

                • CertAuthEnabled (bool)

                • ConnectionString (str)

                • CaCertFileId (long)

                • ClientCertFileId (long)

                • ClientPrivateKeyFileId (long)

                • (added 4.0.26)
                • TenantId ClientKeyPassword (str)HostnameVerification (bool(added 4.0.26)
                • MqttHostname AzureServicePrincipalClientId (str)(added 4.0.26)
                • DeviceId EventHubNamespace (str)

                • ModuleIdOption (str) "NONE", "ENVIRONMENT_VARIABLE" or "IGNITION_CONFIG"

                • (added 4.0.26)
                • EventHubName ModuleId (str)HistoryEnabled (bool(added 4.0.26)HistoryStoreType
                • ClientCertFileId (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)

                Event Hubs
                • long)(added 4.0.26)
                • ClientPrivateKeyFileId (long)(added 4.0.26)
                • ClientKeyPassword (str)(added 4.0.26)

                • ConnectionString (str)

                • HistoryEnabled (bool)

                • HistoryStoreType (str) "In_Memory" or "Disk_Backed" (added 4.0.17)

                • MessageCapacity (int)(deprecated 4.0.19)

                • HistoryMaxSize (int)(added 4.0.22)
                • HistoryMaxAge (int)(added 4.0.19)

                • FlushPeriod (long)

                • H2dbDirectory (str)(added 4.0.25)
                • H2dbPort (int)(added 4.0.22)

                • MaxSize (int)

                • ContentEncoding (str) "NONE", "UTF_8", "UTF_16", or "UTF_32"

                • 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)

                • Name (str) (added 4.0.17)
                • Enabled (bool) (added 4.0.17)

                • TagProvider (str)

                • TagPath (str)

                • PushTrigger (str) "EVENT_DRIVEN", "PERIODIC" or "PERIODICHYBRID"

                • TagPacingPeriod (long)

                • ConvertUdts (bool)

                • PublishUdtDefinitions (bool)

                • OptimizeUdts (bool)

                • AzureSetId (long)

                • AutoDiscover (bool)

                • GroupId (str)

                • EdgeNodeId (str)

                • DeviceId (str)

                • FilteredProperties (str)

                • SendAllProps (bool)(added 4.0.25)
                • IncludeInfoFolders (bool)(added 4.0.30)
              • Sets

                • Id (long)

                • Name (str)

                • Description (str)

                • PushPolicy (str) "PUSH_TO_ALL" or "PUSH_TO_ANY"

        • Return Value
          • None

        • Return Value
          • A map representing the updated configuration after it has been written to the database. (added 4.0.16)
      • Anchor
        deleteConfig
        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 Edges"
              • "IoT Centrals"
              • "Event Hubs"
              • "Agents"
              • "Sets"
          • Id (long)Long id
            • The ID of the record to delete
        • Return Value
          • NoneTrue if the record was successfully deleted otherwise False (added 4.0.16)

      Sample Script


      Warning
      Cirrus Link provides these scripts as examples only, they are not supported or guaranteed to meet any particular functionality. Cirrus Link cannot provide any assistance to modify these scripts to meet a particular need.

      ...