Enrollment Group - Get

Servicio:: IoT Hub Device Provisioning Service

Versión de la API:: 2021-10-01

Obtener un grupo de inscripción de dispositivos.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
dpsName	path	True	string	El nombre de host de la instancia DPS.
id	path	True	string	Identificador del grupo de inscripción.
api-version	query	True	string minLength: 1	Versión de API que se va a usar para esta operación.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Authorization	True	string

Respuestas

Nombre	Tipo	Description
200 OK	EnrollmentGroup	La solicitud se ha realizado correctamente.
Other Status Codes	ProvisioningServiceErrorDetails	Una respuesta de error inesperada. Encabezados x-ms-error-code: string

Nombre

Tipo

Description

200 OK

EnrollmentGroup

La solicitud se ha realizado correctamente.

Other Status Codes

ProvisioningServiceErrorDetails

Una respuesta de error inesperada.

Encabezados

x-ms-error-code: string

Seguridad

Authorization

Tipo: apiKey
En: header

Ejemplos

EnrollmentGroup_Get_MaximumSet_Gen

EnrollmentGroup_Get_MinimumSet_Gen

EnrollmentGroup_Get_MaximumSet_Gen

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 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

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 200

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

Definiciones

Nombre	Description
AllocationPolicy	La política de asignación de este recurso. Esta política prevalece sobre la política de asignación a nivel de inquilino para este grupo individual de inscripción o grupo de inscripción. Los valores posibles incluyen 'hashado': los hubs IoT vinculados tienen la misma probabilidad de tener dispositivos provisionados en ellos, 'geoLatency': Los dispositivos se provisionan en un hub IoT con la latencia más baja al dispositivo. Si varios hubs IoT enlazados proporcionaran la misma latencia más baja, el servicio de aprovisionamiento hasheja los dispositivos a través de esos hubs, 'estático': La especificación del hub IoT deseado en la lista de inscripción tiene prioridad sobre la política de asignación por nivel de servicio, 'personalizado': Los dispositivos se provisionan en un hub IoT según tu propia lógica personalizada. El servicio de aprovisionamiento transmite información sobre el dispositivo a la lógica, y la lógica devuelve el hub IoT deseado así como la configuración inicial deseada. Recomendamos usar Azure Functions para alojar tu lógica.
AttestationMechanism	Mecanismo de atestación para individualInscripción así como para el Grupo de Inscripción.
AttestationType	Tipo de atestado.
CustomAllocationDefinition	Esto indica al DPS qué webhook llamar cuando se usa asignación personalizada.
DeviceCapabilities	Capacidades del dispositivo.
EnrollmentGroup	Registro del grupo de matrícula.
InitialTwin	Dispositivo inicial gemelo. Contiene un subconjunto de las propiedades de Gemelo.
InitialTwinProperties	Representa las propiedades iniciales que se establecerán en el gemelo de dispositivos.
Metadata	Metadatos para la TwinCollection
ProvisioningServiceErrorDetails	Contiene las propiedades de un error devuelto por el Azure IoT Hub Provisioning Service.
ProvisioningStatus	El estado de provisionamiento.
ReprovisionPolicy	El comportamiento del servicio cuando un dispositivo se vuelve a aprovisionar en un hub IoT.
SymmetricKeyAttestation	Atestación vía SymmetricKey.
TpmAttestation	Atestación mediante TPM.
TwinCollection	Representa un conjunto de propiedades dentro de un Gemelo
X509Attestation	Atestación vía X509.
X509CAReferences	Referencias primarias y secundarias de CA.
X509CertificateInfo	Información del certificado X509.
X509Certificates	Certificados de primaria y secundaria
X509CertificateWithInfo	Certificado e información sobre el certificado

AllocationPolicy

Enumeración

La política de asignación de este recurso. Esta política prevalece sobre la política de asignación a nivel de inquilino para este grupo individual de inscripción o grupo de inscripción. Los valores posibles incluyen 'hashado': los hubs IoT vinculados tienen la misma probabilidad de tener dispositivos provisionados en ellos, 'geoLatency': Los dispositivos se provisionan en un hub IoT con la latencia más baja al dispositivo. Si varios hubs IoT enlazados proporcionaran la misma latencia más baja, el servicio de aprovisionamiento hasheja los dispositivos a través de esos hubs, 'estático': La especificación del hub IoT deseado en la lista de inscripción tiene prioridad sobre la política de asignación por nivel de servicio, 'personalizado': Los dispositivos se provisionan en un hub IoT según tu propia lógica personalizada. El servicio de aprovisionamiento transmite información sobre el dispositivo a la lógica, y la lógica devuelve el hub IoT deseado así como la configuración inicial deseada. Recomendamos usar Azure Functions para alojar tu lógica.

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

AttestationMechanism

Objeto

Mecanismo de atestación para individualInscripción así como para el Grupo de Inscripción.

Nombre	Tipo	Description
symmetricKey	SymmetricKeyAttestation	Método de atestación de claves simétricas.
tpm	TpmAttestation	Método de atestación TPM.
type	AttestationType	Tipo de atestado.
x509	X509Attestation	Método de atestación X509.

AttestationType

Enumeración

Tipo de atestado.

Valor	Description
none	ninguno
tpm	tpm
x509	x509
symmetricKey	symmetricKey

CustomAllocationDefinition

Objeto

Esto indica al DPS qué webhook llamar cuando se usa asignación personalizada.

Nombre	Tipo	Description
apiVersion	string	La versión API de los tipos de servicio de aprovisionamiento (como IndividualEnrollment) enviaba en la solicitud de asignación personalizada. Versión mínima soportada: "2018-09-01-preview".
webhookUrl	string	La URL del webhook utilizada para las solicitudes de asignación.

DeviceCapabilities

Objeto

Capacidades del dispositivo.

Nombre	Tipo	Valor predeterminado	Description
iotEdge	boolean	False	Si se configura como verdadero, este dispositivo es un dispositivo IoTEdge.

EnrollmentGroup

Objeto

Registro del grupo de matrícula.

Nombre	Tipo	Valor predeterminado	Description
allocationPolicy	AllocationPolicy		La política de asignación de este recurso. Esta política prevalece sobre la política de asignación a nivel de inquilino para este grupo individual de inscripción o grupo de inscripción. Los valores posibles incluyen 'hashado': los hubs IoT vinculados tienen la misma probabilidad de tener dispositivos provisionados en ellos, 'geoLatency': Los dispositivos se provisionan en un hub IoT con la latencia más baja al dispositivo. Si varios hubs IoT enlazados proporcionaran la misma latencia más baja, el servicio de aprovisionamiento hasheja los dispositivos a través de esos hubs, 'estático': La especificación del hub IoT deseado en la lista de inscripción tiene prioridad sobre la política de asignación por nivel de servicio, 'personalizado': Los dispositivos se provisionan en un hub IoT según tu propia lógica personalizada. El servicio de aprovisionamiento transmite información sobre el dispositivo a la lógica, y la lógica devuelve el hub IoT deseado así como la configuración inicial deseada. Recomendamos usar Azure Functions para alojar tu lógica.
attestation	AttestationMechanism		Método de atestación utilizado por el dispositivo.
capabilities	DeviceCapabilities		Capacidades del dispositivo.
createdDateTimeUtc	string (date-time)		El recurso DateTime, se creó.
customAllocationDefinition	CustomAllocationDefinition		Esto indica al DPS qué webhook llamar cuando se usa asignación personalizada.
enrollmentGroupId	string		ID del grupo de inscripción.
etag	string		La etiqueta de entidad asociada al recurso.
initialTwin	InitialTwin		Dispositivo inicial gemelo.
iotHubHostName	string		El nombre de host Iot Hub.
iotHubs	string[]		La lista de nombres de host IoT Hub a los dispositivos o dispositivos de este recurso pueden asignarse. Debe ser un subconjunto de la lista a nivel de inquilino de hubs IoT.
lastUpdatedDateTimeUtc	string (date-time)		La FechaHora de este recurso fue actualizado por última vez.
provisioningStatus	ProvisioningStatus	enabled	El estado de provisionamiento.
reprovisionPolicy	ReprovisionPolicy		El comportamiento cuando un dispositivo se vuelve a aprovisionar en un hub IoT.

InitialTwin

Objeto

Dispositivo inicial gemelo. Contiene un subconjunto de las propiedades de Gemelo.

Nombre	Tipo	Description
properties	InitialTwinProperties	Propiedades deseadas de gemelos.
tags	TwinCollection	Etiquetas gemelas.

InitialTwinProperties

Objeto

Representa las propiedades iniciales que se establecerán en el gemelo de dispositivos.

Nombre	Tipo	Description
desired	TwinCollection	Obtiene y establece las propiedades deseadas de InitialTwin.

Metadata

Objeto

Metadatos para la TwinCollection

Nombre	Tipo	Description
lastUpdated	string (date-time)	La última vez que se actualizó la TwinCollection
lastUpdatedVersion	integer (int32)	Esto es nulo para los metadatos de propiedades reportadas y no es nulo para los metadatos deseados de propiedades.

ProvisioningServiceErrorDetails

Objeto

Contiene las propiedades de un error devuelto por el Azure IoT Hub Provisioning Service.

Nombre	Tipo	Description
errorCode	integer (int32)	Código de error para la operación.
info	object	Diccionario de <cadenas>
message	string	Mensaje de error legible por humanos.
timestampUtc	string (date-time)	Marca de tiempo UTC del error.
trackingId	string	ID de seguimiento para el error.

ProvisioningStatus

Enumeración

El estado de provisionamiento.

Valor	Description
enabled	enabled
disabled	disabled

ReprovisionPolicy

Objeto

El comportamiento del servicio cuando un dispositivo se vuelve a aprovisionar en un hub IoT.

Nombre	Tipo	Valor predeterminado	Description
migrateDeviceData	boolean	True	Cuando se configura en verdadero (por defecto), el Servicio de Provisionamiento de Dispositivos migrará los datos del dispositivo (gemelo, capacidades del dispositivo e ID del dispositivo) de un hub IoT a otro durante una actualización de asignación de hub IoT. Si se configura como false, el Servicio de Provisionamiento de Dispositivos restablecerá los datos del dispositivo a la configuración inicial deseada almacenada en la lista de inscripción correspondiente.
updateHubAssignment	boolean	True	Cuando se configura en verdadero (por defecto), el Servicio de Provisión de Dispositivos evaluará la asignación del IoT Hub del dispositivo y la actualizará si es necesario para cualquier solicitud de aprovisionamiento más allá de la primera procedente de un dispositivo determinado. Si se configura como falso, el dispositivo seguirá asignado a su hub IoT actual.

SymmetricKeyAttestation

Objeto

Atestación vía SymmetricKey.

Nombre	Tipo	Description
primaryKey	string	Clave simétrica primaria.
secondaryKey	string	Clave simétrica secundaria.

TpmAttestation

Objeto

Atestación mediante TPM.

Nombre	Tipo	Description
endorsementKey	string	Clave de respaldo de TPM.
storageRootKey	string	Clave raíz de almacenamiento TPM.

TwinCollection

Objeto

Representa un conjunto de propiedades dentro de un Gemelo

Nombre	Tipo	Description
count	integer (int32)	Número de propiedades en la TwinCollection
metadata	Metadata	Metadatos para la TwinCollection
version	integer (int32)	Versión de la TwinCollection

X509Attestation

Objeto

Atestación vía X509.

Nombre	Tipo	Description
caReferences	X509CAReferences	Referencias primarias y secundarias de CA.
clientCertificates	X509Certificates	Certificados de primaria y secundaria
signingCertificates	X509Certificates	Certificados de primaria y secundaria

X509CAReferences

Objeto

Referencias primarias y secundarias de CA.

Nombre	Tipo	Description
primary	string	Referencia principal de CA.
secondary	string	Referencia secundaria de CA.

X509CertificateInfo

Objeto

Información del certificado X509.

Nombre	Tipo	Description
issuerName	string	Nombre del emisor del certificado.
notAfterUtc	string (date-time)	Fin de la validez del certificado (UTC).
notBeforeUtc	string (date-time)	Inicio de validez del certificado (UTC).
serialNumber	string	Número de serie del certificado.
sha1Thumbprint	string	Huella digital SHA-1 del certificado.
sha256Thumbprint	string	Huella digital SHA-256 del certificado.
subjectName	string	Nombre del firmante del certificado.
version	integer (int32)	Versión del certificado.

X509Certificates

Objeto

Certificados de primaria y secundaria

Nombre	Tipo	Description
primary	X509CertificateWithInfo	Certificado e información sobre el certificado
secondary	X509CertificateWithInfo	Certificado e información sobre el certificado

X509CertificateWithInfo

Objeto

Certificado e información sobre el certificado

Nombre	Tipo	Description
certificate	string	Cadena de certificados con formato PEM.
info	X509CertificateInfo	Información del certificado X509.