Share via

DeviceUpdateClient class

  • Reference
Package:
@azure/iot-device-update
Extends
DeviceUpdateClientContext

Constructors

DeviceUpdateClient(TokenCredential | ServiceClientCredentials, string, string, DeviceUpdateClientOptionalParams)

Initializes a new instance of the DeviceUpdateClient class.

Properties

deployments
devices
updates

Inherited Properties

accountEndpoint
instanceId

Inherited Methods

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Send an HTTP request that is populated using the provided OperationSpec.
sendRequest(RequestPrepareOptions | WebResourceLike)

Send the provided httpRequest.

Constructor Details

DeviceUpdateClient(TokenCredential | ServiceClientCredentials, string, string, DeviceUpdateClientOptionalParams)

Initializes a new instance of the DeviceUpdateClient class.

new DeviceUpdateClient(credentials: TokenCredential | ServiceClientCredentials, accountEndpoint: string, instanceId: string, options?: DeviceUpdateClientOptionalParams)

Parameters

credentials

TokenCredential | ServiceClientCredentials

Subscription credentials which uniquely identify client subscription.

accountEndpoint

string

Account endpoint.

instanceId

string

Account instance identifier.

options
DeviceUpdateClientOptionalParams

The parameter options

Property Details

deployments 

deployments: Deployments

Property Value

Deployments

devices 

devices: Devices

Property Value

Devices

updates 

updates: Updates

Property Value

Updates

Inherited Property Details

accountEndpoint 

accountEndpoint: string

Property Value

string

Inherited From DeviceUpdateClientContext.accountEndpoint

instanceId 

instanceId: string

Property Value

string

Inherited From DeviceUpdateClientContext.instanceId

Inherited Method Details

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Send an HTTP request that is populated using the provided OperationSpec.

function sendOperationRequest(operationArguments: OperationArguments, operationSpec: OperationSpec, callback?: ServiceCallback<any>): Promise<RestResponse>

Parameters

operationArguments
OperationArguments

The arguments that the HTTP request's templated values will be populated from.

operationSpec
OperationSpec

The OperationSpec to use to populate the httpRequest.

callback

ServiceCallback<any>

The callback to call when the response is received.

Returns

Promise<RestResponse>

Inherited From DeviceUpdateClientContext.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

Send the provided httpRequest.

function sendRequest(options: RequestPrepareOptions | WebResourceLike): Promise<HttpOperationResponse>

Parameters

options

RequestPrepareOptions | WebResourceLike

Returns

Promise<HttpOperationResponse>

Inherited From DeviceUpdateClientContext.sendRequest