次の方法で共有

JavaScript 用 Azure Core LRO クライアント ライブラリ - バージョン 2.7.2

  • [アーティクル]

これは、ブラウザーと NodeJS の両方で動作する Azure SDK JavaScript クライアント ライブラリでの実行時間の長い操作の既定の実装です。 このライブラリは主に AutoRest および autorest.typescript によって生成されたコードで使用することを目的としています。

@azure/core-lro実行時間の長い操作に関する Azure SDK 設計ガイドラインに従う

主要リンク:

はじめに

現在サポートされている環境

インストール

このパッケージは主に生成されたコードで使用され、エンド ユーザーが直接使用することを意図したものではありません。

主要な概念

SimplePollerLike

poller は、サーバーで実行時間の長い操作をポーリングして、その状態をポーリングし、終了状態に達するまで実行できるオブジェクトです。 次のメソッドが提供されます。

  • getOperationState: を拡張する型として型指定された操作の状態を返します。 OperationState
  • getResult: 操作の完了時に操作の結果を返します undefined 。それ以外の場合は を返します。
  • isDone: 操作が終了状態であるかどうかを返します
  • isStopped: ポーリングが停止したかどうかを返します
  • onProgress: ポーリング応答を受信するたびに呼び出されるコールバック関数を登録します
  • poll: 1 つのポーリング要求を送信します
  • pollUntilDone: 操作の結果で解決される promise を返します
  • stopPolling: ポーリングを停止します。
  • toString: ポーリングャーの状態をシリアル化します

OperationState

操作状態の型。 これには、statusおよび の使用可能な値notStartedsucceededrunningfailedを持つフィールドがcanceled含まれています。 次のようにアクセスできます。

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

型 SimplePollerLikeのオブジェクトを返す関数。 エラーが発生した場合、このポーリングは次のように動作します。

  • と pollUntilDone をpoll呼び出すと、オプションが true に設定されていない限りresolveOnUnsuccessful、操作が失敗または取り消された場合にエラーがスローされます。
  • poller.getOperationState().status は、操作が失敗するか、エラー応答を返す場合に true に設定されます。

例

例については、samples フォルダーを参照してください。

トラブルシューティング

ログ記録

ログは、長時間実行操作ポーリングを実装するライブラリの裁量で追加できます。 azure-sdk-for-js 内のパッケージでは、@azure/logger が使用されます。

次の手順

このライブラリの使用方法の詳細な例については、 samples ディレクトリを参照してください。

共同作成

このライブラリに投稿する場合、コードをビルドしてテストする方法の詳細については、投稿ガイドを参照してください。

テスト

テストを実行するには、まず依存関係 (または rush installを使用npm install) をインストールしてから、 を使用して単体テストをnpm run unit-test実行します。

倫理規定

このプロジェクトでは、Microsoft オープン ソースの倫理規定を採用しています。 詳しくは、「Code of Conduct FAQ (倫理規定についてよくある質問)」を参照するか、opencode@microsoft.com 宛てに質問またはコメントをお送りください。

インプレッション数