Enrollment Group - Run Bulk Operation

  • Başvuru
Service:
IoT Hub Device Provisioning Service
API Version:
2021-10-01

En fazla 10 grup içeren toplu cihaz kayıt grubu işlemi.

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

URI Parametreleri

Name İçinde Gerekli Tür Description
api-version
 query True

string

İstek için kullanılacak API sürümü. Desteklenen sürümler şunlardır: 2021-10-01

İstek Gövdesi

Name Gerekli Tür Description
enrollmentGroups True

EnrollmentGroup[]

Kayıt öğeleri
mode True enum:
  • create
  • update
  • updateIfMatchETag
  • delete

İşlem modu.

Yanıtlar

Name Tür Description
200 OK

BulkEnrollmentGroupOperationResult

Başarılı
Other Status Codes

ProvisioningServiceErrorDetails

Hata yanıtı

Headers

x-ms-error-code: string

Tanımlar

Name Description
AttestationMechanism

individualEnrollment ve enrollmentGroup için kanıtlama mekanizması.
BulkEnrollmentGroupOperation

Toplu kayıt işlemi.
BulkEnrollmentGroupOperationError

Toplu kayıt işlemi hatası.
BulkEnrollmentGroupOperationResult

Toplu kayıt grubu işleminin sonuçları.
CustomAllocationDefinition

Bu, DPS'ye özel ayırma kullanılırken hangi web kancasının çağrılacaklarını bildirir.
DeviceCapabilities

Cihaz özellikleri.
EnrollmentGroup

Kayıt grubu kaydı.
InitialTwin

İlk cihaz ikizi. İkiz'in özelliklerinin bir alt kümesini içerir.
InitialTwinProperties

Cihaz ikizinde ayarlanacak ilk özellikleri temsil eder.
Metadata

TwinCollection meta verileri
ProvisioningServiceErrorDetails

Azure IoT Hub Sağlama Hizmeti tarafından döndürülen bir hatanın özelliklerini içerir.
ReprovisionPolicy

IoT hub'ına bir cihaz yeniden sağlandığında hizmetin davranışı.
SymmetricKeyAttestation

Simetrik Anahtar aracılığıyla kanıtlama.
TpmAttestation

TPM aracılığıyla kanıtlama.
TwinCollection

İkiz içindeki bir özellik koleksiyonunu temsil eder
X509Attestation

X509 aracılığıyla kanıtlama.
X509CAReferences

Birincil ve ikincil CA başvuruları.
X509CertificateInfo

X509 sertifika bilgileri.
X509Certificates

Birincil ve ikincil sertifikalar
X509CertificateWithInfo

Sertifika ve Sertifika bilgileri

AttestationMechanism

individualEnrollment ve enrollmentGroup için kanıtlama mekanizması.

Name Tür Description
symmetricKey

SymmetricKeyAttestation

Simetrik Anahtar aracılığıyla kanıtlama.
tpm

TpmAttestation

TPM aracılığıyla kanıtlama.
type enum:
  • none
  • symmetricKey
  • tpm
  • x509

Kanıtlama Türü.
x509

X509Attestation

X509 aracılığıyla kanıtlama.

BulkEnrollmentGroupOperation

Toplu kayıt işlemi.

Name Tür Description
enrollmentGroups

EnrollmentGroup[]

Kayıt öğeleri
mode enum:
  • create
  • delete
  • update
  • updateIfMatchETag

İşlem modu.

BulkEnrollmentGroupOperationError

Toplu kayıt işlemi hatası.

Name Tür Description
enrollmentGroupId

string

Kayıt grubu kimliği.
errorCode

integer

Hata kodu
errorStatus

string

Hata durumu.

BulkEnrollmentGroupOperationResult

Toplu kayıt grubu işleminin sonuçları.

Name Tür Description
errors

BulkEnrollmentGroupOperationError[]

Kayıt hataları
isSuccessful

boolean

İşlemin tamamen başarılı olup olmadığını gösterir.

CustomAllocationDefinition

Bu, DPS'ye özel ayırma kullanılırken hangi web kancasının çağrılacaklarını bildirir.

Name Tür Description
apiVersion

string

Özel ayırma isteğinde gönderilen sağlama hizmeti türlerinin (IndividualEnrollment gibi) API sürümü. Desteklenen en düşük sürüm: "2018-09-01-preview".
webhookUrl

string

Ayırma istekleri için kullanılan web kancası URL'si.

DeviceCapabilities

Cihaz özellikleri.

Name Tür Varsayılan değer Description
iotEdge

boolean

False

True olarak ayarlanırsa bu cihaz bir IoTEdge cihazıdır.

EnrollmentGroup

Kayıt grubu kaydı.

Name Tür Varsayılan değer Description
allocationPolicy enum:
  • custom
  • geoLatency
  • hashed
  • static

Bu kaynağın ayırma ilkesi. Bu ilke, bu bireysel kayıt veya kayıt grubu için kiracı düzeyi ayırma ilkesini geçersiz kılar. Olası değerler arasında 'karma' vardır: Bağlı IoT hub'larında cihazlara sağlanan cihazlara eşit oranda sahip olma olasılığı yüksektir, 'geoLatency': Cihazlar, cihazda en düşük gecikme süresine sahip bir IoT hub'ına sağlanır. Birden çok bağlı IoT hub'ı aynı en düşük gecikme süresini sağlayacaksa, sağlama hizmeti cihazları bu hub'lar arasında karma hale getirir, 'statik' : Kayıt listesindeki istenen IoT hub'ının belirtimi, hizmet düzeyi ayırma ilkesi olan 'özel' önceliklidir: Cihazlar kendi özel mantığınıza göre ioT hub'ına sağlanır. Sağlama hizmeti cihaz hakkındaki bilgileri mantığa geçirir ve mantık istenen IoT hub'ının yanı sıra istenen ilk yapılandırmayı döndürür. Mantığınızı barındırmak için Azure İşlevleri kullanmanızı öneririz.
attestation

AttestationMechanism

individualEnrollment ve enrollmentGroup için kanıtlama mekanizması.
capabilities

DeviceCapabilities

Cihaz özellikleri.
createdDateTimeUtc

string

Bu kaynağın oluşturulduğu DateTime.
customAllocationDefinition

CustomAllocationDefinition

Bu, DPS'ye özel ayırma kullanılırken hangi web kancasının çağrılacaklarını bildirir.
enrollmentGroupId

string

Kayıt Grubu Kimliği.
etag

string

Kaynakla ilişkili varlık etiketi.
initialTwin

InitialTwin

İlk cihaz ikizi. İkiz'in özelliklerinin bir alt kümesini içerir.
iotHubHostName

string

Iot Hub ana bilgisayar adı.
iotHubs

string[]

Bu kaynaktaki cihazın ayrılabileceği IoT Hub konak adlarının listesi. IoT hub'larının kiracı düzeyi listesinin bir alt kümesi olmalıdır.
lastUpdatedDateTimeUtc

string

Bu kaynağın son güncelleştirilen DateTime değeri.
provisioningStatus enum:
  • disabled
  • enabled
enabled

Sağlama durumu.
reprovisionPolicy

ReprovisionPolicy

IoT hub'ına bir cihaz yeniden sağlandığında hizmetin davranışı.

InitialTwin

İlk cihaz ikizi. İkiz'in özelliklerinin bir alt kümesini içerir.

Name Tür Description
properties

InitialTwinProperties

Cihaz ikizinde ayarlanacak ilk özellikleri temsil eder.
tags

TwinCollection

İkiz içindeki bir özellik koleksiyonunu temsil eder

InitialTwinProperties

Cihaz ikizinde ayarlanacak ilk özellikleri temsil eder.

Name Tür Description
desired

TwinCollection

İkiz içindeki bir özellik koleksiyonunu temsil eder

Metadata

TwinCollection meta verileri

Name Tür Description
lastUpdated

string

TwinCollection'ın son güncelleştirilme zamanı
lastUpdatedVersion

integer

Bu, bildirilen özellikler meta verileri için null ve istenen özellikler meta verileri için null değildir.

ProvisioningServiceErrorDetails

Azure IoT Hub Sağlama Hizmeti tarafından döndürülen bir hatanın özelliklerini içerir.

Name Tür Description
errorCode

integer

info

object

message

string

timestampUtc

string

trackingId

string

ReprovisionPolicy

IoT hub'ına bir cihaz yeniden sağlandığında hizmetin davranışı.

Name Tür Varsayılan değer Description
migrateDeviceData

boolean

True

True (varsayılan) olarak ayarlandığında, Cihaz Sağlama Hizmeti bir IoT hub atama güncelleştirmesi sırasında cihazın verilerini (ikiz, cihaz özellikleri ve cihaz kimliği) bir IoT hub'ından diğerine geçirir. False olarak ayarlanırsa, Cihaz Sağlama Hizmeti cihazın verilerini ilgili kayıt listesinde depolanan ilk istenen yapılandırmaya sıfırlar.
updateHubAssignment

boolean

True

True (varsayılan) olarak ayarlandığında, Cihaz Sağlama Hizmeti cihazın IoT Hub atamasını değerlendirir ve belirli bir cihazdan ilkinin ötesindeki sağlama istekleri için gerekirse cihazı güncelleştirir. False olarak ayarlanırsa cihaz geçerli IoT hub'ına atanmış olarak kalır.

SymmetricKeyAttestation

Simetrik Anahtar aracılığıyla kanıtlama.

Name Tür Description
primaryKey

string

Birincil simetrik anahtar.
secondaryKey

string

İkincil simetrik anahtar.

TpmAttestation

TPM aracılığıyla kanıtlama.

Name Tür Description
endorsementKey

string

storageRootKey

string

TwinCollection

İkiz içindeki bir özellik koleksiyonunu temsil eder

Name Tür Description
count

integer

TwinCollection'daki özellik sayısı
metadata

Metadata

TwinCollection meta verileri
version

integer

TwinCollection sürümü

X509Attestation

X509 aracılığıyla kanıtlama.

Name Tür Description
caReferences

X509CAReferences

Birincil ve ikincil CA başvuruları.
clientCertificates

X509Certificates

Birincil ve ikincil sertifikalar
signingCertificates

X509Certificates

Birincil ve ikincil sertifikalar

X509CAReferences

Birincil ve ikincil CA başvuruları.

Name Tür Description
primary

string

secondary

string

X509CertificateInfo

X509 sertifika bilgileri.

Name Tür Description
issuerName

string

notAfterUtc

string

notBeforeUtc

string

serialNumber

string

sha1Thumbprint

string

sha256Thumbprint

string

subjectName

string

version

integer

X509Certificates

Birincil ve ikincil sertifikalar

Name Tür Description
primary

X509CertificateWithInfo

Sertifika ve Sertifika bilgileri
secondary

X509CertificateWithInfo

Sertifika ve Sertifika bilgileri

X509CertificateWithInfo

Sertifika ve Sertifika bilgileri

Name Tür Description
certificate

string

info

X509CertificateInfo

X509 sertifika bilgileri.