-
Notifications
You must be signed in to change notification settings - Fork 821
/
models.go
2755 lines (2487 loc) · 115 KB
/
models.go
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
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package devices
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License. See License.txt in the project root for license information.
//
// Code generated by Microsoft (R) AutoRest Code Generator.
// Changes may cause incorrect behavior and will be lost if the code is regenerated.
import (
"context"
"encoding/json"
"github.com/Azure/go-autorest/autorest"
"github.com/Azure/go-autorest/autorest/azure"
"github.com/Azure/go-autorest/autorest/date"
"github.com/Azure/go-autorest/autorest/to"
"github.com/Azure/go-autorest/tracing"
"net/http"
)
// The package's fully qualified name.
const fqdn = "github.com/Azure/azure-sdk-for-go/services/preview/iothub/mgmt/2021-03-03-preview/devices"
// ArmIdentity ...
type ArmIdentity struct {
// PrincipalID - READ-ONLY; Principal Id
PrincipalID *string `json:"principalId,omitempty"`
// TenantID - READ-ONLY; Tenant Id
TenantID *string `json:"tenantId,omitempty"`
// Type - The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service. Possible values include: 'ResourceIdentityTypeSystemAssigned', 'ResourceIdentityTypeUserAssigned', 'ResourceIdentityTypeSystemAssignedUserAssigned', 'ResourceIdentityTypeNone'
Type ResourceIdentityType `json:"type,omitempty"`
UserAssignedIdentities map[string]*ArmUserIdentity `json:"userAssignedIdentities"`
}
// MarshalJSON is the custom marshaler for ArmIdentity.
func (ai ArmIdentity) MarshalJSON() ([]byte, error) {
objectMap := make(map[string]interface{})
if ai.Type != "" {
objectMap["type"] = ai.Type
}
if ai.UserAssignedIdentities != nil {
objectMap["userAssignedIdentities"] = ai.UserAssignedIdentities
}
return json.Marshal(objectMap)
}
// ArmUserIdentity ...
type ArmUserIdentity struct {
// PrincipalID - READ-ONLY
PrincipalID *string `json:"principalId,omitempty"`
// ClientID - READ-ONLY
ClientID *string `json:"clientId,omitempty"`
}
// CertificateBodyDescription the JSON-serialized X509 Certificate.
type CertificateBodyDescription struct {
// Certificate - base-64 representation of the X509 leaf certificate .cer file or just .pem file content.
Certificate *string `json:"certificate,omitempty"`
}
// CertificateDescription the X509 Certificate.
type CertificateDescription struct {
autorest.Response `json:"-"`
Properties *CertificateProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The resource identifier.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the certificate.
Name *string `json:"name,omitempty"`
// Etag - READ-ONLY; The entity tag.
Etag *string `json:"etag,omitempty"`
// Type - READ-ONLY; The resource type.
Type *string `json:"type,omitempty"`
}
// MarshalJSON is the custom marshaler for CertificateDescription.
func (cd CertificateDescription) MarshalJSON() ([]byte, error) {
objectMap := make(map[string]interface{})
if cd.Properties != nil {
objectMap["properties"] = cd.Properties
}
return json.Marshal(objectMap)
}
// CertificateListDescription the JSON-serialized array of Certificate objects.
type CertificateListDescription struct {
autorest.Response `json:"-"`
// Value - The array of Certificate objects.
Value *[]CertificateDescription `json:"value,omitempty"`
}
// CertificateProperties the description of an X509 CA Certificate.
type CertificateProperties struct {
// Subject - READ-ONLY; The certificate's subject name.
Subject *string `json:"subject,omitempty"`
// Expiry - READ-ONLY; The certificate's expiration date and time.
Expiry *date.TimeRFC1123 `json:"expiry,omitempty"`
// Thumbprint - READ-ONLY; The certificate's thumbprint.
Thumbprint *string `json:"thumbprint,omitempty"`
// IsVerified - READ-ONLY; Determines whether certificate has been verified.
IsVerified *bool `json:"isVerified,omitempty"`
// Created - READ-ONLY; The certificate's create date and time.
Created *date.TimeRFC1123 `json:"created,omitempty"`
// Updated - READ-ONLY; The certificate's last update date and time.
Updated *date.TimeRFC1123 `json:"updated,omitempty"`
// Certificate - The certificate content
Certificate *string `json:"certificate,omitempty"`
}
// MarshalJSON is the custom marshaler for CertificateProperties.
func (cp CertificateProperties) MarshalJSON() ([]byte, error) {
objectMap := make(map[string]interface{})
if cp.Certificate != nil {
objectMap["certificate"] = cp.Certificate
}
return json.Marshal(objectMap)
}
// CertificatePropertiesWithNonce the description of an X509 CA Certificate including the challenge nonce
// issued for the Proof-Of-Possession flow.
type CertificatePropertiesWithNonce struct {
// Subject - READ-ONLY; The certificate's subject name.
Subject *string `json:"subject,omitempty"`
// Expiry - READ-ONLY; The certificate's expiration date and time.
Expiry *date.TimeRFC1123 `json:"expiry,omitempty"`
// Thumbprint - READ-ONLY; The certificate's thumbprint.
Thumbprint *string `json:"thumbprint,omitempty"`
// IsVerified - READ-ONLY; Determines whether certificate has been verified.
IsVerified *bool `json:"isVerified,omitempty"`
// Created - READ-ONLY; The certificate's create date and time.
Created *date.TimeRFC1123 `json:"created,omitempty"`
// Updated - READ-ONLY; The certificate's last update date and time.
Updated *date.TimeRFC1123 `json:"updated,omitempty"`
// VerificationCode - READ-ONLY; The certificate's verification code that will be used for proof of possession.
VerificationCode *string `json:"verificationCode,omitempty"`
// Certificate - READ-ONLY; The certificate content
Certificate *string `json:"certificate,omitempty"`
}
// CertificateVerificationDescription the JSON-serialized leaf certificate
type CertificateVerificationDescription struct {
// Certificate - base-64 representation of X509 certificate .cer file or just .pem file content.
Certificate *string `json:"certificate,omitempty"`
}
// CertificateWithNonceDescription the X509 Certificate.
type CertificateWithNonceDescription struct {
autorest.Response `json:"-"`
Properties *CertificatePropertiesWithNonce `json:"properties,omitempty"`
// ID - READ-ONLY; The resource identifier.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the certificate.
Name *string `json:"name,omitempty"`
// Etag - READ-ONLY; The entity tag.
Etag *string `json:"etag,omitempty"`
// Type - READ-ONLY; The resource type.
Type *string `json:"type,omitempty"`
}
// MarshalJSON is the custom marshaler for CertificateWithNonceDescription.
func (cwnd CertificateWithNonceDescription) MarshalJSON() ([]byte, error) {
objectMap := make(map[string]interface{})
if cwnd.Properties != nil {
objectMap["properties"] = cwnd.Properties
}
return json.Marshal(objectMap)
}
// CloudToDeviceProperties the IoT hub cloud-to-device messaging properties.
type CloudToDeviceProperties struct {
// MaxDeliveryCount - The max delivery count for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
MaxDeliveryCount *int32 `json:"maxDeliveryCount,omitempty"`
// DefaultTTLAsIso8601 - The default time to live for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
DefaultTTLAsIso8601 *string `json:"defaultTtlAsIso8601,omitempty"`
Feedback *FeedbackProperties `json:"feedback,omitempty"`
}
// EncryptionPropertiesDescription the encryption properties for the IoT hub.
type EncryptionPropertiesDescription struct {
// KeySource - The source of the key.
KeySource *string `json:"keySource,omitempty"`
// KeyVaultProperties - The properties of the KeyVault key.
KeyVaultProperties *[]KeyVaultKeyProperties `json:"keyVaultProperties,omitempty"`
}
// EndpointHealthData the health data for an endpoint
type EndpointHealthData struct {
// EndpointID - Id of the endpoint
EndpointID *string `json:"endpointId,omitempty"`
// HealthStatus - Health statuses have following meanings. The 'healthy' status shows that the endpoint is accepting messages as expected. The 'unhealthy' status shows that the endpoint is not accepting messages as expected and IoT Hub is retrying to send data to this endpoint. The status of an unhealthy endpoint will be updated to healthy when IoT Hub has established an eventually consistent state of health. The 'dead' status shows that the endpoint is not accepting messages, after IoT Hub retried sending messages for the retrial period. See IoT Hub metrics to identify errors and monitor issues with endpoints. The 'unknown' status shows that the IoT Hub has not established a connection with the endpoint. No messages have been delivered to or rejected from this endpoint. Possible values include: 'Unknown', 'Healthy', 'Degraded', 'Unhealthy', 'Dead'
HealthStatus EndpointHealthStatus `json:"healthStatus,omitempty"`
// LastKnownError - Last error obtained when a message failed to be delivered to iot hub
LastKnownError *string `json:"lastKnownError,omitempty"`
// LastKnownErrorTime - Time at which the last known error occurred
LastKnownErrorTime *date.TimeRFC1123 `json:"lastKnownErrorTime,omitempty"`
// LastSuccessfulSendAttemptTime - Last time iot hub successfully sent a message to the endpoint
LastSuccessfulSendAttemptTime *date.TimeRFC1123 `json:"lastSuccessfulSendAttemptTime,omitempty"`
// LastSendAttemptTime - Last time iot hub tried to send a message to the endpoint
LastSendAttemptTime *date.TimeRFC1123 `json:"lastSendAttemptTime,omitempty"`
}
// EndpointHealthDataListResult the JSON-serialized array of EndpointHealthData objects with a next link.
type EndpointHealthDataListResult struct {
autorest.Response `json:"-"`
// Value - JSON-serialized array of Endpoint health data
Value *[]EndpointHealthData `json:"value,omitempty"`
// NextLink - READ-ONLY; Link to more results
NextLink *string `json:"nextLink,omitempty"`
}
// MarshalJSON is the custom marshaler for EndpointHealthDataListResult.
func (ehdlr EndpointHealthDataListResult) MarshalJSON() ([]byte, error) {
objectMap := make(map[string]interface{})
if ehdlr.Value != nil {
objectMap["value"] = ehdlr.Value
}
return json.Marshal(objectMap)
}
// EndpointHealthDataListResultIterator provides access to a complete listing of EndpointHealthData values.
type EndpointHealthDataListResultIterator struct {
i int
page EndpointHealthDataListResultPage
}
// NextWithContext advances to the next value. If there was an error making
// the request the iterator does not advance and the error is returned.
func (iter *EndpointHealthDataListResultIterator) NextWithContext(ctx context.Context) (err error) {
if tracing.IsEnabled() {
ctx = tracing.StartSpan(ctx, fqdn+"/EndpointHealthDataListResultIterator.NextWithContext")
defer func() {
sc := -1
if iter.Response().Response.Response != nil {
sc = iter.Response().Response.Response.StatusCode
}
tracing.EndSpan(ctx, sc, err)
}()
}
iter.i++
if iter.i < len(iter.page.Values()) {
return nil
}
err = iter.page.NextWithContext(ctx)
if err != nil {
iter.i--
return err
}
iter.i = 0
return nil
}
// Next advances to the next value. If there was an error making
// the request the iterator does not advance and the error is returned.
// Deprecated: Use NextWithContext() instead.
func (iter *EndpointHealthDataListResultIterator) Next() error {
return iter.NextWithContext(context.Background())
}
// NotDone returns true if the enumeration should be started or is not yet complete.
func (iter EndpointHealthDataListResultIterator) NotDone() bool {
return iter.page.NotDone() && iter.i < len(iter.page.Values())
}
// Response returns the raw server response from the last page request.
func (iter EndpointHealthDataListResultIterator) Response() EndpointHealthDataListResult {
return iter.page.Response()
}
// Value returns the current value or a zero-initialized value if the
// iterator has advanced beyond the end of the collection.
func (iter EndpointHealthDataListResultIterator) Value() EndpointHealthData {
if !iter.page.NotDone() {
return EndpointHealthData{}
}
return iter.page.Values()[iter.i]
}
// Creates a new instance of the EndpointHealthDataListResultIterator type.
func NewEndpointHealthDataListResultIterator(page EndpointHealthDataListResultPage) EndpointHealthDataListResultIterator {
return EndpointHealthDataListResultIterator{page: page}
}
// IsEmpty returns true if the ListResult contains no values.
func (ehdlr EndpointHealthDataListResult) IsEmpty() bool {
return ehdlr.Value == nil || len(*ehdlr.Value) == 0
}
// hasNextLink returns true if the NextLink is not empty.
func (ehdlr EndpointHealthDataListResult) hasNextLink() bool {
return ehdlr.NextLink != nil && len(*ehdlr.NextLink) != 0
}
// endpointHealthDataListResultPreparer prepares a request to retrieve the next set of results.
// It returns nil if no more results exist.
func (ehdlr EndpointHealthDataListResult) endpointHealthDataListResultPreparer(ctx context.Context) (*http.Request, error) {
if !ehdlr.hasNextLink() {
return nil, nil
}
return autorest.Prepare((&http.Request{}).WithContext(ctx),
autorest.AsJSON(),
autorest.AsGet(),
autorest.WithBaseURL(to.String(ehdlr.NextLink)))
}
// EndpointHealthDataListResultPage contains a page of EndpointHealthData values.
type EndpointHealthDataListResultPage struct {
fn func(context.Context, EndpointHealthDataListResult) (EndpointHealthDataListResult, error)
ehdlr EndpointHealthDataListResult
}
// NextWithContext advances to the next page of values. If there was an error making
// the request the page does not advance and the error is returned.
func (page *EndpointHealthDataListResultPage) NextWithContext(ctx context.Context) (err error) {
if tracing.IsEnabled() {
ctx = tracing.StartSpan(ctx, fqdn+"/EndpointHealthDataListResultPage.NextWithContext")
defer func() {
sc := -1
if page.Response().Response.Response != nil {
sc = page.Response().Response.Response.StatusCode
}
tracing.EndSpan(ctx, sc, err)
}()
}
for {
next, err := page.fn(ctx, page.ehdlr)
if err != nil {
return err
}
page.ehdlr = next
if !next.hasNextLink() || !next.IsEmpty() {
break
}
}
return nil
}
// Next advances to the next page of values. If there was an error making
// the request the page does not advance and the error is returned.
// Deprecated: Use NextWithContext() instead.
func (page *EndpointHealthDataListResultPage) Next() error {
return page.NextWithContext(context.Background())
}
// NotDone returns true if the page enumeration should be started or is not yet complete.
func (page EndpointHealthDataListResultPage) NotDone() bool {
return !page.ehdlr.IsEmpty()
}
// Response returns the raw server response from the last page request.
func (page EndpointHealthDataListResultPage) Response() EndpointHealthDataListResult {
return page.ehdlr
}
// Values returns the slice of values for the current page or nil if there are no values.
func (page EndpointHealthDataListResultPage) Values() []EndpointHealthData {
if page.ehdlr.IsEmpty() {
return nil
}
return *page.ehdlr.Value
}
// Creates a new instance of the EndpointHealthDataListResultPage type.
func NewEndpointHealthDataListResultPage(cur EndpointHealthDataListResult, getNextPage func(context.Context, EndpointHealthDataListResult) (EndpointHealthDataListResult, error)) EndpointHealthDataListResultPage {
return EndpointHealthDataListResultPage{
fn: getNextPage,
ehdlr: cur,
}
}
// EnrichmentProperties the properties of an enrichment that your IoT hub applies to messages delivered to
// endpoints.
type EnrichmentProperties struct {
// Key - The key or name for the enrichment property.
Key *string `json:"key,omitempty"`
// Value - The value for the enrichment property.
Value *string `json:"value,omitempty"`
// EndpointNames - The list of endpoints for which the enrichment is applied to the message.
EndpointNames *[]string `json:"endpointNames,omitempty"`
}
// ErrorDetails error details.
type ErrorDetails struct {
// Code - READ-ONLY; The error code.
Code *string `json:"code,omitempty"`
// HTTPStatusCode - READ-ONLY; The HTTP status code.
HTTPStatusCode *string `json:"httpStatusCode,omitempty"`
// Message - READ-ONLY; The error message.
Message *string `json:"message,omitempty"`
// Details - READ-ONLY; The error details.
Details *string `json:"details,omitempty"`
}
// EventHubConsumerGroupBodyDescription the EventHub consumer group.
type EventHubConsumerGroupBodyDescription struct {
Properties *EventHubConsumerGroupName `json:"properties,omitempty"`
}
// EventHubConsumerGroupInfo the properties of the EventHubConsumerGroupInfo object.
type EventHubConsumerGroupInfo struct {
autorest.Response `json:"-"`
// Properties - The tags.
Properties map[string]*string `json:"properties"`
// ID - READ-ONLY; The Event Hub-compatible consumer group identifier.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The Event Hub-compatible consumer group name.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; the resource type.
Type *string `json:"type,omitempty"`
// Etag - READ-ONLY; The etag.
Etag *string `json:"etag,omitempty"`
}
// MarshalJSON is the custom marshaler for EventHubConsumerGroupInfo.
func (ehcgi EventHubConsumerGroupInfo) MarshalJSON() ([]byte, error) {
objectMap := make(map[string]interface{})
if ehcgi.Properties != nil {
objectMap["properties"] = ehcgi.Properties
}
return json.Marshal(objectMap)
}
// EventHubConsumerGroupName the EventHub consumer group name.
type EventHubConsumerGroupName struct {
// Name - EventHub consumer group name
Name *string `json:"name,omitempty"`
}
// EventHubConsumerGroupsListResult the JSON-serialized array of Event Hub-compatible consumer group names
// with a next link.
type EventHubConsumerGroupsListResult struct {
autorest.Response `json:"-"`
// Value - List of consumer groups objects
Value *[]EventHubConsumerGroupInfo `json:"value,omitempty"`
// NextLink - READ-ONLY; The next link.
NextLink *string `json:"nextLink,omitempty"`
}
// MarshalJSON is the custom marshaler for EventHubConsumerGroupsListResult.
func (ehcglr EventHubConsumerGroupsListResult) MarshalJSON() ([]byte, error) {
objectMap := make(map[string]interface{})
if ehcglr.Value != nil {
objectMap["value"] = ehcglr.Value
}
return json.Marshal(objectMap)
}
// EventHubConsumerGroupsListResultIterator provides access to a complete listing of
// EventHubConsumerGroupInfo values.
type EventHubConsumerGroupsListResultIterator struct {
i int
page EventHubConsumerGroupsListResultPage
}
// NextWithContext advances to the next value. If there was an error making
// the request the iterator does not advance and the error is returned.
func (iter *EventHubConsumerGroupsListResultIterator) NextWithContext(ctx context.Context) (err error) {
if tracing.IsEnabled() {
ctx = tracing.StartSpan(ctx, fqdn+"/EventHubConsumerGroupsListResultIterator.NextWithContext")
defer func() {
sc := -1
if iter.Response().Response.Response != nil {
sc = iter.Response().Response.Response.StatusCode
}
tracing.EndSpan(ctx, sc, err)
}()
}
iter.i++
if iter.i < len(iter.page.Values()) {
return nil
}
err = iter.page.NextWithContext(ctx)
if err != nil {
iter.i--
return err
}
iter.i = 0
return nil
}
// Next advances to the next value. If there was an error making
// the request the iterator does not advance and the error is returned.
// Deprecated: Use NextWithContext() instead.
func (iter *EventHubConsumerGroupsListResultIterator) Next() error {
return iter.NextWithContext(context.Background())
}
// NotDone returns true if the enumeration should be started or is not yet complete.
func (iter EventHubConsumerGroupsListResultIterator) NotDone() bool {
return iter.page.NotDone() && iter.i < len(iter.page.Values())
}
// Response returns the raw server response from the last page request.
func (iter EventHubConsumerGroupsListResultIterator) Response() EventHubConsumerGroupsListResult {
return iter.page.Response()
}
// Value returns the current value or a zero-initialized value if the
// iterator has advanced beyond the end of the collection.
func (iter EventHubConsumerGroupsListResultIterator) Value() EventHubConsumerGroupInfo {
if !iter.page.NotDone() {
return EventHubConsumerGroupInfo{}
}
return iter.page.Values()[iter.i]
}
// Creates a new instance of the EventHubConsumerGroupsListResultIterator type.
func NewEventHubConsumerGroupsListResultIterator(page EventHubConsumerGroupsListResultPage) EventHubConsumerGroupsListResultIterator {
return EventHubConsumerGroupsListResultIterator{page: page}
}
// IsEmpty returns true if the ListResult contains no values.
func (ehcglr EventHubConsumerGroupsListResult) IsEmpty() bool {
return ehcglr.Value == nil || len(*ehcglr.Value) == 0
}
// hasNextLink returns true if the NextLink is not empty.
func (ehcglr EventHubConsumerGroupsListResult) hasNextLink() bool {
return ehcglr.NextLink != nil && len(*ehcglr.NextLink) != 0
}
// eventHubConsumerGroupsListResultPreparer prepares a request to retrieve the next set of results.
// It returns nil if no more results exist.
func (ehcglr EventHubConsumerGroupsListResult) eventHubConsumerGroupsListResultPreparer(ctx context.Context) (*http.Request, error) {
if !ehcglr.hasNextLink() {
return nil, nil
}
return autorest.Prepare((&http.Request{}).WithContext(ctx),
autorest.AsJSON(),
autorest.AsGet(),
autorest.WithBaseURL(to.String(ehcglr.NextLink)))
}
// EventHubConsumerGroupsListResultPage contains a page of EventHubConsumerGroupInfo values.
type EventHubConsumerGroupsListResultPage struct {
fn func(context.Context, EventHubConsumerGroupsListResult) (EventHubConsumerGroupsListResult, error)
ehcglr EventHubConsumerGroupsListResult
}
// NextWithContext advances to the next page of values. If there was an error making
// the request the page does not advance and the error is returned.
func (page *EventHubConsumerGroupsListResultPage) NextWithContext(ctx context.Context) (err error) {
if tracing.IsEnabled() {
ctx = tracing.StartSpan(ctx, fqdn+"/EventHubConsumerGroupsListResultPage.NextWithContext")
defer func() {
sc := -1
if page.Response().Response.Response != nil {
sc = page.Response().Response.Response.StatusCode
}
tracing.EndSpan(ctx, sc, err)
}()
}
for {
next, err := page.fn(ctx, page.ehcglr)
if err != nil {
return err
}
page.ehcglr = next
if !next.hasNextLink() || !next.IsEmpty() {
break
}
}
return nil
}
// Next advances to the next page of values. If there was an error making
// the request the page does not advance and the error is returned.
// Deprecated: Use NextWithContext() instead.
func (page *EventHubConsumerGroupsListResultPage) Next() error {
return page.NextWithContext(context.Background())
}
// NotDone returns true if the page enumeration should be started or is not yet complete.
func (page EventHubConsumerGroupsListResultPage) NotDone() bool {
return !page.ehcglr.IsEmpty()
}
// Response returns the raw server response from the last page request.
func (page EventHubConsumerGroupsListResultPage) Response() EventHubConsumerGroupsListResult {
return page.ehcglr
}
// Values returns the slice of values for the current page or nil if there are no values.
func (page EventHubConsumerGroupsListResultPage) Values() []EventHubConsumerGroupInfo {
if page.ehcglr.IsEmpty() {
return nil
}
return *page.ehcglr.Value
}
// Creates a new instance of the EventHubConsumerGroupsListResultPage type.
func NewEventHubConsumerGroupsListResultPage(cur EventHubConsumerGroupsListResult, getNextPage func(context.Context, EventHubConsumerGroupsListResult) (EventHubConsumerGroupsListResult, error)) EventHubConsumerGroupsListResultPage {
return EventHubConsumerGroupsListResultPage{
fn: getNextPage,
ehcglr: cur,
}
}
// EventHubProperties the properties of the provisioned Event Hub-compatible endpoint used by the IoT hub.
type EventHubProperties struct {
// RetentionTimeInDays - The retention time for device-to-cloud messages in days. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages
RetentionTimeInDays *int64 `json:"retentionTimeInDays,omitempty"`
// PartitionCount - The number of partitions for receiving device-to-cloud messages in the Event Hub-compatible endpoint. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.
PartitionCount *int32 `json:"partitionCount,omitempty"`
// PartitionIds - READ-ONLY; The partition ids in the Event Hub-compatible endpoint.
PartitionIds *[]string `json:"partitionIds,omitempty"`
// Path - READ-ONLY; The Event Hub-compatible name.
Path *string `json:"path,omitempty"`
// Endpoint - READ-ONLY; The Event Hub-compatible endpoint.
Endpoint *string `json:"endpoint,omitempty"`
}
// MarshalJSON is the custom marshaler for EventHubProperties.
func (ehp EventHubProperties) MarshalJSON() ([]byte, error) {
objectMap := make(map[string]interface{})
if ehp.RetentionTimeInDays != nil {
objectMap["retentionTimeInDays"] = ehp.RetentionTimeInDays
}
if ehp.PartitionCount != nil {
objectMap["partitionCount"] = ehp.PartitionCount
}
return json.Marshal(objectMap)
}
// ExportDevicesRequest use to provide parameters when requesting an export of all devices in the IoT hub.
type ExportDevicesRequest struct {
// ExportBlobContainerURI - The export blob container URI.
ExportBlobContainerURI *string `json:"exportBlobContainerUri,omitempty"`
// ExcludeKeys - The value indicating whether keys should be excluded during export.
ExcludeKeys *bool `json:"excludeKeys,omitempty"`
// ExportBlobName - The name of the blob that will be created in the provided output blob container. This blob will contain the exported device registry information for the IoT Hub.
ExportBlobName *string `json:"exportBlobName,omitempty"`
// AuthenticationType - Specifies authentication type being used for connecting to the storage account. Possible values include: 'KeyBased', 'IdentityBased'
AuthenticationType AuthenticationType `json:"authenticationType,omitempty"`
// Identity - Managed identity properties of storage endpoint for export devices.
Identity *ManagedIdentity `json:"identity,omitempty"`
}
// FailoverInput use to provide failover region when requesting manual Failover for a hub.
type FailoverInput struct {
// FailoverRegion - Region the hub will be failed over to
FailoverRegion *string `json:"failoverRegion,omitempty"`
}
// FallbackRouteProperties the properties of the fallback route. IoT Hub uses these properties when it
// routes messages to the fallback endpoint.
type FallbackRouteProperties struct {
// Name - The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.
Name *string `json:"name,omitempty"`
// Source - The source to which the routing rule is to be applied to. For example, DeviceMessages
Source *string `json:"source,omitempty"`
// Condition - The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
Condition *string `json:"condition,omitempty"`
// EndpointNames - The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed.
EndpointNames *[]string `json:"endpointNames,omitempty"`
// IsEnabled - Used to specify whether the fallback route is enabled.
IsEnabled *bool `json:"isEnabled,omitempty"`
}
// FeedbackProperties the properties of the feedback queue for cloud-to-device messages.
type FeedbackProperties struct {
// LockDurationAsIso8601 - The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
LockDurationAsIso8601 *string `json:"lockDurationAsIso8601,omitempty"`
// TTLAsIso8601 - The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
TTLAsIso8601 *string `json:"ttlAsIso8601,omitempty"`
// MaxDeliveryCount - The number of times the IoT hub attempts to deliver a message on the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
MaxDeliveryCount *int32 `json:"maxDeliveryCount,omitempty"`
}
// GroupIDInformation the group information for creating a private endpoint on an IotHub
type GroupIDInformation struct {
autorest.Response `json:"-"`
// ID - READ-ONLY; The resource identifier.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The resource name.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The resource type.
Type *string `json:"type,omitempty"`
Properties *GroupIDInformationProperties `json:"properties,omitempty"`
}
// MarshalJSON is the custom marshaler for GroupIDInformation.
func (gii GroupIDInformation) MarshalJSON() ([]byte, error) {
objectMap := make(map[string]interface{})
if gii.Properties != nil {
objectMap["properties"] = gii.Properties
}
return json.Marshal(objectMap)
}
// GroupIDInformationProperties the properties for a group information object
type GroupIDInformationProperties struct {
// GroupID - The group id
GroupID *string `json:"groupId,omitempty"`
// RequiredMembers - The required members for a specific group id
RequiredMembers *[]string `json:"requiredMembers,omitempty"`
// RequiredZoneNames - The required DNS zones for a specific group id
RequiredZoneNames *[]string `json:"requiredZoneNames,omitempty"`
}
// IPFilterRule the IP filter rules for the IoT hub.
type IPFilterRule struct {
// FilterName - The name of the IP filter rule.
FilterName *string `json:"filterName,omitempty"`
// Action - The desired action for requests captured by this rule. Possible values include: 'Accept', 'Reject'
Action IPFilterActionType `json:"action,omitempty"`
// IPMask - A string that contains the IP address range in CIDR notation for the rule.
IPMask *string `json:"ipMask,omitempty"`
}
// ImportDevicesRequest use to provide parameters when requesting an import of all devices in the hub.
type ImportDevicesRequest struct {
// InputBlobContainerURI - The input blob container URI.
InputBlobContainerURI *string `json:"inputBlobContainerUri,omitempty"`
// OutputBlobContainerURI - The output blob container URI.
OutputBlobContainerURI *string `json:"outputBlobContainerUri,omitempty"`
// InputBlobName - The blob name to be used when importing from the provided input blob container.
InputBlobName *string `json:"inputBlobName,omitempty"`
// OutputBlobName - The blob name to use for storing the status of the import job.
OutputBlobName *string `json:"outputBlobName,omitempty"`
// AuthenticationType - Specifies authentication type being used for connecting to the storage account. Possible values include: 'KeyBased', 'IdentityBased'
AuthenticationType AuthenticationType `json:"authenticationType,omitempty"`
// Identity - Managed identity properties of storage endpoint for import devices.
Identity *ManagedIdentity `json:"identity,omitempty"`
}
// IotHubCapacity ioT Hub capacity information.
type IotHubCapacity struct {
// Minimum - READ-ONLY; The minimum number of units.
Minimum *int64 `json:"minimum,omitempty"`
// Maximum - READ-ONLY; The maximum number of units.
Maximum *int64 `json:"maximum,omitempty"`
// Default - READ-ONLY; The default number of units.
Default *int64 `json:"default,omitempty"`
// ScaleType - READ-ONLY; The type of the scaling enabled. Possible values include: 'IotHubScaleTypeAutomatic', 'IotHubScaleTypeManual', 'IotHubScaleTypeNone'
ScaleType IotHubScaleType `json:"scaleType,omitempty"`
}
// IotHubDescription the description of the IoT hub.
type IotHubDescription struct {
autorest.Response `json:"-"`
// Etag - The Etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.
Etag *string `json:"etag,omitempty"`
// Properties - IotHub properties
Properties *IotHubProperties `json:"properties,omitempty"`
// Sku - IotHub SKU info
Sku *IotHubSkuInfo `json:"sku,omitempty"`
// Identity - The managed identities for the IotHub.
Identity *ArmIdentity `json:"identity,omitempty"`
// ID - READ-ONLY; The resource identifier.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The resource name.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The resource type.
Type *string `json:"type,omitempty"`
// Location - The resource location.
Location *string `json:"location,omitempty"`
// Tags - The resource tags.
Tags map[string]*string `json:"tags"`
}
// MarshalJSON is the custom marshaler for IotHubDescription.
func (ihd IotHubDescription) MarshalJSON() ([]byte, error) {
objectMap := make(map[string]interface{})
if ihd.Etag != nil {
objectMap["etag"] = ihd.Etag
}
if ihd.Properties != nil {
objectMap["properties"] = ihd.Properties
}
if ihd.Sku != nil {
objectMap["sku"] = ihd.Sku
}
if ihd.Identity != nil {
objectMap["identity"] = ihd.Identity
}
if ihd.Location != nil {
objectMap["location"] = ihd.Location
}
if ihd.Tags != nil {
objectMap["tags"] = ihd.Tags
}
return json.Marshal(objectMap)
}
// IotHubDescriptionListResult the JSON-serialized array of IotHubDescription objects with a next link.
type IotHubDescriptionListResult struct {
autorest.Response `json:"-"`
// Value - The array of IotHubDescription objects.
Value *[]IotHubDescription `json:"value,omitempty"`
// NextLink - READ-ONLY; The next link.
NextLink *string `json:"nextLink,omitempty"`
}
// MarshalJSON is the custom marshaler for IotHubDescriptionListResult.
func (ihdlr IotHubDescriptionListResult) MarshalJSON() ([]byte, error) {
objectMap := make(map[string]interface{})
if ihdlr.Value != nil {
objectMap["value"] = ihdlr.Value
}
return json.Marshal(objectMap)
}
// IotHubDescriptionListResultIterator provides access to a complete listing of IotHubDescription values.
type IotHubDescriptionListResultIterator struct {
i int
page IotHubDescriptionListResultPage
}
// NextWithContext advances to the next value. If there was an error making
// the request the iterator does not advance and the error is returned.
func (iter *IotHubDescriptionListResultIterator) NextWithContext(ctx context.Context) (err error) {
if tracing.IsEnabled() {
ctx = tracing.StartSpan(ctx, fqdn+"/IotHubDescriptionListResultIterator.NextWithContext")
defer func() {
sc := -1
if iter.Response().Response.Response != nil {
sc = iter.Response().Response.Response.StatusCode
}
tracing.EndSpan(ctx, sc, err)
}()
}
iter.i++
if iter.i < len(iter.page.Values()) {
return nil
}
err = iter.page.NextWithContext(ctx)
if err != nil {
iter.i--
return err
}
iter.i = 0
return nil
}
// Next advances to the next value. If there was an error making
// the request the iterator does not advance and the error is returned.
// Deprecated: Use NextWithContext() instead.
func (iter *IotHubDescriptionListResultIterator) Next() error {
return iter.NextWithContext(context.Background())
}
// NotDone returns true if the enumeration should be started or is not yet complete.
func (iter IotHubDescriptionListResultIterator) NotDone() bool {
return iter.page.NotDone() && iter.i < len(iter.page.Values())
}
// Response returns the raw server response from the last page request.
func (iter IotHubDescriptionListResultIterator) Response() IotHubDescriptionListResult {
return iter.page.Response()
}
// Value returns the current value or a zero-initialized value if the
// iterator has advanced beyond the end of the collection.
func (iter IotHubDescriptionListResultIterator) Value() IotHubDescription {
if !iter.page.NotDone() {
return IotHubDescription{}
}
return iter.page.Values()[iter.i]
}
// Creates a new instance of the IotHubDescriptionListResultIterator type.
func NewIotHubDescriptionListResultIterator(page IotHubDescriptionListResultPage) IotHubDescriptionListResultIterator {
return IotHubDescriptionListResultIterator{page: page}
}
// IsEmpty returns true if the ListResult contains no values.
func (ihdlr IotHubDescriptionListResult) IsEmpty() bool {
return ihdlr.Value == nil || len(*ihdlr.Value) == 0
}
// hasNextLink returns true if the NextLink is not empty.
func (ihdlr IotHubDescriptionListResult) hasNextLink() bool {
return ihdlr.NextLink != nil && len(*ihdlr.NextLink) != 0
}
// iotHubDescriptionListResultPreparer prepares a request to retrieve the next set of results.
// It returns nil if no more results exist.
func (ihdlr IotHubDescriptionListResult) iotHubDescriptionListResultPreparer(ctx context.Context) (*http.Request, error) {
if !ihdlr.hasNextLink() {
return nil, nil
}
return autorest.Prepare((&http.Request{}).WithContext(ctx),
autorest.AsJSON(),
autorest.AsGet(),
autorest.WithBaseURL(to.String(ihdlr.NextLink)))
}
// IotHubDescriptionListResultPage contains a page of IotHubDescription values.
type IotHubDescriptionListResultPage struct {
fn func(context.Context, IotHubDescriptionListResult) (IotHubDescriptionListResult, error)
ihdlr IotHubDescriptionListResult
}
// NextWithContext advances to the next page of values. If there was an error making
// the request the page does not advance and the error is returned.
func (page *IotHubDescriptionListResultPage) NextWithContext(ctx context.Context) (err error) {
if tracing.IsEnabled() {
ctx = tracing.StartSpan(ctx, fqdn+"/IotHubDescriptionListResultPage.NextWithContext")
defer func() {
sc := -1
if page.Response().Response.Response != nil {
sc = page.Response().Response.Response.StatusCode
}
tracing.EndSpan(ctx, sc, err)
}()
}
for {
next, err := page.fn(ctx, page.ihdlr)
if err != nil {
return err
}
page.ihdlr = next
if !next.hasNextLink() || !next.IsEmpty() {
break
}
}
return nil
}
// Next advances to the next page of values. If there was an error making
// the request the page does not advance and the error is returned.
// Deprecated: Use NextWithContext() instead.
func (page *IotHubDescriptionListResultPage) Next() error {
return page.NextWithContext(context.Background())
}
// NotDone returns true if the page enumeration should be started or is not yet complete.
func (page IotHubDescriptionListResultPage) NotDone() bool {
return !page.ihdlr.IsEmpty()
}
// Response returns the raw server response from the last page request.
func (page IotHubDescriptionListResultPage) Response() IotHubDescriptionListResult {
return page.ihdlr
}
// Values returns the slice of values for the current page or nil if there are no values.
func (page IotHubDescriptionListResultPage) Values() []IotHubDescription {
if page.ihdlr.IsEmpty() {
return nil
}
return *page.ihdlr.Value
}
// Creates a new instance of the IotHubDescriptionListResultPage type.
func NewIotHubDescriptionListResultPage(cur IotHubDescriptionListResult, getNextPage func(context.Context, IotHubDescriptionListResult) (IotHubDescriptionListResult, error)) IotHubDescriptionListResultPage {
return IotHubDescriptionListResultPage{
fn: getNextPage,
ihdlr: cur,
}
}
// IotHubLocationDescription public representation of one of the locations where a resource is provisioned.
type IotHubLocationDescription struct {
// Location - The name of the Azure region
Location *string `json:"location,omitempty"`
// Role - The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. Possible values include: 'Primary', 'Secondary'
Role IotHubReplicaRoleType `json:"role,omitempty"`
}
// IotHubManualFailoverFuture an abstraction for monitoring and retrieving the results of a long-running
// operation.
type IotHubManualFailoverFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(IotHubClient) (autorest.Response, error)
}
// UnmarshalJSON is the custom unmarshaller for CreateFuture.
func (future *IotHubManualFailoverFuture) UnmarshalJSON(body []byte) error {
var azFuture azure.Future
if err := json.Unmarshal(body, &azFuture); err != nil {
return err
}
future.FutureAPI = &azFuture
future.Result = future.result
return nil
}
// result is the default implementation for IotHubManualFailoverFuture.Result.
func (future *IotHubManualFailoverFuture) result(client IotHubClient) (ar autorest.Response, err error) {
var done bool
done, err = future.DoneWithContext(context.Background(), client)
if err != nil {
err = autorest.NewErrorWithError(err, "devices.IotHubManualFailoverFuture", "Result", future.Response(), "Polling failure")
return
}
if !done {
ar.Response = future.Response()
err = azure.NewAsyncOpIncompleteError("devices.IotHubManualFailoverFuture")
return
}
ar.Response = future.Response()
return
}
// IotHubNameAvailabilityInfo the properties indicating whether a given IoT hub name is available.
type IotHubNameAvailabilityInfo struct {
autorest.Response `json:"-"`
// NameAvailable - READ-ONLY; The value which indicates whether the provided name is available.
NameAvailable *bool `json:"nameAvailable,omitempty"`