Enrollment Group - Get

Serviço:: IoT Hub Device Provisioning Service

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

Obtenha um grupo de inscrição de dispositivos.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
dpsName	path	True	string	O nome de host da instância DPS.
id	path	True	string	ID do grupo de inscrição.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Authorization	True	string

Respostas

Name	Tipo	Description
200 OK	EnrollmentGroup	O pedido foi bem-sucedido.
Other Status Codes	ProvisioningServiceErrorDetails	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Name

Tipo

Description

200 OK

EnrollmentGroup

O pedido foi bem-sucedido.

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

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 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

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 200

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

Definições

Name	Description
AllocationPolicy	A política de alocação deste recurso. Esta política sobrepõe-se à política de alocação ao nível do inquilino para este indivíduo ou grupo de inscrição. Os valores possíveis incluem 'hashado': Hubs IoT ligados têm a mesma probabilidade de ter dispositivos provisionados para eles, 'geoLatency': Os dispositivos são provisionados para um hub IoT com a menor latência para o dispositivo. Se múltiplos hubs IoT ligados fornecessem a mesma latência mais baixa, 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, 'personalizada': 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 devolve o hub IoT desejado, bem como a configuração inicial desejada. Recomendamos usar o Azure Functions para alojar a sua lógica.
AttestationMechanism	Mecanismo de atestação para inscrição individual, bem como para Grupo de Inscrição.
AttestationType	Tipo de Atestado.
CustomAllocationDefinition	Isto indica ao DPS qual o webhook a chamar quando usar alocação personalizada.
DeviceCapabilities	Capacidades do dispositivo.
EnrollmentGroup	Registo do grupo de matrícula.
InitialTwin	Dispositivo gémeo inicial. 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 devolvido pelo Azure IoT Hub Provisioning Service.
ProvisioningStatus	O estado do provisionamento.
ReprovisionPolicy	O comportamento do serviço quando um dispositivo é re-provisionado para um hub 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 primários e secundários
X509CertificateWithInfo	Certificado e informações sobre certificados

AllocationPolicy

Enumeração

A política de alocação deste recurso. Esta política sobrepõe-se à política de alocação ao nível do inquilino para este indivíduo ou grupo de inscrição. Os valores possíveis incluem 'hashado': Hubs IoT ligados têm a mesma probabilidade de ter dispositivos provisionados para eles, 'geoLatency': Os dispositivos são provisionados para um hub IoT com a menor latência para o dispositivo. Se múltiplos hubs IoT ligados fornecessem a mesma latência mais baixa, 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, 'personalizada': 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 devolve o hub IoT desejado, bem como a configuração inicial desejada. Recomendamos usar o Azure Functions para alojar a sua lógica.

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

AttestationMechanism

Object

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

Name	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	nenhuma
tpm	TPM
x509	x509
symmetricKey	chave simétrica

CustomAllocationDefinition

Object

Isto indica ao DPS qual o webhook a chamar quando usar alocação personalizada.

Name	Tipo	Description
apiVersion	string	A versão API dos tipos de serviço de provisionamento (como IndividualEnrollment) enviou o pedido de alocação personalizado. Versão mínima suportada: "2018-09-01-preview".
webhookUrl	string	A URL do webhook usada para pedidos de alocação.

DeviceCapabilities

Object

Capacidades do dispositivo.

Name	Tipo	Default value	Description
iotEdge	boolean	False	Se definido como true, este dispositivo é um dispositivo IoTEdge.

EnrollmentGroup

Object

Registo do grupo de matrícula.

Name	Tipo	Default value	Description
allocationPolicy	AllocationPolicy		A política de alocação deste recurso. Esta política sobrepõe-se à política de alocação ao nível do inquilino para este indivíduo ou grupo de inscrição. Os valores possíveis incluem 'hashado': Hubs IoT ligados têm a mesma probabilidade de ter dispositivos provisionados para eles, 'geoLatency': Os dispositivos são provisionados para um hub IoT com a menor latência para o dispositivo. Se múltiplos hubs IoT ligados fornecessem a mesma latência mais baixa, 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, 'personalizada': 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 devolve o hub IoT desejado, bem como a configuração inicial desejada. Recomendamos usar o Azure Functions para alojar a sua lógica.
attestation	AttestationMechanism		Método de atestação utilizado pelo dispositivo.
capabilities	DeviceCapabilities		Capacidades do dispositivo.
createdDateTimeUtc	string (date-time)		O DateTime este recurso foi criado.
customAllocationDefinition	CustomAllocationDefinition		Isto indica ao DPS qual o webhook a chamar quando usar alocação personalizada.
enrollmentGroupId	string		ID do Grupo de Inscrição.
etag	string		A etiqueta de entidade associada ao recurso.
initialTwin	InitialTwin		Dispositivo gémeo inicial.
iotHubHostName	string		O nome anfitrião do IoT Hub.
iotHubs	string[]		A lista de nomes de host do IoT Hub aos quais o(s) dispositivo(s) neste recurso pode ser alocado. Deve ser um subconjunto da lista ao nível de inquilino de hubs IoT.
lastUpdatedDateTimeUtc	string (date-time)		O DateTime deste recurso foi atualizado pela última vez.
provisioningStatus	ProvisioningStatus	enabled	O estado do provisionamento.
reprovisionPolicy	ReprovisionPolicy		O comportamento quando um dispositivo é re-provisionado para um hub IoT.

InitialTwin

Object

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

Name	Tipo	Description
properties	InitialTwinProperties	Propriedades desejadas gêmeas.
tags	TwinCollection	Tags gêmeas.

InitialTwinProperties

Object

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

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

Metadata

Object

Metadados para a TwinCollection

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

ProvisioningServiceErrorDetails

Object

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

Name	Tipo	Description
errorCode	integer (int32)	Código de erro para a operação.
info	object	Dicionário de <string>
message	string	Mensagem de erro legível por humanos.
timestampUtc	string (date-time)	Carimbo temporal UTC do erro.
trackingId	string	ID de rastreio para o erro.

ProvisioningStatus

Enumeração

O estado do provisionamento.

Valor	Description
enabled	enabled
disabled	desactivado

ReprovisionPolicy

Object

O comportamento do serviço quando um dispositivo é re-provisionado para um hub IoT.

Name	Tipo	Default value	Description
migrateDeviceData	boolean	True	Quando definido como true (por defeito), o Serviço de Provisionamento de Dispositivos migra os dados do dispositivo (gémeo, capacidades do dispositivo e ID do dispositivo) de um hub IoT para outro durante uma atualização de atribuição de hub IoT. Se definido como falso, o Serviço de Provisionamento de Dispositivos irá reiniciar os dados do dispositivo para a configuração inicial desejada armazenada na lista de inscrição correspondente.
updateHubAssignment	boolean	True	Quando definido como true (por defeito), o Device Provisioning Service avalia a atribuição do IoT Hub do dispositivo e atualiza-a se necessário para quaisquer pedidos de provisionamento além do primeiro provenientes de um determinado dispositivo. Se estiver definido como falso, o dispositivo permanecerá atribuído ao seu hub IoT atual.

SymmetricKeyAttestation

Object

Atestação via SymmetricKey.

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

TpmAttestation

Object

Atestação via TPM.

Name	Tipo	Description
endorsementKey	string	Chave para o endosso do TPM.
storageRootKey	string	Chave raiz de armazenamento TPM.

TwinCollection

Object

Representa um conjunto de propriedades dentro de um Gémeo

Name	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

Object

Atestação via X509.

Name	Tipo	Description
caReferences	X509CAReferences	Referências primárias e secundárias de CA.
clientCertificates	X509Certificates	Certificados primários e secundários
signingCertificates	X509Certificates	Certificados primários e secundários

X509CAReferences

Object

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

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

X509CertificateInfo

Object

Informações do certificado X509.

Name	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 do assunto do certificado.
version	integer (int32)	Versão do certificado.

X509Certificates

Object

Certificados primários e secundários

Name	Tipo	Description
primary	X509CertificateWithInfo	Certificado e informações sobre certificados
secondary	X509CertificateWithInfo	Certificado e informações sobre certificados

X509CertificateWithInfo

Object

Certificado e informações sobre certificados

Name	Tipo	Description
certificate	string	Cadeia de certificados formatada em PEM.
info	X509CertificateInfo	Informações do certificado X509.