Configuration

[AddOrUpdateEndpoints](./directmethods.md#addorupdateendpoints_v1)

Add or update endpoint configuration and nodes on a server. Further information is provided in the OPC Publisher documentation.

patch/v2/configuration

Request body

Versioninteger

Version number of the entry

LastChangeTimespanstring date-time

Last change to the entry

DataSetWriterIdstring

Name of the data set writer.

DataSetWriterGroupstring

The Group the writer belongs to.

DataSetClassIdstring uuid

A dataset class id.

DataSetNamestring

The optional short name of the dataset.

DataSetPublishingIntervalinteger

The Publishing interval for a dataset writer in miliseconds.

DataSetPublishingIntervalTimespanstring date-span

The Publishing interval for a dataset writer in timespan format. Takes precedence over Azure.IIoT.OpcUa.Publisher.Models.PublishedNodesEntryModel.DataSetPublishingInterval if defined.

DataSetKeyFrameCountinteger

Insert a key frame every x messages

MetaDataUpdateTimeinteger

Send metadata at the configured interval even when not changing expressed in milliseconds.

MetaDataUpdateTimeTimespanstring date-span

Send metadata at the configured interval even when not changing expressed as duration. Takes precedence over Azure.IIoT.OpcUa.Publisher.Models.PublishedNodesEntryModel.MetaDataUpdateTimeif defined.

EndpointUrlstring

The endpoint URL of the OPC UA server.

MaxKeepAliveCountinteger

When the publishing timer has expired this number of times without requiring any Notification to be sent, to the writer a keep-alive message is sent.

DataSetDescriptionstring

The optional description of the dataset.

Priorityinteger

Priority of the writer subscription.

MessagingMode'PubSub' | 'Samples' | 'FullNetworkMessages' | 'FullSamples' | 'DataSetMessages' | 'RawDataSets' int32

Message modes

MessageEncoding'Binary' | 'Json' | 'Xml' | 'IsReversible' | 'Uadp' | 'JsonReversible' | 'IsGzipCompressed' | 'JsonGzip' | 'JsonReversibleGzip' int32

Message encoding

BatchSizeinteger

Send network messages when the notification queue exceeds this number. Causes this many notifications to be added to network messages

BatchTriggerIntervalinteger

Send network messages at the specified publishing interval.

BatchTriggerIntervalTimespanstring date-span

Send network messages at the specified publishing interval. Takes precedence over Azure.IIoT.OpcUa.Publisher.Models.PublishedNodesEntryModel.BatchTriggerInterval if defined.

WriterGroupTransport'IoTHub' | 'Mqtt' | 'Dapr' | 'Http' | 'FileSystem' int32

Desired writer group transport

UseSecurityboolean

Secure transport should be used to connect to the opc server.

OpcAuthenticationMode'Anonymous' | 'UsernamePassword' int32

Enum that defines the authentication method

EncryptedAuthUsernamestring

encrypted username

EncryptedAuthPasswordstring

encrypted password

OpcAuthenticationUsernamestring

plain username

OpcAuthenticationPasswordstring

plain password

Response

Success

PublishedNodesResponseModel required

PublishNodes direct method response

Changes