.NET 用 Azure IoT Digital Twins クライアント ライブラリ - バージョン 1.4.0

このライブラリは、ツイン、モデル、リレーションシップなどを管理するための Azure Digital Twins サービスへのアクセスを提供します。

ソースコード | パッケージ (nuget)

作業の開始

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

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

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

NuGet を使用して .NET 用の Azure Digital Twins クライアント ライブラリをインストールします。

dotnet add package Azure.DigitalTwins.Core

nuget.org でパッケージの詳細を表示します。

[前提条件]

  • Microsoft Azure サブスクリプション
  • Azure Digital Twins インスタンス

クライアントの認証

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

主要な概念

Azure Digital Twins プレビューは、物理環境の包括的なモデルを作成する Azure IoT サービスです。 人、空間、デバイスの間の関係と相互作用をモデル化する空間インテリジェンス グラフを作成することができます。

Azure Digital Twins の詳細については、Azure Digital Twins のドキュメントを参照してください

スレッド セーフ

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

その他の概念

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

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

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

/Src

Digital Twins パブリック クライアント、 DigitalTwinsClient、および Digital Twins サービスに送信できる追加の構成オプション DigitalTwinsClientOptions

/src/Generated

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

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

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

/src/Customized

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

  • 生成された型の一部の名前を変更します。例: GetModelsOptions
  • 生成された型の一部を、autorest の既定値である public ではなく 、内部として宣言 します
  • オブジェクトの代わりに 文字列 として入力パラメーターを受け入れるメソッドをいくつか宣言 します
  • オブジェクトの代わりに 文字列 として応答を返すメソッドをいくつか宣言 します

/src/Models

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

/src/Properties

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

/src/Serialization

Digital Twins サービス内で一般的に使用される型のシリアル化/逆シリアル化に役立つシリアル化ヘルパーが用意されています。

トラブルシューティング

すべてのサービス操作では、サービスによって報告された障害時に RequestFailedException がスローされ、役に立つエラー コードやその他の情報が表示されます。

たとえば、 操作をGetModelAsync使用して、モデルを作成する前にモデルが存在する場合にチェックし、その特定の HttpStatusCode が指定されている場合にのみキャッチします。

try
{
    Response<ModelData> desiredModel = await DigitalTwinsClient.GetModelAsync(desiredModelId);
}
catch (RequestFailedException ex) when (ex.Status == (int)HttpStatusCode.NotFound)
{
    // Model does not exist, so create it.
}

次のステップ

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

共同作成

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

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

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