Page History

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.

...

Anchor createConfig 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 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)(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 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)MaxSize (int(added 4.0.22)
        Expiration HistoryMaxAge (longint)(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) 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 (longLong)(cannot be null)
        Name (str)
        Enabled (bool)
        ScopeId (str)
        ConnectionString EnrollmentGroupSymmetricKey (str)
        HistoryEnabled GlobalEndpoint (boolstr)
        HistoryStoreType ProvisionedDeviceId (str) "In_Memory"
        MessageCapacity ModelId (intstr)
        FlushPeriod AureSetId (long)(must 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
AnchorreadConfig
- - - - 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"
readConfigsystem.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"
      - 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"
      - CustomTopicExtension (str)
      IoT Edge
      - Agents
        Id (long)(cannot be null)
        Name (str)
        Enabled (str
        (added 4.0.17)
        Protocol
        Enabled (
        str
        bool)
        "MQTT"AzureSetId (long
        (added 4.0.17)
        MqttServerUrl
        TagProvider (str)
        CertAuthEnabled
        TagPath (
        bool
        str)
        ConnectionString
        PushTrigger (str)
        CaCertFileId
        "EVENT_DRIVEN", "PERIODIC" or "HYBRID"
        TagPacingPeriod (long)
        ClientCertFileId
        ConvertUdts (
        long
        bool)
        ClientPrivateKeyFileId
        PublishUdtDefinitions (
        long
        bool)
        ClientKeyPassword
        OptimizeUdts (
        str
        bool)
        HostnameVerification (bool
        AzureSetId (long)(must be included)
        MqttHostname
        GroupId (str)
        DeviceId
        EdgeNodeId (str)
        ModuleIdOption
        DeviceId (str)
        "NONE", "ENVIRONMENT_VARIABLE" or "IGNITION_CONFIG"
        FilteredProperties
        ModuleId
        (str)
        HistoryEnabled
        SendAllProps (bool)
      - HistoryStoreType (str) "In_Memory"
      - MessageCapacity (int)
      - (added 4.0.25)
      - Sets
        Id
        FlushPeriod
        (long)
        KeepAlive
        (
        int
        cannot be null)
        MaxSize
        Name (
        int
        str)
        Expiration
        Description (
        long)ContentType (
        str)
        "NONE" or "APPLICATION_JSON"ContentEncoding
        PushPolicy (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"
    - - 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
      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 CaCertFileId (strlong)
      Sets
      - ClientCertFileId (long)
      - ClientPrivateKeyFileId
      - Id (long)
      - Name ClientKeyPassword (str)
      - Description HistoryEnabled (strbool)
      - PushPolicy HistoryStoreType (str) "PUSHIn_TO_ALLMemory" or "PUSHDisk_TO_ANY"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
      - 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)
    - 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 (str)
        MqttHostname (str)
        DeviceId ScopeId (str)
        CaCertFileId EnrollmentGroupSymmetricKey (longstr)ClientCertFileId
        GlobalEndpoint (longstr)ClientPrivateKeyFileId
        ModelId (longstr)ClientKeyPassword
        AzureSetId (strlong)
        HistoryEnabled (bool)
        HistoryStoreType (str) "In_Memory" or "Disk_Backed" (added 4.0.17)
        MessageCapacity (int)
        FlushPeriod (long)
        (depreacted 4.0.19)
        HistoryMaxSize (int)(added 4.0.22)
        HistoryMaxAge KeepAlive (int)MaxSize (int(added 4.0.19)
        Expiration FlushPeriod (long)ContentType
        H2dbDirectory (str)(added 4.0.25)
        H2dbPort (int)(added 4.0.22)
        MaximumSize (int) "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
      - 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)
        )
        Enabled ClientKeyPassword (str)HostnameVerification
        CertAuthEnabled (bool)
        MqttHostname (str)
        (added 4.0.26)
        TenantId (str)(added 4.0.26)
        AzureServicePrincipalClientId 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
        (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"
        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.17Id (long)
        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)
      - Sets
        Id (long)
        Name (str)
        Description (str)
        PushPolicy (str) "PUSH_TO_ALL" or "PUSH_TO_ANY"
- Return Value
  - NoneA 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.

Code Block

language	py

# Update Certificates
# 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
# Update Certificates
# Get Id for current certificate
savedCerts = system.cirruslink.azure.readConfig("Cert Files")
for config in savedCerts:
  if config["Name"] == "My current cert name":
    certId = config["Id"]

# Read New Cert File
deviceCaCertFilePath = "/path/to/your/certs/iot-edge-device-ca-CA.cert.pem"
deviceCaCert = open(deviceCaCertFilePath, 'r').read()

# Update existing cert config using MergeOverwrite
certProps = {}
certProps["FileContents"] = deviceCaCert
system.cirruslink.azure.updateConfig(“Cert Files”, certId, “MergeOverwrite”, certProps)

...

Contents

Cirrus Link Resources

Inductive Resources

Versions Compared

Old Version 14

New Version Current

Key

Sample Script