EnrollmentGroup クラス

  • リファレンス

定義

名前空間:
Microsoft.Azure.Devices.Provisioning.Service
アセンブリ:
Microsoft.Azure.Devices.Provisioning.Service.dll
パッケージ:
Microsoft.Azure.Devices.Provisioning.Service v1.18.1
パッケージ:
Microsoft.Azure.Devices.Provisioning.Service v2.0.0-preview002

JSON シリアライザーと逆シリアライザーを使用した単一の Device Provisioning Service 登録グループの表現。

public class EnrollmentGroup : Microsoft.Azure.Devices.Shared.IETagHolder
public class EnrollmentGroup
type EnrollmentGroup = class
    interface IETagHolder
type EnrollmentGroup = class
Public Class EnrollmentGroup
Implements IETagHolder
Public Class EnrollmentGroup
継承
Object
EnrollmentGroup
実装
IETagHolder

例

シリアル化すると、EnrollmentGroup は次の例のようになります。

{
   "enrollmentGroupId":"validEnrollmentGroupId",
   "attestation":{
       "type":"x509",
       "signingCertificates":{
           "primary":{
               "certificate":"[valid certificate]"
           }
       }
   },
   "iotHubHostName":"ContosoIoTHub.azure-devices.net",
   "provisioningStatus":"enabled"
}

次の JSON は、プロビジョニング サービスから受信した EnrollmentGroup 応答のサンプルです。

{
   "enrollmentGroupId":"validEnrollmentGroupId",
   "attestation":{
       "type":"x509",
       "signingCertificates":{
           "primary":{
               "certificate":"[valid certificate]",
               "info": {
                   "subjectName": "CN=ROOT_00000000-0000-0000-0000-000000000000, OU=Azure IoT, O=MSFT, C=US",
                   "sha1Thumbprint": "0000000000000000000000000000000000",
                   "sha256Thumbprint": "validEnrollmentGroupId",
                   "issuerName": "CN=ROOT_00000000-0000-0000-0000-000000000000, OU=Azure IoT, O=MSFT, C=US",
                   "notBeforeUtc": "2017-11-14T12:34:18Z",
                   "notAfterUtc": "2017-11-20T12:34:18Z",
                   "serialNumber": "000000000000000000",
                   "version": 3
               }
           }
       }
   },
   "iotHubHostName":"ContosoIoTHub.azure-devices.net",
   "provisioningStatus":"enabled",
   "createdDateTimeUtc": "2017-09-28T16:29:42.3447817Z",
   "lastUpdatedDateTimeUtc": "2017-09-28T16:29:42.3447817Z",
   "etag": "\"00000000-0000-0000-0000-00000000000\""
}

注釈

このオブジェクトは、EnrollmentGroup 情報をプロビジョニング サービスに送信したり、プロビジョニング サービスから EnrollmentGroup 情報を受信したりするために使用されます。

プロビジョニング サービスで EnrollmentGroup を作成または更新するには、このオブジェクトを入力し、パブリック API {@link ProvisioningServiceClient#createOrUpdateEnrollmentGroup(EnrollmentGroup)} を呼び出す必要があります。 プロビジョニング サービスに必要な最小限の情報は、{@link #enrollmentGroupId} と {@link #attestation} です。

EnrollmentGroup を使用してデバイスをプロビジョニングするには、{@link X509Attestation} メカニズムの signingCertificate を含む X509 チップが含まれている必要があります。

このクラスの内容は JSON 形式でシリアル化され、残りの API の本文としてプロビジョニング サービスに送信されます。

このクラスの内容は、作成、更新、またはクエリ EnrollmentGroup などの EnrollmentGroup 操作の結果として、プロビジョニング サービスから受け取った JSON によって入力できます。

コンストラクター

EnrollmentGroup(String, Attestation)

EnrollmentGroup の新しいインスタンスを作成します。

プロパティ

AllocationPolicy

このリソースの割り当てポリシー。 テナント レベルの割り当てポリシーをオーバーライドします。
Attestation

構成証明の Getter と setter。
Capabilities

デバイスの機能。
CreatedDateTimeUtc

このリソースが作成された DateTime。
CreatedOnUtc

このリソースが作成された DateTime。
CustomAllocationDefinition

カスタム割り当て定義。
EnrollmentGroupId

登録グループ ID。
ETag

登録の ETag。
InitialTwinState

初期ツインの状態。
IotHubHostName

デバイスを割り当てる必要な IoT ハブ。
IotHubs

このリソース内のデバイスが割り当てることができる IoT ハブの名前の一覧。 IoT ハブのテナント レベルリストのサブセットである必要があります
LastUpdatedDateTimeUtc

このリソースが最後に更新された DateTime。
LastUpdatedOnUtc

このリソースが最後に更新された DateTime。
ProvisioningStatus

プロビジョニングの状態。
RegistrationState

現在の登録状態。
ReprovisionPolicy

デバイスが IoT ハブに再プロビジョニングされたときの動作。

メソッド

ToString()

このオブジェクトをプリティ印刷形式で変換します。

適用対象