-
Notifications
You must be signed in to change notification settings - Fork 255
/
PnpConvention.xml
64 lines (64 loc) · 3.34 KB
/
PnpConvention.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
<Type Name="PnpConvention" FullName="Microsoft.Azure.Devices.Provisioning.Client.PlugAndPlay.PnpConvention">
<TypeSignature Language="C#" Value="public static class PnpConvention" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit PnpConvention extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Devices.Provisioning.Client.PlugAndPlay.PnpConvention" />
<TypeSignature Language="VB.NET" Value="Public Class PnpConvention" />
<TypeSignature Language="F#" Value="type PnpConvention = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
<AssemblyVersion>1.16.3.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
<AssemblyVersion>1.17.1.0</AssemblyVersion>
<AssemblyVersion>1.18.0.0</AssemblyVersion>
<AssemblyVersion>1.19.0.0</AssemblyVersion>
<AssemblyVersion>1.19.1.0</AssemblyVersion>
<AssemblyVersion>1.19.2.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
A helper class for formatting the DPS device registration payload, per plug and play convention.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="CreateDpsPayload">
<MemberSignature Language="C#" Value="public static string CreateDpsPayload (string modelId);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig string CreateDpsPayload(string modelId) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Provisioning.Client.PlugAndPlay.PnpConvention.CreateDpsPayload(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function CreateDpsPayload (modelId As String) As String" />
<MemberSignature Language="F#" Value="static member CreateDpsPayload : string -> string" Usage="Microsoft.Azure.Devices.Provisioning.Client.PlugAndPlay.PnpConvention.CreateDpsPayload modelId" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
<AssemblyVersion>1.19.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="modelId" Type="System.String" />
</Parameters>
<Docs>
<param name="modelId">The Id of the model the device adheres to for properties, telemetry, and commands.</param>
<summary>
Create the DPS payload to provision a device as plug and play.
</summary>
<returns>The DPS payload to provision a device as plug and play.</returns>
<remarks>
For more information on device provisioning service and plug and play compatibility,
and PnP device certification, see <see href="https://docs.microsoft.com/azure/iot-pnp/howto-certify-device" />.
The DPS payload should be in the format:
<c>
{
"modelId": "dtmi:com:example:modelName;1"
}
</c>
For information on DTDL, see <see href="https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v2/dtdlv2.md" /></remarks>
</Docs>
</Member>
</Members>
</Type>