@azure-rest/iot-device-update 1.0.0-beta.2 → 1.0.1-alpha.20220923.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.js +4 -4
- package/dist/index.js.map +1 -1
- package/dist-esm/src/clientDefinitions.js.map +1 -1
- package/dist-esm/src/deviceUpdate.js +2 -2
- package/dist-esm/src/deviceUpdate.js.map +1 -1
- package/dist-esm/src/isUnexpected.js +2 -2
- package/dist-esm/src/isUnexpected.js.map +1 -1
- package/dist-esm/src/models.js.map +1 -1
- package/dist-esm/src/outputModels.js.map +1 -1
- package/dist-esm/src/parameters.js.map +1 -1
- package/dist-esm/src/responses.js.map +1 -1
- package/package.json +10 -7
- package/review/iot-device-update.api.md +106 -98
- package/types/iot-device-update.d.ts +123 -117
|
@@ -51,7 +51,7 @@ declare function createClient(endpoint: string, credentials: TokenCredential, op
|
|
|
51
51
|
export default createClient;
|
|
52
52
|
|
|
53
53
|
export declare interface Deployment {
|
|
54
|
-
/** The caller-provided deployment identifier. */
|
|
54
|
+
/** The caller-provided deployment identifier. This cannot be longer than 73 characters, must be all lower-case, and cannot contain '&', '^', '[', ']', '{', '}', '|', '<', '>', forward slash, backslash, or double quote. The Updates view in the Azure Portal IoT Hub resource generates a GUID for deploymentId when you create a deployment. */
|
|
55
55
|
deploymentId: string;
|
|
56
56
|
/** The deployment start datetime. */
|
|
57
57
|
startDateTime: Date | string;
|
|
@@ -92,7 +92,7 @@ export declare interface DeploymentDeviceStatesListOutput {
|
|
|
92
92
|
}
|
|
93
93
|
|
|
94
94
|
export declare interface DeploymentOutput {
|
|
95
|
-
/** The caller-provided deployment identifier. */
|
|
95
|
+
/** The caller-provided deployment identifier. This cannot be longer than 73 characters, must be all lower-case, and cannot contain '&', '^', '[', ']', '{', '}', '|', '<', '>', forward slash, backslash, or double quote. The Updates view in the Azure Portal IoT Hub resource generates a GUID for deploymentId when you create a deployment. */
|
|
96
96
|
deploymentId: string;
|
|
97
97
|
/** The deployment start datetime. */
|
|
98
98
|
startDateTime: string;
|
|
@@ -138,13 +138,13 @@ export declare interface DeviceClassesListOutput {
|
|
|
138
138
|
}
|
|
139
139
|
|
|
140
140
|
export declare interface DeviceClassOutput {
|
|
141
|
-
/** The device class identifier. */
|
|
141
|
+
/** The device class identifier. This is generated from the model Id and the compat properties reported by the device update agent in the Device Update PnP interface in IoT Hub. It is a hex-encoded SHA1 hash. */
|
|
142
142
|
deviceClassId: string;
|
|
143
143
|
/** The device class friendly name. This can be updated by callers after the device class has been automatically created. */
|
|
144
144
|
friendlyName?: string;
|
|
145
145
|
/** The device class properties that are used to calculate the device class Id */
|
|
146
146
|
deviceClassProperties: DeviceClassPropertiesOutput;
|
|
147
|
-
/** Update that is
|
|
147
|
+
/** Update that is the highest version compatible with this device class. */
|
|
148
148
|
bestCompatibleUpdate?: UpdateInfoOutput;
|
|
149
149
|
}
|
|
150
150
|
|
|
@@ -177,7 +177,7 @@ export declare interface DeviceClassSubgroupDeploymentStatusOutput {
|
|
|
177
177
|
}
|
|
178
178
|
|
|
179
179
|
export declare interface DeviceClassSubgroupOutput {
|
|
180
|
-
/** Device class subgroup identity. */
|
|
180
|
+
/** Device class subgroup identity. This is generated from the model Id and the compat properties reported by the device update agent in the Device Update PnP interface in IoT Hub. It is a hex-encoded SHA1 hash. */
|
|
181
181
|
deviceClassId: string;
|
|
182
182
|
/** Group identity. */
|
|
183
183
|
groupId: string;
|
|
@@ -300,13 +300,13 @@ export declare interface DeviceManagementDeleteDeviceClassdefaultResponse extend
|
|
|
300
300
|
|
|
301
301
|
export declare type DeviceManagementDeleteDeviceClassParameters = RequestParameters;
|
|
302
302
|
|
|
303
|
-
/** Deletes a device class subgroup. */
|
|
303
|
+
/** Deletes a device class subgroup. This subgroup is automatically created when a Device Update-enabled device is connected to the hub and reports its properties. Groups, subgroups, and deployments are not automatically cleaned up but are retained for history purposes. Users can call this method to delete a subgroup if they do not need to retain any of the history of the subgroup and no longer need it. If a device is ever connected again for this subgroup after the subgroup was deleted it will be automatically re-created but there will be no history. */
|
|
304
304
|
export declare interface DeviceManagementDeleteDeviceClassSubgroup204Response extends HttpResponse {
|
|
305
305
|
status: "204";
|
|
306
306
|
body: Record<string, unknown>;
|
|
307
307
|
}
|
|
308
308
|
|
|
309
|
-
/** Deletes a device class subgroup. */
|
|
309
|
+
/** Deletes a device class subgroup. This subgroup is automatically created when a Device Update-enabled device is connected to the hub and reports its properties. Groups, subgroups, and deployments are not automatically cleaned up but are retained for history purposes. Users can call this method to delete a subgroup if they do not need to retain any of the history of the subgroup and no longer need it. If a device is ever connected again for this subgroup after the subgroup was deleted it will be automatically re-created but there will be no history. */
|
|
310
310
|
export declare interface DeviceManagementDeleteDeviceClassSubgroupdefaultResponse extends HttpResponse {
|
|
311
311
|
status: string;
|
|
312
312
|
body: ErrorResponseOutput;
|
|
@@ -445,19 +445,19 @@ export declare interface DeviceManagementGetDeviceClassdefaultResponse extends H
|
|
|
445
445
|
export declare type DeviceManagementGetDeviceClassParameters = RequestParameters;
|
|
446
446
|
|
|
447
447
|
export declare interface DeviceManagementGetDeviceClassSubgroup {
|
|
448
|
-
/** Gets device class subgroup details. */
|
|
448
|
+
/** Gets device class subgroup details. A device class subgroup is the set of devices within the group that share the same device class. All devices within the same device class are compatible with the same updates. */
|
|
449
449
|
get(options?: DeviceManagementGetDeviceClassSubgroupParameters): StreamableMethod<DeviceManagementGetDeviceClassSubgroup200Response | DeviceManagementGetDeviceClassSubgroupdefaultResponse>;
|
|
450
|
-
/** Deletes a device class subgroup. */
|
|
450
|
+
/** Deletes a device class subgroup. This subgroup is automatically created when a Device Update-enabled device is connected to the hub and reports its properties. Groups, subgroups, and deployments are not automatically cleaned up but are retained for history purposes. Users can call this method to delete a subgroup if they do not need to retain any of the history of the subgroup and no longer need it. If a device is ever connected again for this subgroup after the subgroup was deleted it will be automatically re-created but there will be no history. */
|
|
451
451
|
delete(options?: DeviceManagementDeleteDeviceClassSubgroupParameters): StreamableMethod<DeviceManagementDeleteDeviceClassSubgroup204Response | DeviceManagementDeleteDeviceClassSubgroupdefaultResponse>;
|
|
452
452
|
}
|
|
453
453
|
|
|
454
|
-
/** Gets device class subgroup details. */
|
|
454
|
+
/** Gets device class subgroup details. A device class subgroup is the set of devices within the group that share the same device class. All devices within the same device class are compatible with the same updates. */
|
|
455
455
|
export declare interface DeviceManagementGetDeviceClassSubgroup200Response extends HttpResponse {
|
|
456
456
|
status: "200";
|
|
457
457
|
body: DeviceClassSubgroupOutput;
|
|
458
458
|
}
|
|
459
459
|
|
|
460
|
-
/** Gets device class subgroup details. */
|
|
460
|
+
/** Gets device class subgroup details. A device class subgroup is the set of devices within the group that share the same device class. All devices within the same device class are compatible with the same updates. */
|
|
461
461
|
export declare interface DeviceManagementGetDeviceClassSubgroupdefaultResponse extends HttpResponse {
|
|
462
462
|
status: string;
|
|
463
463
|
body: ErrorResponseOutput;
|
|
@@ -584,45 +584,45 @@ export declare type DeviceManagementGetLogCollectionDetailedStatusParameters = R
|
|
|
584
584
|
|
|
585
585
|
export declare type DeviceManagementGetLogCollectionParameters = RequestParameters;
|
|
586
586
|
|
|
587
|
-
export declare interface
|
|
587
|
+
export declare interface DeviceManagementGetOperationStatus {
|
|
588
588
|
/** Retrieve operation status. */
|
|
589
|
-
get(options?:
|
|
589
|
+
get(options?: DeviceManagementGetOperationStatusParameters): StreamableMethod<DeviceManagementGetOperationStatus200Response | DeviceManagementGetOperationStatus304Response | DeviceManagementGetOperationStatusdefaultResponse>;
|
|
590
590
|
}
|
|
591
591
|
|
|
592
|
-
export declare interface
|
|
592
|
+
export declare interface DeviceManagementGetOperationStatus200Headers {
|
|
593
593
|
/** Number of seconds to wait before checking the operation status again. */
|
|
594
594
|
"retry-after"?: string;
|
|
595
595
|
}
|
|
596
596
|
|
|
597
597
|
/** Retrieve operation status. */
|
|
598
|
-
export declare interface
|
|
598
|
+
export declare interface DeviceManagementGetOperationStatus200Response extends HttpResponse {
|
|
599
599
|
status: "200";
|
|
600
600
|
body: DeviceOperationOutput;
|
|
601
|
-
headers: RawHttpHeaders &
|
|
601
|
+
headers: RawHttpHeaders & DeviceManagementGetOperationStatus200Headers;
|
|
602
602
|
}
|
|
603
603
|
|
|
604
604
|
/** Retrieve operation status. */
|
|
605
|
-
export declare interface
|
|
605
|
+
export declare interface DeviceManagementGetOperationStatus304Response extends HttpResponse {
|
|
606
606
|
status: "304";
|
|
607
607
|
body: Record<string, unknown>;
|
|
608
608
|
}
|
|
609
609
|
|
|
610
610
|
/** Retrieve operation status. */
|
|
611
|
-
export declare interface
|
|
611
|
+
export declare interface DeviceManagementGetOperationStatusdefaultResponse extends HttpResponse {
|
|
612
612
|
status: string;
|
|
613
613
|
body: ErrorResponseOutput;
|
|
614
614
|
}
|
|
615
615
|
|
|
616
|
-
export declare interface
|
|
617
|
-
headers: RawHttpHeadersInput &
|
|
616
|
+
export declare interface DeviceManagementGetOperationStatusHeaderParam {
|
|
617
|
+
headers: RawHttpHeadersInput & DeviceManagementGetOperationStatusHeaders;
|
|
618
618
|
}
|
|
619
619
|
|
|
620
|
-
export declare interface
|
|
620
|
+
export declare interface DeviceManagementGetOperationStatusHeaders {
|
|
621
621
|
/** Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. */
|
|
622
622
|
"If-None-Match"?: string;
|
|
623
623
|
}
|
|
624
624
|
|
|
625
|
-
export declare type
|
|
625
|
+
export declare type DeviceManagementGetOperationStatusParameters = DeviceManagementGetOperationStatusHeaderParam & RequestParameters;
|
|
626
626
|
|
|
627
627
|
export declare interface DeviceManagementGetUpdateCompliance {
|
|
628
628
|
/** Gets the breakdown of how many devices are on their latest update, have new updates available, or are in progress receiving new updates. */
|
|
@@ -714,16 +714,7 @@ export declare interface DeviceManagementListBestUpdatesForGroupdefaultResponse
|
|
|
714
714
|
body: ErrorResponseOutput;
|
|
715
715
|
}
|
|
716
716
|
|
|
717
|
-
export declare type DeviceManagementListBestUpdatesForGroupParameters =
|
|
718
|
-
|
|
719
|
-
export declare interface DeviceManagementListBestUpdatesForGroupQueryParam {
|
|
720
|
-
queryParameters?: DeviceManagementListBestUpdatesForGroupQueryParamProperties;
|
|
721
|
-
}
|
|
722
|
-
|
|
723
|
-
export declare interface DeviceManagementListBestUpdatesForGroupQueryParamProperties {
|
|
724
|
-
/** Restricts the set of bestUpdates returned. You can filter on update Provider, Name and Version property. This filter is deprecated and should not be used. */
|
|
725
|
-
filter?: string;
|
|
726
|
-
}
|
|
717
|
+
export declare type DeviceManagementListBestUpdatesForGroupParameters = RequestParameters;
|
|
727
718
|
|
|
728
719
|
export declare interface DeviceManagementListDeploymentsForDeviceClassSubgroup {
|
|
729
720
|
/** Gets a list of deployments for a device class subgroup. */
|
|
@@ -782,36 +773,45 @@ export declare interface DeviceManagementListDeploymentsForGroupQueryParamProper
|
|
|
782
773
|
}
|
|
783
774
|
|
|
784
775
|
export declare interface DeviceManagementListDeviceClasses {
|
|
785
|
-
/** Gets a list of all device classes (
|
|
776
|
+
/** Gets a list of all device classes (sets of devices compatible with the same updates based on the model Id and compat properties reported in the Device Update PnP interface in IoT Hub) for all devices connected to Device Update for IoT Hub. */
|
|
786
777
|
get(options?: DeviceManagementListDeviceClassesParameters): StreamableMethod<DeviceManagementListDeviceClasses200Response | DeviceManagementListDeviceClassesdefaultResponse>;
|
|
787
778
|
}
|
|
788
779
|
|
|
789
|
-
/** Gets a list of all device classes (
|
|
780
|
+
/** Gets a list of all device classes (sets of devices compatible with the same updates based on the model Id and compat properties reported in the Device Update PnP interface in IoT Hub) for all devices connected to Device Update for IoT Hub. */
|
|
790
781
|
export declare interface DeviceManagementListDeviceClasses200Response extends HttpResponse {
|
|
791
782
|
status: "200";
|
|
792
783
|
body: DeviceClassesListOutput;
|
|
793
784
|
}
|
|
794
785
|
|
|
795
|
-
/** Gets a list of all device classes (
|
|
786
|
+
/** Gets a list of all device classes (sets of devices compatible with the same updates based on the model Id and compat properties reported in the Device Update PnP interface in IoT Hub) for all devices connected to Device Update for IoT Hub. */
|
|
796
787
|
export declare interface DeviceManagementListDeviceClassesdefaultResponse extends HttpResponse {
|
|
797
788
|
status: string;
|
|
798
789
|
body: ErrorResponseOutput;
|
|
799
790
|
}
|
|
800
791
|
|
|
801
|
-
export declare type DeviceManagementListDeviceClassesParameters = RequestParameters;
|
|
792
|
+
export declare type DeviceManagementListDeviceClassesParameters = DeviceManagementListDeviceClassesQueryParam & RequestParameters;
|
|
793
|
+
|
|
794
|
+
export declare interface DeviceManagementListDeviceClassesQueryParam {
|
|
795
|
+
queryParameters?: DeviceManagementListDeviceClassesQueryParamProperties;
|
|
796
|
+
}
|
|
797
|
+
|
|
798
|
+
export declare interface DeviceManagementListDeviceClassesQueryParamProperties {
|
|
799
|
+
/** Restricts the set of device classes returned. You can filter on friendly name. */
|
|
800
|
+
filter?: string;
|
|
801
|
+
}
|
|
802
802
|
|
|
803
803
|
export declare interface DeviceManagementListDeviceClassSubgroupsForGroup {
|
|
804
|
-
/** Get the device class subgroups for the group. */
|
|
804
|
+
/** Get the device class subgroups for the group. A device class subgroup is the set of devices within the group that share the same device class. All devices within the same device class are compatible with the same updates. */
|
|
805
805
|
get(options?: DeviceManagementListDeviceClassSubgroupsForGroupParameters): StreamableMethod<DeviceManagementListDeviceClassSubgroupsForGroup200Response | DeviceManagementListDeviceClassSubgroupsForGroupdefaultResponse>;
|
|
806
806
|
}
|
|
807
807
|
|
|
808
|
-
/** Get the device class subgroups for the group. */
|
|
808
|
+
/** Get the device class subgroups for the group. A device class subgroup is the set of devices within the group that share the same device class. All devices within the same device class are compatible with the same updates. */
|
|
809
809
|
export declare interface DeviceManagementListDeviceClassSubgroupsForGroup200Response extends HttpResponse {
|
|
810
810
|
status: "200";
|
|
811
811
|
body: DeviceClassSubgroupsListOutput;
|
|
812
812
|
}
|
|
813
813
|
|
|
814
|
-
/** Get the device class subgroups for the group. */
|
|
814
|
+
/** Get the device class subgroups for the group. A device class subgroup is the set of devices within the group that share the same device class. All devices within the same device class are compatible with the same updates. */
|
|
815
815
|
export declare interface DeviceManagementListDeviceClassSubgroupsForGroupdefaultResponse extends HttpResponse {
|
|
816
816
|
status: string;
|
|
817
817
|
body: ErrorResponseOutput;
|
|
@@ -824,38 +824,10 @@ export declare interface DeviceManagementListDeviceClassSubgroupsForGroupQueryPa
|
|
|
824
824
|
}
|
|
825
825
|
|
|
826
826
|
export declare interface DeviceManagementListDeviceClassSubgroupsForGroupQueryParamProperties {
|
|
827
|
-
/** Restricts the set of device class subgroups returned. You can filter on compat properties by name and value. */
|
|
827
|
+
/** Restricts the set of device class subgroups returned. You can filter on compat properties by name and value. (i.e. filter=compatProperties/propertyName1 eq 'value1' and compatProperties/propertyName2 eq 'value2') */
|
|
828
828
|
filter?: string;
|
|
829
829
|
}
|
|
830
830
|
|
|
831
|
-
export declare interface DeviceManagementListDeviceHealth {
|
|
832
|
-
/** Get list of device health */
|
|
833
|
-
get(options: DeviceManagementListDeviceHealthParameters): StreamableMethod<DeviceManagementListDeviceHealth200Response | DeviceManagementListDeviceHealthdefaultResponse>;
|
|
834
|
-
}
|
|
835
|
-
|
|
836
|
-
/** Get list of device health */
|
|
837
|
-
export declare interface DeviceManagementListDeviceHealth200Response extends HttpResponse {
|
|
838
|
-
status: "200";
|
|
839
|
-
body: DeviceHealthListOutput;
|
|
840
|
-
}
|
|
841
|
-
|
|
842
|
-
/** Get list of device health */
|
|
843
|
-
export declare interface DeviceManagementListDeviceHealthdefaultResponse extends HttpResponse {
|
|
844
|
-
status: string;
|
|
845
|
-
body: ErrorResponseOutput;
|
|
846
|
-
}
|
|
847
|
-
|
|
848
|
-
export declare type DeviceManagementListDeviceHealthParameters = DeviceManagementListDeviceHealthQueryParam & RequestParameters;
|
|
849
|
-
|
|
850
|
-
export declare interface DeviceManagementListDeviceHealthQueryParam {
|
|
851
|
-
queryParameters: DeviceManagementListDeviceHealthQueryParamProperties;
|
|
852
|
-
}
|
|
853
|
-
|
|
854
|
-
export declare interface DeviceManagementListDeviceHealthQueryParamProperties {
|
|
855
|
-
/** Filter list by specified properties. */
|
|
856
|
-
filter: string;
|
|
857
|
-
}
|
|
858
|
-
|
|
859
831
|
export declare interface DeviceManagementListDevices {
|
|
860
832
|
/** Gets a list of devices connected to Device Update for IoT Hub. */
|
|
861
833
|
get(options?: DeviceManagementListDevicesParameters): StreamableMethod<DeviceManagementListDevices200Response | DeviceManagementListDevicesdefaultResponse>;
|
|
@@ -880,7 +852,7 @@ export declare interface DeviceManagementListDevicesQueryParam {
|
|
|
880
852
|
}
|
|
881
853
|
|
|
882
854
|
export declare interface DeviceManagementListDevicesQueryParamProperties {
|
|
883
|
-
/** Restricts the set of devices returned. You can filter on GroupId, DeviceClassId, or GroupId and DeploymentStatus. */
|
|
855
|
+
/** Restricts the set of devices returned. You can filter on GroupId, DeviceClassId, or GroupId and DeploymentStatus. Use DeploymentStatus eq null to query for devices with no deployment status (that have never been deployed to). */
|
|
884
856
|
filter?: string;
|
|
885
857
|
}
|
|
886
858
|
|
|
@@ -936,10 +908,38 @@ export declare interface DeviceManagementListGroupsQueryParam {
|
|
|
936
908
|
}
|
|
937
909
|
|
|
938
910
|
export declare interface DeviceManagementListGroupsQueryParamProperties {
|
|
939
|
-
/** Orders the set of groups returned. You can order by
|
|
911
|
+
/** Orders the set of groups returned. You can order by groupId, deviceCount, createdDate, subgroupsWithNewUpdatesAvailableCount, subgroupsWithUpdatesInProgressCount, or subgroupsOnLatestUpdateCount. */
|
|
940
912
|
orderby?: string;
|
|
941
913
|
}
|
|
942
914
|
|
|
915
|
+
export declare interface DeviceManagementListHealthOfDevices {
|
|
916
|
+
/** Get list of device health */
|
|
917
|
+
get(options: DeviceManagementListHealthOfDevicesParameters): StreamableMethod<DeviceManagementListHealthOfDevices200Response | DeviceManagementListHealthOfDevicesdefaultResponse>;
|
|
918
|
+
}
|
|
919
|
+
|
|
920
|
+
/** Get list of device health */
|
|
921
|
+
export declare interface DeviceManagementListHealthOfDevices200Response extends HttpResponse {
|
|
922
|
+
status: "200";
|
|
923
|
+
body: DeviceHealthListOutput;
|
|
924
|
+
}
|
|
925
|
+
|
|
926
|
+
/** Get list of device health */
|
|
927
|
+
export declare interface DeviceManagementListHealthOfDevicesdefaultResponse extends HttpResponse {
|
|
928
|
+
status: string;
|
|
929
|
+
body: ErrorResponseOutput;
|
|
930
|
+
}
|
|
931
|
+
|
|
932
|
+
export declare type DeviceManagementListHealthOfDevicesParameters = DeviceManagementListHealthOfDevicesQueryParam & RequestParameters;
|
|
933
|
+
|
|
934
|
+
export declare interface DeviceManagementListHealthOfDevicesQueryParam {
|
|
935
|
+
queryParameters: DeviceManagementListHealthOfDevicesQueryParamProperties;
|
|
936
|
+
}
|
|
937
|
+
|
|
938
|
+
export declare interface DeviceManagementListHealthOfDevicesQueryParamProperties {
|
|
939
|
+
/** Restricts the set of devices for which device health is returned. You can filter on status, device id and module id. */
|
|
940
|
+
filter: string;
|
|
941
|
+
}
|
|
942
|
+
|
|
943
943
|
export declare interface DeviceManagementListInstallableUpdatesForDeviceClass {
|
|
944
944
|
/** Gets a list of installable updates for a device class. */
|
|
945
945
|
get(options?: DeviceManagementListInstallableUpdatesForDeviceClassParameters): StreamableMethod<DeviceManagementListInstallableUpdatesForDeviceClass200Response | DeviceManagementListInstallableUpdatesForDeviceClassdefaultResponse>;
|
|
@@ -978,30 +978,30 @@ export declare interface DeviceManagementListLogCollectionsdefaultResponse exten
|
|
|
978
978
|
|
|
979
979
|
export declare type DeviceManagementListLogCollectionsParameters = RequestParameters;
|
|
980
980
|
|
|
981
|
-
export declare interface
|
|
981
|
+
export declare interface DeviceManagementListOperationStatuses {
|
|
982
982
|
/** Get a list of all device import operations. Completed operations are kept for 7 days before auto-deleted. */
|
|
983
|
-
get(options?:
|
|
983
|
+
get(options?: DeviceManagementListOperationStatusesParameters): StreamableMethod<DeviceManagementListOperationStatuses200Response | DeviceManagementListOperationStatusesdefaultResponse>;
|
|
984
984
|
}
|
|
985
985
|
|
|
986
986
|
/** Get a list of all device import operations. Completed operations are kept for 7 days before auto-deleted. */
|
|
987
|
-
export declare interface
|
|
987
|
+
export declare interface DeviceManagementListOperationStatuses200Response extends HttpResponse {
|
|
988
988
|
status: "200";
|
|
989
989
|
body: DeviceOperationsListOutput;
|
|
990
990
|
}
|
|
991
991
|
|
|
992
992
|
/** Get a list of all device import operations. Completed operations are kept for 7 days before auto-deleted. */
|
|
993
|
-
export declare interface
|
|
993
|
+
export declare interface DeviceManagementListOperationStatusesdefaultResponse extends HttpResponse {
|
|
994
994
|
status: string;
|
|
995
995
|
body: ErrorResponseOutput;
|
|
996
996
|
}
|
|
997
997
|
|
|
998
|
-
export declare type
|
|
998
|
+
export declare type DeviceManagementListOperationStatusesParameters = DeviceManagementListOperationStatusesQueryParam & RequestParameters;
|
|
999
999
|
|
|
1000
|
-
export declare interface
|
|
1001
|
-
queryParameters?:
|
|
1000
|
+
export declare interface DeviceManagementListOperationStatusesQueryParam {
|
|
1001
|
+
queryParameters?: DeviceManagementListOperationStatusesQueryParamProperties;
|
|
1002
1002
|
}
|
|
1003
1003
|
|
|
1004
|
-
export declare interface
|
|
1004
|
+
export declare interface DeviceManagementListOperationStatusesQueryParamProperties {
|
|
1005
1005
|
/** Restricts the set of operations returned. Only one specific filter is supported: "status eq 'NotStarted' or status eq 'Running'" */
|
|
1006
1006
|
filter?: string;
|
|
1007
1007
|
/** Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n. */
|
|
@@ -1084,7 +1084,7 @@ export declare interface DeviceManagementUpdateDeviceClass200Response extends Ht
|
|
|
1084
1084
|
}
|
|
1085
1085
|
|
|
1086
1086
|
export declare interface DeviceManagementUpdateDeviceClassBodyParam {
|
|
1087
|
-
/** The device class json merge patch body. Currently only supports patching friendlyName */
|
|
1087
|
+
/** The device class json merge patch body. Currently only supports patching friendlyName. */
|
|
1088
1088
|
body: PatchBody;
|
|
1089
1089
|
}
|
|
1090
1090
|
|
|
@@ -1140,7 +1140,7 @@ export declare interface DeviceOutput {
|
|
|
1140
1140
|
deploymentStatus?: "Succeeded" | "InProgress" | "Canceled" | "Failed";
|
|
1141
1141
|
/** Currently installed update on device. */
|
|
1142
1142
|
installedUpdate?: UpdateInfoOutput;
|
|
1143
|
-
/** Boolean flag indicating whether the latest update is installed on the device */
|
|
1143
|
+
/** Boolean flag indicating whether the latest update (the best compatible update for the device's device class and group) is installed on the device */
|
|
1144
1144
|
onLatestUpdate: boolean;
|
|
1145
1145
|
/** The deployment identifier for the last deployment to the device */
|
|
1146
1146
|
lastDeploymentId?: string;
|
|
@@ -1227,45 +1227,45 @@ export declare interface DeviceUpdateGetFileHeaders {
|
|
|
1227
1227
|
|
|
1228
1228
|
export declare type DeviceUpdateGetFileParameters = DeviceUpdateGetFileHeaderParam & RequestParameters;
|
|
1229
1229
|
|
|
1230
|
-
export declare interface
|
|
1230
|
+
export declare interface DeviceUpdateGetOperationStatus {
|
|
1231
1231
|
/** Retrieve operation status. */
|
|
1232
|
-
get(options?:
|
|
1232
|
+
get(options?: DeviceUpdateGetOperationStatusParameters): StreamableMethod<DeviceUpdateGetOperationStatus200Response | DeviceUpdateGetOperationStatus304Response | DeviceUpdateGetOperationStatusdefaultResponse>;
|
|
1233
1233
|
}
|
|
1234
1234
|
|
|
1235
|
-
export declare interface
|
|
1235
|
+
export declare interface DeviceUpdateGetOperationStatus200Headers {
|
|
1236
1236
|
/** Number of seconds to wait before checking the operation status again. */
|
|
1237
1237
|
"retry-after"?: string;
|
|
1238
1238
|
}
|
|
1239
1239
|
|
|
1240
1240
|
/** Retrieve operation status. */
|
|
1241
|
-
export declare interface
|
|
1241
|
+
export declare interface DeviceUpdateGetOperationStatus200Response extends HttpResponse {
|
|
1242
1242
|
status: "200";
|
|
1243
1243
|
body: UpdateOperationOutput;
|
|
1244
|
-
headers: RawHttpHeaders &
|
|
1244
|
+
headers: RawHttpHeaders & DeviceUpdateGetOperationStatus200Headers;
|
|
1245
1245
|
}
|
|
1246
1246
|
|
|
1247
1247
|
/** Retrieve operation status. */
|
|
1248
|
-
export declare interface
|
|
1248
|
+
export declare interface DeviceUpdateGetOperationStatus304Response extends HttpResponse {
|
|
1249
1249
|
status: "304";
|
|
1250
1250
|
body: Record<string, unknown>;
|
|
1251
1251
|
}
|
|
1252
1252
|
|
|
1253
1253
|
/** Retrieve operation status. */
|
|
1254
|
-
export declare interface
|
|
1254
|
+
export declare interface DeviceUpdateGetOperationStatusdefaultResponse extends HttpResponse {
|
|
1255
1255
|
status: string;
|
|
1256
1256
|
body: ErrorResponseOutput;
|
|
1257
1257
|
}
|
|
1258
1258
|
|
|
1259
|
-
export declare interface
|
|
1260
|
-
headers: RawHttpHeadersInput &
|
|
1259
|
+
export declare interface DeviceUpdateGetOperationStatusHeaderParam {
|
|
1260
|
+
headers: RawHttpHeadersInput & DeviceUpdateGetOperationStatusHeaders;
|
|
1261
1261
|
}
|
|
1262
1262
|
|
|
1263
|
-
export declare interface
|
|
1263
|
+
export declare interface DeviceUpdateGetOperationStatusHeaders {
|
|
1264
1264
|
/** Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. */
|
|
1265
1265
|
"If-None-Match"?: string;
|
|
1266
1266
|
}
|
|
1267
1267
|
|
|
1268
|
-
export declare type
|
|
1268
|
+
export declare type DeviceUpdateGetOperationStatusParameters = DeviceUpdateGetOperationStatusHeaderParam & RequestParameters;
|
|
1269
1269
|
|
|
1270
1270
|
export declare interface DeviceUpdateGetUpdate {
|
|
1271
1271
|
/** Get a specific update version. */
|
|
@@ -1305,7 +1305,13 @@ export declare type DeviceUpdateGetUpdateParameters = DeviceUpdateGetUpdateHeade
|
|
|
1305
1305
|
|
|
1306
1306
|
export declare interface DeviceUpdateImportUpdate {
|
|
1307
1307
|
/** Import new update version. This is a long-running-operation; use Operation-Location response header value to check for operation status. */
|
|
1308
|
-
post(options: DeviceUpdateImportUpdateParameters): StreamableMethod<DeviceUpdateImportUpdate202Response | DeviceUpdateImportUpdatedefaultResponse>;
|
|
1308
|
+
post(options: DeviceUpdateImportUpdateParameters): StreamableMethod<DeviceUpdateImportUpdate200Response | DeviceUpdateImportUpdate202Response | DeviceUpdateImportUpdatedefaultResponse>;
|
|
1309
|
+
}
|
|
1310
|
+
|
|
1311
|
+
/** Import new update version. This is a long-running-operation; use Operation-Location response header value to check for operation status. */
|
|
1312
|
+
export declare interface DeviceUpdateImportUpdate200Response extends HttpResponse {
|
|
1313
|
+
status: "200";
|
|
1314
|
+
body: UpdateOutput;
|
|
1309
1315
|
}
|
|
1310
1316
|
|
|
1311
1317
|
export declare interface DeviceUpdateImportUpdate202Headers {
|
|
@@ -1321,7 +1327,7 @@ export declare interface DeviceUpdateImportUpdate202Response extends HttpRespons
|
|
|
1321
1327
|
}
|
|
1322
1328
|
|
|
1323
1329
|
export declare interface DeviceUpdateImportUpdateBodyParam {
|
|
1324
|
-
/** The update to be imported. */
|
|
1330
|
+
/** The update to be imported (see schema https://json.schemastore.org/azure-deviceupdate-import-manifest-5.0.json for details). */
|
|
1325
1331
|
body: Array<ImportUpdateInputItem>;
|
|
1326
1332
|
}
|
|
1327
1333
|
|
|
@@ -1376,31 +1382,31 @@ export declare interface DeviceUpdateListNamesdefaultResponse extends HttpRespon
|
|
|
1376
1382
|
|
|
1377
1383
|
export declare type DeviceUpdateListNamesParameters = RequestParameters;
|
|
1378
1384
|
|
|
1379
|
-
export declare interface
|
|
1385
|
+
export declare interface DeviceUpdateListOperationStatuses {
|
|
1380
1386
|
/** Get a list of all import update operations. Completed operations are kept for 7 days before auto-deleted. Delete operations are not returned by this API version. */
|
|
1381
|
-
get(options?:
|
|
1387
|
+
get(options?: DeviceUpdateListOperationStatusesParameters): StreamableMethod<DeviceUpdateListOperationStatuses200Response | DeviceUpdateListOperationStatusesdefaultResponse>;
|
|
1382
1388
|
}
|
|
1383
1389
|
|
|
1384
1390
|
/** Get a list of all import update operations. Completed operations are kept for 7 days before auto-deleted. Delete operations are not returned by this API version. */
|
|
1385
|
-
export declare interface
|
|
1391
|
+
export declare interface DeviceUpdateListOperationStatuses200Response extends HttpResponse {
|
|
1386
1392
|
status: "200";
|
|
1387
1393
|
body: UpdateOperationsListOutput;
|
|
1388
1394
|
}
|
|
1389
1395
|
|
|
1390
1396
|
/** Get a list of all import update operations. Completed operations are kept for 7 days before auto-deleted. Delete operations are not returned by this API version. */
|
|
1391
|
-
export declare interface
|
|
1397
|
+
export declare interface DeviceUpdateListOperationStatusesdefaultResponse extends HttpResponse {
|
|
1392
1398
|
status: string;
|
|
1393
1399
|
body: ErrorResponseOutput;
|
|
1394
1400
|
}
|
|
1395
1401
|
|
|
1396
|
-
export declare type
|
|
1402
|
+
export declare type DeviceUpdateListOperationStatusesParameters = DeviceUpdateListOperationStatusesQueryParam & RequestParameters;
|
|
1397
1403
|
|
|
1398
|
-
export declare interface
|
|
1399
|
-
queryParameters?:
|
|
1404
|
+
export declare interface DeviceUpdateListOperationStatusesQueryParam {
|
|
1405
|
+
queryParameters?: DeviceUpdateListOperationStatusesQueryParamProperties;
|
|
1400
1406
|
}
|
|
1401
1407
|
|
|
1402
|
-
export declare interface
|
|
1403
|
-
/**
|
|
1408
|
+
export declare interface DeviceUpdateListOperationStatusesQueryParamProperties {
|
|
1409
|
+
/** Optional to filter operations by status property. Only one specific filter is supported: "status eq 'NotStarted' or status eq 'Running'" */
|
|
1404
1410
|
filter?: string;
|
|
1405
1411
|
/** Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n. */
|
|
1406
1412
|
top?: number;
|
|
@@ -1451,7 +1457,7 @@ export declare interface DeviceUpdateListUpdatesQueryParam {
|
|
|
1451
1457
|
export declare interface DeviceUpdateListUpdatesQueryParamProperties {
|
|
1452
1458
|
/** Request updates matching a free-text search expression. */
|
|
1453
1459
|
search?: string;
|
|
1454
|
-
/**
|
|
1460
|
+
/** Optional to filter updates by isDeployable property. */
|
|
1455
1461
|
filter?: string;
|
|
1456
1462
|
}
|
|
1457
1463
|
|
|
@@ -1479,7 +1485,7 @@ export declare interface DeviceUpdateListVersionsQueryParam {
|
|
|
1479
1485
|
}
|
|
1480
1486
|
|
|
1481
1487
|
export declare interface DeviceUpdateListVersionsQueryParamProperties {
|
|
1482
|
-
/**
|
|
1488
|
+
/** Optional to filter updates by isDeployable property. */
|
|
1483
1489
|
filter?: string;
|
|
1484
1490
|
}
|
|
1485
1491
|
|
|
@@ -1533,7 +1539,7 @@ export declare type GetPage<TPage> = (pageLink: string, maxPageSize?: number) =>
|
|
|
1533
1539
|
}>;
|
|
1534
1540
|
|
|
1535
1541
|
export declare interface GroupOutput {
|
|
1536
|
-
/** Group identity. */
|
|
1542
|
+
/** Group identity. This is created from the value of the ADUGroup tag in the Iot Hub's device/module twin or $default for devices with no tag. */
|
|
1537
1543
|
groupId: string;
|
|
1538
1544
|
/** Group type. */
|
|
1539
1545
|
groupType: "IoTHubTag" | "DefaultNoTag";
|
|
@@ -1612,7 +1618,7 @@ export declare interface InstructionsOutput {
|
|
|
1612
1618
|
|
|
1613
1619
|
export declare function isUnexpected(response: DeviceUpdateListUpdates200Response | DeviceUpdateListUpdatesdefaultResponse): response is DeviceUpdateListUpdatesdefaultResponse;
|
|
1614
1620
|
|
|
1615
|
-
export declare function isUnexpected(response: DeviceUpdateImportUpdate202Response | DeviceUpdateImportUpdatedefaultResponse): response is DeviceUpdateImportUpdatedefaultResponse;
|
|
1621
|
+
export declare function isUnexpected(response: DeviceUpdateImportUpdate200Response | DeviceUpdateImportUpdate202Response | DeviceUpdateImportUpdatedefaultResponse): response is DeviceUpdateImportUpdatedefaultResponse;
|
|
1616
1622
|
|
|
1617
1623
|
export declare function isUnexpected(response: DeviceUpdateGetUpdate200Response | DeviceUpdateGetUpdate304Response | DeviceUpdateGetUpdatedefaultResponse): response is DeviceUpdateGetUpdatedefaultResponse;
|
|
1618
1624
|
|
|
@@ -1628,9 +1634,9 @@ export declare function isUnexpected(response: DeviceUpdateListFiles200Response
|
|
|
1628
1634
|
|
|
1629
1635
|
export declare function isUnexpected(response: DeviceUpdateGetFile200Response | DeviceUpdateGetFile304Response | DeviceUpdateGetFiledefaultResponse): response is DeviceUpdateGetFiledefaultResponse;
|
|
1630
1636
|
|
|
1631
|
-
export declare function isUnexpected(response:
|
|
1637
|
+
export declare function isUnexpected(response: DeviceUpdateListOperationStatuses200Response | DeviceUpdateListOperationStatusesdefaultResponse): response is DeviceUpdateListOperationStatusesdefaultResponse;
|
|
1632
1638
|
|
|
1633
|
-
export declare function isUnexpected(response:
|
|
1639
|
+
export declare function isUnexpected(response: DeviceUpdateGetOperationStatus200Response | DeviceUpdateGetOperationStatus304Response | DeviceUpdateGetOperationStatusdefaultResponse): response is DeviceUpdateGetOperationStatusdefaultResponse;
|
|
1634
1640
|
|
|
1635
1641
|
export declare function isUnexpected(response: DeviceManagementListDeviceClasses200Response | DeviceManagementListDeviceClassesdefaultResponse): response is DeviceManagementListDeviceClassesdefaultResponse;
|
|
1636
1642
|
|
|
@@ -1696,9 +1702,9 @@ export declare function isUnexpected(response: DeviceManagementGetDeviceClassSub
|
|
|
1696
1702
|
|
|
1697
1703
|
export declare function isUnexpected(response: DeviceManagementListDeviceStatesForDeviceClassSubgroupDeployment200Response | DeviceManagementListDeviceStatesForDeviceClassSubgroupDeploymentdefaultResponse): response is DeviceManagementListDeviceStatesForDeviceClassSubgroupDeploymentdefaultResponse;
|
|
1698
1704
|
|
|
1699
|
-
export declare function isUnexpected(response:
|
|
1705
|
+
export declare function isUnexpected(response: DeviceManagementGetOperationStatus200Response | DeviceManagementGetOperationStatus304Response | DeviceManagementGetOperationStatusdefaultResponse): response is DeviceManagementGetOperationStatusdefaultResponse;
|
|
1700
1706
|
|
|
1701
|
-
export declare function isUnexpected(response:
|
|
1707
|
+
export declare function isUnexpected(response: DeviceManagementListOperationStatuses200Response | DeviceManagementListOperationStatusesdefaultResponse): response is DeviceManagementListOperationStatusesdefaultResponse;
|
|
1702
1708
|
|
|
1703
1709
|
export declare function isUnexpected(response: DeviceManagementStartLogCollection201Response | DeviceManagementStartLogCollectiondefaultResponse): response is DeviceManagementStartLogCollectiondefaultResponse;
|
|
1704
1710
|
|
|
@@ -1708,7 +1714,7 @@ export declare function isUnexpected(response: DeviceManagementListLogCollection
|
|
|
1708
1714
|
|
|
1709
1715
|
export declare function isUnexpected(response: DeviceManagementGetLogCollectionDetailedStatus200Response | DeviceManagementGetLogCollectionDetailedStatusdefaultResponse): response is DeviceManagementGetLogCollectionDetailedStatusdefaultResponse;
|
|
1710
1716
|
|
|
1711
|
-
export declare function isUnexpected(response:
|
|
1717
|
+
export declare function isUnexpected(response: DeviceManagementListHealthOfDevices200Response | DeviceManagementListHealthOfDevicesdefaultResponse): response is DeviceManagementListHealthOfDevicesdefaultResponse;
|
|
1712
1718
|
|
|
1713
1719
|
export declare interface LogCollection {
|
|
1714
1720
|
/** The log collection id. */
|
|
@@ -1810,7 +1816,7 @@ export declare interface PagingOptions<TResponse> {
|
|
|
1810
1816
|
}
|
|
1811
1817
|
|
|
1812
1818
|
export declare interface PatchBody {
|
|
1813
|
-
/** The device class friendly name. */
|
|
1819
|
+
/** The device class friendly name. Friendly name can be 1-100 characters, alphanumeric, dot, and dash. */
|
|
1814
1820
|
friendlyName: string;
|
|
1815
1821
|
}
|
|
1816
1822
|
|
|
@@ -1832,9 +1838,9 @@ export declare interface Routes {
|
|
|
1832
1838
|
/** Resource for '/deviceUpdate/\{instanceId\}/updates/providers/\{provider\}/names/\{name\}/versions/\{version\}/files/\{fileId\}' has methods for the following verbs: get */
|
|
1833
1839
|
(path: "/deviceUpdate/{instanceId}/updates/providers/{provider}/names/{name}/versions/{version}/files/{fileId}", instanceId: string, provider: string, name: string, version: string, fileId: string): DeviceUpdateGetFile;
|
|
1834
1840
|
/** Resource for '/deviceUpdate/\{instanceId\}/updates/operations' has methods for the following verbs: get */
|
|
1835
|
-
(path: "/deviceUpdate/{instanceId}/updates/operations", instanceId: string):
|
|
1841
|
+
(path: "/deviceUpdate/{instanceId}/updates/operations", instanceId: string): DeviceUpdateListOperationStatuses;
|
|
1836
1842
|
/** Resource for '/deviceUpdate/\{instanceId\}/updates/operations/\{operationId\}' has methods for the following verbs: get */
|
|
1837
|
-
(path: "/deviceUpdate/{instanceId}/updates/operations/{operationId}", instanceId: string, operationId: string):
|
|
1843
|
+
(path: "/deviceUpdate/{instanceId}/updates/operations/{operationId}", instanceId: string, operationId: string): DeviceUpdateGetOperationStatus;
|
|
1838
1844
|
/** Resource for '/deviceUpdate/\{instanceId\}/management/deviceClasses' has methods for the following verbs: get */
|
|
1839
1845
|
(path: "/deviceUpdate/{instanceId}/management/deviceClasses", instanceId: string): DeviceManagementListDeviceClasses;
|
|
1840
1846
|
/** Resource for '/deviceUpdate/\{instanceId\}/management/deviceClasses/\{deviceClassId\}' has methods for the following verbs: get, patch, delete */
|
|
@@ -1886,9 +1892,9 @@ export declare interface Routes {
|
|
|
1886
1892
|
/** Resource for '/deviceUpdate/\{instanceId\}/management/groups/\{groupId\}/deviceClassSubgroups/\{deviceClassId\}/deployments/\{deploymentId\}/devicestates' has methods for the following verbs: get */
|
|
1887
1893
|
(path: "/deviceUpdate/{instanceId}/management/groups/{groupId}/deviceClassSubgroups/{deviceClassId}/deployments/{deploymentId}/devicestates", instanceId: string, groupId: string, deviceClassId: string, deploymentId: string): DeviceManagementListDeviceStatesForDeviceClassSubgroupDeployment;
|
|
1888
1894
|
/** Resource for '/deviceUpdate/\{instanceId\}/management/operations/\{operationId\}' has methods for the following verbs: get */
|
|
1889
|
-
(path: "/deviceUpdate/{instanceId}/management/operations/{operationId}", instanceId: string, operationId: string):
|
|
1895
|
+
(path: "/deviceUpdate/{instanceId}/management/operations/{operationId}", instanceId: string, operationId: string): DeviceManagementGetOperationStatus;
|
|
1890
1896
|
/** Resource for '/deviceUpdate/\{instanceId\}/management/operations' has methods for the following verbs: get */
|
|
1891
|
-
(path: "/deviceUpdate/{instanceId}/management/operations", instanceId: string):
|
|
1897
|
+
(path: "/deviceUpdate/{instanceId}/management/operations", instanceId: string): DeviceManagementListOperationStatuses;
|
|
1892
1898
|
/** Resource for '/deviceUpdate/\{instanceId\}/management/deviceDiagnostics/logCollections/\{operationId\}' has methods for the following verbs: put, get */
|
|
1893
1899
|
(path: "/deviceUpdate/{instanceId}/management/deviceDiagnostics/logCollections/{operationId}", instanceId: string, operationId: string): DeviceManagementStartLogCollection;
|
|
1894
1900
|
/** Resource for '/deviceUpdate/\{instanceId\}/management/deviceDiagnostics/logCollections' has methods for the following verbs: get */
|
|
@@ -1896,7 +1902,7 @@ export declare interface Routes {
|
|
|
1896
1902
|
/** Resource for '/deviceUpdate/\{instanceId\}/management/deviceDiagnostics/logCollections/\{operationId\}/detailedStatus' has methods for the following verbs: get */
|
|
1897
1903
|
(path: "/deviceUpdate/{instanceId}/management/deviceDiagnostics/logCollections/{operationId}/detailedStatus", instanceId: string, operationId: string): DeviceManagementGetLogCollectionDetailedStatus;
|
|
1898
1904
|
/** Resource for '/deviceUpdate/\{instanceId\}/management/deviceDiagnostics/deviceHealth' has methods for the following verbs: get */
|
|
1899
|
-
(path: "/deviceUpdate/{instanceId}/management/deviceDiagnostics/deviceHealth", instanceId: string):
|
|
1905
|
+
(path: "/deviceUpdate/{instanceId}/management/deviceDiagnostics/deviceHealth", instanceId: string): DeviceManagementListHealthOfDevices;
|
|
1900
1906
|
}
|
|
1901
1907
|
|
|
1902
1908
|
export declare interface StepOutput {
|