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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576
|
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/iothub/mgmt/2016-02-03/devices"
// 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"`
}
// 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"`
}
// MarshalJSON is the custom marshaler for ErrorDetails.
func (ed ErrorDetails) MarshalJSON() ([]byte, error) {
objectMap := make(map[string]interface{})
return json.Marshal(objectMap)
}
// EventHubConsumerGroupInfo the properties of the EventHubConsumerGroupInfo object.
type EventHubConsumerGroupInfo struct {
autorest.Response `json:"-"`
// Tags - The tags.
Tags map[string]*string `json:"tags"`
// ID - The Event Hub-compatible consumer group identifier.
ID *string `json:"id,omitempty"`
// Name - The Event Hub-compatible consumer group name.
Name *string `json:"name,omitempty"`
}
// MarshalJSON is the custom marshaler for EventHubConsumerGroupInfo.
func (ehcgi EventHubConsumerGroupInfo) MarshalJSON() ([]byte, error) {
objectMap := make(map[string]interface{})
if ehcgi.Tags != nil {
objectMap["tags"] = ehcgi.Tags
}
if ehcgi.ID != nil {
objectMap["id"] = ehcgi.ID
}
if ehcgi.Name != nil {
objectMap["name"] = ehcgi.Name
}
return json.Marshal(objectMap)
}
// EventHubConsumerGroupsListResult the JSON-serialized array of Event Hub-compatible consumer group names
// with a next link.
type EventHubConsumerGroupsListResult struct {
autorest.Response `json:"-"`
// Value - The array of Event Hub-compatible consumer group names.
Value *[]string `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 string 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() string {
if !iter.page.NotDone() {
return ""
}
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 string 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() []string {
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"`
}
// 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"`
}
// 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"`
}
// 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"`
}
// MarshalJSON is the custom marshaler for IotHubCapacity.
func (ihc IotHubCapacity) MarshalJSON() ([]byte, error) {
objectMap := make(map[string]interface{})
return json.Marshal(objectMap)
}
// IotHubDescription the description of the IoT hub.
type IotHubDescription struct {
autorest.Response `json:"-"`
// Subscriptionid - The subscription identifier.
Subscriptionid *string `json:"subscriptionid,omitempty"`
// Resourcegroup - The name of the resource group that contains the IoT hub. A resource group name uniquely identifies the resource group within the subscription.
Resourcegroup *string `json:"resourcegroup,omitempty"`
// 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 *IotHubProperties `json:"properties,omitempty"`
Sku *IotHubSkuInfo `json:"sku,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.Subscriptionid != nil {
objectMap["subscriptionid"] = ihd.Subscriptionid
}
if ihd.Resourcegroup != nil {
objectMap["resourcegroup"] = ihd.Resourcegroup
}
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.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,
}
}
// 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"`
// Reason - READ-ONLY; The reason for unavailability. Possible values include: 'Invalid', 'AlreadyExists'
Reason IotHubNameUnavailabilityReason `json:"reason,omitempty"`
// Message - The detailed reason message.
Message *string `json:"message,omitempty"`
}
// MarshalJSON is the custom marshaler for IotHubNameAvailabilityInfo.
func (ihnai IotHubNameAvailabilityInfo) MarshalJSON() ([]byte, error) {
objectMap := make(map[string]interface{})
if ihnai.Message != nil {
objectMap["message"] = ihnai.Message
}
return json.Marshal(objectMap)
}
// IotHubProperties the properties of an IoT hub.
type IotHubProperties struct {
// AuthorizationPolicies - The shared access policies you can use to secure a connection to the IoT hub.
AuthorizationPolicies *[]SharedAccessSignatureAuthorizationRule `json:"authorizationPolicies,omitempty"`
// IPFilterRules - The IP filter rules.
IPFilterRules *[]IPFilterRule `json:"ipFilterRules,omitempty"`
// ProvisioningState - READ-ONLY; The provisioning state.
ProvisioningState *string `json:"provisioningState,omitempty"`
// HostName - READ-ONLY; The name of the host.
HostName *string `json:"hostName,omitempty"`
// EventHubEndpoints - The Event Hub-compatible endpoint properties. The possible keys to this dictionary are events and operationsMonitoringEvents. Both of these keys have to be present in the dictionary while making create or update calls for the IoT hub.
EventHubEndpoints map[string]*EventHubProperties `json:"eventHubEndpoints"`
// StorageEndpoints - The list of Azure Storage endpoints where you can upload files. Currently you can configure only one Azure Storage account and that MUST have its key as $default. Specifying more than one storage account causes an error to be thrown. Not specifying a value for this property when the enableFileUploadNotifications property is set to True, causes an error to be thrown.
StorageEndpoints map[string]*StorageEndpointProperties `json:"storageEndpoints"`
// MessagingEndpoints - The messaging endpoint properties for the file upload notification queue.
MessagingEndpoints map[string]*MessagingEndpointProperties `json:"messagingEndpoints"`
// EnableFileUploadNotifications - If True, file upload notifications are enabled.
EnableFileUploadNotifications *bool `json:"enableFileUploadNotifications,omitempty"`
CloudToDevice *CloudToDeviceProperties `json:"cloudToDevice,omitempty"`
// Comments - Comments.
Comments *string `json:"comments,omitempty"`
OperationsMonitoringProperties *OperationsMonitoringProperties `json:"operationsMonitoringProperties,omitempty"`
// Features - The capabilities and features enabled for the IoT hub. Possible values include: 'None', 'DeviceManagement'
Features Capabilities `json:"features,omitempty"`
}
// MarshalJSON is the custom marshaler for IotHubProperties.
func (ihp IotHubProperties) MarshalJSON() ([]byte, error) {
objectMap := make(map[string]interface{})
if ihp.AuthorizationPolicies != nil {
objectMap["authorizationPolicies"] = ihp.AuthorizationPolicies
}
if ihp.IPFilterRules != nil {
objectMap["ipFilterRules"] = ihp.IPFilterRules
}
if ihp.EventHubEndpoints != nil {
objectMap["eventHubEndpoints"] = ihp.EventHubEndpoints
}
if ihp.StorageEndpoints != nil {
objectMap["storageEndpoints"] = ihp.StorageEndpoints
}
if ihp.MessagingEndpoints != nil {
objectMap["messagingEndpoints"] = ihp.MessagingEndpoints
}
if ihp.EnableFileUploadNotifications != nil {
objectMap["enableFileUploadNotifications"] = ihp.EnableFileUploadNotifications
}
if ihp.CloudToDevice != nil {
objectMap["cloudToDevice"] = ihp.CloudToDevice
}
if ihp.Comments != nil {
objectMap["comments"] = ihp.Comments
}
if ihp.OperationsMonitoringProperties != nil {
objectMap["operationsMonitoringProperties"] = ihp.OperationsMonitoringProperties
}
if ihp.Features != "" {
objectMap["features"] = ihp.Features
}
return json.Marshal(objectMap)
}
// IotHubQuotaMetricInfo quota metrics properties.
type IotHubQuotaMetricInfo struct {
// Name - READ-ONLY; The name of the quota metric.
Name *string `json:"Name,omitempty"`
// CurrentValue - READ-ONLY; The current value for the quota metric.
CurrentValue *int64 `json:"CurrentValue,omitempty"`
// MaxValue - READ-ONLY; The maximum value of the quota metric.
MaxValue *int64 `json:"MaxValue,omitempty"`
}
// MarshalJSON is the custom marshaler for IotHubQuotaMetricInfo.
func (ihqmi IotHubQuotaMetricInfo) MarshalJSON() ([]byte, error) {
objectMap := make(map[string]interface{})
return json.Marshal(objectMap)
}
// IotHubQuotaMetricInfoListResult the JSON-serialized array of IotHubQuotaMetricInfo objects with a next
// link.
type IotHubQuotaMetricInfoListResult struct {
autorest.Response `json:"-"`
// Value - The array of quota metrics objects.
Value *[]IotHubQuotaMetricInfo `json:"value,omitempty"`
// NextLink - READ-ONLY; The next link.
NextLink *string `json:"nextLink,omitempty"`
}
// MarshalJSON is the custom marshaler for IotHubQuotaMetricInfoListResult.
func (ihqmilr IotHubQuotaMetricInfoListResult) MarshalJSON() ([]byte, error) {
objectMap := make(map[string]interface{})
if ihqmilr.Value != nil {
objectMap["value"] = ihqmilr.Value
}
return json.Marshal(objectMap)
}
// IotHubQuotaMetricInfoListResultIterator provides access to a complete listing of IotHubQuotaMetricInfo
// values.
type IotHubQuotaMetricInfoListResultIterator struct {
i int
page IotHubQuotaMetricInfoListResultPage
}
// 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 *IotHubQuotaMetricInfoListResultIterator) NextWithContext(ctx context.Context) (err error) {
if tracing.IsEnabled() {
ctx = tracing.StartSpan(ctx, fqdn+"/IotHubQuotaMetricInfoListResultIterator.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 *IotHubQuotaMetricInfoListResultIterator) Next() error {
return iter.NextWithContext(context.Background())
}
// NotDone returns true if the enumeration should be started or is not yet complete.
func (iter IotHubQuotaMetricInfoListResultIterator) 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 IotHubQuotaMetricInfoListResultIterator) Response() IotHubQuotaMetricInfoListResult {
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 IotHubQuotaMetricInfoListResultIterator) Value() IotHubQuotaMetricInfo {
if !iter.page.NotDone() {
return IotHubQuotaMetricInfo{}
}
return iter.page.Values()[iter.i]
}
// Creates a new instance of the IotHubQuotaMetricInfoListResultIterator type.
func NewIotHubQuotaMetricInfoListResultIterator(page IotHubQuotaMetricInfoListResultPage) IotHubQuotaMetricInfoListResultIterator {
return IotHubQuotaMetricInfoListResultIterator{page: page}
}
// IsEmpty returns true if the ListResult contains no values.
func (ihqmilr IotHubQuotaMetricInfoListResult) IsEmpty() bool {
return ihqmilr.Value == nil || len(*ihqmilr.Value) == 0
}
// hasNextLink returns true if the NextLink is not empty.
func (ihqmilr IotHubQuotaMetricInfoListResult) hasNextLink() bool {
return ihqmilr.NextLink != nil && len(*ihqmilr.NextLink) != 0
}
// iotHubQuotaMetricInfoListResultPreparer prepares a request to retrieve the next set of results.
// It returns nil if no more results exist.
func (ihqmilr IotHubQuotaMetricInfoListResult) iotHubQuotaMetricInfoListResultPreparer(ctx context.Context) (*http.Request, error) {
if !ihqmilr.hasNextLink() {
return nil, nil
}
return autorest.Prepare((&http.Request{}).WithContext(ctx),
autorest.AsJSON(),
autorest.AsGet(),
autorest.WithBaseURL(to.String(ihqmilr.NextLink)))
}
// IotHubQuotaMetricInfoListResultPage contains a page of IotHubQuotaMetricInfo values.
type IotHubQuotaMetricInfoListResultPage struct {
fn func(context.Context, IotHubQuotaMetricInfoListResult) (IotHubQuotaMetricInfoListResult, error)
ihqmilr IotHubQuotaMetricInfoListResult
}
// 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 *IotHubQuotaMetricInfoListResultPage) NextWithContext(ctx context.Context) (err error) {
if tracing.IsEnabled() {
ctx = tracing.StartSpan(ctx, fqdn+"/IotHubQuotaMetricInfoListResultPage.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.ihqmilr)
if err != nil {
return err
}
page.ihqmilr = 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 *IotHubQuotaMetricInfoListResultPage) Next() error {
return page.NextWithContext(context.Background())
}
// NotDone returns true if the page enumeration should be started or is not yet complete.
func (page IotHubQuotaMetricInfoListResultPage) NotDone() bool {
return !page.ihqmilr.IsEmpty()
}
// Response returns the raw server response from the last page request.
func (page IotHubQuotaMetricInfoListResultPage) Response() IotHubQuotaMetricInfoListResult {
return page.ihqmilr
}
// Values returns the slice of values for the current page or nil if there are no values.
func (page IotHubQuotaMetricInfoListResultPage) Values() []IotHubQuotaMetricInfo {
if page.ihqmilr.IsEmpty() {
return nil
}
return *page.ihqmilr.Value
}
// Creates a new instance of the IotHubQuotaMetricInfoListResultPage type.
func NewIotHubQuotaMetricInfoListResultPage(cur IotHubQuotaMetricInfoListResult, getNextPage func(context.Context, IotHubQuotaMetricInfoListResult) (IotHubQuotaMetricInfoListResult, error)) IotHubQuotaMetricInfoListResultPage {
return IotHubQuotaMetricInfoListResultPage{
fn: getNextPage,
ihqmilr: cur,
}
}
// IotHubResourceCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a
// long-running operation.
type IotHubResourceCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(IotHubResourceClient) (IotHubDescription, error)
}
// UnmarshalJSON is the custom unmarshaller for CreateFuture.
func (future *IotHubResourceCreateOrUpdateFuture) 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 IotHubResourceCreateOrUpdateFuture.Result.
func (future *IotHubResourceCreateOrUpdateFuture) result(client IotHubResourceClient) (ihd IotHubDescription, err error) {
var done bool
done, err = future.DoneWithContext(context.Background(), client)
if err != nil {
err = autorest.NewErrorWithError(err, "devices.IotHubResourceCreateOrUpdateFuture", "Result", future.Response(), "Polling failure")
return
}
if !done {
ihd.Response.Response = future.Response()
err = azure.NewAsyncOpIncompleteError("devices.IotHubResourceCreateOrUpdateFuture")
return
}
sender := autorest.DecorateSender(client, autorest.DoRetryForStatusCodes(client.RetryAttempts, client.RetryDuration, autorest.StatusCodesForRetry...))
if ihd.Response.Response, err = future.GetResult(sender); err == nil && ihd.Response.Response.StatusCode != http.StatusNoContent {
ihd, err = client.CreateOrUpdateResponder(ihd.Response.Response)
if err != nil {
err = autorest.NewErrorWithError(err, "devices.IotHubResourceCreateOrUpdateFuture", "Result", ihd.Response.Response, "Failure responding to request")
}
}
return
}
// IotHubResourceDeleteFuture an abstraction for monitoring and retrieving the results of a long-running
// operation.
type IotHubResourceDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(IotHubResourceClient) (SetObject, error)
}
// UnmarshalJSON is the custom unmarshaller for CreateFuture.
func (future *IotHubResourceDeleteFuture) 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 IotHubResourceDeleteFuture.Result.
func (future *IotHubResourceDeleteFuture) result(client IotHubResourceClient) (so SetObject, err error) {
var done bool
done, err = future.DoneWithContext(context.Background(), client)
if err != nil {
err = autorest.NewErrorWithError(err, "devices.IotHubResourceDeleteFuture", "Result", future.Response(), "Polling failure")
return
}
if !done {
so.Response.Response = future.Response()
err = azure.NewAsyncOpIncompleteError("devices.IotHubResourceDeleteFuture")
return
}
sender := autorest.DecorateSender(client, autorest.DoRetryForStatusCodes(client.RetryAttempts, client.RetryDuration, autorest.StatusCodesForRetry...))
if so.Response.Response, err = future.GetResult(sender); err == nil && so.Response.Response.StatusCode != http.StatusNoContent {
so, err = client.DeleteResponder(so.Response.Response)
if err != nil {
err = autorest.NewErrorWithError(err, "devices.IotHubResourceDeleteFuture", "Result", so.Response.Response, "Failure responding to request")
}
}
return
}
// IotHubSkuDescription SKU properties.
type IotHubSkuDescription struct {
// ResourceType - READ-ONLY; The type of the resource.
ResourceType *string `json:"resourceType,omitempty"`
Sku *IotHubSkuInfo `json:"sku,omitempty"`
Capacity *IotHubCapacity `json:"capacity,omitempty"`
}
// MarshalJSON is the custom marshaler for IotHubSkuDescription.
func (ihsd IotHubSkuDescription) MarshalJSON() ([]byte, error) {
objectMap := make(map[string]interface{})
if ihsd.Sku != nil {
objectMap["sku"] = ihsd.Sku
}
if ihsd.Capacity != nil {
objectMap["capacity"] = ihsd.Capacity
}
return json.Marshal(objectMap)
}
// IotHubSkuDescriptionListResult the JSON-serialized array of IotHubSkuDescription objects with a next
// link.
type IotHubSkuDescriptionListResult struct {
autorest.Response `json:"-"`
// Value - The array of IotHubSkuDescription.
Value *[]IotHubSkuDescription `json:"value,omitempty"`
// NextLink - READ-ONLY; The next link.
NextLink *string `json:"nextLink,omitempty"`
}
// MarshalJSON is the custom marshaler for IotHubSkuDescriptionListResult.
func (ihsdlr IotHubSkuDescriptionListResult) MarshalJSON() ([]byte, error) {
objectMap := make(map[string]interface{})
if ihsdlr.Value != nil {
objectMap["value"] = ihsdlr.Value
}
return json.Marshal(objectMap)
}
// IotHubSkuDescriptionListResultIterator provides access to a complete listing of IotHubSkuDescription
// values.
type IotHubSkuDescriptionListResultIterator struct {
i int
page IotHubSkuDescriptionListResultPage
}
// 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 *IotHubSkuDescriptionListResultIterator) NextWithContext(ctx context.Context) (err error) {
if tracing.IsEnabled() {
ctx = tracing.StartSpan(ctx, fqdn+"/IotHubSkuDescriptionListResultIterator.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 *IotHubSkuDescriptionListResultIterator) Next() error {
return iter.NextWithContext(context.Background())
}
// NotDone returns true if the enumeration should be started or is not yet complete.
func (iter IotHubSkuDescriptionListResultIterator) 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 IotHubSkuDescriptionListResultIterator) Response() IotHubSkuDescriptionListResult {
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 IotHubSkuDescriptionListResultIterator) Value() IotHubSkuDescription {
if !iter.page.NotDone() {
return IotHubSkuDescription{}
}
return iter.page.Values()[iter.i]
}
// Creates a new instance of the IotHubSkuDescriptionListResultIterator type.
func NewIotHubSkuDescriptionListResultIterator(page IotHubSkuDescriptionListResultPage) IotHubSkuDescriptionListResultIterator {
return IotHubSkuDescriptionListResultIterator{page: page}
}
// IsEmpty returns true if the ListResult contains no values.
func (ihsdlr IotHubSkuDescriptionListResult) IsEmpty() bool {
return ihsdlr.Value == nil || len(*ihsdlr.Value) == 0
}
// hasNextLink returns true if the NextLink is not empty.
func (ihsdlr IotHubSkuDescriptionListResult) hasNextLink() bool {
return ihsdlr.NextLink != nil && len(*ihsdlr.NextLink) != 0
}
// iotHubSkuDescriptionListResultPreparer prepares a request to retrieve the next set of results.
// It returns nil if no more results exist.
func (ihsdlr IotHubSkuDescriptionListResult) iotHubSkuDescriptionListResultPreparer(ctx context.Context) (*http.Request, error) {
if !ihsdlr.hasNextLink() {
return nil, nil
}
return autorest.Prepare((&http.Request{}).WithContext(ctx),
autorest.AsJSON(),
autorest.AsGet(),
autorest.WithBaseURL(to.String(ihsdlr.NextLink)))
}
// IotHubSkuDescriptionListResultPage contains a page of IotHubSkuDescription values.
type IotHubSkuDescriptionListResultPage struct {
fn func(context.Context, IotHubSkuDescriptionListResult) (IotHubSkuDescriptionListResult, error)
ihsdlr IotHubSkuDescriptionListResult
}
// 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 *IotHubSkuDescriptionListResultPage) NextWithContext(ctx context.Context) (err error) {
if tracing.IsEnabled() {
ctx = tracing.StartSpan(ctx, fqdn+"/IotHubSkuDescriptionListResultPage.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.ihsdlr)
if err != nil {
return err
}
page.ihsdlr = 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 *IotHubSkuDescriptionListResultPage) Next() error {
return page.NextWithContext(context.Background())
}
// NotDone returns true if the page enumeration should be started or is not yet complete.
func (page IotHubSkuDescriptionListResultPage) NotDone() bool {
return !page.ihsdlr.IsEmpty()
}
// Response returns the raw server response from the last page request.
func (page IotHubSkuDescriptionListResultPage) Response() IotHubSkuDescriptionListResult {
return page.ihsdlr
}
// Values returns the slice of values for the current page or nil if there are no values.
func (page IotHubSkuDescriptionListResultPage) Values() []IotHubSkuDescription {
if page.ihsdlr.IsEmpty() {
return nil
}
return *page.ihsdlr.Value
}
// Creates a new instance of the IotHubSkuDescriptionListResultPage type.
func NewIotHubSkuDescriptionListResultPage(cur IotHubSkuDescriptionListResult, getNextPage func(context.Context, IotHubSkuDescriptionListResult) (IotHubSkuDescriptionListResult, error)) IotHubSkuDescriptionListResultPage {
return IotHubSkuDescriptionListResultPage{
fn: getNextPage,
ihsdlr: cur,
}
}
// IotHubSkuInfo information about the SKU of the IoT hub.
type IotHubSkuInfo struct {
// Name - The name of the SKU. Possible values include: 'F1', 'S1', 'S2', 'S3'
Name IotHubSku `json:"name,omitempty"`
// Tier - READ-ONLY; The billing tier for the IoT hub. Possible values include: 'Free', 'Standard'
Tier IotHubSkuTier `json:"tier,omitempty"`
// Capacity - The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.
Capacity *int64 `json:"capacity,omitempty"`
}
// MarshalJSON is the custom marshaler for IotHubSkuInfo.
func (ihsi IotHubSkuInfo) MarshalJSON() ([]byte, error) {
objectMap := make(map[string]interface{})
if ihsi.Name != "" {
objectMap["name"] = ihsi.Name
}
if ihsi.Capacity != nil {
objectMap["capacity"] = ihsi.Capacity
}
return json.Marshal(objectMap)
}
// 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"`
}
// JobResponse the properties of the Job Response object.
type JobResponse struct {
autorest.Response `json:"-"`
// JobID - READ-ONLY; The job identifier.
JobID *string `json:"jobId,omitempty"`
// StartTimeUtc - READ-ONLY; The start time of the job.
StartTimeUtc *date.TimeRFC1123 `json:"startTimeUtc,omitempty"`
// EndTimeUtc - READ-ONLY; The time the job stopped processing.
EndTimeUtc *date.TimeRFC1123 `json:"endTimeUtc,omitempty"`
// Type - READ-ONLY; The type of the job. Possible values include: 'JobTypeUnknown', 'JobTypeExport', 'JobTypeImport', 'JobTypeBackup', 'JobTypeReadDeviceProperties', 'JobTypeWriteDeviceProperties', 'JobTypeUpdateDeviceConfiguration', 'JobTypeRebootDevice', 'JobTypeFactoryResetDevice', 'JobTypeFirmwareUpdate'
Type JobType `json:"type,omitempty"`
// Status - READ-ONLY; The status of the job. Possible values include: 'Unknown', 'Enqueued', 'Running', 'Completed', 'Failed', 'Cancelled'
Status JobStatus `json:"status,omitempty"`
// FailureReason - READ-ONLY; If status == failed, this string containing the reason for the failure.
FailureReason *string `json:"failureReason,omitempty"`
// StatusMessage - READ-ONLY; The status message for the job.
StatusMessage *string `json:"statusMessage,omitempty"`
// ParentJobID - READ-ONLY; The job identifier of the parent job, if any.
ParentJobID *string `json:"parentJobId,omitempty"`
}
// MarshalJSON is the custom marshaler for JobResponse.
func (jr JobResponse) MarshalJSON() ([]byte, error) {
objectMap := make(map[string]interface{})
return json.Marshal(objectMap)
}
// JobResponseListResult the JSON-serialized array of JobResponse objects with a next link.
type JobResponseListResult struct {
autorest.Response `json:"-"`
// Value - The array of JobResponse objects.
Value *[]JobResponse `json:"value,omitempty"`
// NextLink - READ-ONLY; The next link.
NextLink *string `json:"nextLink,omitempty"`
}
// MarshalJSON is the custom marshaler for JobResponseListResult.
func (jrlr JobResponseListResult) MarshalJSON() ([]byte, error) {
objectMap := make(map[string]interface{})
if jrlr.Value != nil {
objectMap["value"] = jrlr.Value
}
return json.Marshal(objectMap)
}
// JobResponseListResultIterator provides access to a complete listing of JobResponse values.
type JobResponseListResultIterator struct {
i int
page JobResponseListResultPage
}
// 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 *JobResponseListResultIterator) NextWithContext(ctx context.Context) (err error) {
if tracing.IsEnabled() {
ctx = tracing.StartSpan(ctx, fqdn+"/JobResponseListResultIterator.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 *JobResponseListResultIterator) Next() error {
return iter.NextWithContext(context.Background())
}
// NotDone returns true if the enumeration should be started or is not yet complete.
func (iter JobResponseListResultIterator) 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 JobResponseListResultIterator) Response() JobResponseListResult {
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 JobResponseListResultIterator) Value() JobResponse {
if !iter.page.NotDone() {
return JobResponse{}
}
return iter.page.Values()[iter.i]
}
// Creates a new instance of the JobResponseListResultIterator type.
func NewJobResponseListResultIterator(page JobResponseListResultPage) JobResponseListResultIterator {
return JobResponseListResultIterator{page: page}
}
// IsEmpty returns true if the ListResult contains no values.
func (jrlr JobResponseListResult) IsEmpty() bool {
return jrlr.Value == nil || len(*jrlr.Value) == 0
}
// hasNextLink returns true if the NextLink is not empty.
func (jrlr JobResponseListResult) hasNextLink() bool {
return jrlr.NextLink != nil && len(*jrlr.NextLink) != 0
}
// jobResponseListResultPreparer prepares a request to retrieve the next set of results.
// It returns nil if no more results exist.
func (jrlr JobResponseListResult) jobResponseListResultPreparer(ctx context.Context) (*http.Request, error) {
if !jrlr.hasNextLink() {
return nil, nil
}
return autorest.Prepare((&http.Request{}).WithContext(ctx),
autorest.AsJSON(),
autorest.AsGet(),
autorest.WithBaseURL(to.String(jrlr.NextLink)))
}
// JobResponseListResultPage contains a page of JobResponse values.
type JobResponseListResultPage struct {
fn func(context.Context, JobResponseListResult) (JobResponseListResult, error)
jrlr JobResponseListResult
}
// 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 *JobResponseListResultPage) NextWithContext(ctx context.Context) (err error) {
if tracing.IsEnabled() {
ctx = tracing.StartSpan(ctx, fqdn+"/JobResponseListResultPage.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.jrlr)
if err != nil {
return err
}
page.jrlr = 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 *JobResponseListResultPage) Next() error {
return page.NextWithContext(context.Background())
}
// NotDone returns true if the page enumeration should be started or is not yet complete.
func (page JobResponseListResultPage) NotDone() bool {
return !page.jrlr.IsEmpty()
}
// Response returns the raw server response from the last page request.
func (page JobResponseListResultPage) Response() JobResponseListResult {
return page.jrlr
}
// Values returns the slice of values for the current page or nil if there are no values.
func (page JobResponseListResultPage) Values() []JobResponse {
if page.jrlr.IsEmpty() {
return nil
}
return *page.jrlr.Value
}
// Creates a new instance of the JobResponseListResultPage type.
func NewJobResponseListResultPage(cur JobResponseListResult, getNextPage func(context.Context, JobResponseListResult) (JobResponseListResult, error)) JobResponseListResultPage {
return JobResponseListResultPage{
fn: getNextPage,
jrlr: cur,
}
}
// MessagingEndpointProperties the properties of the messaging endpoints used by this IoT hub.
type MessagingEndpointProperties struct {
// LockDurationAsIso8601 - The lock duration. See: https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-file-upload.
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/en-us/azure/iot-hub/iot-hub-devguide-file-upload.
TTLAsIso8601 *string `json:"ttlAsIso8601,omitempty"`
// MaxDeliveryCount - The number of times the IoT hub attempts to deliver a message. See: https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-file-upload.
MaxDeliveryCount *int32 `json:"maxDeliveryCount,omitempty"`
}
// OperationInputs input values.
type OperationInputs struct {
// Name - The name of the IoT hub to check.
Name *string `json:"Name,omitempty"`
}
// OperationsMonitoringProperties the operations monitoring properties for the IoT hub. The possible keys
// to the dictionary are Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations,
// FileUploadOperations.
type OperationsMonitoringProperties struct {
Events map[string]*OperationMonitoringLevel `json:"events"`
}
// MarshalJSON is the custom marshaler for OperationsMonitoringProperties.
func (omp OperationsMonitoringProperties) MarshalJSON() ([]byte, error) {
objectMap := make(map[string]interface{})
if omp.Events != nil {
objectMap["events"] = omp.Events
}
return json.Marshal(objectMap)
}
// RegistryStatistics identity registry statistics.
type RegistryStatistics struct {
autorest.Response `json:"-"`
// TotalDeviceCount - READ-ONLY; The total count of devices in the identity registry.
TotalDeviceCount *int64 `json:"totalDeviceCount,omitempty"`
// EnabledDeviceCount - READ-ONLY; The count of enabled devices in the identity registry.
EnabledDeviceCount *int64 `json:"enabledDeviceCount,omitempty"`
// DisabledDeviceCount - READ-ONLY; The count of disabled devices in the identity registry.
DisabledDeviceCount *int64 `json:"disabledDeviceCount,omitempty"`
}
// MarshalJSON is the custom marshaler for RegistryStatistics.
func (rs RegistryStatistics) MarshalJSON() ([]byte, error) {
objectMap := make(map[string]interface{})
return json.Marshal(objectMap)
}
// Resource the common properties of an Azure resource.
type Resource struct {
// 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 Resource.
func (r Resource) MarshalJSON() ([]byte, error) {
objectMap := make(map[string]interface{})
if r.Location != nil {
objectMap["location"] = r.Location
}
if r.Tags != nil {
objectMap["tags"] = r.Tags
}
return json.Marshal(objectMap)
}
// SetObject ...
type SetObject struct {
autorest.Response `json:"-"`
Value interface{} `json:"value,omitempty"`
}
// SharedAccessSignatureAuthorizationRule the properties of an IoT hub shared access policy.
type SharedAccessSignatureAuthorizationRule struct {
autorest.Response `json:"-"`
// KeyName - The name of the shared access policy.
KeyName *string `json:"keyName,omitempty"`
// PrimaryKey - The primary key.
PrimaryKey *string `json:"primaryKey,omitempty"`
// SecondaryKey - The secondary key.
SecondaryKey *string `json:"secondaryKey,omitempty"`
// Rights - The permissions assigned to the shared access policy. Possible values include: 'RegistryRead', 'RegistryWrite', 'ServiceConnect', 'DeviceConnect', 'RegistryReadRegistryWrite', 'RegistryReadServiceConnect', 'RegistryReadDeviceConnect', 'RegistryWriteServiceConnect', 'RegistryWriteDeviceConnect', 'ServiceConnectDeviceConnect', 'RegistryReadRegistryWriteServiceConnect', 'RegistryReadRegistryWriteDeviceConnect', 'RegistryReadServiceConnectDeviceConnect', 'RegistryWriteServiceConnectDeviceConnect', 'RegistryReadRegistryWriteServiceConnectDeviceConnect'
Rights AccessRights `json:"rights,omitempty"`
}
// SharedAccessSignatureAuthorizationRuleListResult the list of shared access policies with a next link.
type SharedAccessSignatureAuthorizationRuleListResult struct {
autorest.Response `json:"-"`
// Value - The list of shared access policies.
Value *[]SharedAccessSignatureAuthorizationRule `json:"value,omitempty"`
// NextLink - READ-ONLY; The next link.
NextLink *string `json:"nextLink,omitempty"`
}
// MarshalJSON is the custom marshaler for SharedAccessSignatureAuthorizationRuleListResult.
func (sasarlr SharedAccessSignatureAuthorizationRuleListResult) MarshalJSON() ([]byte, error) {
objectMap := make(map[string]interface{})
if sasarlr.Value != nil {
objectMap["value"] = sasarlr.Value
}
return json.Marshal(objectMap)
}
// SharedAccessSignatureAuthorizationRuleListResultIterator provides access to a complete listing of
// SharedAccessSignatureAuthorizationRule values.
type SharedAccessSignatureAuthorizationRuleListResultIterator struct {
i int
page SharedAccessSignatureAuthorizationRuleListResultPage
}
// 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 *SharedAccessSignatureAuthorizationRuleListResultIterator) NextWithContext(ctx context.Context) (err error) {
if tracing.IsEnabled() {
ctx = tracing.StartSpan(ctx, fqdn+"/SharedAccessSignatureAuthorizationRuleListResultIterator.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 *SharedAccessSignatureAuthorizationRuleListResultIterator) Next() error {
return iter.NextWithContext(context.Background())
}
// NotDone returns true if the enumeration should be started or is not yet complete.
func (iter SharedAccessSignatureAuthorizationRuleListResultIterator) 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 SharedAccessSignatureAuthorizationRuleListResultIterator) Response() SharedAccessSignatureAuthorizationRuleListResult {
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 SharedAccessSignatureAuthorizationRuleListResultIterator) Value() SharedAccessSignatureAuthorizationRule {
if !iter.page.NotDone() {
return SharedAccessSignatureAuthorizationRule{}
}
return iter.page.Values()[iter.i]
}
// Creates a new instance of the SharedAccessSignatureAuthorizationRuleListResultIterator type.
func NewSharedAccessSignatureAuthorizationRuleListResultIterator(page SharedAccessSignatureAuthorizationRuleListResultPage) SharedAccessSignatureAuthorizationRuleListResultIterator {
return SharedAccessSignatureAuthorizationRuleListResultIterator{page: page}
}
// IsEmpty returns true if the ListResult contains no values.
func (sasarlr SharedAccessSignatureAuthorizationRuleListResult) IsEmpty() bool {
return sasarlr.Value == nil || len(*sasarlr.Value) == 0
}
// hasNextLink returns true if the NextLink is not empty.
func (sasarlr SharedAccessSignatureAuthorizationRuleListResult) hasNextLink() bool {
return sasarlr.NextLink != nil && len(*sasarlr.NextLink) != 0
}
// sharedAccessSignatureAuthorizationRuleListResultPreparer prepares a request to retrieve the next set of results.
// It returns nil if no more results exist.
func (sasarlr SharedAccessSignatureAuthorizationRuleListResult) sharedAccessSignatureAuthorizationRuleListResultPreparer(ctx context.Context) (*http.Request, error) {
if !sasarlr.hasNextLink() {
return nil, nil
}
return autorest.Prepare((&http.Request{}).WithContext(ctx),
autorest.AsJSON(),
autorest.AsGet(),
autorest.WithBaseURL(to.String(sasarlr.NextLink)))
}
// SharedAccessSignatureAuthorizationRuleListResultPage contains a page of
// SharedAccessSignatureAuthorizationRule values.
type SharedAccessSignatureAuthorizationRuleListResultPage struct {
fn func(context.Context, SharedAccessSignatureAuthorizationRuleListResult) (SharedAccessSignatureAuthorizationRuleListResult, error)
sasarlr SharedAccessSignatureAuthorizationRuleListResult
}
// 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 *SharedAccessSignatureAuthorizationRuleListResultPage) NextWithContext(ctx context.Context) (err error) {
if tracing.IsEnabled() {
ctx = tracing.StartSpan(ctx, fqdn+"/SharedAccessSignatureAuthorizationRuleListResultPage.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.sasarlr)
if err != nil {
return err
}
page.sasarlr = 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 *SharedAccessSignatureAuthorizationRuleListResultPage) Next() error {
return page.NextWithContext(context.Background())
}
// NotDone returns true if the page enumeration should be started or is not yet complete.
func (page SharedAccessSignatureAuthorizationRuleListResultPage) NotDone() bool {
return !page.sasarlr.IsEmpty()
}
// Response returns the raw server response from the last page request.
func (page SharedAccessSignatureAuthorizationRuleListResultPage) Response() SharedAccessSignatureAuthorizationRuleListResult {
return page.sasarlr
}
// Values returns the slice of values for the current page or nil if there are no values.
func (page SharedAccessSignatureAuthorizationRuleListResultPage) Values() []SharedAccessSignatureAuthorizationRule {
if page.sasarlr.IsEmpty() {
return nil
}
return *page.sasarlr.Value
}
// Creates a new instance of the SharedAccessSignatureAuthorizationRuleListResultPage type.
func NewSharedAccessSignatureAuthorizationRuleListResultPage(cur SharedAccessSignatureAuthorizationRuleListResult, getNextPage func(context.Context, SharedAccessSignatureAuthorizationRuleListResult) (SharedAccessSignatureAuthorizationRuleListResult, error)) SharedAccessSignatureAuthorizationRuleListResultPage {
return SharedAccessSignatureAuthorizationRuleListResultPage{
fn: getNextPage,
sasarlr: cur,
}
}
// StorageEndpointProperties the properties of the Azure Storage endpoint for file upload.
type StorageEndpointProperties struct {
// SasTTLAsIso8601 - The period of time for which the SAS URI generated by IoT Hub for file upload is valid. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.
SasTTLAsIso8601 *string `json:"sasTtlAsIso8601,omitempty"`
// ConnectionString - The connection string for the Azure Storage account to which files are uploaded.
ConnectionString *string `json:"connectionString,omitempty"`
// ContainerName - The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified.
ContainerName *string `json:"containerName,omitempty"`
}
|