.NET 用 Azure IoT Time Series Insights クライアント ライブラリ - バージョン 1.0.0-beta.1

  • [アーティクル]

このライブラリは、Azure Time Series Insights サービスへのアクセスを提供します。

ソース コード

作業の開始

完全な Microsoft Azure SDK は 、Microsoft Azure のダウンロード ページからダウンロードでき、デプロイ パッケージの構築、ツールとの統合、豊富なコマンド ライン ツールなどのサポートが付属しています。

最適な開発エクスペリエンスを実現するために、開発者はライブラリ用の公式の Microsoft NuGet パッケージを使用する必要があります。 NuGet パッケージは、新しい機能と修正プログラムで定期的に更新されます。

パッケージをインストールする

このクライアント ライブラリのパッケージはまだ発行されていません。

前提条件

クライアントの認証

Azure Time Series Insights サービスと対話するには、TokenCredential クラスのインスタンスを作成し、それを TimeSeriesInsightsClient のコンストラクターに渡す必要があります。

主要な概念

Time Series Insights クライアントのメインの概念は次のとおりです。

  • インスタンス クライアント: Time Series インスタンスの作成、一覧表示、置換、削除などの操作を実行します。
  • 型クライアント: Time Series 型の作成、一覧表示、置換、削除などの操作を実行します。
  • 階層クライアント: 時系列階層の作成、一覧表示、置換、削除などの操作を実行します。
  • モデル設定クライアント: Time Series Model 構成設定の取得や更新などの操作を実行します。
  • クエリ クライアント: Time Series Insights でイベント、系列、集計系列のクエリを実行します。

スレッド セーフ

すべてのクライアント インスタンス メソッドがスレッド セーフであり、相互に独立していることを保証します (ガイドライン)。 これにより、スレッド間であっても、クライアント インスタンスの再利用は常に安全になります。

その他の概念

クライアント オプション | 応答 | へのアクセス実行時間の長い操作 | エラーの | 処理診断 | あざける | クライアントの有効期間

例

Time Series Insights のサンプルを使用して、さまざまな API について理解することができます。

ソース コード フォルダーの構造

/Src

Time Series Insights パブリック クライアント、 TimeSeriesInsightsClient、および Time Series Insights サービスに送信できる追加の構成オプション TimeSeriesInsightsClientOptions。

/src/Generated

autorest 構成ファイルで定義されている swagger ファイルを使用して autorest によって生成されたコード。

コードを再生成するには、generate.ps1powershell スクリプトを 実行します。

クライアント ライブラリ コードが更新されるたびに、次のスクリプトを実行する必要があります。

/src/Customized

自動生成されたコードの次の動作をオーバーライドするように記述されたカスタムのコード。

  • 生成された型の一部を、autorest の既定値である public ではなく 、内部として宣言 します。

/src/Models

Time Series Insights クライアント操作で使用するのに役立つモデル クラス。

/src/Properties

単体テストの実行に必要なアセンブリ プロパティ。

トラブルシューティング

Time Series Insights サービス操作エラーは、通常、 TimeSeriesOperationError としてユーザーに返されます。 TimeSeriesOperationError 応答は、クライアント ライブラリ API によって直接返されるか、クライアント ライブラリ API の実際の応答内の入れ子になったプロパティとして返されます。 たとえば、階層クライアントの一部である DeleteByName API は、TimeSeriesOperationError を直接返します。 一方、インスタンス クライアントの一部である Replace API は、内部に入れ子になった TimeSeriesOperationError プロパティを持つ InstancesOperationResult を返します。

次の例は、TimeSeriesInsightsSampleGetTypeById 操作の使用を示しています。応答エラーを反復処理して、型が存在しないかどうかを確認します。

// Code snippet below shows getting a default Type using Id
// The default type Id can be obtained programmatically by using the ModelSettings client.

TimeSeriesInsightsModelSettings modelSettingsClient = client.GetModelSettingsClient();
TimeSeriesModelSettings modelSettings = await modelSettingsClient.GetAsync();
Response<TimeSeriesTypeOperationResult[]> getTypeByIdResults = await typesClient
    .GetByIdAsync(new string[] { modelSettings.DefaultTypeId });

// The response of calling the API contains a list of type or error objects corresponding by position to the input parameter array in the request.
// If the error object is set to null, this means the operation was a success.
for (int i = 0; i < getTypeByIdResults.Value.Length; i++)
{
    if (getTypeByIdResults.Value[i].Error == null)
    {
        Console.WriteLine($"Retrieved Time Series type with Id: '{getTypeByIdResults.Value[i].TimeSeriesType.Id}'.");
    }
    else
    {
        Console.WriteLine($"Failed to retrieve a Time Series type due to '{getTypeByIdResults.Value[i].Error.Message}'.");
    }
}

次の手順

コード サンプルを使用した実装例を参照してください。

共同作成

このプロジェクトでは、共同作成と提案を歓迎しています。 ほとんどの共同作成では、共同作成者使用許諾契約書 (CLA) にご同意いただき、ご自身の共同作成内容を使用する権利を Microsoft に供与する権利をお持ちであり、かつ実際に供与することを宣言していただく必要があります。 詳細については、https://cla.microsoft.com. を参照してください。

pull request を送信すると、CLA を提供して PR (ラベル、コメントなど) を適宜装飾する必要があるかどうかを CLA ボットが自動的に決定します。 ボットによって提供される手順にそのまま従ってください。 この操作は、Microsoft の CLA を使用するすべてのリポジトリについて、1 回だけ行う必要があります。

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