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

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' int32

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' | 'RawDataSets' | 'SingleRawDataSet' 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.

UseReverseConnectboolean

Use reverse connect to connect ot the endpoint

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

Data set routing

WriterGroupQueueNamestring

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

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

Desired writer group transport

UseSecurityboolean

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

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

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' int32
WriterGroupPartitionsinteger

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

Response

Success

PublishedNodesResponseModel required

PublishNodes direct method response

Changes