Writer

GetDataSetWriterEntry

Get the published nodes entry for a specific writer group and dataset writer. Dedicated errors are returned if no, or no unique entry could be found. The entry does not contain the nodes. Nodes can be retrieved using the GetNodes API.

get/v2/writer/{dataSetWriterGroup}/{dataSetWriterId}

Path parameters

dataSetWriterGroupstring required

The writer group name of the entry

dataSetWriterIdstring required

The data set writer identifer of the entry

Response

The item was found

Versioninteger

Version number of the entry

LastChangeDateTimestring 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.

SendKeepAliveDataSetMessagesboolean

Send a keep alive message when a subscription keep alive notification is received inside the writer. If keep alive messages are not supported by the messaging profile chosen this value is ignored.

EndpointUrlstring required

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.

DataSetExtensionFieldsobject

Optional field and value pairs to insert into the data sets emitted by data set writer.

EndpointSecurityMode'Best' | 'Sign' | 'SignAndEncrypt' | 'None' | 'NotNone'

Security mode of endpoint

EndpointSecurityPolicystring

The specific security policy to use for the specified endpoint. Overrides Azure.IIoT.OpcUa.Publisher.Models.PublishedNodesEntryModel.UseSecurity setting. If the security policy is not available with the specified security mode connectivity will fail.

MessagingMode'PubSub' | 'Samples' | 'FullNetworkMessages' | 'FullSamples' | 'DataSetMessages' | 'SingleDataSetMessage' | 'DataSets' | 'SingleDataSet' | 'RawDataSets' | 'SingleRawDataSet'

Message modes

MessageEncoding'Uadp' | 'Json' | 'Xml' | 'Avro' | 'IsReversible' | 'JsonReversible' | 'IsGzipCompressed' | 'JsonGzip' | 'AvroGzip' | 'JsonReversibleGzip'

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.

UseReverseConnectboolean

Use reverse connect to connect ot the endpoint

DataSetRouting'None' | 'UseBrowseNames' | 'UseBrowseNamesWithNamespaceIndex'

Data set routing

WriterGroupQueueNamestring

Writer group queue overrides the default writer group topic template to use.

WriterGroupQualityOfService'AtMostOnce' | 'AtLeastOnce' | 'ExactlyOnce'
WriterGroupTransport'IoTHub' | 'Mqtt' | 'EventHub' | 'Dapr' | 'Http' | 'FileSystem' | 'Null'

Desired writer group transport

UseSecurityboolean

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

OpcAuthenticationMode'Anonymous' | 'UsernamePassword' | 'Certificate'

Enum that defines the authentication method

EncryptedAuthUsernamestring

encrypted username

EncryptedAuthPasswordstring

encrypted password

OpcAuthenticationUsernamestring

plain username

OpcAuthenticationPasswordstring

plain password

QueueNamestring

Writer queue overrides the writer group queue name. Network messages are then split across queues with Qos also accounted for.

MetaDataQueueNamestring

Meta data queue name to use for the writer. Overrides the default metadata topic template.

QualityOfService'AtMostOnce' | 'AtLeastOnce' | 'ExactlyOnce'
WriterGroupPartitionsinteger

Number of partitions to split the writer group into when publishing to target topics.

DisableSubscriptionTransferboolean

Disable subscription transfer on reconnect

RepublishAfterTransferboolean

Republish after transferring the subscription during reconnect handling unless subscription transfer was disabled.

OpcNodeWatchdogTimespanstring date-span

The timeout to use to monitor the monitored items in the subscription are continously reporting fresh data.

DataSetWriterWatchdogBehavior'Diagnostic' | 'Reset' | 'FailFast' | 'ExitProcess'

Subscription watchdog behavior

OpcNodeWatchdogCondition'WhenAllAreLate' | 'WhenAnyIsLate'

Monitored item watchdog condition

DataSetSamplingIntervalinteger

The default sampling interval for all items in a dataset writer in miliseconds if the nodes do not specify a sampling rate.

DataSetSamplingIntervalTimespanstring date-span

The Sampling interval for the nodes in the dataset writer in timespan format. Takes precedence over Azure.IIoT.OpcUa.Publisher.Models.PublishedNodesEntryModel.DataSetSamplingInterval if defined.

DataSetFetchDisplayNamesboolean

Whether to fetch the display name and use it as data set id for all opc node items in the data set

WriterGroupMessageTtlTimepanstring date-span

Default time to live for messages sent through the writer group if the transport supports it.

WriterGroupMessageRetentionboolean

Default message retention setting for messages sent through the writer group if the transport supports it.

MessageTtlTimespanstring date-span

Message time to live for messages sent by the writer if the transport supports it.

MessageRetentionboolean

Message retention setting for messages sent by the writer if the transport supports it.

DefaultHeartbeatIntervalinteger

Default heartbeat interval in milliseconds

DefaultHeartbeatIntervalTimespanstring date-span

Default heartbeat interval for all nodes as duration. Takes precedence over Azure.IIoT.OpcUa.Publisher.Models.PublishedNodesEntryModel.DefaultHeartbeatInterval if defined.

DefaultHeartbeatBehavior'WatchdogLKV' | 'WatchdogLKG' | 'PeriodicLKV' | 'PeriodicLKG' | 'WatchdogLKVWithUpdatedTimestamps' | 'WatchdogLKVDiagnosticsOnly'

Heartbeat behavior

DumpConnectionDiagnosticsboolean

Dump server diagnostics for the connection to enable advanced troubleshooting scenarios.

Changes