EnrollmentGroup Classe

Definição

Representação de um único grupo de registro do Serviço de Provisionamento de Dispositivos com um serializador JSON e desserializador.

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
Herança
EnrollmentGroup
Implementações

Exemplos

Quando serializado, um EnrollmentGroup terá a seguinte aparência:

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

O JSON a seguir é um exemplo da resposta EnrollmentGroup, recebida do serviço de provisionamento.

{
   "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\""
}

Comentários

Esse objeto é usado para enviar informações de EnrollmentGroup para o serviço de provisionamento ou receber informações de EnrollmentGroup do serviço de provisionamento.

Para criar ou atualizar um EnrollmentGroup no serviço de provisionamento, você deve preencher esse objeto e chamar a API pública {@link ProvisioningServiceClient#createOrUpdateEnrollmentGroup(EnrollmentGroup)}. As informações mínimas exigidas pelo serviço de provisionamento são {@link #enrollmentGroupId} e {@link #attestation}.

Para provisionar um dispositivo usando EnrollmentGroup, ele deve conter um chip X509 com um signingCertificate para o mecanismo {@link X509Attestation}.

O conteúdo dessa classe será serializado em um formato JSON e enviado como um corpo da API rest para o serviço de provisionamento.

O conteúdo dessa classe pode ser preenchido por um JSON, recebido do serviço de provisionamento, como resultado de uma operação EnrollmentGroup, como criar, atualizar ou consultar EnrollmentGroup.

Construtores

EnrollmentGroup(String, Attestation)

Cria uma nova instância de EnrollmentGroup.

Propriedades

AllocationPolicy

A política de alocação desse recurso. Substitui a política de alocação no nível do locatário.

Attestation

Getter e setter para Atestado.

Capabilities

Funcionalidades do dispositivo.

CreatedDateTimeUtc

O DateTime em que esse recurso foi criado.

CreatedOnUtc

O DateTime em que esse recurso foi criado.

CustomAllocationDefinition

Definição de alocação personalizada.

EnrollmentGroupId

ID do Grupo de Registro.

ETag

ETag do registro.

InitialTwinState

Estado do gêmeo inicial.

IotHubHostName

Hub IoT desejado ao qual atribuir o dispositivo.

IotHubs

A lista de nomes de hubs IoT aos quais os dispositivos neste recurso podem ser alocados. Deve ser um subconjunto da lista de nível de locatário de hubs IoT

LastUpdatedDateTimeUtc

O DateTime em que esse recurso foi atualizado pela última vez.

LastUpdatedOnUtc

O DateTime em que esse recurso foi atualizado pela última vez.

ProvisioningStatus

O status de provisionamento.

RegistrationState

Estado de registro atual.

ReprovisionPolicy

O comportamento quando um dispositivo é provisionado novamente em um hub IoT.

Métodos

ToString()

Converta esse objeto em um formato de impressão bonito.

Aplica-se a