UPDATE_STRING_PROPERTY

Retrieve the value of a given property (by name) for a given instance of a given model. This function is intended for updates of properties outside of this current model. If you intend on updating a property of your current model, use UPDATE_STRING_RTDT_PROPERTY instead.

Usage

UPDATE_STRING_PROPERTY(providerType, modelId, instanceId, propertyName, newValue)

Parameters

providerType	String	The type of provider (e.g ‘AzureDT’)
modelId	String	The full ID of the model
instanceId	String	The ID of the instance you are updating a property for
propertyName	String	The fully qualified name of the property (see remarks)
newValue	String	The new value to assign to the property

Returns

Action

Examples

UPDATE_STRING_PROPERTY(‘AzureDT’, ‘dtmi:mycompany:mymodel;1’, ‘instance3’, ‘/namespace/Property1’, ‘This is a new value’)

No return value

Remarks

1. This function only updates actual values when executed in a real deployment. In the test environment, it is effectively a no-op instruction.

2. This function is intended for updates of properties outside of this current model. When specifying the name of the property to update, you will need the fully qualified name, using the component name. For instance, if the property you need to act on is in an Azure DT model whose component is named ‘myComponent’, then the property name will be ‘/myComponent/propertyName’