SimplePollerLike interface

Paket:

@azure/arm-compute

En enkel pollerare som kan användas för att avsöka en tidskrävande åtgärd.

Metoder

getOperationState()	Returnerar åtgärdens tillstånd.
getResult()	Returnerar åtgärdens resultatvärde, oavsett pollerarens tillstånd. Den kan returnera odefinierad eller ofullständig form av det slutliga TResult-värdet beroende på implementeringen.
isDone()	Returnerar sant om polleraren har slutfört avsökningen.
isStopped()	Returnerar sant om polleraren stoppas.
onProgress((state: TState) => void)	Anropar den tillhandahållna callbacken efter att varje polling är klar, och skickar det aktuella tillståndet för pollerns operation. Den returnerar en metod som kan användas för att sluta ta emot uppdateringar på den givna callback-funktionen.
poll({ abortSignal?: AbortSignalLike })	Returnerar ett löfte som kommer att lösas när en enda polling-förfrågan är klar. Detta görs genom att anropa uppdateringsmetoden för Pollerns operation.
pollUntilDone({ abortSignal?: AbortSignalLike })	Returnerar ett löfte som kommer att lösas när den underliggande operationen är slutförd.
serialize()	Returnerar ett löfte som kan användas för en serialiserad version av pollerns operation genom att anropa operationens serialiseringsmetod.
stopPolling()	Det stoppar undersökningsinstitutet från att fortsätta att polla. Observera att detta endast stoppar klientsidans polling
submitted()	Vänta på att pollern ska skickas in.
toString()	Returnerar en strängrepresentation av pollerns operation. Liknande serialize men returnerar en sträng.

Metodinformation

getOperationState()

Returnerar åtgärdens tillstånd.

function getOperationState(): TState

Returer

TState

getResult()

Returnerar åtgärdens resultatvärde, oavsett pollerarens tillstånd. Den kan returnera odefinierad eller ofullständig form av det slutliga TResult-värdet beroende på implementeringen.

function getResult(): undefined | TResult

Returer

undefined | TResult

isDone()

Returnerar sant om polleraren har slutfört avsökningen.

function isDone(): boolean

Returer

boolean

isStopped()

Varning

Det här API:et är nu inaktuellt.

Use abortSignal status to track this instead.

Returnerar sant om polleraren stoppas.

function isStopped(): boolean

Returer

boolean

onProgress((state: TState) => void)

Anropar den tillhandahållna callbacken efter att varje polling är klar, och skickar det aktuella tillståndet för pollerns operation.

Den returnerar en metod som kan användas för att sluta ta emot uppdateringar på den givna callback-funktionen.

function onProgress(callback: (state: TState) => void): CancelOnProgress

Parametrar

callback

(state: TState) => void

Returer

CancelOnProgress

poll({ abortSignal?: AbortSignalLike })

Returnerar ett löfte som kommer att lösas när en enda polling-förfrågan är klar. Detta görs genom att anropa uppdateringsmetoden för Pollerns operation.

function poll(options?: { abortSignal?: AbortSignalLike }): Promise<TState>

Parametrar

options

{ abortSignal?: AbortSignalLike }

Returer

Promise<TState>

pollUntilDone({ abortSignal?: AbortSignalLike })

Returnerar ett löfte som kommer att lösas när den underliggande operationen är slutförd.

function pollUntilDone(pollOptions?: { abortSignal?: AbortSignalLike }): Promise<TResult>

Parametrar

pollOptions

{ abortSignal?: AbortSignalLike }

Returer

Promise<TResult>

serialize()

Returnerar ett löfte som kan användas för en serialiserad version av pollerns operation genom att anropa operationens serialiseringsmetod.

function serialize(): Promise<string>

Returer

Promise<string>

stopPolling()

Varning

Det här API:et är nu inaktuellt.

Use abortSignal to stop polling instead.

Det stoppar undersökningsinstitutet från att fortsätta att polla. Observera att detta endast stoppar klientsidans polling

function stopPolling()

submitted()

Vänta på att pollern ska skickas in.

function submitted(): Promise<void>

Returer

Promise<void>

toString()

Varning

Det här API:et är nu inaktuellt.

Use serialize() instead.

Returnerar en strängrepresentation av pollerns operation. Liknande serialize men returnerar en sträng.

function toString(): string

Returer

string