az iot device registration

  • Preview uitvoeren

Note

Deze verwijzing maakt deel uit van de azure-iot-extensie voor de Azure CLI (versie 2.73.0 of hoger). De extensie installeert automatisch de eerste keer dat u een az iot device registration opdracht uitvoert. Meer informatie over uitbreidingen.

Deze opdrachtgroep is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Een apparaat registreren via Azure IoT Hub Device Provisioning Service (DPS).

Gebruik maken voor een afzonderlijke of groepsinschrijving en vervolgens de bewerkingsstatus om een geaccepteerde registratie te volgen. Verifieer het apparaat met de symmetrische sleutel of een X.509-certificaat. Registratierecords van de service en het beheer van de registratiestatus blijven onder az iot dps.

Opdracht

Naam Description Type Status
az iot device registration create

Registreer een apparaat en geef eventueel het operationele certificaat uit.

 Extension Preview
az iot device registration operation-status

De status van een DPS-apparaatregistratiebewerking weergeven.

 Extension Preview

az iot device registration create

Preview uitvoeren

De opdrachtgroep 'iot-apparaatregistratie' is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Registreer een apparaat en geef eventueel het operationele certificaat uit.

Geef voor een afzonderlijke inschrijving het apparaat --symmetrisch-sleutel op. Geef voor een groepsinschrijving de groepssleutel op met --compute-key of geef een al afgeleide apparaatsleutel op zonder --compute-key. U kunt ook --dps-name gebruiken met --auth-type aanmelding om het id-bereik/eindpunt te detecteren en inschrijvingssleutels op te halen; --group-id en --compute-key toevoegen voor een groepsinschrijving. Aanmelden bij Entra autoriseert deze bootstrap lookup, niet de aanvraag voor apparaatregistratie.

Gebruik --id-scope met expliciete apparaatreferenties om DPS-resourcedetectie over te slaan. Stel --host in wanneer u een niet-standaard inrichtingseindpunt gebruikt. Geef voor X.509-verificatie --certificate-file-path en --key-file-path op; voeg alleen een wachtwoordzin toe als de persoonlijke sleutel is versleuteld.

Voeg --csr (alias --csr-file-path) toe om een operationeel certificaat aan te vragen. Het accepteert PEM of base64 DER PKCS #10, inline of uit een bestand. De CSR-handtekening moet geldig zijn en de algemene naam moet overeenkomen met --registration-id. Een CSR vervangt de symmetrische sleutel of X.509-verificatie van het apparaat niet.

De opdracht pollt geaccepteerde registraties, waarbij opnieuw proberen wordt uitgevoerd. Als er een time-out optreedt na ontvangst van een bewerkings-id, gebruikt u de bewerkingsstatus met die id en dezelfde registratie-id, id-bereik, eindpunt- en apparaatverificatie. Een time-out annuleert de back-endbewerking niet; maak niet blind opnieuw uitvoeren. --time-out past een harde deadline toe op dezelfde REST-stroom voor zowel CSR- als niet-CSR-registratie, waaronder opstarten van werkrollen, HTTP-nieuwe pogingen en polling, na voorlopige id-bereik en bootstrapreferentiedetectie. Zonder --time-out wordt het bestaande pollinggedrag van vijf minuten behouden.

JSON-uitvoer behoudt uitgegevenCertificateChain en connectionProfile wanneer DPS deze retourneert, plus registryDeviceExternalId voor correlatie van registerapparaten. Het contract 2026-11-02-preview registerDeviceAndIssueCertificate beschrijft uitgegevenCertificateChain alleen als een matrix van bytes en definieert de wire-codering of certificaatvolgorde niet. Daarom behoudt deze opdracht dat veld in JSON-uitvoer, maar biedt geen uitvoeroptie voor certificaatbestanden; het schrijven van een geraden keten kan een niet-TLS-gereed of onjuist bestelde bundel produceren. --endorsement-key en --storage-root-key worden bewaard als geavanceerde aanvraagschemavelden, maar TPM-alleen-verificatie wordt expliciet niet ondersteund omdat dit contract geen TPM-clientuitdagingsprotocol biedt.

az iot device registration create --registration-id --rid
                                  [--acquire-policy-token]
                                  [--auth-type {key, login}]
                                  [--certificate-file-path --cp]
                                  [--change-reference]
                                  [--ck --compute-key]
                                  [--csr --csr-file-path]
                                  [--dps-name]
                                  [--endorsement-key]
                                  [--enrollment-group-id --gid --group-id]
                                  [--host --provisioning-host]
                                  [--id-scope --scope]
                                  [--key --symmetric-key]
                                  [--key-file-path --kp]
                                  [--login]
                                  [--pass --passphrase]
                                  [--payload]
                                  [--resource-group]
                                  [--storage-root-key]
                                  [--timeout]

Voorbeelden

Een afzonderlijke inschrijving registreren met behulp van door Entra geautoriseerde bootstrap-sleutelzoekactie

az iot device registration create --dps-name MyDps --resource-group MyResourceGroup \
  --registration-id device-01 --auth-type login

Een groepslid registreren met behulp van door Entra geautoriseerde bootstrap-sleutelzoekactie

az iot device registration create --dps-name MyDps --registration-id device-01 \
  --group-id MyEnrollmentGroup --compute-key --auth-type login

Registreren met een apparaatsleutel en een bekend id-bereik, zonder bootstrap lookup

az iot device registration create --id-scope 0ne00000000 \
  --registration-id device-01 --symmetric-key DEVICE_KEY

Een apparaatsleutel afleiden van een inschrijvingsgroepssleutel en registreren

az iot device registration create --id-scope 0ne00000000 \
  --registration-id device-01 --symmetric-key GROUP_KEY --compute-key

Een operationeel certificaat registreren en aanvragen bij een PEM CSR

az iot device registration create --id-scope 0ne00000000 --registration-id device-01 \
  --symmetric-key DEVICE_KEY --csr ./device-01.csr --timeout 120

Registreren met een X.509-apparaatcertificaat

az iot device registration create --id-scope 0ne00000000 \
  --registration-id device-01 --certificate-file-path ./device.pem \
  --key-file-path ./device-key.pem

Vereiste parameters

--registration-id --rid

Apparaatregistratie-id of afzonderlijke inschrijvings-id.

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--acquire-policy-token

Automatisch een Azure Policy token verkrijgen voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--auth-type

Hiermee wordt aangegeven of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. Als het verificatietype aanmelding is en de hostnaam van de resource wordt opgegeven, wordt het opzoeken van resources overgeslagen, tenzij dat nodig is. U kunt de standaardinstelling configureren met behulp van az configure --defaults iothub-data-auth-type={auth-type-value}.

Eigenschap Waarde
Parametergroep: Access Control Arguments
Default value: key
Geaccepteerde waarden: key, login
--certificate-file-path --cp

Pad naar pem-certificaatbestand. Vereist voor x509-registraties.

Eigenschap Waarde
Parametergroep: x509 Authentication Arguments
--change-reference

De gerelateerde wijzigingsverwijzings-id voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--ck --compute-key

Bereken de sleutel per apparaat van --symmetric-key of van de sleutel voor de inschrijvingsgroep die is omgezet door --group-id met --dps-name/-login. Kan niet worden gecombineerd met X.509-invoer.

Eigenschap Waarde
Parametergroep: Symmetric Key Authentication Arguments
Default value: False
--csr --csr-file-path

Inline PEM/base64 DER PKCS #10 CSR of pad naar een CSR-bestand. De handtekening moet geldig zijn en de algemene naam moet overeenkomen met de registratie-id. De aanvraag verzendt base64 DER zonder PEM-headers.

Eigenschap Waarde
Parametergroep: Certificate Issuance Arguments
--dps-name -n

Naam van de Azure IoT Hub Device Provisioning Service. Vereist als --login niet is opgegeven of authenticaton-argumenten en --id-scope niet zijn opgegeven.

Eigenschap Waarde
Parametergroep: DPS Identifier Arguments
--endorsement-key

Geavanceerd TPM-aanvraagveld dat wordt bewaard door het serviceschema. Moet worden gebruikt met --storage-root-key. Clientverificatie met alleen TPM wordt niet ondersteund door deze opdracht.

Eigenschap Waarde
Parametergroep: TPM Arguments
--enrollment-group-id --gid --group-id

Id van inschrijvingsgroep. Alleen nodig om verificatieargumenten op te halen.

--host --provisioning-host

DPS-apparaateindpunt. Wanneer u dit weglaat, wordt het eindpunt afgeleid van de geselecteerde DPS-resource en wordt het vervolgens teruggezet naar het globale eindpunt.

--id-scope --scope

Id-bereik van de Azure IoT Hub Device Provisioning Service. Id-bereik identificeert geen apparaateindpunt: --dps-name of --login wordt nog steeds opgelost wanneer deze is opgegeven. Met alleen --id-scope en expliciete apparaatreferenties wordt de gedocumenteerde globale terugval van eindpunten gebruikt.

Eigenschap Waarde
Parametergroep: DPS Identifier Arguments
--key --symmetric-key

De symmetrische gedeelde toegangssleutel voor de apparaatregistratie.

Eigenschap Waarde
Parametergroep: Symmetric Key Authentication Arguments
--key-file-path --kp

Pad naar het PEM-sleutelbestand. Vereist voor x509-registraties.

Eigenschap Waarde
Parametergroep: x509 Authentication Arguments
--login -l

Deze opdracht ondersteunt een entiteit verbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteit verbindingsreeks als de naam wordt opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --dps-name niet is opgegeven of authenticaton-argumenten en --id-scope niet is opgegeven.

Eigenschap Waarde
Parametergroep: DPS Identifier Arguments
--pass --passphrase

Wachtwoordzin voor de persoonlijke X.509-sleutel. Alleen geldig met zowel --certificate-file-path als --key-file-path.

Eigenschap Waarde
Parametergroep: x509 Authentication Arguments
--payload

Nettolading van registratie als een JSON-object of -pad naar een JSON-bestand.

--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--storage-root-key

Geavanceerd TPM-aanvraagveld dat wordt bewaard door het serviceschema. Moet worden gebruikt met --endorsement-key. Clientverificatie met alleen TPM wordt niet ondersteund door deze opdracht.

Eigenschap Waarde
Parametergroep: TPM Arguments
--timeout

Time-out voor positieve gehele getallen voor harde REST-registratie in seconden, waaronder opstarten van werkrollen, HTTP en polling. Sluit voorlopig id-bereik en bootstrap referentiedetectie uit.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False

az iot device registration operation-status

Preview uitvoeren

De opdrachtgroep 'iot-apparaatregistratie' is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

De status van een DPS-apparaatregistratiebewerking weergeven.

Geef de bewerkings-id op die wordt geretourneerd door DPS of gerapporteerd door maken na een time-out. Gebruik de registratie-id, het id-bereik (of de DPS-naam) opnieuw, waarbij host- en apparaatverificatie wordt ingericht vanaf het maken. Dit is een status gelezen, geen nieuwe registratie.

az iot device registration operation-status --operation-id
                                            --registration-id --rid
                                            [--acquire-policy-token]
                                            [--auth-type {key, login}]
                                            [--certificate-file-path --cp]
                                            [--change-reference]
                                            [--ck --compute-key]
                                            [--dps-name]
                                            [--enrollment-group-id --gid --group-id]
                                            [--host --provisioning-host]
                                            [--id-scope --scope]
                                            [--key --symmetric-key]
                                            [--key-file-path --kp]
                                            [--login]
                                            [--pass --passphrase]
                                            [--resource-group]

Voorbeelden

Een afzonderlijke inschrijving volgen met bootstrap-sleutelzoekactie

az iot device registration operation-status --dps-name MyDps \
  --registration-id device-01 --operation-id OPERATION_ID --auth-type login

Een groepslid volgen met dezelfde groepssleutel en inrichtingshost

az iot device registration operation-status --id-scope 0ne00000000 \
  --registration-id device-01 --operation-id OPERATION_ID \
  --symmetric-key GROUP_KEY --compute-key --host MyProvisioningHost

Een geaccepteerde bewerking volgen na een time-out zonder registratie opnieuw in te dienen

az iot device registration operation-status --id-scope 0ne00000000 \
  --registration-id device-01 --operation-id OPERATION_ID --symmetric-key DEVICE_KEY

Vereiste parameters

--operation-id

Registratiebewerkings-id geretourneerd door maken.

--registration-id --rid

Apparaatregistratie-id of afzonderlijke inschrijvings-id.

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--acquire-policy-token

Automatisch een Azure Policy token verkrijgen voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--auth-type

Hiermee wordt aangegeven of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. Als het verificatietype aanmelding is en de hostnaam van de resource wordt opgegeven, wordt het opzoeken van resources overgeslagen, tenzij dat nodig is. U kunt de standaardinstelling configureren met behulp van az configure --defaults iothub-data-auth-type={auth-type-value}.

Eigenschap Waarde
Parametergroep: Access Control Arguments
Default value: key
Geaccepteerde waarden: key, login
--certificate-file-path --cp

Pad naar pem-certificaatbestand. Vereist voor x509-registraties.

Eigenschap Waarde
Parametergroep: x509 Authentication Arguments
--change-reference

De gerelateerde wijzigingsverwijzings-id voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--ck --compute-key

Bereken de sleutel per apparaat van --symmetric-key of van de sleutel voor de inschrijvingsgroep die is omgezet door --group-id met --dps-name/-login. Kan niet worden gecombineerd met X.509-invoer.

Eigenschap Waarde
Parametergroep: Symmetric Key Authentication Arguments
Default value: False
--dps-name -n

Naam van de Azure IoT Hub Device Provisioning Service. Vereist als --login niet is opgegeven of authenticaton-argumenten en --id-scope niet zijn opgegeven.

Eigenschap Waarde
Parametergroep: DPS Identifier Arguments
--enrollment-group-id --gid --group-id

Id van inschrijvingsgroep. Alleen nodig om verificatieargumenten op te halen.

--host --provisioning-host

DPS-apparaateindpunt. Wanneer u dit weglaat, wordt het eindpunt afgeleid van de geselecteerde DPS-resource en wordt het vervolgens teruggezet naar het globale eindpunt.

--id-scope --scope

Id-bereik van de Azure IoT Hub Device Provisioning Service. Id-bereik identificeert geen apparaateindpunt: --dps-name of --login wordt nog steeds opgelost wanneer deze is opgegeven. Met alleen --id-scope en expliciete apparaatreferenties wordt de gedocumenteerde globale terugval van eindpunten gebruikt.

Eigenschap Waarde
Parametergroep: DPS Identifier Arguments
--key --symmetric-key

De symmetrische gedeelde toegangssleutel voor de apparaatregistratie.

Eigenschap Waarde
Parametergroep: Symmetric Key Authentication Arguments
--key-file-path --kp

Pad naar het PEM-sleutelbestand. Vereist voor x509-registraties.

Eigenschap Waarde
Parametergroep: x509 Authentication Arguments
--login -l

Deze opdracht ondersteunt een entiteit verbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteit verbindingsreeks als de naam wordt opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --dps-name niet is opgegeven of authenticaton-argumenten en --id-scope niet is opgegeven.

Eigenschap Waarde
Parametergroep: DPS Identifier Arguments
--pass --passphrase

Wachtwoordzin voor de persoonlijke X.509-sleutel. Alleen geldig met zowel --certificate-file-path als --key-file-path.

Eigenschap Waarde
Parametergroep: x509 Authentication Arguments
--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False