-
Notifications
You must be signed in to change notification settings - Fork 255
/
BulkEnrollmentOperationError.xml
157 lines (157 loc) · 8.49 KB
/
BulkEnrollmentOperationError.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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
<Type Name="BulkEnrollmentOperationError" FullName="Microsoft.Azure.Devices.Provisioning.Service.BulkEnrollmentOperationError">
<TypeSignature Language="C#" Value="public class BulkEnrollmentOperationError" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit BulkEnrollmentOperationError extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Devices.Provisioning.Service.BulkEnrollmentOperationError" />
<TypeSignature Language="VB.NET" Value="Public Class BulkEnrollmentOperationError" />
<TypeSignature Language="F#" Value="type BulkEnrollmentOperationError = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Service</AssemblyName>
<AssemblyVersion>1.16.3.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
<AssemblyVersion>1.17.1.0</AssemblyVersion>
<AssemblyVersion>1.17.2.0</AssemblyVersion>
<AssemblyVersion>1.18.0.0</AssemblyVersion>
<AssemblyVersion>1.18.1.0</AssemblyVersion>
<AssemblyVersion>1.18.2.0</AssemblyVersion>
<AssemblyVersion>1.19.0.0</AssemblyVersion>
<AssemblyVersion>1.19.1.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Representation of a single Device Provisioning Service device registration operation error.
</summary>
<remarks>
This error is returned as a result of the
<see cref="M:Microsoft.Azure.Devices.Provisioning.Service.IndividualEnrollmentsClient.RunBulkOperationAsync(Microsoft.Azure.Devices.Provisioning.Service.BulkOperationMode,System.Collections.Generic.IEnumerable{Microsoft.Azure.Devices.Provisioning.Service.IndividualEnrollment},System.Threading.CancellationToken)" />
as part of the <see cref="T:Microsoft.Azure.Devices.Provisioning.Service.BulkEnrollmentOperationResult" />.
</remarks>
<example>
The following JSON is an example of a single error operation from a Bulk operation
<code>
{
"registrationId":"validRegistrationId1",
"errorCode":200,
"errorStatus":"Succeeded"
}
</code></example>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public BulkEnrollmentOperationError ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Provisioning.Service.BulkEnrollmentOperationError.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Service</AssemblyName>
<AssemblyVersion>1.18.1.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ErrorCode">
<MemberSignature Language="C#" Value="public int? ErrorCode { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> ErrorCode" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Provisioning.Service.BulkEnrollmentOperationError.ErrorCode" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ErrorCode As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.ErrorCode : Nullable<int>" Usage="Microsoft.Azure.Devices.Provisioning.Service.BulkEnrollmentOperationError.ErrorCode" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Service</AssemblyName>
<AssemblyVersion>1.18.1.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(DefaultValueHandling=Newtonsoft.Json.DefaultValueHandling.Ignore, PropertyName="errorCode")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(DefaultValueHandling=Newtonsoft.Json.DefaultValueHandling.Ignore, PropertyName="errorCode")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
Error code.
</summary>
<value>To be added.</value>
<remarks>
Report any error during the operation for the specific registrationId.
</remarks>
</Docs>
</Member>
<Member MemberName="ErrorStatus">
<MemberSignature Language="C#" Value="public string ErrorStatus { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ErrorStatus" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Provisioning.Service.BulkEnrollmentOperationError.ErrorStatus" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ErrorStatus As String" />
<MemberSignature Language="F#" Value="member this.ErrorStatus : string" Usage="Microsoft.Azure.Devices.Provisioning.Service.BulkEnrollmentOperationError.ErrorStatus" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Service</AssemblyName>
<AssemblyVersion>1.18.1.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(DefaultValueHandling=Newtonsoft.Json.DefaultValueHandling.Ignore, PropertyName="errorStatus")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(DefaultValueHandling=Newtonsoft.Json.DefaultValueHandling.Ignore, PropertyName="errorStatus")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Error status.
</summary>
<value>To be added.</value>
<remarks>
Describe any error during the operation for the specific registrationId.
</remarks>
</Docs>
</Member>
<Member MemberName="RegistrationId">
<MemberSignature Language="C#" Value="public string RegistrationId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string RegistrationId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Provisioning.Service.BulkEnrollmentOperationError.RegistrationId" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property RegistrationId As String" />
<MemberSignature Language="F#" Value="member this.RegistrationId : string" Usage="Microsoft.Azure.Devices.Provisioning.Service.BulkEnrollmentOperationError.RegistrationId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Service</AssemblyName>
<AssemblyVersion>1.18.1.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="registrationId", Required=Newtonsoft.Json.Required.Always)]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="registrationId", Required=Newtonsoft.Json.Required.Always)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Registration Id.
</summary>
<value>To be added.</value>
<remarks>
A valid registration Id shall be alphanumeric, lowercase, and may contain hyphens. Max characters 128.
</remarks>
<exception cref="T:System.ArgumentException">if the provided string does not fit the registration Id requirements</exception>
<exception cref="T:System.InvalidOperationException">If the provided registrationId does not fit the registration Id requirements</exception>
</Docs>
</Member>
</Members>
</Type>