Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/iot-device-update

Package version

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Object literals

Type aliases

DeploymentState

DeploymentState: string

Defines values for DeploymentState.
KnownDeploymentState can be used interchangeably with DeploymentState, this enum contains the known values that the service supports.

Know values supported by the service

Active: The deployment can be sent to devices targeted in the deployment.
Superseded: A newer deployment with the same targeting exists and no devices will receive this deployment.
Canceled: The deployment has been canceled and no devices will receive it.

DeploymentType

DeploymentType: string

Defines values for DeploymentType.
KnownDeploymentType can be used interchangeably with DeploymentType, this enum contains the known values that the service supports.

Know values supported by the service

Complete: A complete deployment including download, install, and apply actions.
Download: A download-only deployment that does not include any install or apply actions. Not currently supported.
Install: An install-only rollout that does not include any download actions, only install and complete. Not currently supported.

DeploymentsCancelDeploymentResponse

DeploymentsCancelDeploymentResponse: Deployment & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: Deployment } }

Contains response data for the cancelDeployment operation.

DeploymentsCreateOrUpdateDeploymentResponse

DeploymentsCreateOrUpdateDeploymentResponse: Deployment & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: Deployment } }

Contains response data for the createOrUpdateDeployment operation.

DeploymentsGetAllDeploymentsNextResponse

DeploymentsGetAllDeploymentsNextResponse: PageableListOfDeployments & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PageableListOfDeployments } }

Contains response data for the getAllDeploymentsNext operation.

DeploymentsGetAllDeploymentsResponse

DeploymentsGetAllDeploymentsResponse: PageableListOfDeployments & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PageableListOfDeployments } }

Contains response data for the getAllDeployments operation.

DeploymentsGetDeploymentDevicesNextResponse

DeploymentsGetDeploymentDevicesNextResponse: PageableListOfDeploymentDeviceStates & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PageableListOfDeploymentDeviceStates } }

Contains response data for the getDeploymentDevicesNext operation.

DeploymentsGetDeploymentDevicesResponse

DeploymentsGetDeploymentDevicesResponse: PageableListOfDeploymentDeviceStates & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PageableListOfDeploymentDeviceStates } }

Contains response data for the getDeploymentDevices operation.

DeploymentsGetDeploymentResponse

DeploymentsGetDeploymentResponse: Deployment & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: Deployment } }

Contains response data for the getDeployment operation.

DeploymentsGetDeploymentStatusResponse

DeploymentsGetDeploymentStatusResponse: DeploymentStatus & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: DeploymentStatus } }

Contains response data for the getDeploymentStatus operation.

DeploymentsRetryDeploymentResponse

DeploymentsRetryDeploymentResponse: Deployment & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: Deployment } }

Contains response data for the retryDeployment operation.

DeviceDeploymentState

DeviceDeploymentState: string

Defines values for DeviceDeploymentState.
KnownDeviceDeploymentState can be used interchangeably with DeviceDeploymentState, this enum contains the known values that the service supports.

Know values supported by the service

Succeeded: Deployment has completed with success.
InProgress: Deployment is in progress.
Failed: Deployment has completed with failure.
Canceled: Deployment was canceled.
Incompatible: Deployment is not compatible with the device.

DeviceGroupType

DeviceGroupType: string

Defines values for DeviceGroupType.
KnownDeviceGroupType can be used interchangeably with DeviceGroupType, this enum contains the known values that the service supports.

Know values supported by the service

All: The deployment should be sent to all devices in the device class.
Devices: The deployment should be sent to the list of devices in the device group definition.
DeviceGroupDefinitions: The deployment should be sent to the list of devices returned by the union of all the device group definition queries.

DeviceState

DeviceState: string

Defines values for DeviceState.
KnownDeviceState can be used interchangeably with DeviceState, this enum contains the known values that the service supports.

Know values supported by the service

NotStarted: Not started (or uninitialized)
Incompatible: Deployment incompatible for this device.
AlreadyInDeployment: Another Deployment is underway for this device.
Canceled: Deployment has been canceled for this device.
InProgress: Deployment underway.
Failed: Deployment failed.
Succeeded: Deployment completed successfully.

DevicesCreateOrUpdateGroupResponse

DevicesCreateOrUpdateGroupResponse: Group & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: Group } }

Contains response data for the createOrUpdateGroup operation.

DevicesGetAllDeviceClassesNextResponse

DevicesGetAllDeviceClassesNextResponse: PageableListOfDeviceClasses & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PageableListOfDeviceClasses } }

Contains response data for the getAllDeviceClassesNext operation.

DevicesGetAllDeviceClassesResponse

DevicesGetAllDeviceClassesResponse: PageableListOfDeviceClasses & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PageableListOfDeviceClasses } }

Contains response data for the getAllDeviceClasses operation.

DevicesGetAllDeviceTagsNextResponse

DevicesGetAllDeviceTagsNextResponse: PageableListOfDeviceTags & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PageableListOfDeviceTags } }

Contains response data for the getAllDeviceTagsNext operation.

DevicesGetAllDeviceTagsResponse

DevicesGetAllDeviceTagsResponse: PageableListOfDeviceTags & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PageableListOfDeviceTags } }

Contains response data for the getAllDeviceTags operation.

DevicesGetAllDevicesNextResponse

DevicesGetAllDevicesNextResponse: PageableListOfDevices & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PageableListOfDevices } }

Contains response data for the getAllDevicesNext operation.

DevicesGetAllDevicesResponse

DevicesGetAllDevicesResponse: PageableListOfDevices & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PageableListOfDevices } }

Contains response data for the getAllDevices operation.

DevicesGetAllGroupsNextResponse

DevicesGetAllGroupsNextResponse: PageableListOfGroups & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PageableListOfGroups } }

Contains response data for the getAllGroupsNext operation.

DevicesGetAllGroupsResponse

DevicesGetAllGroupsResponse: PageableListOfGroups & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PageableListOfGroups } }

Contains response data for the getAllGroups operation.

DevicesGetDeviceClassDeviceIdsNextResponse

DevicesGetDeviceClassDeviceIdsNextResponse: PageableListOfStrings & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PageableListOfStrings } }

Contains response data for the getDeviceClassDeviceIdsNext operation.

DevicesGetDeviceClassDeviceIdsResponse

DevicesGetDeviceClassDeviceIdsResponse: PageableListOfStrings & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PageableListOfStrings } }

Contains response data for the getDeviceClassDeviceIds operation.

DevicesGetDeviceClassInstallableUpdatesNextResponse

DevicesGetDeviceClassInstallableUpdatesNextResponse: PageableListOfUpdateIds & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PageableListOfUpdateIds } }

Contains response data for the getDeviceClassInstallableUpdatesNext operation.

DevicesGetDeviceClassInstallableUpdatesResponse

DevicesGetDeviceClassInstallableUpdatesResponse: PageableListOfUpdateIds & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PageableListOfUpdateIds } }

Contains response data for the getDeviceClassInstallableUpdates operation.

DevicesGetDeviceClassResponse

DevicesGetDeviceClassResponse: DeviceClass & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: DeviceClass } }

Contains response data for the getDeviceClass operation.

DevicesGetDeviceResponse

DevicesGetDeviceResponse: Device & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: Device } }

Contains response data for the getDevice operation.

DevicesGetDeviceTagResponse

DevicesGetDeviceTagResponse: DeviceTag & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: DeviceTag } }

Contains response data for the getDeviceTag operation.

DevicesGetGroupBestUpdatesNextResponse

DevicesGetGroupBestUpdatesNextResponse: PageableListOfUpdatableDevices & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PageableListOfUpdatableDevices } }

Contains response data for the getGroupBestUpdatesNext operation.

DevicesGetGroupBestUpdatesResponse

DevicesGetGroupBestUpdatesResponse: PageableListOfUpdatableDevices & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PageableListOfUpdatableDevices } }

Contains response data for the getGroupBestUpdates operation.

DevicesGetGroupResponse

DevicesGetGroupResponse: Group & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: Group } }

Contains response data for the getGroup operation.

DevicesGetGroupUpdateComplianceResponse

DevicesGetGroupUpdateComplianceResponse: UpdateCompliance & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: UpdateCompliance } }

Contains response data for the getGroupUpdateCompliance operation.

DevicesGetUpdateComplianceResponse

DevicesGetUpdateComplianceResponse: UpdateCompliance & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: UpdateCompliance } }

Contains response data for the getUpdateCompliance operation.

GroupType

GroupType: string

Defines values for GroupType.
KnownGroupType can be used interchangeably with GroupType, this enum contains the known values that the service supports.

Know values supported by the service

IoTHubTag: IoT Hub tag based group.

OperationFilterStatus

OperationFilterStatus: string

Defines values for OperationFilterStatus.
KnownOperationFilterStatus can be used interchangeably with OperationFilterStatus, this enum contains the known values that the service supports.

Know values supported by the service

Running
NotStarted

OperationStatus

OperationStatus: string

Defines values for OperationStatus.
KnownOperationStatus can be used interchangeably with OperationStatus, this enum contains the known values that the service supports.

Know values supported by the service

Undefined: Undefined operation status.
NotStarted: Background operation created but not started yet.
Running: Background operation is currently running.
Succeeded: Background operation finished with success.
Failed: Background operation finished with failure.

UpdatesDeleteUpdateResponse

UpdatesDeleteUpdateResponse: UpdatesDeleteUpdateHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: UpdatesDeleteUpdateHeaders } }

Contains response data for the deleteUpdate operation.

UpdatesGetFileResponse

UpdatesGetFileResponse: File & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: File } }

Contains response data for the getFile operation.

UpdatesGetFilesNextResponse

UpdatesGetFilesNextResponse: PageableListOfStrings & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PageableListOfStrings } }

Contains response data for the getFilesNext operation.

UpdatesGetFilesResponse

UpdatesGetFilesResponse: PageableListOfStrings & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PageableListOfStrings } }

Contains response data for the getFiles operation.

UpdatesGetNamesNextResponse

UpdatesGetNamesNextResponse: PageableListOfStrings & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PageableListOfStrings } }

Contains response data for the getNamesNext operation.

UpdatesGetNamesResponse

UpdatesGetNamesResponse: PageableListOfStrings & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PageableListOfStrings } }

Contains response data for the getNames operation.

UpdatesGetOperationResponse

UpdatesGetOperationResponse: UpdatesGetOperationHeaders & Operation & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: Operation; parsedHeaders: UpdatesGetOperationHeaders } }

Contains response data for the getOperation operation.

UpdatesGetOperationsNextResponse

UpdatesGetOperationsNextResponse: PageableListOfOperations & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PageableListOfOperations } }

Contains response data for the getOperationsNext operation.

UpdatesGetOperationsResponse

UpdatesGetOperationsResponse: PageableListOfOperations & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PageableListOfOperations } }

Contains response data for the getOperations operation.

UpdatesGetProvidersNextResponse

UpdatesGetProvidersNextResponse: PageableListOfStrings & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PageableListOfStrings } }

Contains response data for the getProvidersNext operation.

UpdatesGetProvidersResponse

UpdatesGetProvidersResponse: PageableListOfStrings & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PageableListOfStrings } }

Contains response data for the getProviders operation.

UpdatesGetUpdateResponse

UpdatesGetUpdateResponse: Update & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: Update } }

Contains response data for the getUpdate operation.

UpdatesGetVersionsNextResponse

UpdatesGetVersionsNextResponse: PageableListOfStrings & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PageableListOfStrings } }

Contains response data for the getVersionsNext operation.

UpdatesGetVersionsResponse

UpdatesGetVersionsResponse: PageableListOfStrings & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PageableListOfStrings } }

Contains response data for the getVersions operation.

UpdatesImportUpdateResponse

UpdatesImportUpdateResponse: UpdatesImportUpdateHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: UpdatesImportUpdateHeaders } }

Contains response data for the importUpdate operation.

Variables

Const createSpan

createSpan: any = createSpanFunction({namespace: "Azure.DeviceUpdate",packagePrefix: "Microsoft.DeviceUpdate"})

Const packageName

packageName: "@azure/iot-device-update" = "@azure/iot-device-update"

Const packageVersion

packageVersion: "1.0.0-beta.1" = "1.0.0-beta.1"

Const serializer

serializer: any = new coreHttp.Serializer(Mappers, /* isXml */ false)

Object literals

Const Compatibility

Compatibility: object

type

type: object

className

className: string = "Compatibility"

name

name: string = "Composite"

modelProperties

modelProperties: object

deviceManufacturer

deviceManufacturer: object

required

required: boolean = true

serializedName

serializedName: string = "deviceManufacturer"

type

type: object

name

name: string = "String"

deviceModel

deviceModel: object

required

required: boolean = true

serializedName

serializedName: string = "deviceModel"

type

type: object

name

name: string = "String"

Const Deployment

Deployment: object

type

type: object

className

className: string = "Deployment"

name

name: string = "Composite"

modelProperties

modelProperties: object

deploymentId

deploymentId: object

required

required: boolean = true

serializedName

serializedName: string = "deploymentId"

type

type: object

name

name: string = "String"

deploymentType

deploymentType: object

required

required: boolean = true

serializedName

serializedName: string = "deploymentType"

type

type: object

name

name: string = "String"

deviceClassId

deviceClassId: object

serializedName

serializedName: string = "deviceClassId"

type

type: object

name

name: string = "String"

deviceGroupDefinition

deviceGroupDefinition: object

required

required: boolean = true

serializedName

serializedName: string = "deviceGroupDefinition"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

deviceGroupType

deviceGroupType: object

required

required: boolean = true

serializedName

serializedName: string = "deviceGroupType"

type

type: object

name

name: string = "String"

isCanceled

isCanceled: object

serializedName

serializedName: string = "isCanceled"

type

type: object

name

name: string = "Boolean"

isCompleted

isCompleted: object

serializedName

serializedName: string = "isCompleted"

type

type: object

name

name: string = "Boolean"

isRetried

isRetried: object

serializedName

serializedName: string = "isRetried"

type

type: object

name

name: string = "Boolean"

startDateTime

startDateTime: object

required

required: boolean = true

serializedName

serializedName: string = "startDateTime"

type

type: object

name

name: string = "DateTime"

updateId

updateId: object

serializedName

serializedName: string = "updateId"

type

type: object

className

className: string = "UpdateId"

name

name: string = "Composite"

Const DeploymentDeviceState

DeploymentDeviceState: object

type

type: object

className

className: string = "DeploymentDeviceState"

name

name: string = "Composite"

modelProperties

modelProperties: object

deviceId

deviceId: object

required

required: boolean = true

serializedName

serializedName: string = "deviceId"

type

type: object

name

name: string = "String"

deviceState

deviceState: object

required

required: boolean = true

serializedName

serializedName: string = "deviceState"

type

type: object

name

name: string = "String"

movedOnToNewDeployment

movedOnToNewDeployment: object

required

required: boolean = true

serializedName

serializedName: string = "movedOnToNewDeployment"

type

type: object

name

name: string = "Boolean"

retryCount

retryCount: object

required

required: boolean = true

serializedName

serializedName: string = "retryCount"

type

type: object

name

name: string = "Number"

Const DeploymentDeviceStatesFilter

DeploymentDeviceStatesFilter: object

type

type: object

className

className: string = "DeploymentDeviceStatesFilter"

name

name: string = "Composite"

modelProperties

modelProperties: object

deviceId

deviceId: object

serializedName

serializedName: string = "deviceId"

type

type: object

name

name: string = "String"

deviceState

deviceState: object

serializedName

serializedName: string = "deviceState"

type

type: object

name

name: string = "String"

Const DeploymentFilter

DeploymentFilter: object

type

type: object

className

className: string = "DeploymentFilter"

name

name: string = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

provider

provider: object

serializedName

serializedName: string = "provider"

type

type: object

name

name: string = "String"

version

version: object

serializedName

serializedName: string = "version"

type

type: object

name

name: string = "String"

Const DeploymentStatus

DeploymentStatus: object

type

type: object

className

className: string = "DeploymentStatus"

name

name: string = "Composite"

modelProperties

modelProperties: object

deploymentState

deploymentState: object

required

required: boolean = true

serializedName

serializedName: string = "deploymentState"

type

type: object

name

name: string = "String"

devicesCanceledCount

devicesCanceledCount: object

serializedName

serializedName: string = "devicesCanceledCount"

type

type: object

name

name: string = "Number"

devicesCompletedFailedCount

devicesCompletedFailedCount: object

serializedName

serializedName: string = "devicesCompletedFailedCount"

type

type: object

name

name: string = "Number"

devicesCompletedSucceededCount

devicesCompletedSucceededCount: object

serializedName

serializedName: string = "devicesCompletedSucceededCount"

type

type: object

name

name: string = "Number"

devicesInProgressCount

devicesInProgressCount: object

serializedName

serializedName: string = "devicesInProgressCount"

type

type: object

name

name: string = "Number"

devicesIncompatibleCount

devicesIncompatibleCount: object

serializedName

serializedName: string = "devicesIncompatibleCount"

type

type: object

name

name: string = "Number"

totalDevices

totalDevices: object

serializedName

serializedName: string = "totalDevices"

type

type: object

name

name: string = "Number"

Const Device

Device: object

type

type: object

className

className: string = "Device"

name

name: string = "Composite"

modelProperties

modelProperties: object

deploymentStatus

deploymentStatus: object

serializedName

serializedName: string = "deploymentStatus"

type

type: object

name

name: string = "String"

deviceClassId

deviceClassId: object

required

required: boolean = true

serializedName

serializedName: string = "deviceClassId"

type

type: object

name

name: string = "String"

deviceId

deviceId: object

required

required: boolean = true

serializedName

serializedName: string = "deviceId"

type

type: object

name

name: string = "String"

groupId

groupId: object

serializedName

serializedName: string = "groupId"

type

type: object

name

name: string = "String"

installedUpdateId

installedUpdateId: object

serializedName

serializedName: string = "installedUpdateId"

type

type: object

className

className: string = "UpdateId"

name

name: string = "Composite"

lastAttemptedUpdateId

lastAttemptedUpdateId: object

serializedName

serializedName: string = "lastAttemptedUpdateId"

type

type: object

className

className: string = "UpdateId"

name

name: string = "Composite"

lastDeploymentId

lastDeploymentId: object

serializedName

serializedName: string = "lastDeploymentId"

type

type: object

name

name: string = "String"

manufacturer

manufacturer: object

required

required: boolean = true

serializedName

serializedName: string = "manufacturer"

type

type: object

name

name: string = "String"

model

model: object

required

required: boolean = true

serializedName

serializedName: string = "model"

type

type: object

name

name: string = "String"

onLatestUpdate

onLatestUpdate: object

required

required: boolean = true

serializedName

serializedName: string = "onLatestUpdate"

type

type: object

name

name: string = "Boolean"

Const DeviceClass

DeviceClass: object

type

type: object

className

className: string = "DeviceClass"

name

name: string = "Composite"

modelProperties

modelProperties: object

bestCompatibleUpdateId

bestCompatibleUpdateId: object

serializedName

serializedName: string = "bestCompatibleUpdateId"

type

type: object

className

className: string = "UpdateId"

name

name: string = "Composite"

deviceClassId

deviceClassId: object

required

required: boolean = true

serializedName

serializedName: string = "deviceClassId"

type

type: object

name

name: string = "String"

manufacturer

manufacturer: object

required

required: boolean = true

serializedName

serializedName: string = "manufacturer"

type

type: object

name

name: string = "String"

model

model: object

required

required: boolean = true

serializedName

serializedName: string = "model"

type

type: object

name

name: string = "String"

Const DeviceFilter

DeviceFilter: object

type

type: object

className

className: string = "DeviceFilter"

name

name: string = "Composite"

modelProperties

modelProperties: object

groupId

groupId: object

serializedName

serializedName: string = "groupId"

type

type: object

name

name: string = "String"

Const DeviceTag

DeviceTag: object

type

type: object

className

className: string = "DeviceTag"

name

name: string = "Composite"

modelProperties

modelProperties: object

deviceCount

deviceCount: object

required

required: boolean = true

serializedName

serializedName: string = "deviceCount"

type

type: object

name

name: string = "Number"

tagName

tagName: object

required

required: boolean = true

serializedName

serializedName: string = "tagName"

type

type: object

name

name: string = "String"

Const ErrorModel

ErrorModel: object

type

type: object

className

className: string = "ErrorModel"

name

name: string = "Composite"

modelProperties

modelProperties: object

code

code: object

required

required: boolean = true

serializedName

serializedName: string = "code"

type

type: object

name

name: string = "String"

details

details: object

serializedName

serializedName: string = "details"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ErrorModel"

name

name: string = "Composite"

innererror

innererror: object

serializedName

serializedName: string = "innererror"

type

type: object

className

className: string = "InnerError"

name

name: string = "Composite"

message

message: object

required

required: boolean = true

serializedName

serializedName: string = "message"

type

type: object

name

name: string = "String"

occurredDateTime

occurredDateTime: object

serializedName

serializedName: string = "occurredDateTime"

type

type: object

name

name: string = "DateTime"

target

target: object

serializedName

serializedName: string = "target"

type

type: object

name

name: string = "String"

Const File

File: object

type

type: object

className

className: string = "File"

name

name: string = "Composite"

modelProperties

modelProperties: object

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: string = "String"

fileId

fileId: object

required

required: boolean = true

serializedName

serializedName: string = "fileId"

type

type: object

name

name: string = "String"

fileName

fileName: object

required

required: boolean = true

serializedName

serializedName: string = "fileName"

type

type: object

name

name: string = "String"

hashes

hashes: object

required

required: boolean = true

serializedName

serializedName: string = "hashes"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "String"

mimeType

mimeType: object

serializedName

serializedName: string = "mimeType"

type

type: object

name

name: string = "String"

sizeInBytes

sizeInBytes: object

required

required: boolean = true

serializedName

serializedName: string = "sizeInBytes"

type

type: object

name

name: string = "Number"

Const FileImportMetadata

FileImportMetadata: object

type

type: object

className

className: string = "FileImportMetadata"

name

name: string = "Composite"

modelProperties

modelProperties: object

filename

filename: object

required

required: boolean = true

serializedName

serializedName: string = "filename"

type

type: object

name

name: string = "String"

url

url: object

required

required: boolean = true

serializedName

serializedName: string = "url"

type

type: object

name

name: string = "String"

Const Group

Group: object

type

type: object

className

className: string = "Group"

name

name: string = "Composite"

modelProperties

modelProperties: object

createdDateTime

createdDateTime: object

required

required: boolean = true

serializedName

serializedName: string = "createdDateTime"

type

type: object

name

name: string = "String"

deviceCount

deviceCount: object

serializedName

serializedName: string = "deviceCount"

type

type: object

name

name: string = "Number"

groupId

groupId: object

required

required: boolean = true

serializedName

serializedName: string = "groupId"

type

type: object

name

name: string = "String"

groupType

groupType: object

required

required: boolean = true

serializedName

serializedName: string = "groupType"

type

type: object

name

name: string = "String"

tags

tags: object

required

required: boolean = true

serializedName

serializedName: string = "tags"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const GroupBestUpdatesFilter

GroupBestUpdatesFilter: object

type

type: object

className

className: string = "GroupBestUpdatesFilter"

name

name: string = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

provider

provider: object

serializedName

serializedName: string = "provider"

type

type: object

name

name: string = "String"

version

version: object

serializedName

serializedName: string = "version"

type

type: object

name

name: string = "String"

Const ImportManifestMetadata

ImportManifestMetadata: object

type

type: object

className

className: string = "ImportManifestMetadata"

name

name: string = "Composite"

modelProperties

modelProperties: object

hashes

hashes: object

required

required: boolean = true

serializedName

serializedName: string = "hashes"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "String"

sizeInBytes

sizeInBytes: object

required

required: boolean = true

serializedName

serializedName: string = "sizeInBytes"

type

type: object

name

name: string = "Number"

url

url: object

required

required: boolean = true

serializedName

serializedName: string = "url"

type

type: object

name

name: string = "String"

Const ImportUpdateInput

ImportUpdateInput: object

type

type: object

className

className: string = "ImportUpdateInput"

name

name: string = "Composite"

modelProperties

modelProperties: object

files

files: object

required

required: boolean = true

serializedName

serializedName: string = "files"

constraints

constraints: object

MinItems

MinItems: number = 1

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "FileImportMetadata"

name

name: string = "Composite"

importManifest

importManifest: object

serializedName

serializedName: string = "importManifest"

type

type: object

className

className: string = "ImportManifestMetadata"

name

name: string = "Composite"

Const InnerError

InnerError: object

type

type: object

className

className: string = "InnerError"

name

name: string = "Composite"

modelProperties

modelProperties: object

code

code: object

required

required: boolean = true

serializedName

serializedName: string = "code"

type

type: object

name

name: string = "String"

errorDetail

errorDetail: object

serializedName

serializedName: string = "errorDetail"

type

type: object

name

name: string = "String"

innerError

innerError: object

serializedName

serializedName: string = "innerError"

type

type: object

className

className: string = "InnerError"

name

name: string = "Composite"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: string = "String"

Const Operation

Operation: object

type

type: object

className

className: string = "Operation"

name

name: string = "Composite"

modelProperties

modelProperties: object

createdDateTime

createdDateTime: object

required

required: boolean = true

serializedName

serializedName: string = "createdDateTime"

type

type: object

name

name: string = "DateTime"

error

error: object

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "ErrorModel"

name

name: string = "Composite"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: string = "String"

lastActionDateTime

lastActionDateTime: object

required

required: boolean = true

serializedName

serializedName: string = "lastActionDateTime"

type

type: object

name

name: string = "DateTime"

operationId

operationId: object

required

required: boolean = true

serializedName

serializedName: string = "operationId"

type

type: object

name

name: string = "String"

resourceLocation

resourceLocation: object

serializedName

serializedName: string = "resourceLocation"

type

type: object

name

name: string = "String"

status

status: object

required

required: boolean = true

serializedName

serializedName: string = "status"

type

type: object

name

name: string = "String"

traceId

traceId: object

serializedName

serializedName: string = "traceId"

type

type: object

name

name: string = "String"

updateId

updateId: object

serializedName

serializedName: string = "updateId"

type

type: object

className

className: string = "UpdateId"

name

name: string = "Composite"

Const OperationFilter

OperationFilter: object

type

type: object

className

className: string = "OperationFilter"

name

name: string = "Composite"

modelProperties

modelProperties: object

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: string = "String"

Const PageableListOfDeploymentDeviceStates

PageableListOfDeploymentDeviceStates: object

type

type: object

className

className: string = "PageableListOfDeploymentDeviceStates"

name

name: string = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DeploymentDeviceState"

name

name: string = "Composite"

Const PageableListOfDeployments

PageableListOfDeployments: object

type

type: object

className

className: string = "PageableListOfDeployments"

name

name: string = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "Deployment"

name

name: string = "Composite"

Const PageableListOfDeviceClasses

PageableListOfDeviceClasses: object

type

type: object

className

className: string = "PageableListOfDeviceClasses"

name

name: string = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DeviceClass"

name

name: string = "Composite"

Const PageableListOfDeviceTags

PageableListOfDeviceTags: object

type

type: object

className

className: string = "PageableListOfDeviceTags"

name

name: string = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DeviceTag"

name

name: string = "Composite"

Const PageableListOfDevices

PageableListOfDevices: object

type

type: object

className

className: string = "PageableListOfDevices"

name

name: string = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "Device"

name

name: string = "Composite"

Const PageableListOfGroups

PageableListOfGroups: object

type

type: object

className

className: string = "PageableListOfGroups"

name

name: string = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "Group"

name

name: string = "Composite"

Const PageableListOfOperations

PageableListOfOperations: object

type

type: object

className

className: string = "PageableListOfOperations"

name

name: string = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "Operation"

name

name: string = "Composite"

Const PageableListOfStrings

PageableListOfStrings: object

type

type: object

className

className: string = "PageableListOfStrings"

name

name: string = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const PageableListOfUpdatableDevices

PageableListOfUpdatableDevices: object

type

type: object

className

className: string = "PageableListOfUpdatableDevices"

name

name: string = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "UpdatableDevices"

name

name: string = "Composite"

Const PageableListOfUpdateIds

PageableListOfUpdateIds: object

type

type: object

className

className: string = "PageableListOfUpdateIds"

name

name: string = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "UpdateId"

name

name: string = "Composite"

Const UpdatableDevices

UpdatableDevices: object

type

type: object

className

className: string = "UpdatableDevices"

name

name: string = "Composite"

modelProperties

modelProperties: object

deviceCount

deviceCount: object

required

required: boolean = true

serializedName

serializedName: string = "deviceCount"

type

type: object

name

name: string = "Number"

updateId

updateId: object

serializedName

serializedName: string = "updateId"

type

type: object

className

className: string = "UpdateId"

name

name: string = "Composite"

Const Update

Update: object

type

type: object

className

className: string = "Update"

name

name: string = "Composite"

modelProperties

modelProperties: object

compatibility

compatibility: object

required

required: boolean = true

serializedName

serializedName: string = "compatibility"

constraints

constraints: object

MinItems

MinItems: number = 1

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "Compatibility"

name

name: string = "Composite"

createdDateTime

createdDateTime: object

required

required: boolean = true

serializedName

serializedName: string = "createdDateTime"

type

type: object

name

name: string = "DateTime"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: string = "String"

importedDateTime

importedDateTime: object

required

required: boolean = true

serializedName

serializedName: string = "importedDateTime"

type

type: object

name

name: string = "DateTime"

installedCriteria

installedCriteria: object

required

required: boolean = true

serializedName

serializedName: string = "installedCriteria"

type

type: object

name

name: string = "String"

manifestVersion

manifestVersion: object

required

required: boolean = true

serializedName

serializedName: string = "manifestVersion"

type

type: object

name

name: string = "String"

updateId

updateId: object

serializedName

serializedName: string = "updateId"

type

type: object

className

className: string = "UpdateId"

name

name: string = "Composite"

updateType

updateType: object

required

required: boolean = true

serializedName

serializedName: string = "updateType"

type

type: object

name

name: string = "String"

Const UpdateCompliance

UpdateCompliance: object

type

type: object

className

className: string = "UpdateCompliance"

name

name: string = "Composite"

modelProperties

modelProperties: object

newUpdatesAvailableDeviceCount

newUpdatesAvailableDeviceCount: object

required

required: boolean = true

serializedName

serializedName: string = "newUpdatesAvailableDeviceCount"

type

type: object

name

name: string = "Number"

onLatestUpdateDeviceCount

onLatestUpdateDeviceCount: object

required

required: boolean = true

serializedName

serializedName: string = "onLatestUpdateDeviceCount"

type

type: object

name

name: string = "Number"

totalDeviceCount

totalDeviceCount: object

required

required: boolean = true

serializedName

serializedName: string = "totalDeviceCount"

type

type: object

name

name: string = "Number"

updatesInProgressDeviceCount

updatesInProgressDeviceCount: object

required

required: boolean = true

serializedName

serializedName: string = "updatesInProgressDeviceCount"

type

type: object

name

name: string = "Number"

Const UpdateId

UpdateId: object

type

type: object

className

className: string = "UpdateId"

name

name: string = "Composite"

modelProperties

modelProperties: object

name

name: object

required

required: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

provider

provider: object

required

required: boolean = true

serializedName

serializedName: string = "provider"

type

type: object

name

name: string = "String"

version

version: object

required

required: boolean = true

serializedName

serializedName: string = "version"

type

type: object

name

name: string = "String"

Const UpdatesDeleteUpdateHeaders

UpdatesDeleteUpdateHeaders: object

type

type: object

className

className: string = "UpdatesDeleteUpdateHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: string = "String"

operationLocation

operationLocation: object

serializedName

serializedName: string = "operation-location"

type

type: object

name

name: string = "String"

Const UpdatesGetOperationHeaders

UpdatesGetOperationHeaders: object

type

type: object

className

className: string = "UpdatesGetOperationHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

retryAfter

retryAfter: object

serializedName

serializedName: string = "retry-after"

type

type: object

name

name: string = "String"

Const UpdatesImportUpdateHeaders

UpdatesImportUpdateHeaders: object

type

type: object

className

className: string = "UpdatesImportUpdateHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: string = "String"

operationLocation

operationLocation: object

serializedName

serializedName: string = "operation-location"

type

type: object

name

name: string = "String"

Const accept

accept: object

parameterPath

parameterPath: string = "accept"

mapper

mapper: object

defaultValue

defaultValue: string = "application/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Accept"

type

type: object

name

name: string = "String"

Const accountEndpoint

accountEndpoint: object

parameterPath

parameterPath: string = "accountEndpoint"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "accountEndpoint"

type

type: object

name

name: string = "String"

Const action

action: object

parameterPath

parameterPath: string = "action"

mapper

mapper: object

defaultValue

defaultValue: string = "import"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "action"

type

type: object

name

name: string = "String"

Const action1

action1: object

parameterPath

parameterPath: string = "action"

mapper

mapper: object

defaultValue

defaultValue: string = "cancel"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "action"

type

type: object

name

name: string = "String"

Const action2

action2: object

parameterPath

parameterPath: string = "action"

mapper

mapper: object

defaultValue

defaultValue: string = "retry"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "action"

type

type: object

name

name: string = "String"

Const cancelDeploymentOperationSpec

cancelDeploymentOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "POST"

path

path: string = "/deviceupdate/{instanceId}/v2/management/deployments/{deploymentId}"

queryParameters

queryParameters: any[] = [Parameters.action1]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint, Parameters.instanceId, Parameters.deploymentId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.Deployment

404

404: object

isError

isError: boolean = true

Const contentType

contentType: object

parameterPath

parameterPath: string[] = ["options", "contentType"]

mapper

mapper: object

defaultValue

defaultValue: string = "application/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Content-Type"

type

type: object

name

name: string = "String"

Const createOrUpdateDeploymentOperationSpec

createOrUpdateDeploymentOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.contentType, Parameters.accept]

httpMethod

httpMethod: string = "PUT"

mediaType

mediaType: string = "json"

path

path: string = "/deviceupdate/{instanceId}/v2/management/deployments/{deploymentId}"

requestBody

requestBody: any = Parameters.deployment

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint, Parameters.instanceId, Parameters.deploymentId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.Deployment

404

404: object

isError

isError: boolean = true

Const createOrUpdateGroupOperationSpec

createOrUpdateGroupOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.contentType, Parameters.accept]

httpMethod

httpMethod: string = "PUT"

mediaType

mediaType: string = "json"

path

path: string = "/deviceupdate/{instanceId}/v2/management/groups/{groupId}"

requestBody

requestBody: any = Parameters.group

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint, Parameters.instanceId, Parameters.groupId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.Group

400

400: object

isError

isError: boolean = true

404

404: object

isError

isError: boolean = true

Const deleteDeploymentOperationSpec

deleteDeploymentOperationSpec: object

httpMethod

httpMethod: string = "DELETE"

path

path: string = "/deviceupdate/{instanceId}/v2/management/deployments/{deploymentId}"

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint, Parameters.instanceId, Parameters.deploymentId]

responses

responses: object

200

200: {}

Type declaration

404

404: object

isError

isError: boolean = true

Const deleteGroupOperationSpec

deleteGroupOperationSpec: object

httpMethod

httpMethod: string = "DELETE"

path

path: string = "/deviceupdate/{instanceId}/v2/management/groups/{groupId}"

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint, Parameters.instanceId, Parameters.groupId]

responses

responses: object

200

200: {}

Type declaration

204

204: {}

Type declaration

Const deleteUpdateOperationSpec

deleteUpdateOperationSpec: object

httpMethod

httpMethod: string = "DELETE"

path

path: string = "/deviceupdate/{instanceId}/v2/updates/providers/{provider}/names/{name}/versions/{version}"

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint,Parameters.instanceId,Parameters.provider,Parameters.name,Parameters.version]

responses

responses: object

202

202: object

headersMapper

headersMapper: any = Mappers.UpdatesDeleteUpdateHeaders

429

429: object

isError

isError: boolean = true

Const deployment

deployment: object

mapper

mapper: any = DeploymentMapper

parameterPath

parameterPath: string = "deployment"

Const deploymentId

deploymentId: object

parameterPath

parameterPath: string = "deploymentId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "deploymentId"

type

type: object

name

name: string = "String"

Const deviceClassId

deviceClassId: object

parameterPath

parameterPath: string = "deviceClassId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "deviceClassId"

type

type: object

name

name: string = "String"

Const deviceId

deviceId: object

parameterPath

parameterPath: string = "deviceId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "deviceId"

type

type: object

name

name: string = "String"

Const fileId

fileId: object

parameterPath

parameterPath: string = "fileId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "fileId"

type

type: object

name

name: string = "String"

Const filter

filter: object

parameterPath

parameterPath: string[] = ["options", "filter"]

mapper

mapper: object

serializedName

serializedName: string = "$filter"

type

type: object

name

name: string = "String"

Const getAllDeploymentsNextOperationSpec

getAllDeploymentsNextOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

queryParameters

queryParameters: any[] = [Parameters.filter]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint, Parameters.instanceId, Parameters.nextLink]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PageableListOfDeployments

Const getAllDeploymentsOperationSpec

getAllDeploymentsOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/deviceupdate/{instanceId}/v2/management/deployments"

queryParameters

queryParameters: any[] = [Parameters.filter]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint, Parameters.instanceId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PageableListOfDeployments

Const getAllDeviceClassesNextOperationSpec

getAllDeviceClassesNextOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint, Parameters.instanceId, Parameters.nextLink]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PageableListOfDeviceClasses

Const getAllDeviceClassesOperationSpec

getAllDeviceClassesOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/deviceupdate/{instanceId}/v2/management/deviceclasses"

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint, Parameters.instanceId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PageableListOfDeviceClasses

Const getAllDeviceTagsNextOperationSpec

getAllDeviceTagsNextOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint, Parameters.instanceId, Parameters.nextLink]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PageableListOfDeviceTags

Const getAllDeviceTagsOperationSpec

getAllDeviceTagsOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/deviceupdate/{instanceId}/v2/management/devicetags"

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint, Parameters.instanceId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PageableListOfDeviceTags

Const getAllDevicesNextOperationSpec

getAllDevicesNextOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

queryParameters

queryParameters: any[] = [Parameters.filter]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint, Parameters.instanceId, Parameters.nextLink]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PageableListOfDevices

Const getAllDevicesOperationSpec

getAllDevicesOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/deviceupdate/{instanceId}/v2/management/devices"

queryParameters

queryParameters: any[] = [Parameters.filter]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint, Parameters.instanceId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PageableListOfDevices

Const getAllGroupsNextOperationSpec

getAllGroupsNextOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint, Parameters.instanceId, Parameters.nextLink]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PageableListOfGroups

Const getAllGroupsOperationSpec

getAllGroupsOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/deviceupdate/{instanceId}/v2/management/groups"

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint, Parameters.instanceId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PageableListOfGroups

Const getDeploymentDevicesNextOperationSpec

getDeploymentDevicesNextOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

queryParameters

queryParameters: any[] = [Parameters.filter]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint,Parameters.instanceId,Parameters.nextLink,Parameters.deploymentId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PageableListOfDeploymentDeviceStates

404

404: object

isError

isError: boolean = true

Const getDeploymentDevicesOperationSpec

getDeploymentDevicesOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/deviceupdate/{instanceId}/v2/management/deployments/{deploymentId}/devicestates"

queryParameters

queryParameters: any[] = [Parameters.filter]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint, Parameters.instanceId, Parameters.deploymentId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PageableListOfDeploymentDeviceStates

404

404: object

isError

isError: boolean = true

Const getDeploymentOperationSpec

getDeploymentOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/deviceupdate/{instanceId}/v2/management/deployments/{deploymentId}"

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint, Parameters.instanceId, Parameters.deploymentId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.Deployment

404

404: object

isError

isError: boolean = true

Const getDeploymentStatusOperationSpec

getDeploymentStatusOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/deviceupdate/{instanceId}/v2/management/deployments/{deploymentId}/status"

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint, Parameters.instanceId, Parameters.deploymentId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.DeploymentStatus

404

404: object

isError

isError: boolean = true

Const getDeviceClassDeviceIdsNextOperationSpec

getDeviceClassDeviceIdsNextOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint,Parameters.instanceId,Parameters.nextLink,Parameters.deviceClassId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PageableListOfStrings

404

404: object

isError

isError: boolean = true

Const getDeviceClassDeviceIdsOperationSpec

getDeviceClassDeviceIdsOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/deviceupdate/{instanceId}/v2/management/deviceclasses/{deviceClassId}/deviceids"

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint, Parameters.instanceId, Parameters.deviceClassId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PageableListOfStrings

404

404: object

isError

isError: boolean = true

Const getDeviceClassInstallableUpdatesNextOperationSpec

getDeviceClassInstallableUpdatesNextOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint,Parameters.instanceId,Parameters.nextLink,Parameters.deviceClassId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PageableListOfUpdateIds

404

404: object

isError

isError: boolean = true

Const getDeviceClassInstallableUpdatesOperationSpec

getDeviceClassInstallableUpdatesOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/deviceupdate/{instanceId}/v2/management/deviceclasses/{deviceClassId}/installableupdates"

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint, Parameters.instanceId, Parameters.deviceClassId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PageableListOfUpdateIds

404

404: object

isError

isError: boolean = true

Const getDeviceClassOperationSpec

getDeviceClassOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/deviceupdate/{instanceId}/v2/management/deviceclasses/{deviceClassId}"

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint, Parameters.instanceId, Parameters.deviceClassId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.DeviceClass

404

404: object

isError

isError: boolean = true

Const getDeviceOperationSpec

getDeviceOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/deviceupdate/{instanceId}/v2/management/devices/{deviceId}"

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint, Parameters.instanceId, Parameters.deviceId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.Device

404

404: object

isError

isError: boolean = true

Const getDeviceTagOperationSpec

getDeviceTagOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/deviceupdate/{instanceId}/v2/management/devicetags/{tagName}"

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint, Parameters.instanceId, Parameters.tagName]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.DeviceTag

404

404: object

isError

isError: boolean = true

Const getFileOperationSpec

getFileOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept, Parameters.ifNoneMatch]

httpMethod

httpMethod: string = "GET"

path

path: string = "/deviceupdate/{instanceId}/v2/updates/providers/{provider}/names/{name}/versions/{version}/files/{fileId}"

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint,Parameters.instanceId,Parameters.provider,Parameters.name,Parameters.version,Parameters.fileId]

responses

responses: object

304

304: {}

Type declaration

200

200: object

bodyMapper

bodyMapper: any = Mappers.File

404

404: object

isError

isError: boolean = true

429

429: object

isError

isError: boolean = true

Const getFilesNextOperationSpec

getFilesNextOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint,Parameters.instanceId,Parameters.provider,Parameters.name,Parameters.version,Parameters.nextLink]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PageableListOfStrings

404

404: object

isError

isError: boolean = true

429

429: object

isError

isError: boolean = true

Const getFilesOperationSpec

getFilesOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/deviceupdate/{instanceId}/v2/updates/providers/{provider}/names/{name}/versions/{version}/files"

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint,Parameters.instanceId,Parameters.provider,Parameters.name,Parameters.version]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PageableListOfStrings

404

404: object

isError

isError: boolean = true

429

429: object

isError

isError: boolean = true

Const getGroupBestUpdatesNextOperationSpec

getGroupBestUpdatesNextOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

queryParameters

queryParameters: any[] = [Parameters.filter]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint,Parameters.instanceId,Parameters.nextLink,Parameters.groupId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PageableListOfUpdatableDevices

404

404: object

isError

isError: boolean = true

Const getGroupBestUpdatesOperationSpec

getGroupBestUpdatesOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/deviceupdate/{instanceId}/v2/management/groups/{groupId}/bestUpdates"

queryParameters

queryParameters: any[] = [Parameters.filter]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint, Parameters.instanceId, Parameters.groupId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PageableListOfUpdatableDevices

404

404: object

isError

isError: boolean = true

Const getGroupOperationSpec

getGroupOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/deviceupdate/{instanceId}/v2/management/groups/{groupId}"

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint, Parameters.instanceId, Parameters.groupId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.Group

404

404: object

isError

isError: boolean = true

Const getGroupUpdateComplianceOperationSpec

getGroupUpdateComplianceOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/deviceupdate/{instanceId}/v2/management/groups/{groupId}/updateCompliance"

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint, Parameters.instanceId, Parameters.groupId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.UpdateCompliance

404

404: object

isError

isError: boolean = true

Const getNamesNextOperationSpec

getNamesNextOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint,Parameters.instanceId,Parameters.provider,Parameters.nextLink]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PageableListOfStrings

404

404: object

isError

isError: boolean = true

429

429: object

isError

isError: boolean = true

Const getNamesOperationSpec

getNamesOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/deviceupdate/{instanceId}/v2/updates/providers/{provider}/names"

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint, Parameters.instanceId, Parameters.provider]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PageableListOfStrings

404

404: object

isError

isError: boolean = true

429

429: object

isError

isError: boolean = true

Const getOperationOperationSpec

getOperationOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept, Parameters.ifNoneMatch]

httpMethod

httpMethod: string = "GET"

path

path: string = "/deviceupdate/{instanceId}/v2/updates/operations/{operationId}"

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint, Parameters.instanceId, Parameters.operationId]

responses

responses: object

304

304: {}

Type declaration

200

200: object

bodyMapper

bodyMapper: any = Mappers.Operation

headersMapper

headersMapper: any = Mappers.UpdatesGetOperationHeaders

404

404: object

isError

isError: boolean = true

429

429: object

isError

isError: boolean = true

Const getOperationsNextOperationSpec

getOperationsNextOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

queryParameters

queryParameters: any[] = [Parameters.filter, Parameters.top]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint, Parameters.instanceId, Parameters.nextLink]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PageableListOfOperations

429

429: object

isError

isError: boolean = true

Const getOperationsOperationSpec

getOperationsOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/deviceupdate/{instanceId}/v2/updates/operations"

queryParameters

queryParameters: any[] = [Parameters.filter, Parameters.top]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint, Parameters.instanceId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PageableListOfOperations

429

429: object

isError

isError: boolean = true

Const getProvidersNextOperationSpec

getProvidersNextOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint, Parameters.instanceId, Parameters.nextLink]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PageableListOfStrings

429

429: object

isError

isError: boolean = true

Const getProvidersOperationSpec

getProvidersOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/deviceupdate/{instanceId}/v2/updates/providers"

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint, Parameters.instanceId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PageableListOfStrings

429

429: object

isError

isError: boolean = true

Const getUpdateComplianceOperationSpec

getUpdateComplianceOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/deviceupdate/{instanceId}/v2/management/updatecompliance"

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint, Parameters.instanceId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.UpdateCompliance

Const getUpdateOperationSpec

getUpdateOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept, Parameters.ifNoneMatch]

httpMethod

httpMethod: string = "GET"

path

path: string = "/deviceupdate/{instanceId}/v2/updates/providers/{provider}/names/{name}/versions/{version}"

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint,Parameters.instanceId,Parameters.provider,Parameters.name,Parameters.version]

responses

responses: object

304

304: {}

Type declaration

200

200: object

bodyMapper

bodyMapper: any = Mappers.Update

404

404: object

isError

isError: boolean = true

429

429: object

isError

isError: boolean = true

Const getVersionsNextOperationSpec

getVersionsNextOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint,Parameters.instanceId,Parameters.provider,Parameters.name,Parameters.nextLink]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PageableListOfStrings

404

404: object

isError

isError: boolean = true

429

429: object

isError

isError: boolean = true

Const getVersionsOperationSpec

getVersionsOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/deviceupdate/{instanceId}/v2/updates/providers/{provider}/names/{name}/versions"

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint,Parameters.instanceId,Parameters.provider,Parameters.name]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PageableListOfStrings

404

404: object

isError

isError: boolean = true

429

429: object

isError

isError: boolean = true

Const group

group: object

mapper

mapper: any = GroupMapper

parameterPath

parameterPath: string = "group"

Const groupId

groupId: object

parameterPath

parameterPath: string = "groupId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "groupId"

type

type: object

name

name: string = "String"

Const ifNoneMatch

ifNoneMatch: object

parameterPath

parameterPath: string[] = ["options", "accessCondition", "ifNoneMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-None-Match"

type

type: object

name

name: string = "String"

Const importUpdateOperationSpec

importUpdateOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.contentType]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/deviceupdate/{instanceId}/v2/updates"

queryParameters

queryParameters: any[] = [Parameters.action]

requestBody

requestBody: any = Parameters.updateToImport

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint, Parameters.instanceId]

responses

responses: object

202

202: object

headersMapper

headersMapper: any = Mappers.UpdatesImportUpdateHeaders

429

429: object

isError

isError: boolean = true

Const instanceId

instanceId: object

parameterPath

parameterPath: string = "instanceId"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "instanceId"

type

type: object

name

name: string = "String"

Const name

name: object

parameterPath

parameterPath: string = "name"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

Const nextLink

nextLink: object

parameterPath

parameterPath: string = "nextLink"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

Const operationId

operationId: object

parameterPath

parameterPath: string = "operationId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "operationId"

type

type: object

name

name: string = "String"

Const provider

provider: object

parameterPath

parameterPath: string = "provider"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "provider"

type

type: object

name

name: string = "String"

Const retryDeploymentOperationSpec

retryDeploymentOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "POST"

path

path: string = "/deviceupdate/{instanceId}/v2/management/deployments/{deploymentId}"

queryParameters

queryParameters: any[] = [Parameters.action2]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.accountEndpoint, Parameters.instanceId, Parameters.deploymentId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.Deployment

404

404: object

isError

isError: boolean = true

Const tagName

tagName: object

parameterPath

parameterPath: string = "tagName"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "tagName"

type

type: object

name

name: string = "String"

Const top

top: object

parameterPath

parameterPath: string[] = ["options", "top"]

mapper

mapper: object

serializedName

serializedName: string = "$top"

type

type: object

name

name: string = "Number"

Const updateToImport

updateToImport: object

mapper

mapper: any = ImportUpdateInputMapper

parameterPath

parameterPath: string = "updateToImport"

Const version

version: object

parameterPath

parameterPath: string = "version"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "version"

type

type: object

name

name: string = "String"

Generated using TypeDoc