@azure/ms-rest-azure-js

constructor

constructor(credentials: any, options?: AzureServiceClientOptions);

property acceptLanguage

acceptLanguage: string;

property longRunningOperationRetryTimeout

longRunningOperationRetryTimeout?: number;

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

method beginLongRunningRequest

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

• 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.

  Parameter request

  The request object

  Parameter options

  Additional options to be sent while making the request

  Returns

  {Promise} The HttpLongRunningOperationResponse that provides methods for interacting with the LRO.

method restoreLROPoller

restoreLROPoller: (lroPollState: LROPollState) => LROPoller;

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

method sendLongRunningRequest

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

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

  Parameter request

  The request object

  Parameter options

  Additional options to be sent while making the request

  Returns

  {Promise<msRest.HttpOperationResponse>} The HttpOperationResponse containing the final polling request, response and the responseBody.

method sendLRORequest

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

• 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.

  Parameter operationArguments

  The arguments to the operation.

  Parameter operationSpec

  The specification for the operation.

  Parameter options

  Additional options to be sent while making the request.

  Returns

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

constructor

constructor(subscriptionKey: string);

constructor

constructor(
    _lroPollStrategy: LROPollStrategy,
    _initialResponse: HttpOperationResponse
);

• Create a new HttpLongRunningOperationResponse.

  Parameter _lroPollStrategy

  The LROPollStrategy that this HttpLongRunningOperationResponse will use to interact with the LRO.

method getInitialResponse

getInitialResponse: () => HttpOperationResponse;

• Get the first response that the service sent back when the LRO was initiated.

method getMostRecentResponse

getMostRecentResponse: () => HttpOperationResponse;

• Get the most recent response that the service sent back during this LRO.

method getOperationResponse

getOperationResponse: () => Promise<HttpOperationResponse | undefined>;

• If the LRO is finished and in an acceptable state, then return the HttpOperationResponse. If the LRO is finished and not in an acceptable state, then throw the error that the LRO produced. If the LRO is not finished, then return undefined.

method getOperationStatus

getOperationStatus: () => LongRunningOperationStates;

• Get the current status of the LRO.

method getPollState

getPollState: () => LROPollState | undefined;

• Get an LROPollState object that can be used to poll this LRO in a different context (such as on a different process or a different machine). If the LRO couldn't produce an LRO polling strategy, then this will return undefined.

method isFinalStatusAcceptable

isFinalStatusAcceptable: () => boolean | undefined;

• Get whether or not the LRO is finished and its final state is acceptable. If the LRO has not finished yet, then undefined will be returned. An "acceptable" final state is determined by the LRO strategy that the Azure service uses to perform long running operations.

method isFinished

isFinished: () => boolean;

• Get whether or not the LRO is finished.

method poll

poll: () => Promise<LongRunningOperationStates>;

• Send a single poll request and return the LRO's state.

method pollUntilFinished

pollUntilFinished: () => Promise<RestResponse>;

• Send poll requests that check the LRO's status until it is determined that the LRO is finished.

property acceptLanguage

acceptLanguage?: string;

• {string} [options.acceptLanguage] - Gets or sets the preferred language for the response. Default value is: "en-US".

property longRunningOperationRetryTimeout

longRunningOperationRetryTimeout?: number;

• {number} [options.longRunningOperationRetryTimeout] - Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

property additionalInfo

additionalInfo?: AdditionalInfoElement;

• {AdditionalInfoElement} [innerError] The additional error information

property code

code: string;

• {string} code The error code parsed from the body of the http error response.

property details

details?: Array<CloudError>;

• {Array} [details] An array of CloudError objects specifying the details.

property innerError

innerError?: any;

• {any} [innerError] The inner error parsed from the body of the http error response

property message

message: string;

• {string} message The error message parsed from the body of the http error response.

property target

target?: string;

• {string} [target] The target of the error.