Page History

The following API calls are available for the Azure Injector Module and can be executed within any of the

...

available Ignition scopes.

`APIs`

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"
        MessageCapacity (int)
        FlushPeriod (long)
        KeepAlive (int)
        MaxSize (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 Expiration (long)ContentType
        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" 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)
        MaxSize HistoryMaxAge (int)(added 4.0.19)
        Expiration 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)
        ConnectionString ScopeId (str)
        EnrollmentGroupSymmetricKey (str)
        GlobalEndpoint (strHistoryEnabled (bool)
        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)
      - 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
        Sets
        Id (long)
        Name (str)
        Description Enabled (strbool)
        PushPolicy (str) "PUSH_TO_ALL" or "PUSH_TO_ANY"
- Return Value
  - None
AnchorreadConfig
- - - - 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) (added 4.0.17)
        Enabled (bool) (added 4.0.17)
        TagProvider (str)
        TagPath (str)
        Protocol
        PushTrigger (str) "
        MQTT
        EVENT_DRIVEN", "PERIODIC" or "HYBRID"
        AzureSetId
        TagPacingPeriod (long)
        MqttServerUrl
        ConvertUdts (
        str
        bool)
        CertAuthEnabled
        PublishUdtDefinitions (bool)
        ConnectionString
        OptimizeUdts (
        str
        bool)
        CaCertFileId
        AzureSetId (long)
      - ClientCertFileId (long)
      - ClientPrivateKeyFileId (long)
      - (must be included)
        GroupId (str)
        EdgeNodeId (str)
        DeviceId (str)
        FilteredProperties
        ClientKeyPassword
        (str)
        HostnameVerification
        SendAllProps (bool
        )
        )(added 4.0.25)
      - Sets
        Id (long)(cannot be null)
        Name
        MqttHostname
        (str)
        DeviceId
        Description (str)
        ModuleIdOption
        PushPolicy (str) "
        NONE", "ENVIRONMENT_VARIABLE
        PUSH_TO_ALL" or "
        IGNITION
        PUSH_TO_
        CONFIG
        ANY"
      - 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)
- 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:
    - GeneralEvent Hubs
      - Id (long)
      - Name Enabled (strbool)
    - Cert Files
      - Enabled Name (str)
      - ConnectionString FileName (str)
      - HistoryEnabled FileContents (boolstr)
      - HistoryStoreType Description (str) "In_Memory"
    - IoT Hubs
      - Id (long)
      - Name (str)
      - Enabled (str)
      - Protocol
      - MessageCapacity (int)
      - FlushPeriod (long)
      - MaxSize (int)
      - AzureDateTimeFormat (str) "LONG_MS_SINCE_EPOCH" or "STRING_AZURE_COMPAT"
      Agents
      - MQTT"
      - AzureSetId (long)
      - CertAuthEnabled (bool)
      - ConnectionString
      - Id (long)
      - TagProvider (str)
      - TagPath MqttHostname (str)
      - PushTrigger DeviceId (str) "EVENT_DRIVEN" or "PERIODIC"
      - CaCertFileId TagPacingPeriod (long)
      - ConvertUdts ClientCertFileId (boollong)
      - PublishUdtDefinitions ClientPrivateKeyFileId (boollong)
      - OptimizeUdts ClientKeyPassword (boolstr)
      - AzureSetId HistoryEnabled (longbool)
      - AutoDiscover HistoryStoreType (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"
AnchorupdateConfigupdateConfigsystem.cirruslink.azure.
- - - - 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)
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)
      - DeviceId (str)
        CaCertFileId
      - ModuleIdOption (str) "NONE", "ENVIRONMENT_VARIABLE" or "IGNITION_CONFIG"
      - ModuleId
        long)
      - ClientCertFileId (long)
      - ClientPrivateKeyFileId (long)
      - 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
      - MaxSize (int)
      - ContentType 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"
        ) "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
    - IoT Centrals
      - Id (long)
      - Name (str)
      - Enabled (strbool)
      - Protocol ScopeId (str) "MQTT"
      - AzureSetId EnrollmentGroupSymmetricKey (longstr)
      - MqttServerUrl GlobalEndpoint (str)
      - CertAuthEnabled ProvisionedDeviceId (boolstr)
      - ConnectionString ModelId (str)
      - CaCertFileId (long)
      - ClientCertFileId (long)
      - ClientPrivateKeyFileId (long)
      - HostnameVerification HistoryEnabled (bool)
      - MqttHostname HistoryStoreType (str)
      - DeviceId (str)
      - ModuleId (str)
      - HistoryEnabled (bool)
      - HistoryStoreType (str) "In_Memory"
      - MessageCapacity (int)
      - FlushPeriod (long)
      - KeepAlive (int)
      - MaxSize (int)
      - Expiration (long)
      - ContentType (str) "NONE" or "APPLICATION_JSON"
      - 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_EPOCHEPOCK" or "STRING_AZURE_COMPAT"CustomTopicExtension (str)
    - Event Hubs
      - Id (long)
      - Name (str)
      - Enabled (str)
        ConnectionString (
      - CertAuthEnabled (bool)(added 4.0.26)
      - TenantId (str)HistoryEnabled (bool(added 4.0.26)
      - HistoryStoreType AzureServicePrincipalClientId (str) "In_Memory"
      - MessageCapacity (int)
      - FlushPeriod (long)
      - MaxSize (int)
      - AzureDateTimeFormat (str) "LONG_MS_SINCE_EPOCH" or "STRING_AZURE_COMPAT"
      - Agents
        Id (long)
        TagProvider (str)
        TagPath (str)
        PushTrigger (str) "EVENT_DRIVEN" or "PERIODIC"
        TagPacingPeriod (long)
        ConvertUdts (bool)
        PublishUdtDefinitions (bool)
        OptimizeUdts (bool)
        AzureSetId (long)
        AutoDiscover (bool)
        GroupId (str)
        EdgeNodeId (str)
        DeviceId (str)
        FilteredProperties (str)
      - Sets
        Id (long)
        Name (str)
        Description (str)
        PushPolicy (str) "PUSH_TO_ALL" or "PUSH_TO_ANY"
- Return Value
  - None
AnchordeleteConfigdeleteConfigsystem.cirruslink.azure.deleteConfig(type, id) → void
Parameters
- String type
  - The type of configuration to delete with valid options:
    - Cert Files
    - IoT Hubs
    - IoT Edge
    - Event Hubs
    - Agents
    - Sets
- Long id
  - The ID of the record to delete

Return Value

None

- - - (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
        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)
        MessageCapacity (int)(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)
        MaximumSize (int)
        AzureDateTimeFormat (str) "LONG_MS_SINCE_EPOCH" 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"
- 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.

Code Block

language	py

# 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 7

New Version 36

Key

`APIs`

Sample Script