-
Notifications
You must be signed in to change notification settings - Fork 241
/
com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.yml
423 lines (423 loc) · 43.4 KB
/
com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.yml
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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
### YamlMime:JavaType
uid: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup"
fullName: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup"
name: "EnrollmentGroup"
nameWithType: "EnrollmentGroup"
summary: "Representation of a single Device Provisioning Service enrollment group with a JSON serializer and deserializer."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.sdk.iot.provisioning.service.configs.Serializable?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"com.microsoft.azure.sdk.iot.provisioning.service.configs.Serializable?alt=com.microsoft.azure.sdk.iot.provisioning.service.configs.Serializable&text=Serializable\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"com.microsoft.azure.sdk.iot.provisioning.service.configs.Serializable.toJson()?alt=com.microsoft.azure.sdk.iot.provisioning.service.configs.Serializable.toJson&text=toJson\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.sdk.iot.provisioning.service.configs.Serializable.toJsonElement()?alt=com.microsoft.azure.sdk.iot.provisioning.service.configs.Serializable.toJsonElement&text=toJsonElement\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.sdk.iot.provisioning.service.configs.Serializable.toString()?alt=com.microsoft.azure.sdk.iot.provisioning.service.configs.Serializable.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
syntax: "public class **EnrollmentGroup**</br> extends <xref href=\"com.microsoft.azure.sdk.iot.provisioning.service.configs.Serializable?alt=com.microsoft.azure.sdk.iot.provisioning.service.configs.Serializable&text=Serializable\" data-throw-if-not-resolved=\"False\" />"
constructors:
- uid: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.EnrollmentGroup(java.lang.String)"
fullName: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.EnrollmentGroup(String json)"
name: "EnrollmentGroup(String json)"
nameWithType: "EnrollmentGroup.EnrollmentGroup(String json)"
summary: "CONSTRUCTOR"
parameters:
- description: "the <code>String</code> with the JSON received from the provisioning service."
name: "json"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public EnrollmentGroup(String json)"
desc: "CONSTRUCTOR\n\nThis constructor creates an instance of the enrollment group filling the class with the information provided in the JSON.\n\nThe following JSON is a sample of the EnrollmentGroup response, received from the provisioning service.\n\n```java\n{\n \"enrollmentGroupId\":\"validEnrollmentGroupId\",\n \"attestation\":{\n \"type\":\"x509\",\n \"signingCertificates\":{\n \"primary\":{\n \"certificate\":\"[valid certificate]\",\n \"info\": {\n \"subjectName\": \"CN=ROOT_00000000-0000-0000-0000-000000000000, OU=Azure IoT, O=MSFT, C=US\",\n \"sha1Thumbprint\": \"0000000000000000000000000000000000\",\n \"sha256Thumbprint\": \"validEnrollmentGroupId\",\n \"issuerName\": \"CN=ROOT_00000000-0000-0000-0000-000000000000, OU=Azure IoT, O=MSFT, C=US\",\n \"notBeforeUtc\": \"2017-11-14T12:34:18Z\",\n \"notAfterUtc\": \"2017-11-20T12:34:18Z\",\n \"serialNumber\": \"000000000000000000\",\n \"version\": 3\n }\n }\n }\n },\n \"iotHubHostName\":\"ContosoIoTHub.azure-devices.net\",\n \"provisioningStatus\":\"enabled\"\n \"createdDateTimeUtc\": \"2017-09-28T16:29:42.3447817Z\",\n \"lastUpdatedDateTimeUtc\": \"2017-09-28T16:29:42.3447817Z\",\n \"etag\": \"\\\"00000000-0000-0000-0000-00000000000\\\"\"\n }\n```"
- uid: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.EnrollmentGroup(java.lang.String,com.microsoft.azure.sdk.iot.provisioning.service.configs.Attestation)"
fullName: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.EnrollmentGroup(String enrollmentGroupId, Attestation attestation)"
name: "EnrollmentGroup(String enrollmentGroupId, Attestation attestation)"
nameWithType: "EnrollmentGroup.EnrollmentGroup(String enrollmentGroupId, Attestation attestation)"
summary: "CONSTRUCTOR"
parameters:
- description: "the <code>String</code> with an unique id for this enrollment group."
name: "enrollmentGroupId"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the <xref uid=\"com.microsoft.azure.sdk.iot.provisioning.service.configs.Attestation\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Attestation\"></xref> mechanism that shall be <code>signedCertificate</code> of <xref uid=\"com.microsoft.azure.sdk.iot.provisioning.service.configs.X509Attestation\" data-throw-if-not-resolved=\"false\" data-raw-source=\"X509Attestation\"></xref> or <code>symmetricKey</code> of <xref uid=\"com.microsoft.azure.sdk.iot.provisioning.service.configs.SymmetricKeyAttestation\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SymmetricKeyAttestation\"></xref>"
name: "attestation"
type: "<xref href=\"com.microsoft.azure.sdk.iot.provisioning.service.configs.Attestation?alt=com.microsoft.azure.sdk.iot.provisioning.service.configs.Attestation&text=Attestation\" data-throw-if-not-resolved=\"False\" />"
syntax: "public EnrollmentGroup(String enrollmentGroupId, Attestation attestation)"
desc: "CONSTRUCTOR\n\nThis constructor creates an instance of the enrollment group with the minimum set of information required by the provisioning service.\n\nWhen serialized, an EnrollmentGroup will look like the following example:\n\n```java\n{\n \"enrollmentGroupId\":\"validEnrollmentGroupId\",\n \"attestation\":{\n \"type\":\"x509\",\n \"signingCertificates\":{\n \"primary\":{\n \"certificate\":\"[valid certificate]\"\n }\n }\n }\n }\n```"
methods:
- uid: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.getAllocationPolicy()"
fullName: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.getAllocationPolicy()"
name: "getAllocationPolicy()"
nameWithType: "EnrollmentGroup.getAllocationPolicy()"
summary: "Getter for the allocation policy."
syntax: "public AllocationPolicy getAllocationPolicy()"
desc: "Getter for the allocation policy."
returns:
description: "The <code>AllocationPolicy</code> with the allocationPolicy content."
type: "<xref href=\"com.microsoft.azure.sdk.iot.provisioning.service.configs.AllocationPolicy?alt=com.microsoft.azure.sdk.iot.provisioning.service.configs.AllocationPolicy&text=AllocationPolicy\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.getAttestation()"
fullName: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.getAttestation()"
name: "getAttestation()"
nameWithType: "EnrollmentGroup.getAttestation()"
summary: "Getter for the attestation mechanism."
syntax: "public Attestation getAttestation()"
exceptions:
- description: "If the type of the attestation mechanism is unknown."
type: "<xref href=\"com.microsoft.azure.sdk.iot.provisioning.service.exceptions.ProvisioningServiceClientException?alt=com.microsoft.azure.sdk.iot.provisioning.service.exceptions.ProvisioningServiceClientException&text=ProvisioningServiceClientException\" data-throw-if-not-resolved=\"False\" />"
desc: "Getter for the attestation mechanism."
returns:
description: "The <code>Attestation</code> with the attestation content. It cannot be <code>null</code>."
type: "<xref href=\"com.microsoft.azure.sdk.iot.provisioning.service.configs.Attestation?alt=com.microsoft.azure.sdk.iot.provisioning.service.configs.Attestation&text=Attestation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.getCapabilities()"
fullName: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.getCapabilities()"
name: "getCapabilities()"
nameWithType: "EnrollmentGroup.getCapabilities()"
syntax: "public DeviceCapabilities getCapabilities()"
returns:
type: "<xref href=\"com.microsoft.azure.sdk.iot.deps.twin.DeviceCapabilities?alt=com.microsoft.azure.sdk.iot.deps.twin.DeviceCapabilities&text=DeviceCapabilities\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.getCreatedDateTimeUtc()"
fullName: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.getCreatedDateTimeUtc()"
name: "getCreatedDateTimeUtc()"
nameWithType: "EnrollmentGroup.getCreatedDateTimeUtc()"
summary: "Getter for the created<wbr>Date<wbr>Time<wbr>Utc<wbr>Date."
syntax: "public Date getCreatedDateTimeUtc()"
desc: "Getter for the createdDateTimeUtcDate."
returns:
description: "The <code>Date</code> with the createdDateTimeUtcDate content. It can be <code>null</code>."
type: "<xref href=\"java.util.Date?alt=java.util.Date&text=Date\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.getCustomAllocationDefinition()"
fullName: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.getCustomAllocationDefinition()"
name: "getCustomAllocationDefinition()"
nameWithType: "EnrollmentGroup.getCustomAllocationDefinition()"
summary: "Getter for the custom allocation definition policy."
syntax: "public CustomAllocationDefinition getCustomAllocationDefinition()"
desc: "Getter for the custom allocation definition policy."
returns:
description: "The <code>CustomAllocationDefinition</code> policy."
type: "<xref href=\"com.microsoft.azure.sdk.iot.provisioning.service.configs.CustomAllocationDefinition?alt=com.microsoft.azure.sdk.iot.provisioning.service.configs.CustomAllocationDefinition&text=CustomAllocationDefinition\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.getEnrollmentGroupId()"
fullName: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.getEnrollmentGroupId()"
name: "getEnrollmentGroupId()"
nameWithType: "EnrollmentGroup.getEnrollmentGroupId()"
summary: "Getter for the enrollment<wbr>Group<wbr>Id."
syntax: "public String getEnrollmentGroupId()"
desc: "Getter for the enrollmentGroupId."
returns:
description: "The <code>String</code> with the enrollmentGroupId content. It cannot be <code>null</code> or empty."
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.getEtag()"
fullName: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.getEtag()"
name: "getEtag()"
nameWithType: "EnrollmentGroup.getEtag()"
summary: "Getter for the etag."
syntax: "public String getEtag()"
desc: "Getter for the etag."
returns:
description: "The <code>String</code> with the etag content. It can be <code>null</code>."
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.getInitialTwin()"
fullName: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.getInitialTwin()"
name: "getInitialTwin()"
nameWithType: "EnrollmentGroup.getInitialTwin()"
summary: "Getter for the initial<wbr>Twin."
syntax: "public TwinState getInitialTwin()"
desc: "Getter for the initialTwin."
returns:
description: "The <code>TwinState</code> with the initialTwin content. Its optional and can be <code>null</code>."
type: "<xref href=\"com.microsoft.azure.sdk.iot.provisioning.service.configs.TwinState?alt=com.microsoft.azure.sdk.iot.provisioning.service.configs.TwinState&text=TwinState\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.getIotHubHostName()"
fullName: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.getIotHubHostName()"
name: "getIotHubHostName()"
nameWithType: "EnrollmentGroup.getIotHubHostName()"
summary: "Getter for the iot<wbr>Hub<wbr>Host<wbr>Name."
syntax: "public String getIotHubHostName()"
desc: "Getter for the iotHubHostName."
returns:
description: "The <code>String</code> with the iotHubHostName content. It cannot be <code>null</code> or empty."
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.getIotHubs()"
fullName: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.getIotHubs()"
name: "getIotHubs()"
nameWithType: "EnrollmentGroup.getIotHubs()"
summary: "Getter for the list of Io<wbr>THub names that the device can be allocated to.."
syntax: "public Collection<String> getIotHubs()"
desc: "Getter for the list of IoTHub names that the device can be allocated to.."
returns:
description: "The <code>AllocationPolicy</code> with the allocationPolicy content."
type: "<xref href=\"java.util.Collection?alt=java.util.Collection&text=Collection\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.getLastUpdatedDateTimeUtc()"
fullName: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.getLastUpdatedDateTimeUtc()"
name: "getLastUpdatedDateTimeUtc()"
nameWithType: "EnrollmentGroup.getLastUpdatedDateTimeUtc()"
summary: "Getter for the last<wbr>Updated<wbr>Date<wbr>Time<wbr>Utc<wbr>Date."
syntax: "public Date getLastUpdatedDateTimeUtc()"
desc: "Getter for the lastUpdatedDateTimeUtcDate."
returns:
description: "The <code>Date</code> with the lastUpdatedDateTimeUtcDate content. It can be <code>null</code>."
type: "<xref href=\"java.util.Date?alt=java.util.Date&text=Date\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.getProvisioningStatus()"
fullName: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.getProvisioningStatus()"
name: "getProvisioningStatus()"
nameWithType: "EnrollmentGroup.getProvisioningStatus()"
summary: "Getter for the provisioning<wbr>Status."
syntax: "public ProvisioningStatus getProvisioningStatus()"
desc: "Getter for the provisioningStatus."
returns:
description: "The <code>ProvisioningStatus</code> with the provisioningStatus content. It can be 'enabled' or 'disabled'."
type: "<xref href=\"com.microsoft.azure.sdk.iot.provisioning.service.configs.ProvisioningStatus?alt=com.microsoft.azure.sdk.iot.provisioning.service.configs.ProvisioningStatus&text=ProvisioningStatus\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.getReprovisionPolicy()"
fullName: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.getReprovisionPolicy()"
name: "getReprovisionPolicy()"
nameWithType: "EnrollmentGroup.getReprovisionPolicy()"
summary: "Getter for the reprovision policy."
syntax: "public ReprovisionPolicy getReprovisionPolicy()"
desc: "Getter for the reprovision policy."
returns:
description: "The <code>ReprovisionPolicy</code> with the reprovisionPolicy content."
type: "<xref href=\"com.microsoft.azure.sdk.iot.provisioning.service.configs.ReprovisionPolicy?alt=com.microsoft.azure.sdk.iot.provisioning.service.configs.ReprovisionPolicy&text=ReprovisionPolicy\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.setAllocationPolicy(com.microsoft.azure.sdk.iot.provisioning.service.configs.AllocationPolicy)"
fullName: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.setAllocationPolicy(AllocationPolicy allocationPolicy)"
name: "setAllocationPolicy(AllocationPolicy allocationPolicy)"
nameWithType: "EnrollmentGroup.setAllocationPolicy(AllocationPolicy allocationPolicy)"
summary: "Setter for the allocation policy."
parameters:
- description: "the <code>AllocationPolicy</code> with the allocation policy of this resource. Overrides the tenant level allocation policy."
name: "allocationPolicy"
type: "<xref href=\"com.microsoft.azure.sdk.iot.provisioning.service.configs.AllocationPolicy?alt=com.microsoft.azure.sdk.iot.provisioning.service.configs.AllocationPolicy&text=AllocationPolicy\" data-throw-if-not-resolved=\"False\" />"
syntax: "public void setAllocationPolicy(AllocationPolicy allocationPolicy)"
desc: "Setter for the allocation policy."
- uid: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.setAttestation(com.microsoft.azure.sdk.iot.provisioning.service.configs.Attestation)"
fullName: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.setAttestation(Attestation attestation)"
name: "setAttestation(Attestation attestation)"
nameWithType: "EnrollmentGroup.setAttestation(Attestation attestation)"
summary: "Setter for the attestation."
parameters:
- description: "the <xref uid=\"com.microsoft.azure.sdk.iot.provisioning.service.configs.Attestation\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Attestation\"></xref> with the new attestation mechanism. It shall be <xref uid=\"com.microsoft.azure.sdk.iot.provisioning.service.configs.X509Attestation\" data-throw-if-not-resolved=\"false\" data-raw-source=\"X509Attestation\"></xref> or <xref uid=\"com.microsoft.azure.sdk.iot.provisioning.service.configs.SymmetricKeyAttestation\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SymmetricKeyAttestation\"></xref>"
name: "attestation"
type: "<xref href=\"com.microsoft.azure.sdk.iot.provisioning.service.configs.Attestation?alt=com.microsoft.azure.sdk.iot.provisioning.service.configs.Attestation&text=Attestation\" data-throw-if-not-resolved=\"False\" />"
syntax: "public void setAttestation(Attestation attestation)"
desc: "Setter for the attestation.\n\nAttestation mechanism is mandatory parameter that provides the mechanism type and the necessary certificates.\n\nEnrollmentGroup only accept <xref uid=\"com.microsoft.azure.sdk.iot.provisioning.service.configs.X509Attestation\" data-throw-if-not-resolved=\"false\" data-raw-source=\"X509Attestation\"></xref> with the RootCertificates, or <xref uid=\"com.microsoft.azure.sdk.iot.provisioning.service.configs.SymmetricKeyAttestation\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SymmetricKeyAttestation\"></xref> with Primary and Secondary Keys. You can create an <xref uid=\"com.microsoft.azure.sdk.iot.provisioning.service.configs.X509Attestation\" data-throw-if-not-resolved=\"false\" data-raw-source=\"X509Attestation\"></xref> by providing the **.pem** content to <xref uid=\"com.microsoft.azure.sdk.iot.provisioning.service.configs.X509Attestation.createFromRootCertificates(java.lang.String,java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"X509Attestation#createFromRootCertificates(String, String)\"></xref>. You can create a <xref uid=\"com.microsoft.azure.sdk.iot.provisioning.service.configs.SymmetricKeyAttestation\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SymmetricKeyAttestation\"></xref> by providing the Primary and Secondary Keys in Base64 format."
- uid: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.setAttestation(com.microsoft.azure.sdk.iot.provisioning.service.configs.AttestationMechanism)"
fullName: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.setAttestation(AttestationMechanism attestationMechanism)"
name: "setAttestation(AttestationMechanism attestationMechanism)"
nameWithType: "EnrollmentGroup.setAttestation(AttestationMechanism attestationMechanism)"
summary: "Setter for the attestation."
modifiers:
- "protected"
- "final"
parameters:
- description: "the <code>AttestationMechanism</code> with the new attestation mechanism. It can be `tpm`, `x509` or 'symmetricKey'."
name: "attestationMechanism"
type: "<xref href=\"com.microsoft.azure.sdk.iot.provisioning.service.configs.AttestationMechanism?alt=com.microsoft.azure.sdk.iot.provisioning.service.configs.AttestationMechanism&text=AttestationMechanism\" data-throw-if-not-resolved=\"False\" />"
syntax: "protected final void setAttestation(AttestationMechanism attestationMechanism)"
desc: "Setter for the attestation.\n\nAttestation mechanism is mandatory parameter that provides the mechanism type and the necessary keys/certificates"
- uid: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.setCapabilities(com.microsoft.azure.sdk.iot.deps.twin.DeviceCapabilities)"
fullName: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.setCapabilities(DeviceCapabilities capabilities)"
name: "setCapabilities(DeviceCapabilities capabilities)"
nameWithType: "EnrollmentGroup.setCapabilities(DeviceCapabilities capabilities)"
modifiers:
- "final"
parameters:
- description: "the device capabilities to set"
name: "capabilities"
type: "<xref href=\"com.microsoft.azure.sdk.iot.deps.twin.DeviceCapabilities?alt=com.microsoft.azure.sdk.iot.deps.twin.DeviceCapabilities&text=DeviceCapabilities\" data-throw-if-not-resolved=\"False\" />"
syntax: "public final void setCapabilities(DeviceCapabilities capabilities)"
- uid: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.setCreatedDateTimeUtc(java.lang.String)"
fullName: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.setCreatedDateTimeUtc(String createdDateTimeUtc)"
name: "setCreatedDateTimeUtc(String createdDateTimeUtc)"
nameWithType: "EnrollmentGroup.setCreatedDateTimeUtc(String createdDateTimeUtc)"
summary: "Setter for the created<wbr>Date<wbr>Time<wbr>Utc."
modifiers:
- "protected"
- "final"
parameters:
- description: "the <code>String</code> with the new createdDateTimeUtc. It can be <code>null</code>, empty or not valid."
name: "createdDateTimeUtc"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "protected final void setCreatedDateTimeUtc(String createdDateTimeUtc)"
desc: "Setter for the createdDateTimeUtc.\n\nThis Date and Time is provided by the provisioning service. If the enrollmentGroup is not created yet, this string can represent an invalid Date. In this case, it will be ignored. Example of the expected format: \"2016-06-01T21:22:43.7996883Z\""
- uid: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.setCustomAllocationDefinition(com.microsoft.azure.sdk.iot.provisioning.service.configs.CustomAllocationDefinition)"
fullName: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.setCustomAllocationDefinition(CustomAllocationDefinition customAllocationDefinition)"
name: "setCustomAllocationDefinition(CustomAllocationDefinition customAllocationDefinition)"
nameWithType: "EnrollmentGroup.setCustomAllocationDefinition(CustomAllocationDefinition customAllocationDefinition)"
summary: "Setter for the custom allocation definition policy."
parameters:
- description: "the <code>CustomAllocationDefinition</code> with the custom allocation policy of this resource."
name: "customAllocationDefinition"
type: "<xref href=\"com.microsoft.azure.sdk.iot.provisioning.service.configs.CustomAllocationDefinition?alt=com.microsoft.azure.sdk.iot.provisioning.service.configs.CustomAllocationDefinition&text=CustomAllocationDefinition\" data-throw-if-not-resolved=\"False\" />"
syntax: "public void setCustomAllocationDefinition(CustomAllocationDefinition customAllocationDefinition)"
desc: "Setter for the custom allocation definition policy."
- uid: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.setEnrollmentGroupId(java.lang.String)"
fullName: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.setEnrollmentGroupId(String enrollmentGroupId)"
name: "setEnrollmentGroupId(String enrollmentGroupId)"
nameWithType: "EnrollmentGroup.setEnrollmentGroupId(String enrollmentGroupId)"
summary: "Setter for the enrollment<wbr>Group<wbr>Id."
modifiers:
- "protected"
- "final"
parameters:
- description: "the <code>String</code> with the new enrollmentGroupId. It cannot be <code>null</code>, empty, or invalid."
name: "enrollmentGroupId"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "protected final void setEnrollmentGroupId(String enrollmentGroupId)"
desc: "Setter for the enrollmentGroupId.\n\nA valid enrollment group Id shall follow this criteria. A case-sensitive string (up to 128 char long) of ASCII 7-bit alphanumeric chars + \\{'-', ':', '.', '+', '%', '\\_', '\\#', '\\*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''\\}."
- uid: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.setEtag(java.lang.String)"
fullName: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.setEtag(String etag)"
name: "setEtag(String etag)"
nameWithType: "EnrollmentGroup.setEtag(String etag)"
summary: "Setter for the etag."
deprecatedTag: "as of provisioning-service-client version 1.3.3, please use <xref uid=\"com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.setEtagFinal(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#setEtagFinal(String)\"></xref>"
parameters:
- description: "the <code>String</code> with the new etag. It cannot be <code>null</code>, empty or invalid."
name: "etag"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "</br>public void setEtag(String etag)"
desc: "Setter for the etag."
hasDeprecatedTag: true
- uid: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.setEtagFinal(java.lang.String)"
fullName: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.setEtagFinal(String etag)"
name: "setEtagFinal(String etag)"
nameWithType: "EnrollmentGroup.setEtagFinal(String etag)"
summary: "Setter for the etag."
modifiers:
- "final"
parameters:
- description: "the <code>String</code> with the new etag. It cannot be <code>null</code>, empty or invalid."
name: "etag"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public final void setEtagFinal(String etag)"
desc: "Setter for the etag."
- uid: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.setInitialTwin(com.microsoft.azure.sdk.iot.provisioning.service.configs.TwinState)"
fullName: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.setInitialTwin(TwinState initialTwin)"
name: "setInitialTwin(TwinState initialTwin)"
nameWithType: "EnrollmentGroup.setInitialTwin(TwinState initialTwin)"
summary: "Setter for the initial<wbr>Twin."
parameters:
- description: "the <code>TwinState</code> with the new initialTwin. It cannot be <code>null</code>."
name: "initialTwin"
type: "<xref href=\"com.microsoft.azure.sdk.iot.provisioning.service.configs.TwinState?alt=com.microsoft.azure.sdk.iot.provisioning.service.configs.TwinState&text=TwinState\" data-throw-if-not-resolved=\"False\" />"
syntax: "</br>public void setInitialTwin(TwinState initialTwin)"
desc: "Setter for the initialTwin.\n\nIt provides a Twin precondition for the provisioned device."
- uid: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.setInitialTwinFinal(com.microsoft.azure.sdk.iot.provisioning.service.configs.TwinState)"
fullName: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.setInitialTwinFinal(TwinState initialTwin)"
name: "setInitialTwinFinal(TwinState initialTwin)"
nameWithType: "EnrollmentGroup.setInitialTwinFinal(TwinState initialTwin)"
summary: "Setter for the initial<wbr>Twin."
modifiers:
- "final"
parameters:
- description: "the <code>TwinState</code> with the new initialTwin. It cannot be <code>null</code>."
name: "initialTwin"
type: "<xref href=\"com.microsoft.azure.sdk.iot.provisioning.service.configs.TwinState?alt=com.microsoft.azure.sdk.iot.provisioning.service.configs.TwinState&text=TwinState\" data-throw-if-not-resolved=\"False\" />"
syntax: "public final void setInitialTwinFinal(TwinState initialTwin)"
desc: "Setter for the initialTwin.\n\nIt provides a Twin precondition for the provisioned device."
- uid: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.setIotHubHostName(java.lang.String)"
fullName: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.setIotHubHostName(String iotHubHostName)"
name: "setIotHubHostName(String iotHubHostName)"
nameWithType: "EnrollmentGroup.setIotHubHostName(String iotHubHostName)"
summary: "Setter for the iot<wbr>Hub<wbr>Host<wbr>Name."
parameters:
- description: "the <code>String</code> with the new iotHubHostName. It cannot be <code>null</code>, empty, or invalid."
name: "iotHubHostName"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "</br>public void setIotHubHostName(String iotHubHostName)"
desc: "Setter for the iotHubHostName.\n\nA valid iothub host name shall follow this criteria. A case-sensitive string (up to 128 char long) of ASCII 7-bit alphanumeric chars + \\{'-', ':', '.', '+', '%', '\\_', '\\#', '\\*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''\\}. A valid host name shall have, at least 2 parts separated by '.'."
- uid: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.setIotHubHostNameFinal(java.lang.String)"
fullName: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.setIotHubHostNameFinal(String iotHubHostName)"
name: "setIotHubHostNameFinal(String iotHubHostName)"
nameWithType: "EnrollmentGroup.setIotHubHostNameFinal(String iotHubHostName)"
summary: "Setter for the iot<wbr>Hub<wbr>Host<wbr>Name."
modifiers:
- "final"
parameters:
- description: "the <code>String</code> with the new iotHubHostName. It cannot be <code>null</code>, empty, or invalid."
name: "iotHubHostName"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public final void setIotHubHostNameFinal(String iotHubHostName)"
desc: "Setter for the iotHubHostName.\n\nA valid iothub host name shall follow this criteria. A case-sensitive string (up to 128 char long) of ASCII 7-bit alphanumeric chars + \\{'-', ':', '.', '+', '%', '\\_', '\\#', '\\*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''\\}. A valid host name shall have, at least 2 parts separated by '.'."
- uid: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.setIotHubs(java.util.Collection<java.lang.String>)"
fullName: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.setIotHubs(Collection<String> iotHubs)"
name: "setIotHubs(Collection<String> iotHubs)"
nameWithType: "EnrollmentGroup.setIotHubs(Collection<String> iotHubs)"
summary: "Setter for the list of Iot<wbr>Hubs available for allocation."
parameters:
- description: "the <code>List<String></code> of names of IoT hubs the device(s) in this resource can be allocated to. Must be a subset of tenant level list of IoT hubs"
name: "iotHubs"
type: "<xref href=\"java.util.Collection?alt=java.util.Collection&text=Collection\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />>"
syntax: "public void setIotHubs(Collection<String> iotHubs)"
desc: "Setter for the list of IotHubs available for allocation."
- uid: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.setLastUpdatedDateTimeUtc(java.lang.String)"
fullName: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.setLastUpdatedDateTimeUtc(String lastUpdatedDateTimeUtc)"
name: "setLastUpdatedDateTimeUtc(String lastUpdatedDateTimeUtc)"
nameWithType: "EnrollmentGroup.setLastUpdatedDateTimeUtc(String lastUpdatedDateTimeUtc)"
summary: "Setter for the last<wbr>Updated<wbr>Date<wbr>Time<wbr>Utc."
modifiers:
- "protected"
- "final"
parameters:
- description: "the <code>String</code> with the new lastUpdatedDateTimeUtc. It can be <code>null</code>, empty or not valid."
name: "lastUpdatedDateTimeUtc"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "protected final void setLastUpdatedDateTimeUtc(String lastUpdatedDateTimeUtc)"
desc: "Setter for the lastUpdatedDateTimeUtc.\n\nThis Date and Time is provided by the provisioning service. If the enrollmentGroup is not created yet, this string can represent an invalid Date. In this case, it will be ignored. Example of the expected format: \"2016-06-01T21:22:43.7996883Z\""
- uid: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.setProvisioningStatus(com.microsoft.azure.sdk.iot.provisioning.service.configs.ProvisioningStatus)"
fullName: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.setProvisioningStatus(ProvisioningStatus provisioningStatus)"
name: "setProvisioningStatus(ProvisioningStatus provisioningStatus)"
nameWithType: "EnrollmentGroup.setProvisioningStatus(ProvisioningStatus provisioningStatus)"
summary: "Setter for the provisioning<wbr>Status."
deprecatedTag: "as of provisioning-service-client version 1.3.3, please use <xref uid=\"com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.setProvisioningStatusFinal(com.microsoft.azure.sdk.iot.provisioning.service.configs.ProvisioningStatus)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#setProvisioningStatusFinal(ProvisioningStatus)\"></xref>"
parameters:
- description: "the <code>ProvisioningStatus</code> with the new provisioningStatus. It cannot be <code>null</code>."
name: "provisioningStatus"
type: "<xref href=\"com.microsoft.azure.sdk.iot.provisioning.service.configs.ProvisioningStatus?alt=com.microsoft.azure.sdk.iot.provisioning.service.configs.ProvisioningStatus&text=ProvisioningStatus\" data-throw-if-not-resolved=\"False\" />"
syntax: "</br>public void setProvisioningStatus(ProvisioningStatus provisioningStatus)"
desc: "Setter for the provisioningStatus.\n\nIt provides a Status precondition for the provisioned device."
hasDeprecatedTag: true
- uid: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.setProvisioningStatusFinal(com.microsoft.azure.sdk.iot.provisioning.service.configs.ProvisioningStatus)"
fullName: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.setProvisioningStatusFinal(ProvisioningStatus provisioningStatus)"
name: "setProvisioningStatusFinal(ProvisioningStatus provisioningStatus)"
nameWithType: "EnrollmentGroup.setProvisioningStatusFinal(ProvisioningStatus provisioningStatus)"
summary: "Setter for the provisioning<wbr>Status."
modifiers:
- "final"
parameters:
- description: "the <code>ProvisioningStatus</code> with the new provisioningStatus. It cannot be <code>null</code>."
name: "provisioningStatus"
type: "<xref href=\"com.microsoft.azure.sdk.iot.provisioning.service.configs.ProvisioningStatus?alt=com.microsoft.azure.sdk.iot.provisioning.service.configs.ProvisioningStatus&text=ProvisioningStatus\" data-throw-if-not-resolved=\"False\" />"
syntax: "public final void setProvisioningStatusFinal(ProvisioningStatus provisioningStatus)"
desc: "Setter for the provisioningStatus.\n\nIt provides a Status precondition for the provisioned device."
- uid: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.setReprovisionPolicy(com.microsoft.azure.sdk.iot.provisioning.service.configs.ReprovisionPolicy)"
fullName: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.setReprovisionPolicy(ReprovisionPolicy reprovisionPolicy)"
name: "setReprovisionPolicy(ReprovisionPolicy reprovisionPolicy)"
nameWithType: "EnrollmentGroup.setReprovisionPolicy(ReprovisionPolicy reprovisionPolicy)"
summary: "Setter for the reprovision policy."
parameters:
- description: "the <code>ReprovisionPolicy</code> with the behavior when a device is re-provisioned to an IoT hub."
name: "reprovisionPolicy"
type: "<xref href=\"com.microsoft.azure.sdk.iot.provisioning.service.configs.ReprovisionPolicy?alt=com.microsoft.azure.sdk.iot.provisioning.service.configs.ReprovisionPolicy&text=ReprovisionPolicy\" data-throw-if-not-resolved=\"False\" />"
syntax: "public void setReprovisionPolicy(ReprovisionPolicy reprovisionPolicy)"
desc: "Setter for the reprovision policy."
- uid: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.toJsonElement()"
fullName: "com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.toJsonElement()"
name: "toJsonElement()"
nameWithType: "EnrollmentGroup.toJsonElement()"
summary: "Serializer"
overridden: "com.microsoft.azure.sdk.iot.provisioning.service.configs.Serializable.toJsonElement()"
syntax: "public JsonElement toJsonElement()"
desc: "Serializer\n\nCreates a `JsonElement`, which the content represents the information in this class and its subclasses in a JSON format. This is useful if the caller will integrate this JSON with jsons from other classes to generate a consolidated JSON."
returns:
description: "The <code>JsonElement</code> with the content of this class."
type: "<xref href=\"com.google.gson.JsonElement?alt=com.google.gson.JsonElement&text=JsonElement\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Representation of a single Device Provisioning Service enrollment group with a JSON serializer and deserializer.\n\nThis object is used to send EnrollmentGroup information to the provisioning service, or receive EnrollmentGroup information from the provisioning service.\n\nTo create or update an EnrollmentGroup on the provisioning service you should fill this object and call the public API <xref uid=\"com.microsoft.azure.sdk.iot.provisioning.service.ProvisioningServiceClient.createOrUpdateEnrollmentGroup(com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ProvisioningServiceClient#createOrUpdateEnrollmentGroup(EnrollmentGroup)\"></xref>. The minimum information required by the provisioning service is the <xref uid=\"com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.enrollmentGroupId\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#enrollmentGroupId\"></xref> and the <xref uid=\"com.microsoft.azure.sdk.iot.provisioning.service.configs.EnrollmentGroup.attestation\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#attestation\"></xref>.\n\nTo provision a device using EnrollmentGroup, it must contain a X509 chip with a signingCertificate for the <xref uid=\"com.microsoft.azure.sdk.iot.provisioning.service.configs.X509Attestation\" data-throw-if-not-resolved=\"false\" data-raw-source=\"X509Attestation\"></xref> mechanism, or use <xref uid=\"com.microsoft.azure.sdk.iot.provisioning.service.configs.SymmetricKeyAttestation\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SymmetricKeyAttestation\"></xref> mechanism.\n\nThe content of this class will be serialized in a JSON format and sent as a body of the rest API to the provisioning service.\n\nWhen serialized, an EnrollmentGroup will look like the following example:\n\n```java\n{\n \"enrollmentGroupId\":\"validEnrollmentGroupId\",\n \"attestation\":{\n \"type\":\"x509\",\n \"signingCertificates\":{\n \"primary\":{\n \"certificate\":\"[valid certificate]\"\n }\n }\n },\n \"iotHubHostName\":\"ContosoIoTHub.azure-devices.net\",\n \"provisioningStatus\":\"enabled\"\n }\n```\n\nThe content of this class can be filled by a JSON, received from the provisioning service, as result of a EnrollmentGroup operation like create, update, or query EnrollmentGroup.\n\nThe following JSON is a sample of the EnrollmentGroup response, received from the provisioning service.\n\n```java\n{\n \"enrollmentGroupId\":\"validEnrollmentGroupId\",\n \"attestation\":{\n \"type\":\"x509\",\n \"signingCertificates\":{\n \"primary\":{\n \"certificate\":\"[valid certificate]\",\n \"info\": {\n \"subjectName\": \"CN=ROOT_00000000-0000-0000-0000-000000000000, OU=Azure IoT, O=MSFT, C=US\",\n \"sha1Thumbprint\": \"0000000000000000000000000000000000\",\n \"sha256Thumbprint\": \"validEnrollmentGroupId\",\n \"issuerName\": \"CN=ROOT_00000000-0000-0000-0000-000000000000, OU=Azure IoT, O=MSFT, C=US\",\n \"notBeforeUtc\": \"2017-11-14T12:34:18Z\",\n \"notAfterUtc\": \"2017-11-20T12:34:18Z\",\n \"serialNumber\": \"000000000000000000\",\n \"version\": 3\n }\n }\n }\n },\n \"iotHubHostName\":\"ContosoIoTHub.azure-devices.net\",\n \"provisioningStatus\":\"enabled\",\n \"createdDateTimeUtc\": \"2017-09-28T16:29:42.3447817Z\",\n \"lastUpdatedDateTimeUtc\": \"2017-09-28T16:29:42.3447817Z\",\n \"etag\": \"\\\"00000000-0000-0000-0000-00000000000\\\"\"\n }\n```"
metadata: {}
package: "com.microsoft.azure.sdk.iot.provisioning.service.configs"
artifact: com.microsoft.azure.sdk.iot.provisioning:provisioning-service-client:1.7.0