Versions Compared

Old Version 25

changes.mady.by.user Gill Houghton

Saved on

compared with

New Version 32

changes.mady.by.user Gill Houghton

Saved on

Key

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

...

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

        • The type of configuration to create with valid options:

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

            • 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)(added 4.0.22)
            • HistoryMaxAge MaxSize (int)(added 4.0.19)

            • FlushPeriod Expiration (long)ContentType

            • H2dbPort (int)(added 4.0.22)

            • KeepAlive (int)

            • MaxSize (int)

            • Expiration (long)

            • ContentType (str) "NONE" 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 (bool)

            • 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 (int)(added 4.0.19)

            • FlushPeriod (long)

            • 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)
            • AureSetId (long)(must be included)
            • 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)MessageCapacity (int)
            • FlushPeriod (long)
            • H2dbPort (int)(added 4.0.22)
            • MaximumSize (int)
            • AzureDateTimeFormat (str) "LONG_MS_SINCE_EPCOH" or "STRING_AZURE_COMPAT"
          • Event Hubs

            • Id (long)

            • Name (str)

            • Enabled (bool)

            • AzureSetId(long)(must be included)

            • ConnectionString (ConnectionString (str)

            • HistoryEnabled (bool)

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

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

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

            • FlushPeriod (long)

            • H2dbPort (int)(added 4.0.22)

            • MaxSize (int)

            • AzureDateTimeFormat (str) "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" or "PERIODIC"

            • TagPacingPeriod (long)

            • ConvertUdts (bool)

            • PublishUdtDefinitions (bool)

            • OptimizeUdts (bool)

            • AzureSetId (long)(must be included)

            • 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
      • A map representing the newly created configuration after it has been written to the database. (added 4.0.16)
  • Anchoranchor
    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 (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)(added 4.0.19)

          • FlushPeriod Expiration (long)ContentType

          • H2dbPort (int)(added 4.0.22)

          • KeepAlive (int)

          • MaxSize (int)

          • Expiration (long)

          • ContentType (str) "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)FlushPeriod (long(deprecated 4.0.19)KeepAlive

          • HistoryMaxSize (int)

          • MaxSize (int)

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

          • FlushPeriod (long)

          • 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"
          • MessageCapacity (int)
          • " 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)
          • 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)

          • ConnectionString (str)

          • HistoryEnabled (bool)

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

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

          • HistoryMaxSize (int)

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

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

          • FlushPeriod (long)

          • H2dbPort (int)(added 4.0.22)

          • 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" or "PERIODIC"

          • TagPacingPeriod (long)

          • ConvertUdts (bool)

          • PublishUdtDefinitions (bool)

          Agents

          • Id (long)

          • TagProvider (str)

          • TagPath (str)

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

          • TagPacingPeriod (long)

          • ConvertUdts (bool)

          • PublishUdtDefinitions (bool)

          • OptimizeUdts (bool)

          • AzureSetId (long)

          • GroupId (str)

          • EdgeNodeId (str)

          • DeviceId (str)

          • FilteredProperties (str)

        • 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)FlushPeriod (long(deprecated 4.0.19)KeepAlive

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

            • FlushPeriod Expiration (long)ContentType

            • H2dbPort (int)(added 4.0.22)

            • KeepAlive (int)

            • MaxSize (int)

            • Expiration (long)

            • ContentType (str) "NONE" or "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

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

            • 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)
            • ModelId (str)
            • AzureSetId (long)

            • 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)(depreacted 4.0.19)

            • FlushPeriod (long)

            • KeepAlive (int)

            • MaxSize (int)

            • Expiration (long)

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

            • HistoryMaxSize (int)(added 4.0.22)
            • HistoryMaxAge (int)(added 4.0.19)
            • FlushPeriod (long)
            • H2dbPort (int)(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)

            • "
          • Event HubsIoT Centrals

            • Id (long)

            • Name (str)

            • Enabled (

              bool)ScopeId (

              str)

            • EnrollmentGroupSymmetricKey

              ConnectionString (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

              Disk_

              AZURE_COMPAT"
            Event Hubs

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

            • H2dbPort (int)(added 4.0.22

            • 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" or "PERIODIC"

            • TagPacingPeriod (long)

            • ConvertUdts (bool)

            • PublishUdtDefinitions (bool)

            • OptimizeUdts (bool)

            • AzureSetId (long)

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

        • The type of configuration to delete with valid options:

          • "Cert Files"
          • "IoT Hubs"
          • "IoT Edges"
          • "IoT Centrals"
          • "Event Hubs"
          • "Agents"
          • "Sets"
      • Id (long)
        • The ID of the record to delete
    • Return Value
      • True 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.

...