@azure/core-lro package

Osztályok

LroEngine	Az LRO Engine, egy lekérdezést végző osztály.
Poller	Egy olyan osztály, amely egy olyan program definícióját jelöli, amely egymást követő kéréseken keresztül kérdezi le, amíg el nem éri a befejezési állapotot. A lekérdezések manuálisan, kéréssel történő lekérdezésével hajthatók végre úgy, hogy a poll() metódust többször is meghívják, amíg a művelet be nem fejeződik. Azt is lehetővé teszi, hogy várja meg a művelet befejeződéséig, hívással pollUntilDone() és várakozással, amíg a művelet befejeződik. A választók kérhetik annak a folyamatban lévő folyamatnak a törlését is, amelynek a mögöttes hosszú futású műveletet nyújtják. const poller = new MyPoller(); // Polling just once: await poller.poll(); // We can try to cancel the request here, by calling: // // await poller.cancelOperation(); // // Getting the final result: const result = await poller.pollUntilDone(); A Pollert két típus határozza meg: a lekérdezés állapotát jelölő típus, amelynek tartalmaznia kell a elem alapvető tulajdonságkészletét PollOperationState<TResult>és a által TResultdefiniált visszatérési típust, amely bármi lehet. A Poller osztály implementálja a felületet, amely lehetővé teszi, hogy a PollerLike poller-implementációk ne kelljen közvetlenül exportálniuk a Poller osztályát, hanem csak a már példányosított pollert exportálják PollerLike típussal. class Client { public async makePoller: PollerLike<MyOperationState, MyResult> { const poller = new MyPoller({}); // It might be preferred to return the poller after the first request is made, // so that some information can be obtained right away. await poller.poll(); return poller; } } const poller: PollerLike<MyOperationState, MyResult> = myClient.makePoller(); A lekérdezés a konstruktorán keresztül hozható létre, majd lekérdezhető, amíg be nem fejeződik. A lekérdezés állapota bármikor lekérhető a getOperationState metódussal. Az eredménytípus köztes formái bármikor kérhetők. Ha a mögöttes művelet befejezettként van megjelölve, a lekérdezés leáll, és a végső érték lesz visszaadva. const poller = myClient.makePoller(); const state: MyOperationState = poller.getOperationState(); // The intermediate result can be obtained at any time. const result: MyResult | undefined = poller.getResult(); // The final result can only be obtained after the poller finishes. const result: MyResult = await poller.pollUntilDone();
PollerCancelledError	A művelet megszakítása után a poller a PollerCancelledError egy példányával lesz elutasítva.
PollerStoppedError	Ha a metódussal manuálisan leállítja a stopPolling lekérdezést, a rendszer a PollerStoppedError egy példányával elutasítja a lekérdezést.

Interfészek

CreateHttpPollerOptions	Beállítások a következőhöz: createPoller.
LongRunningOperation	Hosszú ideig futó művelet leírása.
LroEngineOptions	Az LRO poller beállításai.
LroResponse	Az LRO válaszának típusa.
OperationState	Bár a poller helyi vezérlési mechanizmusként működik, hogy elindítsa és megvárja a hosszú ideig futó műveletet, az OperationState dokumentálja a távoli hosszú ideig futó művelet állapotát. Minden szavazás után frissül.
PollOperation	A PollOperation egy felület, amely meghatározza, hogyan frissítheti a távoli hosszú ideig futó művelet állapotának helyi hivatkozását, valamint azt is, hogyan kérheti ugyanannak a műveletnek a törlését. Emellett van egy metódusa a művelet szerializálására, hogy bármikor tárolható és folytatható legyen.
PollOperationState	A PollOperationState a hosszú ideig futó művelet pollerének definiálásához szükséges legkisebb tulajdonságkészlet véleményezett listáját tartalmazza. Bár a Poller osztály helyi vezérlési mechanizmusként működik egy hosszú ideig futó művelet elindításához, várakozásához és esetleges megszakításához, a PollOperationState dokumentálja a távoli hosszú ideig futó művelet állapotát. Legalább a művelet indításakor, befejeződésekor és a megszakításkor frissíteni kell. Az implementációk azonban tetszőleges számú tulajdonsággal rendelkezhetnek, amelyek más okból frissíthetők.
PollerLike	A poller absztrakt ábrázolása, amely csak a felhasználó által igényelt minimális API-t teszi elérhetővé.
RawResponse	A nyers válasz egyszerű típusa.
SimplePollerLike	Egy egyszerű poller interfész.

Típusaliasok

CancelOnProgress	A CancelOnProgress a Poller onProgress metódusának visszatérési értéke. Amikor egy felhasználó meghívja az onProgress parancsot, át kell adnia egy függvényt, amely visszahívásként lesz meghívva a lekérdezési művelet minden egyes frissítésekor kapott új adatokkal. Az onProgress függvényt ad vissza, amely megakadályozza, hogy a további frissítések elérjék az eredeti visszahívást.
LroResourceLocationConfig	Az LRO eredményének lehetséges helye, ha azt a swagger LRO-bővítménye határozza meg.
OperationStatus	A lehetséges állapotok halmaza, amelyben egy művelet bármikor szerepelhet.
PollProgressCallback	A PollProgressCallback az onProgress számára küldött visszahívási függvények típusa. Ezek a függvények a Poller osztály implementációja által meghatározott TState-t kapnak.

Függvények

createHttpPoller<TResult, TState>(LongRunningOperation<unknown>, CreateHttpPollerOptions<TResult, TState>)

Létrehoz egy lekérdezést, amely egy hosszú ideig futó művelet lekérdezéséhez használható.

Függvény adatai

createHttpPoller<TResult, TState>(LongRunningOperation<unknown>, CreateHttpPollerOptions<TResult, TState>)

Létrehoz egy lekérdezést, amely egy hosszú ideig futó művelet lekérdezéséhez használható.

function createHttpPoller<TResult, TState>(lro: LongRunningOperation<unknown>, options?: CreateHttpPollerOptions<TResult, TState>): Promise<SimplePollerLike<TState, TResult>>

Paraméterek

lro

LongRunningOperation<unknown>

A hosszú ideig futó művelet leírása

options

CreateHttpPollerOptions<TResult, TState>

beállítások a poller konfigurálásához

Válaszok

Promise<SimplePollerLike<TState, TResult>>

inicializált poller