PnpConvention.CreateDpsPayload(String) Method

Reference

Definition

Namespace:: Microsoft.Azure.Devices.Provisioning.Client

Assembly:: Microsoft.Azure.Devices.Provisioning.Client.dll

Package:: Microsoft.Azure.Devices.Provisioning.Client v2.0.0-preview002

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Create the DPS payload to provision a device as plug and play.

public static string CreateDpsPayload (string modelId);

static member CreateDpsPayload : string -> string

Public Shared Function CreateDpsPayload (modelId As String) As String

Parameters

modelId: String

The Id of the model the device adheres to for properties, telemetry, and commands.

Returns

String

The DPS payload to provision a device as plug and play.

Remarks

For more information on device provisioning service and plug and play compatibility, and PnP device certification, see https://docs.microsoft.com/azure/iot-pnp/howto-certify-device. The DPS payload should be in the format:

{
  "modelId": "dtmi:com:example:modelName;1"
}

For information on DTDL, see https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v2/dtdlv2.md

Applies to

Dela via