Enrollment Group - Query

Referens

Service:: IoT Hub Device Provisioning Service

API Version:: 2021-06-01

Fråga enhetsregistreringsgrupperna.

POST https://your-dps.azure-devices-provisioning.net/enrollmentGroups/query?api-version=2021-06-01

URI-parametrar

Name	In	Required	Type	Description
api-version	query	True	string	DEN API-version som ska användas för begäran. Versioner som stöds är: 2021-06-01

Begärandehuvud

Name	Required	Type	Description
x-ms-max-item-count		integer int32	Sidstorlek
x-ms-continuation		string	Fortsättningstoken

Begärandetext

Name	Required	Type	Description
query	True	string

Svar

Name	Type	Description
200 OK	EnrollmentGroup[]	Klart Headers x-ms-continuation: string x-ms-max-item-count: integer x-ms-item-type: string
Other Status Codes	ProvisioningServiceErrorDetails	Felsvar

Name

Type

Description

200 OK

EnrollmentGroup[]

Klart

Headers

x-ms-continuation: string
x-ms-max-item-count: integer
x-ms-item-type: string

Other Status Codes

ProvisioningServiceErrorDetails

Felsvar

Definitioner

AttestationMechanism	Attesteringsmekanism för individualEnrollment samt enrollmentGroup.
CustomAllocationDefinition	Detta talar om för DPS vilken webhook som ska anropas när du använder anpassad allokering.
DeviceCapabilities	Enhetsfunktioner.
EnrollmentGroup	Registreringsgrupppost.
InitialTwin	Inledande enhetstvilling. Innehåller en delmängd av egenskaperna för Twin.
InitialTwinProperties	Representerar de första egenskaperna som ska anges på enhetstvillingen.
Metadata	Metadata för TwinCollection
ProvisioningServiceErrorDetails	Innehåller egenskaperna för ett fel som returneras av Azure IoT Hub Provisioning Service.
QuerySpecification
ReprovisionPolicy	Beteendet för tjänsten när en enhet etableras på nytt till en IoT-hubb.
SymmetricKeyAttestation	Attestering via SymmetricKey.
TpmAttestation	Attestering via TPM.
TwinCollection	Representerar en samling egenskaper i en tvilling
X509Attestation	Attestering via X509.
X509CAReferences	Primära och sekundära CA-referenser.
X509CertificateInfo	X509-certifikatinformation.
X509Certificates	Primära och sekundära certifikat
X509CertificateWithInfo	Certifikat- och certifikatinformation

AttestationMechanism

Attesteringsmekanism för individualEnrollment samt enrollmentGroup.

Name	Type	Description
symmetricKey	SymmetricKeyAttestation	Symmetrisk nyckelattesteringsmetod.
tpm	TpmAttestation	TPM-attesteringsmetod.
type	enum: none symmetricKey tpm x509	Attesteringstyp.
x509	X509Attestation	X509-attesteringsmetod.

CustomAllocationDefinition

Detta talar om för DPS vilken webhook som ska anropas när du använder anpassad allokering.

Name	Type	Description
apiVersion	string	API-versionen av etableringstjänsttyperna (till exempel IndividualEnrollment) som skickas i den anpassade allokeringsbegäran. Lägsta version som stöds: "2018-09-01-preview".
webhookUrl	string	Webhookens URL som används för allokeringsbegäranden.

DeviceCapabilities

Enhetsfunktioner.

Name	Type	Default Value	Description
iotEdge	boolean	false	Om värdet är true är den här enheten en IoTEdge-enhet.

EnrollmentGroup

Registreringsgrupppost.

Name	Type	Default Value	Description
allocationPolicy	enum: custom geoLatency hashed static		Resursens allokeringsprincip. Den här principen åsidosätter allokeringsprincipen på klientnivå för den här enskilda registrerings- eller registreringsgruppen. Möjliga värden inkluderar "hashed": Länkade IoT-hubbar har lika stor sannolikhet att ha enheter etablerade till sig, "geoLatency": Enheter etableras till en IoT-hubb med den lägsta svarstiden till enheten. Om flera länkade IoT-hubbar skulle ge samma lägsta svarstid prioriterar etableringstjänsten enheter över dessa hubbar, "statisk" : Specifikationen för önskad IoT-hubb i registreringslistan prioriteras framför allokeringsprincipen på tjänstnivå, "anpassad": Enheter etableras till en IoT-hubb baserat på din egen anpassade logik. Etableringstjänsten skickar information om enheten till logiken och logiken returnerar önskad IoT-hubb samt önskad inledande konfiguration. Vi rekommenderar att du använder Azure Functions som värd för din logik.
attestation	AttestationMechanism		Attesteringsmetod som används av enheten.
capabilities	DeviceCapabilities		Enhetens funktioner.
createdDateTimeUtc	string		DateTime den här resursen skapades.
customAllocationDefinition	CustomAllocationDefinition		Detta talar om för DPS vilken webhook som ska anropas när du använder anpassad allokering.
enrollmentGroupId	string		Registreringsgrupp-ID.
etag	string		Entitetstaggen som är associerad med resursen.
initialTwin	InitialTwin		Inledande enhetstvilling.
iotHubHostName	string		Iot Hub-värdnamnet.
iotHubs	string[]		Listan över IoT Hub värdnamn som enheterna i den här resursen kan allokeras till. Måste vara en delmängd av klientnivålistan över IoT-hubbar.
lastUpdatedDateTimeUtc	string		DateTime den här resursen uppdaterades senast.
provisioningStatus	enum: disabled enabled	enabled	Etableringsstatus.
reprovisionPolicy	ReprovisionPolicy		Beteendet när en enhet etableras på nytt till en IoT-hubb.

InitialTwin

Inledande enhetstvilling. Innehåller en delmängd av egenskaperna för Twin.

Name	Type	Description
properties	InitialTwinProperties	Önskade egenskaper för tvilling.
tags	TwinCollection	Tvillingtaggar.

InitialTwinProperties

Representerar de första egenskaperna som ska anges på enhetstvillingen.

Name	Type	Description
desired	TwinCollection	Hämtar och anger önskade InitialTwin-egenskaper.

Metadata

Metadata för TwinCollection

Name	Type	Description
lastUpdated	string	Senaste gången TwinCollection uppdaterades
lastUpdatedVersion	integer	Detta är null för metadata för rapporterade egenskaper och är inte null för metadata för önskade egenskaper.

ProvisioningServiceErrorDetails

Innehåller egenskaperna för ett fel som returneras av Azure IoT Hub Provisioning Service.

Name	Type	Description
errorCode	integer
info	object
message	string
timestampUtc	string
trackingId	string

QuerySpecification

Name	Type	Description
query	string

ReprovisionPolicy

Beteendet för tjänsten när en enhet etableras på nytt till en IoT-hubb.

Name	Type	Default Value	Description
migrateDeviceData	boolean	true	När värdet är true (standard) migrerar Device Provisioning Service enhetens data (tvilling, enhetsfunktioner och enhets-ID) från en IoT-hubb till en annan under en IoT Hub-tilldelningsuppdatering. Om värdet är falskt återställer Enhetsetableringstjänsten enhetens data till den ursprungliga önskade konfigurationen som lagras i motsvarande registreringslista.
updateHubAssignment	boolean	true	När värdet är true (standard) utvärderar Enhetsetableringstjänsten enhetens IoT Hub tilldelning och uppdaterar den om det behövs för etableringsbegäranden utöver den första från en viss enhet. Om värdet är falskt förblir enheten tilldelad till den aktuella IoT-hubben.

SymmetricKeyAttestation

Attestering via SymmetricKey.

Name	Type	Description
primaryKey	string	Primär symmetrisk nyckel.
secondaryKey	string	Sekundär symmetrisk nyckel.

TpmAttestation

Attestering via TPM.

Name	Type	Description
endorsementKey	string
storageRootKey	string

TwinCollection

Representerar en samling egenskaper i en tvilling

Name	Type	Description
count	integer	Antal egenskaper i TwinCollection
metadata	Metadata	Metadata för TwinCollection
version	integer	Version av TwinCollection

X509Attestation

Attestering via X509.

Name	Type	Description
caReferences	X509CAReferences	Primära och sekundära CA-referenser.
clientCertificates	X509Certificates	Primära och sekundära certifikat
signingCertificates	X509Certificates	Primära och sekundära certifikat

X509CAReferences

Primära och sekundära CA-referenser.

Name	Type	Description
primary	string
secondary	string

X509CertificateInfo

X509-certifikatinformation.

Name	Type	Description
issuerName	string
notAfterUtc	string
notBeforeUtc	string
serialNumber	string
sha1Thumbprint	string
sha256Thumbprint	string
subjectName	string
version	integer

X509Certificates

Primära och sekundära certifikat

Name	Type	Description
primary	X509CertificateWithInfo	Certifikat- och certifikatinformation
secondary	X509CertificateWithInfo	Certifikat- och certifikatinformation

X509CertificateWithInfo

Certifikat- och certifikatinformation

Name	Type	Description
certificate	string
info	X509CertificateInfo	X509-certifikatinformation.