Azure.DigitalTwins.Core 1.4.0

Azure IoT Digital Twins 的 .NET 客户端库

此库提供对 Azure Digital Twins 服务的访问，用于管理双胞胎、模型、关系等。

源代码 | 软件包 (nuget)

入门

完整的 Microsoft Azure SDK 可以从 Microsoft Azure 下载页面 下载，其中包括支持构建部署包、集成到工具、丰富的命令行工具等。

为了获得最佳的开发体验，开发人员应使用官方的 Microsoft NuGet 软件包库。NuGet 软件包会定期更新，以包含新的功能和支持热补丁。

安装软件包

使用 NuGet 安装 Azure Digital Twins 客户端库 (.NET)

dotnet add package Azure.DigitalTwins.Core

在 nuget.org 查看软件包详情。

先决条件

• Microsoft Azure 订阅
  • 要调用 Microsoft Azure 服务，创建一个 Azure 订阅。
• Azure 数字孪生实例
  • 为了使用 Azure 数字孪生 SDK，首先需要使用以下任一方式创建一个数字孪生实例
    • 使用 Azure 门户
    • 使用 Azure 管理API
    • 使用 Azure CLI
      • 您需要安装 azure cli 和 Azure IoT 扩展 以用于 Azure CLI。
      • 有关创建和交互您的数字孪生实例的更多信息，请参阅 IoT CLI 文档。

客户端认证

要与 Azure 数字孪生服务交互，您需要创建一个 TokenCredential 类 的实例，并将其传递给您的 DigitalTwinsClient 构造函数。

关键概念

Azure 数字孪生预览是一个 Azure IoT 服务，可以创建物理环境的全面模型。它可以创建空间智能图来建模人员、空间和设备之间的关系和交互。

要了解更多有关 Azure 数字孪生的信息，请访问 Azure 数字孪生文档

线程安全

我们保证所有客户端实例方法都是线程安全的且相互独立 (指南)。这确保了重用客户端实例的建议始终是安全的，即使在多线程的情况下也是如此。

其他概念

客户端选项 | 访问响应 | 长时间运行的操作 | 处理失败 | 诊断 | 模拟 | 客户端生命周期

示例

您可以通过 数字孪生示例 熟悉不同的 API。

源代码文件夹结构

/src

DigitalTwinsClient 公共客户端，DigitalTwinsClient，以及可以发送到数字孪生服务的附加配置选项 DigitalTwinsClientOptions。

/src/Generated

使用 autorest 根据配置文件中定义的 swagger 文件生成的代码。

要重新生成代码，运行 PowerShell 脚本 generate.ps1。

每当客户端库代码更新时，需要运行以下脚本

• Export-AdtApis.ps1，它将更新 API 表面积档。
• Update-Snippets.ps1，该脚本将更新README文件和客户端文档注释中所有的代码片段。

/src/Customized

编写的自定义代码用于覆盖以下自动生成代码的行为

• 重命名一些生成的类型，例如：GetModelsOptions
• 将一些生成的类型声明为internal，而不是Autorest默认的public。
• 将一些方法声明为接受输入参数为strings而不是objects。
• 将一些方法声明为返回响应为strings而不是objects。

/src/Models

模型类，适用于与数字孪生客户端操作一起使用。

/src/Properties

运行单元测试所需的程序集属性。

/src/Serialization

提供的序列化助手，帮助在数字孪生服务内串行化和反串行化常用类型。

问题排查

所有服务操作在服务报告失败时会抛出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），声明你有权，并且实际上确实授予我们使用你的贡献的权利。有关详细信息，请访问https://cla.microsoft.com.

当你提交一个pull request时，一个CLA机器人会自动确定你是否需要提供CLA，并相应地标记PR（例如，标记，注释）。只需遵循机器人提供的说明。你只需在整个使用我们的CLA的所有仓库中做一次即可。

本项目已经采用了Microsoft Open Source Code of Conduct。更多信息见Code of Conduct FAQ，或联系[email protected]以获得任何额外的问题或评论。