Condividi tramite

Libreria client LRO di Azure Core per JavaScript - versione 2.7.2

  • Articolo

Si tratta dell'implementazione predefinita delle operazioni a esecuzione prolungata nelle librerie client JavaScript di Azure SDK che funzionano sia nel browser che in NodeJS. Questa libreria viene in genere usata nel codice generato da AutoRest e autorest.typescript.

@azure/core-lro segue le linee guida per la progettazione di Azure SDK per le operazioni a esecuzione prolungata

Collegamenti principali:

Introduzione

Ambienti attualmente supportati

Installazione

Questo pacchetto viene in genere usato nel codice generato e non è destinato a essere utilizzato direttamente dagli utenti finali.

Concetti chiave

SimplePollerLike

Un poller è un oggetto che può eseguire il polling dell'operazione a esecuzione prolungata nel server per lo stato fino a raggiungere uno stato del terminale. Fornisce i metodi seguenti:

  • getOperationState: restituisce lo stato dell'operazione, digitato come tipo che estende OperationState
  • getResult: restituisce il risultato dell'operazione al termine e undefined in caso contrario
  • isDone: restituisce se l'operazione è in uno stato del terminale
  • isStopped: restituisce se il polling è stato arrestato
  • onProgress: registra le funzioni di callback da chiamare ogni volta che viene ricevuta una risposta di polling
  • poll: invia una singola richiesta di polling
  • pollUntilDone: restituisce una promessa che verrà risolta con il risultato dell'operazione
  • stopPolling: arresta il polling;
  • toString: serializza lo stato del poller

OperationState

Tipo per lo stato dell'operazione. Contiene un status campo con i valori possibili seguenti: notStarted, runningsucceeded, , failede canceled. È possibile accedervi come segue:

switch(poller.getOperationState().status) {
  case "succeeded":  // return poller.getResult();
  case "failed":     // throw poller.getOperationState().error;
  case "canceled":   // throw new Error("Operation was canceled");
  case "running":    // ...
  case "notStarted": // ...
}

createHttpPoller

Funzione che restituisce un oggetto di tipo SimplePollerLike. Questo poller si comporta come segue in presenza di errori:

  • chiamate a poll e pollUntilDone genererà un errore nel caso in cui l'operazione non sia riuscita o annullata a meno che l'opzione resolveOnUnsuccessful non sia stata impostata su true.
  • poller.getOperationState().status verrà impostato su true quando l'operazione ha esito negativo o restituisce una risposta di errore.

Esempio

Gli esempi sono disponibili nella cartella samples.

Risoluzione dei problemi

Registrazione

I log possono essere aggiunti a discrezione della libreria che implementano il poller di operazione a esecuzione prolungata. I pacchetti all'interno di azure-sdk-for-js usano @azure/logger.

Passaggi successivi

Per esempi dettagliati su come usare questa libreria, vedere la directory degli esempi .

Contributo

Per contribuire a questa libreria, leggere la guida ai contributi per altre informazioni su come compilare e testare il codice.

Test

Per eseguire i test, installare prima le dipendenze (con npm install o ), rush installquindi eseguire gli unit test con: npm run unit-test.

Codice di comportamento

Questo progetto ha adottato il Codice di comportamento di Microsoft per l'open source. Per altre informazioni, vedere Code of Conduct FAQ (Domande frequenti sul Codice di comportamento Open Source di Microsoft) oppure contattare opencode@microsoft.com per eventuali altre domande o commenti.

Impression