Enrollment Group - Get

Serviço:: IoT Hub Device Provisioning Service

Versão da API:: 2021-10-01

Obtenha um grupo de registro de dispositivo.

GET https://{dpsName}.azure-devices-provisioning.net/enrollmentGroups/{id}?api-version=2021-10-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
dpsName	path	True	string	O nome de host da instância DPS.
id	path	True	string	ID do grupo de registro.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	True	string

Respostas

Nome	Tipo	Description
200 OK	EnrollmentGroup	A solicitação foi bem-sucedida.
Other Status Codes	ProvisioningServiceErrorDetails	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Nome

Tipo

Description

200 OK

EnrollmentGroup

A solicitação foi bem-sucedida.

Other Status Codes

ProvisioningServiceErrorDetails

Uma resposta de erro inesperada.

Cabeçalhos

x-ms-error-code: string

Segurança

Authorization

Tipo: apiKey
Em: header

Exemplos

EnrollmentGroup_Get_MaximumSet_Gen

EnrollmentGroup_Get_MinimumSet_Gen

EnrollmentGroup_Get_MaximumSet_Gen

Solicitação de exemplo

HTTP

GET https://{dpsName}.azure-devices-provisioning.net/enrollmentGroups/aeejtkwwsgoraodfdlh?api-version=2021-10-01

Resposta de exemplo

Código de status:: 200

{
  "allocationPolicy": "hashed",
  "attestation": {
    "type": "none",
    "symmetricKey": {
      "primaryKey": "tdoshkmlo",
      "secondaryKey": "lmajoyzuojahffcmdlcwjhntqzyqzk"
    },
    "tpm": {
      "endorsementKey": "naoofgjbxiulcitlysusxdvagyucgn",
      "storageRootKey": "tdgkgcvptrsw"
    },
    "x509": {
      "caReferences": {
        "primary": "efbkbboxkvrsdl",
        "secondary": "vckhuzqgbcinighxwyuyd"
      },
      "clientCertificates": {
        "primary": {
          "info": {
            "issuerName": "pkuinyhttjlozsbtvxuizzkjlakga",
            "notAfterUtc": "2025-10-01T17:42:04.760Z",
            "notBeforeUtc": "2025-10-01T17:42:04.760Z",
            "serialNumber": "mzoidcxayenpgyrek",
            "sha1Thumbprint": "fdmftjqllzvxcd",
            "sha256Thumbprint": "ei",
            "subjectName": "qqjdjgrkiqvtnshkisozut",
            "version": 12
          },
          "certificate": "gkozpt"
        },
        "secondary": {
          "info": {
            "issuerName": "pkuinyhttjlozsbtvxuizzkjlakga",
            "notAfterUtc": "2025-10-01T17:42:04.760Z",
            "notBeforeUtc": "2025-10-01T17:42:04.760Z",
            "serialNumber": "mzoidcxayenpgyrek",
            "sha1Thumbprint": "fdmftjqllzvxcd",
            "sha256Thumbprint": "ei",
            "subjectName": "qqjdjgrkiqvtnshkisozut",
            "version": 12
          },
          "certificate": "gkozpt"
        }
      },
      "signingCertificates": {
        "primary": {
          "info": {
            "issuerName": "pkuinyhttjlozsbtvxuizzkjlakga",
            "notAfterUtc": "2025-10-01T17:42:04.760Z",
            "notBeforeUtc": "2025-10-01T17:42:04.760Z",
            "serialNumber": "mzoidcxayenpgyrek",
            "sha1Thumbprint": "fdmftjqllzvxcd",
            "sha256Thumbprint": "ei",
            "subjectName": "qqjdjgrkiqvtnshkisozut",
            "version": 12
          },
          "certificate": "gkozpt"
        },
        "secondary": {
          "info": {
            "issuerName": "pkuinyhttjlozsbtvxuizzkjlakga",
            "notAfterUtc": "2025-10-01T17:42:04.760Z",
            "notBeforeUtc": "2025-10-01T17:42:04.760Z",
            "serialNumber": "mzoidcxayenpgyrek",
            "sha1Thumbprint": "fdmftjqllzvxcd",
            "sha256Thumbprint": "ei",
            "subjectName": "qqjdjgrkiqvtnshkisozut",
            "version": 12
          },
          "certificate": "gkozpt"
        }
      }
    }
  },
  "capabilities": {
    "iotEdge": true
  },
  "createdDateTimeUtc": "2025-10-01T17:42:05.495Z",
  "customAllocationDefinition": {
    "apiVersion": "gbannxdstouqrfonxdxfurv",
    "webhookUrl": "todqbubyxeumrtvhsscedwrkz"
  },
  "enrollmentGroupId": "sfsevlobqfdnqmghunj",
  "etag": "kmvtdrkjyfzj",
  "initialTwin": {
    "properties": {
      "desired": {
        "count": 16,
        "key2428": {},
        "metadata": {
          "lastUpdated": "2025-10-01T17:42:04.760Z",
          "lastUpdatedVersion": 19
        },
        "version": 9
      }
    },
    "tags": {
      "count": 16,
      "key2428": {},
      "metadata": {
        "lastUpdated": "2025-10-01T17:42:04.760Z",
        "lastUpdatedVersion": 19
      },
      "version": 9
    }
  },
  "iotHubHostName": "dey",
  "iotHubs": [
    "ehqilokxpijrvaigiaf"
  ],
  "lastUpdatedDateTimeUtc": "2025-10-01T17:42:05.495Z",
  "provisioningStatus": "enabled",
  "reprovisionPolicy": {
    "migrateDeviceData": true,
    "updateHubAssignment": true
  }
}

EnrollmentGroup_Get_MinimumSet_Gen

Solicitação de exemplo

HTTP

GET https://{dpsName}.azure-devices-provisioning.net/enrollmentGroups/foizrzwygyrulkdxcyb?api-version=2021-10-01

Resposta de exemplo

Código de status:: 200

{
  "attestation": {
    "type": "none"
  },
  "enrollmentGroupId": "sfsevlobqfdnqmghunj"
}

Definições

Nome	Description
AllocationPolicy	A política de alocação deste recurso. Esta política prevalece sobre a política de alocação em nível de inquilino para esse indivíduo de inscrição ou grupo de inscrição. Valores possíveis incluem 'hashado': hubs IoT conectados têm a mesma probabilidade de ter dispositivos provisionados para eles, 'geoLatency': Dispositivos são provisionados para um hub IoT com a menor latência para o dispositivo. Se múltiplos hubs IoT vinculados fornecerem a mesma menor latência, o serviço de provisionamento faz hash dos dispositivos entre esses hubs, 'estático': A especificação do hub IoT desejado na lista de inscrição tem prioridade sobre a política de alocação por nível de serviço, 'custom': Os dispositivos são provisionados para um hub IoT com base na sua própria lógica personalizada. O serviço de provisionamento passa informações sobre o dispositivo para a lógica, e a lógica retorna o hub IoT desejado, bem como a configuração inicial desejada. Recomendamos usar o Azure Functions para hospedar sua lógica.
AttestationMechanism	Mecanismo de atestação para inscrição individual, bem como para Grupo de Inscrição.
AttestationType	Tipo de atestado.
CustomAllocationDefinition	Isso informa ao DPS qual webhook chamar ao usar alocação personalizada.
DeviceCapabilities	Capacidades do dispositivo.
EnrollmentGroup	Registro do grupo de matrícula.
InitialTwin	Dispositivo inicial gêmeo. Contém um subconjunto das propriedades de Twin.
InitialTwinProperties	Representa as propriedades iniciais que serão definidas no dispositivo gêmeo.
Metadata	Metadados para a TwinCollection
ProvisioningServiceErrorDetails	Contém as propriedades de um erro retornado pelo Azure IoT Hub Provisioning Service.
ProvisioningStatus	O status de provisionamento.
ReprovisionPolicy	O comportamento do serviço quando um dispositivo é reprovisionado em um hub de IoT.
SymmetricKeyAttestation	Atestação via SymmetricKey.
TpmAttestation	Atestação via TPM.
TwinCollection	Representa um conjunto de propriedades dentro de um Gêmeo
X509Attestation	Atestação via X509.
X509CAReferences	Referências primárias e secundárias de CA.
X509CertificateInfo	Informações do certificado X509.
X509Certificates	Certificados do ensino fundamental e secundário
X509CertificateWithInfo	Certificados e informações sobre certificados

AllocationPolicy

Enumeração

A política de alocação deste recurso. Esta política prevalece sobre a política de alocação em nível de inquilino para esse indivíduo de inscrição ou grupo de inscrição. Valores possíveis incluem 'hashado': hubs IoT conectados têm a mesma probabilidade de ter dispositivos provisionados para eles, 'geoLatency': Dispositivos são provisionados para um hub IoT com a menor latência para o dispositivo. Se múltiplos hubs IoT vinculados fornecerem a mesma menor latência, o serviço de provisionamento faz hash dos dispositivos entre esses hubs, 'estático': A especificação do hub IoT desejado na lista de inscrição tem prioridade sobre a política de alocação por nível de serviço, 'custom': Os dispositivos são provisionados para um hub IoT com base na sua própria lógica personalizada. O serviço de provisionamento passa informações sobre o dispositivo para a lógica, e a lógica retorna o hub IoT desejado, bem como a configuração inicial desejada. Recomendamos usar o Azure Functions para hospedar sua lógica.

Valor	Description
hashed	hashado
geoLatency	geoLatency
static	estático
custom	custom

AttestationMechanism

Objeto

Mecanismo de atestação para inscrição individual, bem como para Grupo de Inscrição.

Nome	Tipo	Description
symmetricKey	SymmetricKeyAttestation	Método de atestação de chave simétrica.
tpm	TpmAttestation	Método de atestação TPM.
type	AttestationType	Tipo de atestado.
x509	X509Attestation	Método de atestação X509.

AttestationType

Enumeração

Tipo de atestado.

Valor	Description
none	none
tpm	tpm
x509	x509
symmetricKey	symmetricKey

CustomAllocationDefinition

Objeto

Isso informa ao DPS qual webhook chamar ao usar alocação personalizada.

Nome	Tipo	Description
apiVersion	string	A versão API dos tipos de serviço de provisionamento (como IndividualEnrollment) enviava na solicitação personalizada de alocação. Versão mínima suportada: "2018-09-01-preview".
webhookUrl	string	A URL do webhook usada para solicitações de alocação.

DeviceCapabilities

Objeto

Capacidades do dispositivo.

Nome	Tipo	Valor padrão	Description
iotEdge	boolean	False	Se configurado como true, esse dispositivo é um dispositivo IoTEdge.

EnrollmentGroup

Objeto

Registro do grupo de matrícula.

Nome	Tipo	Valor padrão	Description
allocationPolicy	AllocationPolicy		A política de alocação deste recurso. Esta política prevalece sobre a política de alocação em nível de inquilino para esse indivíduo de inscrição ou grupo de inscrição. Valores possíveis incluem 'hashado': hubs IoT conectados têm a mesma probabilidade de ter dispositivos provisionados para eles, 'geoLatency': Dispositivos são provisionados para um hub IoT com a menor latência para o dispositivo. Se múltiplos hubs IoT vinculados fornecerem a mesma menor latência, o serviço de provisionamento faz hash dos dispositivos entre esses hubs, 'estático': A especificação do hub IoT desejado na lista de inscrição tem prioridade sobre a política de alocação por nível de serviço, 'custom': Os dispositivos são provisionados para um hub IoT com base na sua própria lógica personalizada. O serviço de provisionamento passa informações sobre o dispositivo para a lógica, e a lógica retorna o hub IoT desejado, bem como a configuração inicial desejada. Recomendamos usar o Azure Functions para hospedar sua lógica.
attestation	AttestationMechanism		Método de atestação usado pelo dispositivo.
capabilities	DeviceCapabilities		Capacidades do dispositivo.
createdDateTimeUtc	string (date-time)		O DateTime este recurso foi criado.
customAllocationDefinition	CustomAllocationDefinition		Isso informa ao DPS qual webhook chamar ao usar alocação personalizada.
enrollmentGroupId	string		ID do Grupo de Matrícula.
etag	string		A tag da entidade associada ao recurso.
initialTwin	InitialTwin		Dispositivo inicial gêmeo.
iotHubHostName	string		O nome de host do Iot Hub.
iotHubs	string[]		A lista de nomes de host do IoT Hub para os dispositivos nesse recurso pode ser alocado. Deve ser um subconjunto da lista de hubs IoT em nível de inquilino.
lastUpdatedDateTimeUtc	string (date-time)		O DateTime este recurso foi atualizado pela última vez.
provisioningStatus	ProvisioningStatus	enabled	O status de provisionamento.
reprovisionPolicy	ReprovisionPolicy		O comportamento quando um dispositivo é reprovisionado em um hub de IoT.

InitialTwin

Objeto

Dispositivo inicial gêmeo. Contém um subconjunto das propriedades de Twin.

Nome	Tipo	Description
properties	InitialTwinProperties	Propriedades desejadas do gêmeo.
tags	TwinCollection	Marcas de gêmeos.

InitialTwinProperties

Objeto

Representa as propriedades iniciais que serão definidas no dispositivo gêmeo.

Nome	Tipo	Description
desired	TwinCollection	Obtém e definem as propriedades desejadas do InitialTwin.

Metadata

Objeto

Metadados para a TwinCollection

Nome	Tipo	Description
lastUpdated	string (date-time)	Da última vez, a TwinCollection foi atualizada
lastUpdatedVersion	integer (int32)	Isso é nulo para metadados de propriedades reportadas e não é nulo para metadados de propriedades desejadas.

ProvisioningServiceErrorDetails

Objeto

Contém as propriedades de um erro retornado pelo Azure IoT Hub Provisioning Service.

Nome	Tipo	Description
errorCode	integer (int32)	Código de erro da operação.
info	object	Dicionário de< de cadeia de caracteres >
message	string	Mensagem de erro legível para humanos.
timestampUtc	string (date-time)	Carimbo de data do erro em UTC.
trackingId	string	ID de rastreamento para o erro.

ProvisioningStatus

Enumeração

O status de provisionamento.

Valor	Description
enabled	enabled
disabled	desabilitado

ReprovisionPolicy

Objeto

O comportamento do serviço quando um dispositivo é reprovisionado em um hub de IoT.

Nome	Tipo	Valor padrão	Description
migrateDeviceData	boolean	True	Quando configurado como true (padrão), o Serviço de Provisionamento de Dispositivos migrará os dados do dispositivo (gêmeos, capacidades do dispositivo e ID do dispositivo) de um hub IoT para outro durante uma atualização de atribuição de hub IoT. Se configurado como falso, o Serviço de Provisionamento de Dispositivos resetará os dados do dispositivo para a configuração inicial desejada armazenada na lista de inscrição correspondente.
updateHubAssignment	boolean	True	Quando configurado como true (padrão), o Serviço de Provisão de Dispositivos avaliará a atribuição do IoT Hub do dispositivo e a atualizará se necessário para quaisquer solicitações de provisionamento além da primeira de um determinado dispositivo. Se configurado como falso, o dispositivo permanecerá atribuído ao seu hub IoT atual.

SymmetricKeyAttestation

Objeto

Atestação via SymmetricKey.

Nome	Tipo	Description
primaryKey	string	Chave simétrica primária.
secondaryKey	string	Chave simétrica secundária.

TpmAttestation

Objeto

Atestação via TPM.

Nome	Tipo	Description
endorsementKey	string	Chave de endosso do TPM.
storageRootKey	string	Chave raiz de armazenamento TPM.

TwinCollection

Objeto

Representa um conjunto de propriedades dentro de um Gêmeo

Nome	Tipo	Description
count	integer (int32)	Número de propriedades na TwinCollection
metadata	Metadata	Metadados para a TwinCollection
version	integer (int32)	Versão da TwinCollection

X509Attestation

Objeto

Atestação via X509.

Nome	Tipo	Description
caReferences	X509CAReferences	Referências primárias e secundárias de CA.
clientCertificates	X509Certificates	Certificados do ensino fundamental e secundário
signingCertificates	X509Certificates	Certificados do ensino fundamental e secundário

X509CAReferences

Objeto

Referências primárias e secundárias de CA.

Nome	Tipo	Description
primary	string	Referência principal da Califórnia.
secondary	string	Referência secundária da Califórnia.

X509CertificateInfo

Objeto

Informações do certificado X509.

Nome	Tipo	Description
issuerName	string	Nome do emissor do certificado.
notAfterUtc	string (date-time)	Fim da validade do certificado (UTC).
notBeforeUtc	string (date-time)	Início da validade do certificado (UTC).
serialNumber	string	Número de série do certificado.
sha1Thumbprint	string	Impressão digital SHA-1 do certificado.
sha256Thumbprint	string	Impressão digital SHA-256 do certificado.
subjectName	string	Nome da entidade do certificado.
version	integer (int32)	Versão do certificado.

X509Certificates

Objeto

Certificados do ensino fundamental e secundário

Nome	Tipo	Description
primary	X509CertificateWithInfo	Certificados e informações sobre certificados
secondary	X509CertificateWithInfo	Certificados e informações sobre certificados

X509CertificateWithInfo

Objeto

Certificados e informações sobre certificados

Nome	Tipo	Description
certificate	string	String de certificado formatada em PEM.
info	X509CertificateInfo	Informações do certificado X509.