Versions Compared

Old Version 33

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.

...

  • 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)(cannot be null)

            • 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)(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)(cannot be null)

            • 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)(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)(cannot be null)
            • 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)
            • 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)

            • ConnectionString (str)

            • HistoryEnabled CertAuthEnabled (bool)HistoryStoreType (str) "In_Memory" or "Disk_Backed" (added 4.0.1726)
            • MessageCapacity TenantId (intstr)(deprecated added 4.0.1926)
            • HistoryMaxSize AzureServicePrincipalClientId (intstr)(added 4.0.2226)
            • HistoryMaxAge EventHubNamespace (intstr)(added 4.0.1926)
            • FlushPeriod EventHubName (long)H2dbDirectory (str)(added 4.0.2526)
            • H2dbPort ClientCertFileId (intlong)(added 4.0.2226)

            • MaxSize (int)

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

            Agents

            • Id (long)

            • Name (strClientPrivateKeyFileId (long)(added 4.0.1726)
            • Enabled ClientKeyPassword (boolstr)(added 4.0.1726)

            • TagProvider ConnectionString (str)

            • TagPath HistoryEnabled (strbool)

            • PushTrigger HistoryStoreType (str) "EVENTIn_DRIVENMemory" or "PERIODIC"

            • TagPacingPeriod (long)

            • ConvertUdts (bool)

            • PublishUdtDefinitions (bool)

            • OptimizeUdts (bool)

            • AzureSetId (long)(must be included)

            • GroupId (str)

            • EdgeNodeId (str)

            • DeviceId (str)

            • FilteredProperties (str)

            • 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 (intSendAllProps (bool)(added 4.0.2522)
            Sets

            • Id MaxSize (longint)Name

            • ContentEncoding (str)

            • Description (str)

            • "NONE", "UTF_8", "UTF_16", or "UTF_32"

            • AzureDateTimeFormat PushPolicy (str) "PUSHLONG_MS_TOSINCE_ALLEPOCH" or "PUSHSTRING_TOAZURE_ANYCOMPAT"

      Return Value
          • Agents

            • Id (long)(cannot be null)

            • Name (str)
      • A map representing the newly created configuration after it has been written to the database.
            • (added 4.0.
        16
            • 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)
          • 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 (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

    AnchorreadConfigreadConfigsystem.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)(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", "ENVIRONMENTUTF_VARIABLE" 8", "UTF_16", or "IGNITIONUTF_CONFIG32"

          • ModuleId AzureDateTimeFormat (str)

          • HistoryEnabled (bool)

          • HistoryStoreType (str) "In_Memory"LONG_MS_SINCE_EPOCH" or "DiskSTRING_AZURE_BackedCOMPAT" (added 4.0.17)

          • 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

          • 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", ENVIRONMENT_VARIABLE" or "UTFIGNITION_32"CONFIG"

          • ModuleId (str)

          • HistoryEnabled (bool)

          • HistoryStoreType AzureDateTimeFormat (str) "LONG_MS_SINCE_EPOCHIn_Memory" or "STRINGDisk_AZURE_COMPATBacked"

          • CustomTopicExtension (str)

          IoT Centrals

          • (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)(
          • 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.1722)MessageCapacity

          • KeepAlive (int

            )(deprecated 4.0.19

            )

            HistoryMaxSize

          • MaxSize (int)

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

          • Expiration

            FlushPeriod

            (long)

            H2dbDirectory

          • ContentType (str)

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

          • "NONE" or "APPLICATION_JSON"

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

            MaximumSize (int)

          • AzureDateTimeFormat (str) "LONG_MS_SINCE_

            EPOCK

            EPOCH" or "STRING_AZURE_COMPAT"

          • CustomTopicExtension (str)

        • IoT CentralsEvent Hubs
          • Id (long)
          • Name (str)
          • Enabled (strbool)
          • ConnectionString 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)
          • MaxSize MaximumSize (int)
          • AzureDateTimeFormat (str) "LONG_MS_SINCE_EPOCHEPOCK" or "STRING_AZURE_COMPAT"
          Agents
        • Event Hubs

          • Id (long)

          • Name (str)

          • Enabled (str)

          • CertAuthEnabled (bool)(added 4.0.1726)
          • Enabled TenantId (boolstr)(added 4.0.1726)
          • TagProvider AzureServicePrincipalClientId (str)TagPath (str(added 4.0.26)
          • PushTrigger EventHubNamespace (str) "EVENT_DRIVEN" or "PERIODIC"

          • TagPacingPeriod (long)

          • ConvertUdts (bool)

          • PublishUdtDefinitions (bool)

          • OptimizeUdts (bool)

          • AzureSetId (long)

          • GroupId (str)

          • EdgeNodeId (str)

          • DeviceId (str)

          • FilteredProperties (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" (

            SendAllProps (bool)(

            added 4.0.

            25

            17)

        • Sets

          • Id (long)

          • Name (str)

          • Description (str)

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

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

            • MqttServerUrl (str)

            • CertAuthEnabled (bool)

            • ConnectionString (str)

            • CaCertFileId (long)

            • ClientCertFileId (long)

            • ClientPrivateKeyFileId (long)

            • MqttHostname ClientKeyPassword (str)

            • HostnameVerification (bool)

            • DeviceId MqttHostname (str)

            • CaCertFileId DeviceId (longstr)

            • ClientCertFileId ModuleIdOption (long)

            • ClientPrivateKeyFileId (long)

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

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

            • "

            • 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)(deprecated depreacted 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"MaximumSize (int)
            • AzureDateTimeFormat (str) "LONG_MS_SINCE_EPOCH" or "STRING_AZURE_COMPAT"

            • CustomTopicExtension (str)

          • Event Hubs
              IoT Centrals

              • Id (long)

              • Name (str)

              • Enabled

                (bool)ScopeId

                (str

                )
              • EnrollmentGroupSymmetricKey (str)
              • GlobalEndpoint (str)
              • ModelId (str)
              • AzureSetId (long)
              • HistoryEnabled (bool)
              • HistoryStoreType (str) "In_Memory" or "Disk_Backed" (added 4.0.17)

              • )

              • CertAuthEnabled (bool)(added MessageCapacity (int)(depreacted 4.0.1926)
              • HistoryMaxSize TenantId (intstr)(added 4.0.2226)
              • HistoryMaxAge AzureServicePrincipalClientId (intstr)(added 4.0.1926)
              • FlushPeriod (long)
              • H2dbDirectory EventHubNamespace (str)(added 4.0.2526)
              • H2dbPort EventHubName (intstr)(added 4.0.22)
              • MaximumSize (int)
              • AzureDateTimeFormat (str) "LONG_MS_SINCE_EPOCH" or "STRING_AZURE_COMPAT"
              Event Hubs
              • 26)
              • ClientCertFileId (long)(added 4.0.26)
              • ClientPrivateKeyFileId (long)(added 4.0.26)
              • ClientKeyPassword (str)(added 4.0.26

              • Id (long)

              • Name (str)

              • Enabled (str)

              • 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 "PERIODICHYBRID"

              • TagPacingPeriod (long)

              • ConvertUdts (bool)

              • PublishUdtDefinitions (bool)

              • OptimizeUdts (bool)

              • AzureSetId (long)

              • GroupId (str)

              • EdgeNodeId (str)

              • DeviceId (str)

              • FilteredProperties (str)

              • SendAllProps (bool)(added 4.0.25)
            • 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)

    ...