@azure-rest/iot-device-update package

Interfaces

CloudInitiatedRollbackPolicy	Rollback policy for deployment
CloudInitiatedRollbackPolicyFailure	Failure conditions to initiate rollback policy
CloudInitiatedRollbackPolicyFailureOutput	Failure conditions to initiate rollback policy
CloudInitiatedRollbackPolicyOutput	Rollback policy for deployment
ContractModelOutput	The Device Update agent contract model.
Deployment	Deployment metadata.
DeploymentDeviceStateOutput	Deployment device status.
DeploymentDeviceStatesListOutput	The list of deployment device states.
DeploymentOutput	Deployment metadata.
DeploymentStatusOutput	Deployment status metadata.
DeploymentsListOutput	The list of deployments.
DeviceClassOutput	Device class metadata.
DeviceClassPropertiesOutput	The device class properties that are used to calculate the device class Id
DeviceClassSubgroupDeploymentStatusOutput	Device class subgroup deployment status metadata.
DeviceClassSubgroupOutput	Device class subgroup details. A device class subgroup is a subset of devices in a group that share the same device class id.
DeviceClassSubgroupUpdatableDevicesListOutput	The list of updatable devices for a device class subgroup.
DeviceClassSubgroupUpdatableDevicesOutput	Device class subgroup, update information, and the number of devices for which the update is applicable.
DeviceClassSubgroupsListOutput	The list of device class subgroups within a group.
DeviceClassesListOutput	The list of device classes.
DeviceHealthListOutput	Array of Device Health, with server paging support.
DeviceHealthOutput	Device Health
DeviceManagementCreateOrUpdateDeployment200Response	Creates or updates a deployment.
DeviceManagementCreateOrUpdateDeploymentBodyParam
DeviceManagementCreateOrUpdateDeploymentDefaultResponse	Creates or updates a deployment.
DeviceManagementCreateOrUpdateDeploymentMediaTypesParam
DeviceManagementDeleteDeployment204Response	Deletes a deployment.
DeviceManagementDeleteDeploymentDefaultResponse	Deletes a deployment.
DeviceManagementDeleteDeploymentForDeviceClassSubgroup204Response	Deletes a device class subgroup deployment.
DeviceManagementDeleteDeploymentForDeviceClassSubgroupDefaultResponse	Deletes a device class subgroup deployment.
DeviceManagementDeleteDeviceClass204Response	Deletes a device class. Device classes are created automatically when Device Update-enabled devices are connected to the hub but are not automatically cleaned up since they are referenced by DeviceClassSubgroups. If the user has deleted all DeviceClassSubgroups for a device class they can also delete the device class to remove the records from the system and to stop checking the compatibility of this device class with new updates. If a device is ever reconnected for this device class it will be re-created.
DeviceManagementDeleteDeviceClassDefaultResponse	Deletes a device class. Device classes are created automatically when Device Update-enabled devices are connected to the hub but are not automatically cleaned up since they are referenced by DeviceClassSubgroups. If the user has deleted all DeviceClassSubgroups for a device class they can also delete the device class to remove the records from the system and to stop checking the compatibility of this device class with new updates. If a device is ever reconnected for this device class it will be re-created.
DeviceManagementDeleteDeviceClassSubgroup204Response	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.
DeviceManagementDeleteDeviceClassSubgroupDefaultResponse	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.
DeviceManagementDeleteGroup204Response	Deletes a device group. This group 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 group if they do not need to retain any of the history of the group and no longer need it. If a device is ever connected again for this group after the group was deleted it will be automatically re-created but there will be no history.
DeviceManagementDeleteGroupDefaultResponse	Deletes a device group. This group 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 group if they do not need to retain any of the history of the group and no longer need it. If a device is ever connected again for this group after the group was deleted it will be automatically re-created but there will be no history.
DeviceManagementGetBestUpdatesForDeviceClassSubgroup
DeviceManagementGetBestUpdatesForDeviceClassSubgroup200Response	Get the best available update for a device class subgroup and a count of how many devices need this update.
DeviceManagementGetBestUpdatesForDeviceClassSubgroupDefaultResponse	Get the best available update for a device class subgroup and a count of how many devices need this update.
DeviceManagementGetDeployment
DeviceManagementGetDeployment200Response	Gets the deployment properties.
DeviceManagementGetDeploymentDefaultResponse	Gets the deployment properties.
DeviceManagementGetDeploymentForDeviceClassSubgroup
DeviceManagementGetDeploymentForDeviceClassSubgroup200Response	Gets the deployment properties.
DeviceManagementGetDeploymentForDeviceClassSubgroupDefaultResponse	Gets the deployment properties.
DeviceManagementGetDeploymentStatus
DeviceManagementGetDeploymentStatus200Response	Gets the status of a deployment including a breakdown of how many devices in the deployment are in progress, completed, or failed.
DeviceManagementGetDeploymentStatusDefaultResponse	Gets the status of a deployment including a breakdown of how many devices in the deployment are in progress, completed, or failed.
DeviceManagementGetDevice
DeviceManagementGetDevice200Response	Gets the device properties and latest deployment status for a device connected to Device Update for IoT Hub.
DeviceManagementGetDeviceClass
DeviceManagementGetDeviceClass200Response	Gets the properties of a device class.
DeviceManagementGetDeviceClassDefaultResponse	Gets the properties of a device class.
DeviceManagementGetDeviceClassSubgroup
DeviceManagementGetDeviceClassSubgroup200Response	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.
DeviceManagementGetDeviceClassSubgroupDefaultResponse	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.
DeviceManagementGetDeviceClassSubgroupDeploymentStatus
DeviceManagementGetDeviceClassSubgroupDeploymentStatus200Response	Gets the status of a deployment including a breakdown of how many devices in the deployment are in progress, completed, or failed.
DeviceManagementGetDeviceClassSubgroupDeploymentStatusDefaultResponse	Gets the status of a deployment including a breakdown of how many devices in the deployment are in progress, completed, or failed.
DeviceManagementGetDeviceClassSubgroupUpdateCompliance
DeviceManagementGetDeviceClassSubgroupUpdateCompliance200Response	Get device class subgroup update compliance information such as how many devices are on their latest update, how many need new updates, and how many are in progress on receiving a new update.
DeviceManagementGetDeviceClassSubgroupUpdateComplianceDefaultResponse	Get device class subgroup update compliance information such as how many devices are on their latest update, how many need new updates, and how many are in progress on receiving a new update.
DeviceManagementGetDeviceDefaultResponse	Gets the device properties and latest deployment status for a device connected to Device Update for IoT Hub.
DeviceManagementGetDeviceModule
DeviceManagementGetDeviceModule200Response	Gets the device module properties and latest deployment status for a device module connected to Device Update for IoT Hub.
DeviceManagementGetDeviceModuleDefaultResponse	Gets the device module properties and latest deployment status for a device module connected to Device Update for IoT Hub.
DeviceManagementGetGroup
DeviceManagementGetGroup200Response	Gets the device group properties.
DeviceManagementGetGroupDefaultResponse	Gets the device group properties.
DeviceManagementGetLogCollection200Response	Get the device diagnostics log collection
DeviceManagementGetLogCollectionDefaultResponse	Get the device diagnostics log collection
DeviceManagementGetLogCollectionDetailedStatus
DeviceManagementGetLogCollectionDetailedStatus200Response	Get log collection with detailed status
DeviceManagementGetLogCollectionDetailedStatusDefaultResponse	Get log collection with detailed status
DeviceManagementGetOperationStatus
DeviceManagementGetOperationStatus200Headers
DeviceManagementGetOperationStatus200Response	Retrieve operation status.
DeviceManagementGetOperationStatus304Response	Retrieve operation status.
DeviceManagementGetOperationStatusDefaultResponse	Retrieve operation status.
DeviceManagementGetOperationStatusHeaderParam
DeviceManagementGetOperationStatusHeaders
DeviceManagementGetUpdateCompliance
DeviceManagementGetUpdateCompliance200Response	Gets the breakdown of how many devices are on their latest update, have new updates available, or are in progress receiving new updates.
DeviceManagementGetUpdateComplianceDefaultResponse	Gets the breakdown of how many devices are on their latest update, have new updates available, or are in progress receiving new updates.
DeviceManagementGetUpdateComplianceForGroup
DeviceManagementGetUpdateComplianceForGroup200Response	Get device group update compliance information such as how many devices are on their latest update, how many need new updates, and how many are in progress on receiving a new update.
DeviceManagementGetUpdateComplianceForGroupDefaultResponse	Get device group update compliance information such as how many devices are on their latest update, how many need new updates, and how many are in progress on receiving a new update.
DeviceManagementImportDevices
DeviceManagementImportDevices202Headers
DeviceManagementImportDevices202Response	Import existing devices from IoT Hub. This is a long-running-operation; use Operation-Location response header value to check for operation status.
DeviceManagementImportDevicesBodyParam
DeviceManagementImportDevicesDefaultResponse	Import existing devices from IoT Hub. This is a long-running-operation; use Operation-Location response header value to check for operation status.
DeviceManagementImportDevicesMediaTypesParam
DeviceManagementListBestUpdatesForGroup
DeviceManagementListBestUpdatesForGroup200Response	Get the best available updates for a device group and a count of how many devices need each update.
DeviceManagementListBestUpdatesForGroupDefaultResponse	Get the best available updates for a device group and a count of how many devices need each update.
DeviceManagementListDeploymentsForDeviceClassSubgroup
DeviceManagementListDeploymentsForDeviceClassSubgroup200Response	Gets a list of deployments for a device class subgroup.
DeviceManagementListDeploymentsForDeviceClassSubgroupDefaultResponse	Gets a list of deployments for a device class subgroup.
DeviceManagementListDeploymentsForDeviceClassSubgroupQueryParam
DeviceManagementListDeploymentsForDeviceClassSubgroupQueryParamProperties
DeviceManagementListDeploymentsForGroup
DeviceManagementListDeploymentsForGroup200Response	Gets a list of deployments for a device group.
DeviceManagementListDeploymentsForGroupDefaultResponse	Gets a list of deployments for a device group.
DeviceManagementListDeploymentsForGroupQueryParam
DeviceManagementListDeploymentsForGroupQueryParamProperties
DeviceManagementListDeviceClassSubgroupsForGroup
DeviceManagementListDeviceClassSubgroupsForGroup200Response	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.
DeviceManagementListDeviceClassSubgroupsForGroupDefaultResponse	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.
DeviceManagementListDeviceClassSubgroupsForGroupQueryParam
DeviceManagementListDeviceClassSubgroupsForGroupQueryParamProperties
DeviceManagementListDeviceClasses
DeviceManagementListDeviceClasses200Response	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.
DeviceManagementListDeviceClassesDefaultResponse	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.
DeviceManagementListDeviceClassesQueryParam
DeviceManagementListDeviceClassesQueryParamProperties
DeviceManagementListDeviceStatesForDeviceClassSubgroupDeployment
DeviceManagementListDeviceStatesForDeviceClassSubgroupDeployment200Response	Gets a list of devices in a deployment along with their state. Useful for getting a list of failed devices.
DeviceManagementListDeviceStatesForDeviceClassSubgroupDeploymentDefaultResponse	Gets a list of devices in a deployment along with their state. Useful for getting a list of failed devices.
DeviceManagementListDeviceStatesForDeviceClassSubgroupDeploymentQueryParam
DeviceManagementListDeviceStatesForDeviceClassSubgroupDeploymentQueryParamProperties
DeviceManagementListDevices
DeviceManagementListDevices200Response	Gets a list of devices connected to Device Update for IoT Hub.
DeviceManagementListDevicesDefaultResponse	Gets a list of devices connected to Device Update for IoT Hub.
DeviceManagementListDevicesQueryParam
DeviceManagementListDevicesQueryParamProperties
DeviceManagementListGroups
DeviceManagementListGroups200Response	Gets a list of all device groups. The $default group will always be returned first.
DeviceManagementListGroupsDefaultResponse	Gets a list of all device groups. The $default group will always be returned first.
DeviceManagementListGroupsQueryParam
DeviceManagementListGroupsQueryParamProperties
DeviceManagementListHealthOfDevices
DeviceManagementListHealthOfDevices200Response	Get list of device health
DeviceManagementListHealthOfDevicesDefaultResponse	Get list of device health
DeviceManagementListHealthOfDevicesQueryParam
DeviceManagementListHealthOfDevicesQueryParamProperties
DeviceManagementListInstallableUpdatesForDeviceClass
DeviceManagementListInstallableUpdatesForDeviceClass200Response	Gets a list of installable updates for a device class.
DeviceManagementListInstallableUpdatesForDeviceClassDefaultResponse	Gets a list of installable updates for a device class.
DeviceManagementListLogCollections
DeviceManagementListLogCollections200Response	Get all device diagnostics log collections
DeviceManagementListLogCollectionsDefaultResponse	Get all device diagnostics log collections
DeviceManagementListOperationStatuses
DeviceManagementListOperationStatuses200Response	Get a list of all device import operations. Completed operations are kept for 7 days before auto-deleted.
DeviceManagementListOperationStatusesDefaultResponse	Get a list of all device import operations. Completed operations are kept for 7 days before auto-deleted.
DeviceManagementListOperationStatusesQueryParam
DeviceManagementListOperationStatusesQueryParamProperties
DeviceManagementRetryDeployment
DeviceManagementRetryDeployment200Response	Retries a deployment with failed devices.
DeviceManagementRetryDeploymentDefaultResponse	Retries a deployment with failed devices.
DeviceManagementStartLogCollection
DeviceManagementStartLogCollection201Response	Start the device diagnostics log collection on specified devices.
DeviceManagementStartLogCollectionBodyParam
DeviceManagementStartLogCollectionDefaultResponse	Start the device diagnostics log collection on specified devices.
DeviceManagementStartLogCollectionMediaTypesParam
DeviceManagementStopDeployment
DeviceManagementStopDeployment200Response	Stops a deployment.
DeviceManagementStopDeploymentDefaultResponse	Stops a deployment.
DeviceManagementUpdateDeviceClass200Response	Update device class details.
DeviceManagementUpdateDeviceClassBodyParam
DeviceManagementUpdateDeviceClassDefaultResponse	Update device class details.
DeviceManagementUpdateDeviceClassMediaTypesParam
DeviceOperationOutput	Operation metadata.
DeviceOperationsListOutput	The list of device operations with server paging support.
DeviceOutput	Device metadata.
DeviceUpdateAgentId	Device Update agent id
DeviceUpdateAgentIdOutput	Device Update agent id
DeviceUpdateClientOptions	The optional parameters for the client
DeviceUpdateDeleteUpdate202Headers
DeviceUpdateDeleteUpdate202Response	Delete a specific update version. This is a long-running-operation; use Operation-Location response header value to check for operation status.
DeviceUpdateDeleteUpdateDefaultResponse	Delete a specific update version. This is a long-running-operation; use Operation-Location response header value to check for operation status.
DeviceUpdateGetFile
DeviceUpdateGetFile200Response	Get a specific update file from the version.
DeviceUpdateGetFile304Response	Get a specific update file from the version.
DeviceUpdateGetFileDefaultResponse	Get a specific update file from the version.
DeviceUpdateGetFileHeaderParam
DeviceUpdateGetFileHeaders
DeviceUpdateGetOperationStatus
DeviceUpdateGetOperationStatus200Headers
DeviceUpdateGetOperationStatus200Response	Retrieve operation status.
DeviceUpdateGetOperationStatus304Response	Retrieve operation status.
DeviceUpdateGetOperationStatusDefaultResponse	Retrieve operation status.
DeviceUpdateGetOperationStatusHeaderParam
DeviceUpdateGetOperationStatusHeaders
DeviceUpdateGetUpdate
DeviceUpdateGetUpdate200Response	Get a specific update version.
DeviceUpdateGetUpdate304Response	Get a specific update version.
DeviceUpdateGetUpdateDefaultResponse	Get a specific update version.
DeviceUpdateGetUpdateHeaderParam
DeviceUpdateGetUpdateHeaders
DeviceUpdateImportUpdate
DeviceUpdateImportUpdate200Response	Import new update version. This is a long-running-operation; use Operation-Location response header value to check for operation status.
DeviceUpdateImportUpdate202Headers
DeviceUpdateImportUpdate202Response	Import new update version. This is a long-running-operation; use Operation-Location response header value to check for operation status.
DeviceUpdateImportUpdateBodyParam
DeviceUpdateImportUpdateDefaultResponse	Import new update version. This is a long-running-operation; use Operation-Location response header value to check for operation status.
DeviceUpdateImportUpdateMediaTypesParam
DeviceUpdateListFiles
DeviceUpdateListFiles200Response	Get a list of all update file identifiers for the specified version.
DeviceUpdateListFilesDefaultResponse	Get a list of all update file identifiers for the specified version.
DeviceUpdateListNames
DeviceUpdateListNames200Response	Get a list of all update names that match the specified provider.
DeviceUpdateListNamesDefaultResponse	Get a list of all update names that match the specified provider.
DeviceUpdateListOperationStatuses
DeviceUpdateListOperationStatuses200Response	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.
DeviceUpdateListOperationStatusesDefaultResponse	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.
DeviceUpdateListOperationStatusesQueryParam
DeviceUpdateListOperationStatusesQueryParamProperties
DeviceUpdateListProviders
DeviceUpdateListProviders200Response	Get a list of all update providers that have been imported to Device Update for IoT Hub.
DeviceUpdateListProvidersDefaultResponse	Get a list of all update providers that have been imported to Device Update for IoT Hub.
DeviceUpdateListUpdates
DeviceUpdateListUpdates200Response	Get a list of all updates that have been imported to Device Update for IoT Hub.
DeviceUpdateListUpdatesDefaultResponse	Get a list of all updates that have been imported to Device Update for IoT Hub.
DeviceUpdateListUpdatesQueryParam
DeviceUpdateListUpdatesQueryParamProperties
DeviceUpdateListVersions
DeviceUpdateListVersions200Response	Get a list of all update versions that match the specified provider and name.
DeviceUpdateListVersionsDefaultResponse	Get a list of all update versions that match the specified provider and name.
DeviceUpdateListVersionsQueryParam
DeviceUpdateListVersionsQueryParamProperties
DevicesListOutput	The list of devices.
ErrorModelOutput	Error details.
ErrorResponseOutput	Common error response.
FileImportMetadata	Metadata describing an update file.
GroupOutput	Group details.
GroupsListOutput	The list of groups.
HealthCheckOutput	Health check
ImportManifestMetadata	Metadata describing the import manifest, a document which describes the files and other metadata about an update version.
ImportUpdateInputItem	Import update input item metadata.
InnerErrorOutput	An object containing more specific information than the current object about the error.
InstallResultOutput	The install result of an update and any step results under it.
InstructionsOutput
LogCollection	Diagnostics request body
LogCollectionListOutput	The list of log collections with server paging support.
LogCollectionOperationDetailedStatusOutput	Device diagnostics operation detailed status
LogCollectionOperationDeviceStatusOutput	Diagnostics operation device status
LogCollectionOutput	Diagnostics request body
PageSettings	An interface that tracks the settings for paged iteration
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PagingOptions	Options for the paging helper
PatchBody	Device Class JSON Merge Patch request body
Routes
SimplePollerLike	A simple poller that can be used to poll a long running operation.
StepOutput	Update install instruction step.
StepResultOutput	The step result under an update.
StringsListOutput	The list of strings with server paging support.
UpdateComplianceOutput	Update compliance information.
UpdateFileBaseOutput	Update file basic metadata.
UpdateFileDownloadHandlerOutput	Download handler for utilizing related files to download payload file.
UpdateFileOutput	Update file metadata.
UpdateId	Update identifier.
UpdateIdOutput	Update identifier.
UpdateInfo	Update information.
UpdateInfoListOutput	List of update information.
UpdateInfoOutput	Update information.
UpdateListOutput	The list of updates.
UpdateOperationOutput	Operation metadata.
UpdateOperationsListOutput	The list of operations with server paging support.
UpdateOutput	Update metadata.

Type Aliases

DeviceManagementCreateOrUpdateDeploymentParameters
DeviceManagementDeleteDeploymentForDeviceClassSubgroupParameters
DeviceManagementDeleteDeploymentParameters
DeviceManagementDeleteDeviceClassParameters
DeviceManagementDeleteDeviceClassSubgroupParameters
DeviceManagementDeleteGroupParameters
DeviceManagementGetBestUpdatesForDeviceClassSubgroupParameters
DeviceManagementGetDeploymentForDeviceClassSubgroupParameters
DeviceManagementGetDeploymentParameters
DeviceManagementGetDeploymentStatusParameters
DeviceManagementGetDeviceClassParameters
DeviceManagementGetDeviceClassSubgroupDeploymentStatusParameters
DeviceManagementGetDeviceClassSubgroupParameters
DeviceManagementGetDeviceClassSubgroupUpdateComplianceParameters
DeviceManagementGetDeviceModuleParameters
DeviceManagementGetDeviceParameters
DeviceManagementGetGroupParameters
DeviceManagementGetLogCollectionDetailedStatusParameters
DeviceManagementGetLogCollectionParameters
DeviceManagementGetOperationStatusParameters
DeviceManagementGetUpdateComplianceForGroupParameters
DeviceManagementGetUpdateComplianceParameters
DeviceManagementImportDevicesParameters
DeviceManagementListBestUpdatesForGroupParameters
DeviceManagementListDeploymentsForDeviceClassSubgroupParameters
DeviceManagementListDeploymentsForGroupParameters
DeviceManagementListDeviceClassSubgroupsForGroupParameters
DeviceManagementListDeviceClassesParameters
DeviceManagementListDeviceStatesForDeviceClassSubgroupDeploymentParameters
DeviceManagementListDevicesParameters
DeviceManagementListGroupsParameters
DeviceManagementListHealthOfDevicesParameters
DeviceManagementListInstallableUpdatesForDeviceClassParameters
DeviceManagementListLogCollectionsParameters
DeviceManagementListOperationStatusesParameters
DeviceManagementRetryDeploymentParameters
DeviceManagementStartLogCollectionParameters
DeviceManagementStopDeploymentParameters
DeviceManagementUpdateDeviceClassParameters
DeviceUpdateClient
DeviceUpdateDeleteUpdateParameters
DeviceUpdateGetFileParameters
DeviceUpdateGetOperationStatusParameters
DeviceUpdateGetUpdateParameters
DeviceUpdateImportUpdateParameters
DeviceUpdateListFilesParameters
DeviceUpdateListNamesParameters
DeviceUpdateListOperationStatusesParameters
DeviceUpdateListProvidersParameters
DeviceUpdateListUpdatesParameters
DeviceUpdateListVersionsParameters
GetArrayType	Helper type to extract the type of an array
GetPage	The type of a custom function that defines how to get a page and a link to the next one if any.
PaginateReturn	Helper type to infer the Type of the paged elements from the response type This type is generated based on the swagger information for x-ms-pageable specifically on the itemName property which indicates the property of the response where the page items are found. The default value is value. This type will allow us to provide strongly typed Iterator based on the response we get as second parameter
PatchBodyResourceMergeAndPatch	The device class json merge patch body. Currently only supports patching friendlyName.

Functions

default(string, TokenCredential, DeviceUpdateClientOptions)	Initialize a new instance of DeviceUpdateClient
getLongRunningPoller<TResult>(Client, TResult, CreateHttpPollerOptions<TResult, OperationState<TResult>>)	Helper function that builds a Poller object to help polling a long running operation.
isUnexpected(DeviceUpdateListUpdates200Response | DeviceUpdateListUpdatesDefaultResponse)
isUnexpected(DeviceUpdateImportUpdate200Response | DeviceUpdateImportUpdate202Response | DeviceUpdateImportUpdateDefaultResponse)
isUnexpected(DeviceUpdateGetUpdate200Response | DeviceUpdateGetUpdate304Response | DeviceUpdateGetUpdateDefaultResponse)
isUnexpected(DeviceUpdateDeleteUpdate202Response | DeviceUpdateDeleteUpdateDefaultResponse)
isUnexpected(DeviceUpdateListProviders200Response | DeviceUpdateListProvidersDefaultResponse)
isUnexpected(DeviceUpdateListNames200Response | DeviceUpdateListNamesDefaultResponse)
isUnexpected(DeviceUpdateListVersions200Response | DeviceUpdateListVersionsDefaultResponse)
isUnexpected(DeviceUpdateListFiles200Response | DeviceUpdateListFilesDefaultResponse)
isUnexpected(DeviceUpdateGetFile200Response | DeviceUpdateGetFile304Response | DeviceUpdateGetFileDefaultResponse)
isUnexpected(DeviceUpdateListOperationStatuses200Response | DeviceUpdateListOperationStatusesDefaultResponse)
isUnexpected(DeviceUpdateGetOperationStatus200Response | DeviceUpdateGetOperationStatus304Response | DeviceUpdateGetOperationStatusDefaultResponse)
isUnexpected(DeviceManagementListDeviceClasses200Response | DeviceManagementListDeviceClassesDefaultResponse)
isUnexpected(DeviceManagementGetDeviceClass200Response | DeviceManagementGetDeviceClassDefaultResponse)
isUnexpected(DeviceManagementUpdateDeviceClass200Response | DeviceManagementUpdateDeviceClassDefaultResponse)
isUnexpected(DeviceManagementDeleteDeviceClass204Response | DeviceManagementDeleteDeviceClassDefaultResponse)
isUnexpected(DeviceManagementListInstallableUpdatesForDeviceClass200Response | DeviceManagementListInstallableUpdatesForDeviceClassDefaultResponse)
isUnexpected(DeviceManagementListDevices200Response | DeviceManagementListDevicesDefaultResponse)
isUnexpected(DeviceManagementImportDevices202Response | DeviceManagementImportDevicesDefaultResponse)
isUnexpected(DeviceManagementGetDevice200Response | DeviceManagementGetDeviceDefaultResponse)
isUnexpected(DeviceManagementGetDeviceModule200Response | DeviceManagementGetDeviceModuleDefaultResponse)
isUnexpected(DeviceManagementGetUpdateCompliance200Response | DeviceManagementGetUpdateComplianceDefaultResponse)
isUnexpected(DeviceManagementListGroups200Response | DeviceManagementListGroupsDefaultResponse)
isUnexpected(DeviceManagementGetGroup200Response | DeviceManagementGetGroupDefaultResponse)
isUnexpected(DeviceManagementDeleteGroup204Response | DeviceManagementDeleteGroupDefaultResponse)
isUnexpected(DeviceManagementGetUpdateComplianceForGroup200Response | DeviceManagementGetUpdateComplianceForGroupDefaultResponse)
isUnexpected(DeviceManagementListBestUpdatesForGroup200Response | DeviceManagementListBestUpdatesForGroupDefaultResponse)
isUnexpected(DeviceManagementListDeploymentsForGroup200Response | DeviceManagementListDeploymentsForGroupDefaultResponse)
isUnexpected(DeviceManagementGetDeployment200Response | DeviceManagementGetDeploymentDefaultResponse)
isUnexpected(DeviceManagementCreateOrUpdateDeployment200Response | DeviceManagementCreateOrUpdateDeploymentDefaultResponse)
isUnexpected(DeviceManagementDeleteDeployment204Response | DeviceManagementDeleteDeploymentDefaultResponse)
isUnexpected(DeviceManagementGetDeploymentStatus200Response | DeviceManagementGetDeploymentStatusDefaultResponse)
isUnexpected(DeviceManagementListDeviceClassSubgroupsForGroup200Response | DeviceManagementListDeviceClassSubgroupsForGroupDefaultResponse)
isUnexpected(DeviceManagementGetDeviceClassSubgroup200Response | DeviceManagementGetDeviceClassSubgroupDefaultResponse)
isUnexpected(DeviceManagementDeleteDeviceClassSubgroup204Response | DeviceManagementDeleteDeviceClassSubgroupDefaultResponse)
isUnexpected(DeviceManagementGetDeviceClassSubgroupUpdateCompliance200Response | DeviceManagementGetDeviceClassSubgroupUpdateComplianceDefaultResponse)
isUnexpected(DeviceManagementGetBestUpdatesForDeviceClassSubgroup200Response | DeviceManagementGetBestUpdatesForDeviceClassSubgroupDefaultResponse)
isUnexpected(DeviceManagementListDeploymentsForDeviceClassSubgroup200Response | DeviceManagementListDeploymentsForDeviceClassSubgroupDefaultResponse)
isUnexpected(DeviceManagementGetDeploymentForDeviceClassSubgroup200Response | DeviceManagementGetDeploymentForDeviceClassSubgroupDefaultResponse)
isUnexpected(DeviceManagementDeleteDeploymentForDeviceClassSubgroup204Response | DeviceManagementDeleteDeploymentForDeviceClassSubgroupDefaultResponse)
isUnexpected(DeviceManagementStopDeployment200Response | DeviceManagementStopDeploymentDefaultResponse)
isUnexpected(DeviceManagementRetryDeployment200Response | DeviceManagementRetryDeploymentDefaultResponse)
isUnexpected(DeviceManagementGetDeviceClassSubgroupDeploymentStatus200Response | DeviceManagementGetDeviceClassSubgroupDeploymentStatusDefaultResponse)
isUnexpected(DeviceManagementListDeviceStatesForDeviceClassSubgroupDeployment200Response | DeviceManagementListDeviceStatesForDeviceClassSubgroupDeploymentDefaultResponse)
isUnexpected(DeviceManagementGetOperationStatus200Response | DeviceManagementGetOperationStatus304Response | DeviceManagementGetOperationStatusDefaultResponse)
isUnexpected(DeviceManagementListOperationStatuses200Response | DeviceManagementListOperationStatusesDefaultResponse)
isUnexpected(DeviceManagementStartLogCollection201Response | DeviceManagementStartLogCollectionDefaultResponse)
isUnexpected(DeviceManagementGetLogCollection200Response | DeviceManagementGetLogCollectionDefaultResponse)
isUnexpected(DeviceManagementListLogCollections200Response | DeviceManagementListLogCollectionsDefaultResponse)
isUnexpected(DeviceManagementGetLogCollectionDetailedStatus200Response | DeviceManagementGetLogCollectionDetailedStatusDefaultResponse)
isUnexpected(DeviceManagementListHealthOfDevices200Response | DeviceManagementListHealthOfDevicesDefaultResponse)
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)	Helper to paginate results from an initial response that follows the specification of Autorest x-ms-pageable extension

Function Details

default(string, TokenCredential, DeviceUpdateClientOptions)

Initialize a new instance of DeviceUpdateClient

function default(endpoint: string, credentials: TokenCredential, options?: DeviceUpdateClientOptions): DeviceUpdateClient

Parameters

endpoint

string

The Device Update for IoT Hub account endpoint (hostname only, no protocol).

credentials

TokenCredential

uniquely identify client credential

options

DeviceUpdateClientOptions

the parameter for all optional parameters

Returns

DeviceUpdateClient

getLongRunningPoller<TResult>(Client, TResult, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

Helper function that builds a Poller object to help polling a long running operation.

function getLongRunningPoller<TResult>(client: Client, initialResponse: TResult, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>

Parameters

client

Client

Client to use for sending the request to get additional pages.

initialResponse

TResult

The initial response.

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Options to set a resume state or custom polling interval.

Returns

Promise<SimplePollerLike<OperationState<TResult>, TResult>>

• A poller object to poll for operation state updates and eventually get the final response.

isUnexpected(DeviceUpdateListUpdates200Response | DeviceUpdateListUpdatesDefaultResponse)

function isUnexpected(response: DeviceUpdateListUpdates200Response | DeviceUpdateListUpdatesDefaultResponse): response

Parameters

response

DeviceUpdateListUpdates200Response | DeviceUpdateListUpdatesDefaultResponse

Returns

response

isUnexpected(DeviceUpdateImportUpdate200Response | DeviceUpdateImportUpdate202Response | DeviceUpdateImportUpdateDefaultResponse)

function isUnexpected(response: DeviceUpdateImportUpdate200Response | DeviceUpdateImportUpdate202Response | DeviceUpdateImportUpdateDefaultResponse): response

Parameters

response

DeviceUpdateImportUpdate200Response | DeviceUpdateImportUpdate202Response | DeviceUpdateImportUpdateDefaultResponse

Returns

response

isUnexpected(DeviceUpdateGetUpdate200Response | DeviceUpdateGetUpdate304Response | DeviceUpdateGetUpdateDefaultResponse)

function isUnexpected(response: DeviceUpdateGetUpdate200Response | DeviceUpdateGetUpdate304Response | DeviceUpdateGetUpdateDefaultResponse): response

Parameters

response

DeviceUpdateGetUpdate200Response | DeviceUpdateGetUpdate304Response | DeviceUpdateGetUpdateDefaultResponse

Returns

response

isUnexpected(DeviceUpdateDeleteUpdate202Response | DeviceUpdateDeleteUpdateDefaultResponse)

function isUnexpected(response: DeviceUpdateDeleteUpdate202Response | DeviceUpdateDeleteUpdateDefaultResponse): response

Parameters

response

DeviceUpdateDeleteUpdate202Response | DeviceUpdateDeleteUpdateDefaultResponse

Returns

response

isUnexpected(DeviceUpdateListProviders200Response | DeviceUpdateListProvidersDefaultResponse)

function isUnexpected(response: DeviceUpdateListProviders200Response | DeviceUpdateListProvidersDefaultResponse): response

Parameters

response

DeviceUpdateListProviders200Response | DeviceUpdateListProvidersDefaultResponse

Returns

response

isUnexpected(DeviceUpdateListNames200Response | DeviceUpdateListNamesDefaultResponse)

function isUnexpected(response: DeviceUpdateListNames200Response | DeviceUpdateListNamesDefaultResponse): response

Parameters

response

DeviceUpdateListNames200Response | DeviceUpdateListNamesDefaultResponse

Returns

response

isUnexpected(DeviceUpdateListVersions200Response | DeviceUpdateListVersionsDefaultResponse)

function isUnexpected(response: DeviceUpdateListVersions200Response | DeviceUpdateListVersionsDefaultResponse): response

Parameters

response

DeviceUpdateListVersions200Response | DeviceUpdateListVersionsDefaultResponse

Returns

response

isUnexpected(DeviceUpdateListFiles200Response | DeviceUpdateListFilesDefaultResponse)

function isUnexpected(response: DeviceUpdateListFiles200Response | DeviceUpdateListFilesDefaultResponse): response

Parameters

response

DeviceUpdateListFiles200Response | DeviceUpdateListFilesDefaultResponse

Returns

response

isUnexpected(DeviceUpdateGetFile200Response | DeviceUpdateGetFile304Response | DeviceUpdateGetFileDefaultResponse)

function isUnexpected(response: DeviceUpdateGetFile200Response | DeviceUpdateGetFile304Response | DeviceUpdateGetFileDefaultResponse): response

Parameters

response

DeviceUpdateGetFile200Response | DeviceUpdateGetFile304Response | DeviceUpdateGetFileDefaultResponse

Returns

response

isUnexpected(DeviceUpdateListOperationStatuses200Response | DeviceUpdateListOperationStatusesDefaultResponse)

function isUnexpected(response: DeviceUpdateListOperationStatuses200Response | DeviceUpdateListOperationStatusesDefaultResponse): response

Parameters

response

DeviceUpdateListOperationStatuses200Response | DeviceUpdateListOperationStatusesDefaultResponse

Returns

response

isUnexpected(DeviceUpdateGetOperationStatus200Response | DeviceUpdateGetOperationStatus304Response | DeviceUpdateGetOperationStatusDefaultResponse)

function isUnexpected(response: DeviceUpdateGetOperationStatus200Response | DeviceUpdateGetOperationStatus304Response | DeviceUpdateGetOperationStatusDefaultResponse): response

Parameters

response

DeviceUpdateGetOperationStatus200Response | DeviceUpdateGetOperationStatus304Response | DeviceUpdateGetOperationStatusDefaultResponse

Returns

response

isUnexpected(DeviceManagementListDeviceClasses200Response | DeviceManagementListDeviceClassesDefaultResponse)

function isUnexpected(response: DeviceManagementListDeviceClasses200Response | DeviceManagementListDeviceClassesDefaultResponse): response

Parameters

response

DeviceManagementListDeviceClasses200Response | DeviceManagementListDeviceClassesDefaultResponse

Returns

response

isUnexpected(DeviceManagementGetDeviceClass200Response | DeviceManagementGetDeviceClassDefaultResponse)

function isUnexpected(response: DeviceManagementGetDeviceClass200Response | DeviceManagementGetDeviceClassDefaultResponse): response

Parameters

response

DeviceManagementGetDeviceClass200Response | DeviceManagementGetDeviceClassDefaultResponse

Returns

response

isUnexpected(DeviceManagementUpdateDeviceClass200Response | DeviceManagementUpdateDeviceClassDefaultResponse)

function isUnexpected(response: DeviceManagementUpdateDeviceClass200Response | DeviceManagementUpdateDeviceClassDefaultResponse): response

Parameters

response

DeviceManagementUpdateDeviceClass200Response | DeviceManagementUpdateDeviceClassDefaultResponse

Returns

response

isUnexpected(DeviceManagementDeleteDeviceClass204Response | DeviceManagementDeleteDeviceClassDefaultResponse)

function isUnexpected(response: DeviceManagementDeleteDeviceClass204Response | DeviceManagementDeleteDeviceClassDefaultResponse): response

Parameters

response

DeviceManagementDeleteDeviceClass204Response | DeviceManagementDeleteDeviceClassDefaultResponse

Returns

response

isUnexpected(DeviceManagementListInstallableUpdatesForDeviceClass200Response | DeviceManagementListInstallableUpdatesForDeviceClassDefaultResponse)

function isUnexpected(response: DeviceManagementListInstallableUpdatesForDeviceClass200Response | DeviceManagementListInstallableUpdatesForDeviceClassDefaultResponse): response

Parameters

response

DeviceManagementListInstallableUpdatesForDeviceClass200Response | DeviceManagementListInstallableUpdatesForDeviceClassDefaultResponse

Returns

response

isUnexpected(DeviceManagementListDevices200Response | DeviceManagementListDevicesDefaultResponse)

function isUnexpected(response: DeviceManagementListDevices200Response | DeviceManagementListDevicesDefaultResponse): response

Parameters

response

DeviceManagementListDevices200Response | DeviceManagementListDevicesDefaultResponse

Returns

response

isUnexpected(DeviceManagementImportDevices202Response | DeviceManagementImportDevicesDefaultResponse)

function isUnexpected(response: DeviceManagementImportDevices202Response | DeviceManagementImportDevicesDefaultResponse): response

Parameters

response

DeviceManagementImportDevices202Response | DeviceManagementImportDevicesDefaultResponse

Returns

response

isUnexpected(DeviceManagementGetDevice200Response | DeviceManagementGetDeviceDefaultResponse)

function isUnexpected(response: DeviceManagementGetDevice200Response | DeviceManagementGetDeviceDefaultResponse): response

Parameters

response

DeviceManagementGetDevice200Response | DeviceManagementGetDeviceDefaultResponse

Returns

response

isUnexpected(DeviceManagementGetDeviceModule200Response | DeviceManagementGetDeviceModuleDefaultResponse)

function isUnexpected(response: DeviceManagementGetDeviceModule200Response | DeviceManagementGetDeviceModuleDefaultResponse): response

Parameters

response

DeviceManagementGetDeviceModule200Response | DeviceManagementGetDeviceModuleDefaultResponse

Returns

response

isUnexpected(DeviceManagementGetUpdateCompliance200Response | DeviceManagementGetUpdateComplianceDefaultResponse)

function isUnexpected(response: DeviceManagementGetUpdateCompliance200Response | DeviceManagementGetUpdateComplianceDefaultResponse): response

Parameters

response

DeviceManagementGetUpdateCompliance200Response | DeviceManagementGetUpdateComplianceDefaultResponse

Returns

response

isUnexpected(DeviceManagementListGroups200Response | DeviceManagementListGroupsDefaultResponse)

function isUnexpected(response: DeviceManagementListGroups200Response | DeviceManagementListGroupsDefaultResponse): response

Parameters

response

DeviceManagementListGroups200Response | DeviceManagementListGroupsDefaultResponse

Returns

response

isUnexpected(DeviceManagementGetGroup200Response | DeviceManagementGetGroupDefaultResponse)

function isUnexpected(response: DeviceManagementGetGroup200Response | DeviceManagementGetGroupDefaultResponse): response

Parameters

response

DeviceManagementGetGroup200Response | DeviceManagementGetGroupDefaultResponse

Returns

response

isUnexpected(DeviceManagementDeleteGroup204Response | DeviceManagementDeleteGroupDefaultResponse)

function isUnexpected(response: DeviceManagementDeleteGroup204Response | DeviceManagementDeleteGroupDefaultResponse): response

Parameters

response

DeviceManagementDeleteGroup204Response | DeviceManagementDeleteGroupDefaultResponse

Returns

response

isUnexpected(DeviceManagementGetUpdateComplianceForGroup200Response | DeviceManagementGetUpdateComplianceForGroupDefaultResponse)

function isUnexpected(response: DeviceManagementGetUpdateComplianceForGroup200Response | DeviceManagementGetUpdateComplianceForGroupDefaultResponse): response

Parameters

response

DeviceManagementGetUpdateComplianceForGroup200Response | DeviceManagementGetUpdateComplianceForGroupDefaultResponse

Returns

response

isUnexpected(DeviceManagementListBestUpdatesForGroup200Response | DeviceManagementListBestUpdatesForGroupDefaultResponse)

function isUnexpected(response: DeviceManagementListBestUpdatesForGroup200Response | DeviceManagementListBestUpdatesForGroupDefaultResponse): response

Parameters

response

DeviceManagementListBestUpdatesForGroup200Response | DeviceManagementListBestUpdatesForGroupDefaultResponse

Returns

response

isUnexpected(DeviceManagementListDeploymentsForGroup200Response | DeviceManagementListDeploymentsForGroupDefaultResponse)

function isUnexpected(response: DeviceManagementListDeploymentsForGroup200Response | DeviceManagementListDeploymentsForGroupDefaultResponse): response

Parameters

response

DeviceManagementListDeploymentsForGroup200Response | DeviceManagementListDeploymentsForGroupDefaultResponse

Returns

response

isUnexpected(DeviceManagementGetDeployment200Response | DeviceManagementGetDeploymentDefaultResponse)

function isUnexpected(response: DeviceManagementGetDeployment200Response | DeviceManagementGetDeploymentDefaultResponse): response

Parameters

response

DeviceManagementGetDeployment200Response | DeviceManagementGetDeploymentDefaultResponse

Returns

response

isUnexpected(DeviceManagementCreateOrUpdateDeployment200Response | DeviceManagementCreateOrUpdateDeploymentDefaultResponse)

function isUnexpected(response: DeviceManagementCreateOrUpdateDeployment200Response | DeviceManagementCreateOrUpdateDeploymentDefaultResponse): response

Parameters

response

DeviceManagementCreateOrUpdateDeployment200Response | DeviceManagementCreateOrUpdateDeploymentDefaultResponse

Returns

response

isUnexpected(DeviceManagementDeleteDeployment204Response | DeviceManagementDeleteDeploymentDefaultResponse)

function isUnexpected(response: DeviceManagementDeleteDeployment204Response | DeviceManagementDeleteDeploymentDefaultResponse): response

Parameters

response

DeviceManagementDeleteDeployment204Response | DeviceManagementDeleteDeploymentDefaultResponse

Returns

response

isUnexpected(DeviceManagementGetDeploymentStatus200Response | DeviceManagementGetDeploymentStatusDefaultResponse)

function isUnexpected(response: DeviceManagementGetDeploymentStatus200Response | DeviceManagementGetDeploymentStatusDefaultResponse): response

Parameters

response

DeviceManagementGetDeploymentStatus200Response | DeviceManagementGetDeploymentStatusDefaultResponse

Returns

response

isUnexpected(DeviceManagementListDeviceClassSubgroupsForGroup200Response | DeviceManagementListDeviceClassSubgroupsForGroupDefaultResponse)

function isUnexpected(response: DeviceManagementListDeviceClassSubgroupsForGroup200Response | DeviceManagementListDeviceClassSubgroupsForGroupDefaultResponse): response

Parameters

response

DeviceManagementListDeviceClassSubgroupsForGroup200Response | DeviceManagementListDeviceClassSubgroupsForGroupDefaultResponse

Returns

response

isUnexpected(DeviceManagementGetDeviceClassSubgroup200Response | DeviceManagementGetDeviceClassSubgroupDefaultResponse)

function isUnexpected(response: DeviceManagementGetDeviceClassSubgroup200Response | DeviceManagementGetDeviceClassSubgroupDefaultResponse): response

Parameters

response

DeviceManagementGetDeviceClassSubgroup200Response | DeviceManagementGetDeviceClassSubgroupDefaultResponse

Returns

response

isUnexpected(DeviceManagementDeleteDeviceClassSubgroup204Response | DeviceManagementDeleteDeviceClassSubgroupDefaultResponse)

function isUnexpected(response: DeviceManagementDeleteDeviceClassSubgroup204Response | DeviceManagementDeleteDeviceClassSubgroupDefaultResponse): response

Parameters

response

DeviceManagementDeleteDeviceClassSubgroup204Response | DeviceManagementDeleteDeviceClassSubgroupDefaultResponse

Returns

response

isUnexpected(DeviceManagementGetDeviceClassSubgroupUpdateCompliance200Response | DeviceManagementGetDeviceClassSubgroupUpdateComplianceDefaultResponse)

function isUnexpected(response: DeviceManagementGetDeviceClassSubgroupUpdateCompliance200Response | DeviceManagementGetDeviceClassSubgroupUpdateComplianceDefaultResponse): response

Parameters

response

DeviceManagementGetDeviceClassSubgroupUpdateCompliance200Response | DeviceManagementGetDeviceClassSubgroupUpdateComplianceDefaultResponse

Returns

response

isUnexpected(DeviceManagementGetBestUpdatesForDeviceClassSubgroup200Response | DeviceManagementGetBestUpdatesForDeviceClassSubgroupDefaultResponse)

function isUnexpected(response: DeviceManagementGetBestUpdatesForDeviceClassSubgroup200Response | DeviceManagementGetBestUpdatesForDeviceClassSubgroupDefaultResponse): response

Parameters

response

DeviceManagementGetBestUpdatesForDeviceClassSubgroup200Response | DeviceManagementGetBestUpdatesForDeviceClassSubgroupDefaultResponse

Returns

response

isUnexpected(DeviceManagementListDeploymentsForDeviceClassSubgroup200Response | DeviceManagementListDeploymentsForDeviceClassSubgroupDefaultResponse)

function isUnexpected(response: DeviceManagementListDeploymentsForDeviceClassSubgroup200Response | DeviceManagementListDeploymentsForDeviceClassSubgroupDefaultResponse): response

Parameters

response

DeviceManagementListDeploymentsForDeviceClassSubgroup200Response | DeviceManagementListDeploymentsForDeviceClassSubgroupDefaultResponse

Returns

response

isUnexpected(DeviceManagementGetDeploymentForDeviceClassSubgroup200Response | DeviceManagementGetDeploymentForDeviceClassSubgroupDefaultResponse)

function isUnexpected(response: DeviceManagementGetDeploymentForDeviceClassSubgroup200Response | DeviceManagementGetDeploymentForDeviceClassSubgroupDefaultResponse): response

Parameters

response

DeviceManagementGetDeploymentForDeviceClassSubgroup200Response | DeviceManagementGetDeploymentForDeviceClassSubgroupDefaultResponse

Returns

response

isUnexpected(DeviceManagementDeleteDeploymentForDeviceClassSubgroup204Response | DeviceManagementDeleteDeploymentForDeviceClassSubgroupDefaultResponse)

function isUnexpected(response: DeviceManagementDeleteDeploymentForDeviceClassSubgroup204Response | DeviceManagementDeleteDeploymentForDeviceClassSubgroupDefaultResponse): response

Parameters

response

DeviceManagementDeleteDeploymentForDeviceClassSubgroup204Response | DeviceManagementDeleteDeploymentForDeviceClassSubgroupDefaultResponse

Returns

response

isUnexpected(DeviceManagementStopDeployment200Response | DeviceManagementStopDeploymentDefaultResponse)

function isUnexpected(response: DeviceManagementStopDeployment200Response | DeviceManagementStopDeploymentDefaultResponse): response

Parameters

response

DeviceManagementStopDeployment200Response | DeviceManagementStopDeploymentDefaultResponse

Returns

response

isUnexpected(DeviceManagementRetryDeployment200Response | DeviceManagementRetryDeploymentDefaultResponse)

function isUnexpected(response: DeviceManagementRetryDeployment200Response | DeviceManagementRetryDeploymentDefaultResponse): response

Parameters

response

DeviceManagementRetryDeployment200Response | DeviceManagementRetryDeploymentDefaultResponse

Returns

response

isUnexpected(DeviceManagementGetDeviceClassSubgroupDeploymentStatus200Response | DeviceManagementGetDeviceClassSubgroupDeploymentStatusDefaultResponse)

function isUnexpected(response: DeviceManagementGetDeviceClassSubgroupDeploymentStatus200Response | DeviceManagementGetDeviceClassSubgroupDeploymentStatusDefaultResponse): response

Parameters

response

DeviceManagementGetDeviceClassSubgroupDeploymentStatus200Response | DeviceManagementGetDeviceClassSubgroupDeploymentStatusDefaultResponse

Returns

response

isUnexpected(DeviceManagementListDeviceStatesForDeviceClassSubgroupDeployment200Response | DeviceManagementListDeviceStatesForDeviceClassSubgroupDeploymentDefaultResponse)

function isUnexpected(response: DeviceManagementListDeviceStatesForDeviceClassSubgroupDeployment200Response | DeviceManagementListDeviceStatesForDeviceClassSubgroupDeploymentDefaultResponse): response

Parameters

response

DeviceManagementListDeviceStatesForDeviceClassSubgroupDeployment200Response | DeviceManagementListDeviceStatesForDeviceClassSubgroupDeploymentDefaultResponse

Returns

response

isUnexpected(DeviceManagementGetOperationStatus200Response | DeviceManagementGetOperationStatus304Response | DeviceManagementGetOperationStatusDefaultResponse)

function isUnexpected(response: DeviceManagementGetOperationStatus200Response | DeviceManagementGetOperationStatus304Response | DeviceManagementGetOperationStatusDefaultResponse): response

Parameters

response

DeviceManagementGetOperationStatus200Response | DeviceManagementGetOperationStatus304Response | DeviceManagementGetOperationStatusDefaultResponse

Returns

response

isUnexpected(DeviceManagementListOperationStatuses200Response | DeviceManagementListOperationStatusesDefaultResponse)

function isUnexpected(response: DeviceManagementListOperationStatuses200Response | DeviceManagementListOperationStatusesDefaultResponse): response

Parameters

response

DeviceManagementListOperationStatuses200Response | DeviceManagementListOperationStatusesDefaultResponse

Returns

response

isUnexpected(DeviceManagementStartLogCollection201Response | DeviceManagementStartLogCollectionDefaultResponse)

function isUnexpected(response: DeviceManagementStartLogCollection201Response | DeviceManagementStartLogCollectionDefaultResponse): response

Parameters

response

DeviceManagementStartLogCollection201Response | DeviceManagementStartLogCollectionDefaultResponse

Returns

response

isUnexpected(DeviceManagementGetLogCollection200Response | DeviceManagementGetLogCollectionDefaultResponse)

function isUnexpected(response: DeviceManagementGetLogCollection200Response | DeviceManagementGetLogCollectionDefaultResponse): response

Parameters

response

DeviceManagementGetLogCollection200Response | DeviceManagementGetLogCollectionDefaultResponse

Returns

response

isUnexpected(DeviceManagementListLogCollections200Response | DeviceManagementListLogCollectionsDefaultResponse)

function isUnexpected(response: DeviceManagementListLogCollections200Response | DeviceManagementListLogCollectionsDefaultResponse): response

Parameters

response

DeviceManagementListLogCollections200Response | DeviceManagementListLogCollectionsDefaultResponse

Returns

response

isUnexpected(DeviceManagementGetLogCollectionDetailedStatus200Response | DeviceManagementGetLogCollectionDetailedStatusDefaultResponse)

function isUnexpected(response: DeviceManagementGetLogCollectionDetailedStatus200Response | DeviceManagementGetLogCollectionDetailedStatusDefaultResponse): response

Parameters

response

DeviceManagementGetLogCollectionDetailedStatus200Response | DeviceManagementGetLogCollectionDetailedStatusDefaultResponse

Returns

response

isUnexpected(DeviceManagementListHealthOfDevices200Response | DeviceManagementListHealthOfDevicesDefaultResponse)

function isUnexpected(response: DeviceManagementListHealthOfDevices200Response | DeviceManagementListHealthOfDevicesDefaultResponse): response

Parameters

response

DeviceManagementListHealthOfDevices200Response | DeviceManagementListHealthOfDevicesDefaultResponse

Returns

response

paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)

Helper to paginate results from an initial response that follows the specification of Autorest x-ms-pageable extension

function paginate<TResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>

Parameters

client

Client

Client to use for sending the next page requests

initialResponse

TResponse

Initial response containing the nextLink and current page of elements

options

PagingOptions<TResponse>

Returns

PagedAsyncIterableIterator<PaginateReturn<TResponse>>

• PagedAsyncIterableIterator to iterate the elements