az iot device registration

  • Förhandsversion

Note

Den här referensen är en del av azure-iot-tillägget för Azure CLI (version 2.73.0 eller senare). Tillägget installeras automatiskt första gången du kör ett az iot device registration kommando. Läs mer om tillägg.

Den här kommandogruppen är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Registrera en enhet via Azure IoT Hub Device Provisioning Service (DPS).

Använd skapa för en enskild registrering eller gruppregistrering och sedan åtgärdsstatus för att följa en godkänd registrering. Autentisera enheten med dess symmetriska nyckel eller ett X.509-certifikat. Tjänstregistreringsposter och registreringstillståndsadministration finns kvar under az iot dps.

Kommandon

Name Description Typ Status
az iot device registration create

Registrera en enhet och utfärda eventuellt dess driftcertifikat.

 Extension Preview
az iot device registration operation-status

Visa status för en DPS-enhetsregistreringsåtgärd.

 Extension Preview

az iot device registration create

Förhandsversion

Kommandogruppen "iot device registration" är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Registrera en enhet och utfärda eventuellt dess driftcertifikat.

För en enskild registrering anger du enheten --symmetrisk-nyckel. För en gruppregistrering anger du gruppnyckeln med --compute-key eller anger en redan härledd enhetsnyckel utan --compute-key. Du kan också använda --dps-name med --auth-type login för att identifiera ID-omfånget/slutpunkten och hämta registreringsnycklar. lägg till --group-id och --compute-key för en gruppregistrering. Entra-inloggning auktoriserar den här bootstrap-sökningen, inte enhetsregistreringsbegäran.

Använd --id-scope med explicita enhetsautentiseringsuppgifter för att hoppa över DPS-resursidentifiering. Ange --host när du använder en slutpunkt för icke-standardetablering. För X.509-autentisering anger du --certificate-file-path och --key-file-path; lägg bara till --lösenfras om den privata nyckeln är krypterad.

Lägg till --csr (alias --csr-file-path) för att begära ett driftcertifikat. Den accepterar PEM eller base64 DER PKCS #10, infogad eller från en fil. CSR-signaturen måste vara giltig och dess gemensamma namn måste matcha --registration-id. En CSR ersätter inte enhetens symmetriska nyckel eller X.509-autentisering.

Kommandot omröstningar accepterade registreringar, som respekterar återförsök efter. Om tidsgränsen överskrids när ett åtgärds-ID har tagits emot använder du åtgärdsstatus med det ID:t och samma registrerings-ID, ID-omfång, slutpunkt och enhetsautentisering. En timeout avbryter inte serverdelsåtgärden. kör inte skapa igen. --timeout tillämpar en hård tidsgräns för samma REST-flöde för både CSR- och icke-CSR-registrering, inklusive arbetsstart, HTTP-återförsök och avsökning, efter preliminär ID-omfång och bootstrap-identifiering av autentiseringsuppgifter. Utan --timeout behålls det befintliga avgränsade avsökningsbeteendet på fem minuter.

JSON-utdata bevarar issuedCertificateChain och connectionProfile när DPS returnerar dem, plus registryDeviceExternalId för korrelation mellan registerenheter. 2026-11-02-preview RegisterDeviceAndIssueCertificate-kontraktet beskriver endast issuedCertificateChain som en matris med byte och definierar inte dess trådkodning eller certifikatordning. Därför bevarar det här kommandot fältet i JSON-utdata men erbjuder inte något utdataalternativ för certifikatfilen. att skriva en gissad kedja kan skapa ett icke-TLS-redo eller felaktigt ordnat paket. --endorsement-key och --storage-root-key behålls som avancerade fält för begäran-schema, men TPM-endast autentisering stöds uttryckligen inte eftersom det här kontraktet inte tillhandahåller något TPM-utmaningsprotokoll för klienten.

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]

Exempel

Registrera en enskild registrering med hjälp av entra-auktoriserad bootstrap-nyckelsökning

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

Registrera en gruppmedlem med hjälp av entra-auktoriserad bootstrap-nyckelsökning

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

Registrera dig med en enhetsnyckel och känt ID-omfång, utan bootstrap-sökning

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

Härled en enhetsnyckel från en registreringsgruppnyckel och registrera

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

Registrera och begära ett driftcertifikat från en PEM CSR

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

Registrera dig med ett X.509-enhetscertifikat

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

Obligatoriska parametrar

--registration-id --rid

Enhetsregistrerings-ID eller individuellt registrerings-ID.

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--acquire-policy-token

Hämtar en Azure Policy token automatiskt för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--auth-type

Anger om åtgärden ska automatiskt härleda en principnyckel eller använda den aktuella Azure AD-sessionen. Om autentiseringstypen är inloggning och resursens värdnamn anges hoppas resurssökningen över om det inte behövs. Du kan konfigurera standardinställningen med .az configure --defaults iothub-data-auth-type={auth-type-value}

Egenskap Värde
Parametergrupp: Access Control Arguments
Standardvärde: key
Godkända värden: key, login
--certificate-file-path --cp

Sökväg till PEM-certifikatfilen. Krävs för x509-registreringar.

Egenskap Värde
Parametergrupp: x509 Authentication Arguments
--change-reference

Det relaterade ändringsreferens-ID:t för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--ck --compute-key

Beräkna nyckeln per enhet från --symmetrisk-nyckel eller från registreringsgruppsnyckeln som matchas av --group-id med --dps-name/--login. Det går inte att kombinera med X.509-indata.

Egenskap Värde
Parametergrupp: Symmetric Key Authentication Arguments
Standardvärde: False
--csr --csr-file-path

Infogad PEM/base64 DER PKCS #10 CSR eller sökväg till en CSR-fil. Signaturen måste vara giltig och Det gemensamma namnet måste matcha registrerings-ID:t. Begäran skickar base64 DER utan PEM-huvuden.

Egenskap Värde
Parametergrupp: Certificate Issuance Arguments
--dps-name -n

Namnet på Azure IoT Hub Device Provisioning Service. Krävs om --login inte tillhandahålls eller autentiseringsargument och --id-scope inte anges.

Egenskap Värde
Parametergrupp: DPS Identifier Arguments
--endorsement-key

Avancerat TPM-begärandefält som behålls av tjänstschemat. Måste användas med --storage-root-key. TPM-endast klientautentisering stöds inte av det här kommandot.

Egenskap Värde
Parametergrupp: TPM Arguments
--enrollment-group-id --gid --group-id

Registreringsgrupp-ID. Behövs bara för att hämta autentiseringsargument.

--host --provisioning-host

DPS-enhetens slutpunkt. När den utelämnas härleds slutpunkten från den valda DPS-resursen och återgår sedan till den globala slutpunkten.

--id-scope --scope

ID-omfånget för Azure IoT Hub Device Provisioning Service. ID-omfånget identifierar inte en enhetsslutpunkt: --dps-name eller --login matchas fortfarande när den tillhandahålls. Med endast --id-scope och explicita enhetsautentiseringsuppgifter används den dokumenterade globala återställningen av slutpunkter.

Egenskap Värde
Parametergrupp: DPS Identifier Arguments
--key --symmetric-key

Den symmetriska delade åtkomstnyckeln för enhetsregistreringen.

Egenskap Värde
Parametergrupp: Symmetric Key Authentication Arguments
--key-file-path --kp

Sökväg till pem-nyckelfil. Krävs för x509-registreringar.

Egenskap Värde
Parametergrupp: x509 Authentication Arguments
--login -l

Det här kommandot stöder en entitet reťazec pripojenia med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet reťazec pripojenia och namn anges prioriteras reťazec pripojenia. Krävs om --dps-name inte har angetts eller om authenticaton-argument och --id-scope inte anges.

Egenskap Värde
Parametergrupp: DPS Identifier Arguments
--pass --passphrase

Lösenfras för den privata X.509-nyckeln. Endast giltigt med både --certificate-file-path och --key-file-path.

Egenskap Värde
Parametergrupp: x509 Authentication Arguments
--payload

Registrera nyttolasten som ett JSON-objekt eller sökväg till en JSON-fil.

--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

--storage-root-key

Avancerat TPM-begärandefält som behålls av tjänstschemat. Måste användas med --endorsement-key. TPM-endast klientautentisering stöds inte av det här kommandot.

Egenskap Värde
Parametergrupp: TPM Arguments
--timeout

Timeout för positiv heltalshård REST-registrering i sekunder, inklusive arbetsstart, HTTP och avsökning. Exkluderar preliminär ID-omfång och bootstrap-identifiering av autentiseringsuppgifter.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az iot device registration operation-status

Förhandsversion

Kommandogruppen "iot device registration" är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Visa status för en DPS-enhetsregistreringsåtgärd.

Ange åtgärds-ID:t som returneras av DPS eller rapporteras av create efter en timeout. Återanvänd registrerings-ID, ID-omfång (eller DPS-namn), etablering av värd- och enhetsautentisering från skapa. Det här är en statusläsning, inte en ny registrering.

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]

Exempel

Följ en enskild registrering med bootstrap-nyckelsökning

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

Följ en gruppmedlem med samma gruppnyckel och etableringsvärd

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

Följ en godkänd åtgärd efter en timeout utan att skicka registreringen igen

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

Obligatoriska parametrar

--operation-id

Identifierare för registreringsåtgärd som returneras av create.

--registration-id --rid

Enhetsregistrerings-ID eller individuellt registrerings-ID.

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--acquire-policy-token

Hämtar en Azure Policy token automatiskt för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--auth-type

Anger om åtgärden ska automatiskt härleda en principnyckel eller använda den aktuella Azure AD-sessionen. Om autentiseringstypen är inloggning och resursens värdnamn anges hoppas resurssökningen över om det inte behövs. Du kan konfigurera standardinställningen med .az configure --defaults iothub-data-auth-type={auth-type-value}

Egenskap Värde
Parametergrupp: Access Control Arguments
Standardvärde: key
Godkända värden: key, login
--certificate-file-path --cp

Sökväg till PEM-certifikatfilen. Krävs för x509-registreringar.

Egenskap Värde
Parametergrupp: x509 Authentication Arguments
--change-reference

Det relaterade ändringsreferens-ID:t för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--ck --compute-key

Beräkna nyckeln per enhet från --symmetrisk-nyckel eller från registreringsgruppsnyckeln som matchas av --group-id med --dps-name/--login. Det går inte att kombinera med X.509-indata.

Egenskap Värde
Parametergrupp: Symmetric Key Authentication Arguments
Standardvärde: False
--dps-name -n

Namnet på Azure IoT Hub Device Provisioning Service. Krävs om --login inte tillhandahålls eller autentiseringsargument och --id-scope inte anges.

Egenskap Värde
Parametergrupp: DPS Identifier Arguments
--enrollment-group-id --gid --group-id

Registreringsgrupp-ID. Behövs bara för att hämta autentiseringsargument.

--host --provisioning-host

DPS-enhetens slutpunkt. När den utelämnas härleds slutpunkten från den valda DPS-resursen och återgår sedan till den globala slutpunkten.

--id-scope --scope

ID-omfånget för Azure IoT Hub Device Provisioning Service. ID-omfånget identifierar inte en enhetsslutpunkt: --dps-name eller --login matchas fortfarande när den tillhandahålls. Med endast --id-scope och explicita enhetsautentiseringsuppgifter används den dokumenterade globala återställningen av slutpunkter.

Egenskap Värde
Parametergrupp: DPS Identifier Arguments
--key --symmetric-key

Den symmetriska delade åtkomstnyckeln för enhetsregistreringen.

Egenskap Värde
Parametergrupp: Symmetric Key Authentication Arguments
--key-file-path --kp

Sökväg till pem-nyckelfil. Krävs för x509-registreringar.

Egenskap Värde
Parametergrupp: x509 Authentication Arguments
--login -l

Det här kommandot stöder en entitet reťazec pripojenia med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet reťazec pripojenia och namn anges prioriteras reťazec pripojenia. Krävs om --dps-name inte har angetts eller om authenticaton-argument och --id-scope inte anges.

Egenskap Värde
Parametergrupp: DPS Identifier Arguments
--pass --passphrase

Lösenfras för den privata X.509-nyckeln. Endast giltigt med både --certificate-file-path och --key-file-path.

Egenskap Värde
Parametergrupp: x509 Authentication Arguments
--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False