Share via

IoTSpacesClient class

Package:
@azure/arm-iotspaces
Extends
IoTSpacesClientContext

Constructors

IoTSpacesClient(ServiceClientCredentials | TokenCredential, string, IoTSpacesClientOptions)

Initializes a new instance of the IoTSpacesClient class.

Properties

ioTSpaces
operations

Inherited Properties

acceptLanguage
apiVersion
credentials
longRunningOperationRetryTimeout

The retry timeout in seconds for Long Running Operations. Default value is 30.
subscriptionId

Inherited Methods

beginLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

Send the initial request of a LRO (long running operation) and get back an HttpLongRunningOperationResponse that provides methods for polling the LRO and checking if the LRO is finished.
restoreLROPoller(LROPollState)

Restore an LROPoller from the provided LROPollState. This method can be used to recreate an LROPoller on a different process or machine.
sendLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

Provides a mechanism to make a request that will poll and provide the final result.
sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)

Send the initial request of a LRO (long running operation) and get back an LROPoller that provides methods for polling the LRO and checking if the LRO is finished.
sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

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

Send the provided httpRequest.

Constructor Details

IoTSpacesClient(ServiceClientCredentials | TokenCredential, string, IoTSpacesClientOptions)

Initializes a new instance of the IoTSpacesClient class.

new IoTSpacesClient(credentials: ServiceClientCredentials | TokenCredential, subscriptionId: string, options?: IoTSpacesClientOptions)

Parameters

credentials

@azure/ms-rest-js.ServiceClientCredentials | @azure/core-auth.TokenCredential

Credentials needed for the client to connect to Azure. Credentials implementing the TokenCredential interface from the @azure/identity package are recommended. For more information about these credentials, see https://www.npmjs.com/package/@azure/identity. Credentials implementing the ServiceClientCredentials interface from the older packages @azure/ms-rest-nodeauth and @azure/ms-rest-browserauth are also supported.

subscriptionId

string

The subscription identifier.

options
IoTSpacesClientOptions

The parameter options

Property Details

ioTSpaces 

ioTSpaces: IoTSpaces

Property Value

IoTSpaces

operations 

operations: Operations

Property Value

Operations

Inherited Property Details

acceptLanguage 

acceptLanguage: string

Property Value

string

Inherited From IoTSpacesClientContext.acceptLanguage

apiVersion 

apiVersion?: string

Property Value

string

Inherited From IoTSpacesClientContext.apiVersion

credentials 

credentials: ServiceClientCredentials | TokenCredential

Property Value

@azure/ms-rest-js.ServiceClientCredentials | @azure/core-auth.TokenCredential

Inherited From IoTSpacesClientContext.credentials

longRunningOperationRetryTimeout

The retry timeout in seconds for Long Running Operations. Default value is 30.

longRunningOperationRetryTimeout?: number

Property Value

number

Inherited From IoTSpacesClientContext.longRunningOperationRetryTimeout

subscriptionId 

subscriptionId: string

Property Value

string

Inherited From IoTSpacesClientContext.subscriptionId

Inherited Method Details

beginLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

Send the initial request of a LRO (long running operation) and get back an HttpLongRunningOperationResponse that provides methods for polling the LRO and checking if the LRO is finished.

function beginLongRunningRequest(request: RequestPrepareOptions | WebResource, options?: RequestOptionsBase): Promise<LROPoller>

Parameters

request

@azure/ms-rest-js.RequestPrepareOptions | @azure/ms-rest-js.WebResource

The request object

options
@azure/ms-rest-js.RequestOptionsBase

Additional options to be sent while making the request

Returns

Promise<@azure/ms-rest-azure-js.LROPoller>

The HttpLongRunningOperationResponse that provides methods for interacting with the LRO.

Inherited From IoTSpacesClientContext.beginLongRunningRequest

restoreLROPoller(LROPollState)

Restore an LROPoller from the provided LROPollState. This method can be used to recreate an LROPoller on a different process or machine.

function restoreLROPoller(lroPollState: LROPollState): LROPoller

Parameters

lroPollState
@azure/ms-rest-azure-js.LROPollState

Returns

@azure/ms-rest-azure-js.LROPoller

Inherited From IoTSpacesClientContext.restoreLROPoller

sendLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

Provides a mechanism to make a request that will poll and provide the final result.

function sendLongRunningRequest(request: RequestPrepareOptions | WebResource, options?: RequestOptionsBase): Promise<HttpOperationResponse>

Parameters

request

@azure/ms-rest-js.RequestPrepareOptions | @azure/ms-rest-js.WebResource

The request object

options
@azure/ms-rest-js.RequestOptionsBase

Additional options to be sent while making the request

Returns

Promise<@azure/ms-rest-js.HttpOperationResponse>

The HttpOperationResponse containing the final polling request, response and the responseBody.

Inherited From IoTSpacesClientContext.sendLongRunningRequest

sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)

Send the initial request of a LRO (long running operation) and get back an LROPoller that provides methods for polling the LRO and checking if the LRO is finished.

function sendLRORequest(operationArguments: OperationArguments, operationSpec: OperationSpec, options?: RequestOptionsBase): Promise<LROPoller>

Parameters

operationArguments
@azure/ms-rest-js.OperationArguments

The arguments to the operation.

operationSpec
@azure/ms-rest-js.OperationSpec

The specification for the operation.

options
@azure/ms-rest-js.RequestOptionsBase

Additional options to be sent while making the request.

Returns

Promise<@azure/ms-rest-azure-js.LROPoller>

The LROPoller object that provides methods for interacting with the LRO.

Inherited From IoTSpacesClientContext.sendLRORequest

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
@azure/ms-rest-js.OperationArguments

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

operationSpec
@azure/ms-rest-js.OperationSpec

The OperationSpec to use to populate the httpRequest.

callback

@azure/ms-rest-js.ServiceCallback<any>

The callback to call when the response is received.

Returns

Promise<@azure/ms-rest-js.RestResponse>

Inherited From IoTSpacesClientContext.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResource)

Send the provided httpRequest.

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

Parameters

options

@azure/ms-rest-js.RequestPrepareOptions | @azure/ms-rest-js.WebResource

Returns

Promise<@azure/ms-rest-js.HttpOperationResponse>

Inherited From IoTSpacesClientContext.sendRequest