az iot dps enrollment
Poznámka:
Tento odkaz je součástí rozšíření azure-iot pro Azure CLI (verze 2.46.0 nebo vyšší). Rozšíření se automaticky nainstaluje při prvním spuštění příkazu az iot dps enrollment . Přečtěte si další informace o rozšířeních.
Správa jednotlivých registrací zařízení ve službě Azure IoT Hub Device Provisioning
Příkazy
Name | Description | Typ | Stav |
---|---|---|---|
az iot dps enrollment create |
Vytvořte registraci jednotlivých zařízení ve službě Azure IoT Hub Device Provisioning. |
Rozšíření | GA |
az iot dps enrollment delete |
Odstranění registrace jednotlivých zařízení ve službě Azure IoT Hub Device Provisioning |
Rozšíření | GA |
az iot dps enrollment list |
Výpis jednotlivých registrací zařízení ve službě Azure IoT Hub Device Provisioning |
Rozšíření | GA |
az iot dps enrollment registration |
Správa registrace zařízení na straně služby pro jednotlivé registrace ve službě Azure IoT Hub Device Provisioning |
Rozšíření | GA |
az iot dps enrollment registration delete |
Odstranění registrace zařízení pro jednotlivou registraci ve službě Azure IoT Hub Device Provisioning |
Rozšíření | GA |
az iot dps enrollment registration show |
Získejte registraci zařízení pro jednotlivé registrace ve službě Azure IoT Hub Device Provisioning. |
Rozšíření | GA |
az iot dps enrollment show |
Získejte podrobnosti o registraci jednotlivých zařízení ve službě Azure IoT Hub Device Provisioning. |
Rozšíření | GA |
az iot dps enrollment update |
Aktualizace registrace jednotlivých zařízení ve službě Azure IoT Hub Device Provisioning |
Rozšíření | GA |
az iot dps enrollment create
Vytvořte registraci jednotlivých zařízení ve službě Azure IoT Hub Device Provisioning.
Zadejte formát certifikátu pomocí kódování Base64 ASCII a certifikát by měl mít odpovídající segmenty BEGIN a END, například: začněte řetězcem "-----BEGIN CERTIFICATE-----" a končí na "-----END CERTIFICATE-----".
az iot dps enrollment create --at {symmetricKey, tpm, x509}
--eid
[--allocation-policy {custom, geoLatency, hashed, static}]
[--api-version]
[--auth-type {key, login}]
[--certificate-path]
[--device-id]
[--device-information]
[--dps-name]
[--edge-enabled {false, true}]
[--ek]
[--ih]
[--initial-twin-properties]
[--initial-twin-tags]
[--login]
[--pk]
[--provisioning-status {disabled, enabled}]
[--reprovision-policy {never, reprovisionandmigratedata, reprovisionandresetdata}]
[--resource-group]
[--scp]
[--secondary-key]
[--webhook-url]
Příklady
Vytvořte registraci {enrollment_id} s typem ověření identity x509 ve službě Azure IoT Device Provisioning {dps_name} ve skupině prostředků {resource_group_name} se stavem zřizování zakázáno. ID zařízení {device_id}, počáteční vlastnosti dvojčete {"location":{"region":"US"}}", počáteční značky dvojčete {"version":"1"} a informace o zařízení {"color":"red"}".
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type x509 --certificate-path /certificates/Certificate.pem --provisioning-status disabled --initial-twin-properties "{'location':{'region':'US'}}" --initial-twin-tags "{'version':'1'}" --device-info "{'color':'red'}" --device-id {device_id}
Vytvořte registraci MyEnrollment s typem ověření identity tpm ve službě Azure IoT Device Provisioning {dps_name} ve skupině prostředků {resource_group_name}.
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type tpm --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89
Vytvořte registraci MyEnrollment s typem ověření identity symetrický klíč ve službě Azure IoT Device Provisioning {dps_name} ve skupině prostředků {resource_group_name}.
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type symmetrickey --primary-key {primary_key} --secondary-key {secondary_key}
Vytvořte registraci MyEnrollment s opětovným zřízením ve službě Azure IoT Device Provisioning {dps_name} ve skupině prostředků {resource_group_name}.
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type tpm --reprovision-policy {reprovision_type} --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89
Vytvořte registraci MyEnrollment se statickými zásadami přidělování ve službě Azure IoT Device Provisioning {dps_name} ve skupině prostředků {resource_group_name}.
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type tpm --allocation-policy static --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89 --iot-hubs {iot_hub_host_name}
Vytvořte registraci MyEnrollment se zásadami přidělování hash a několika rozbočovači ve službě Azure IoT Device Provisioning {dps_name} ve skupině prostředků {resource_group_name}.
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type tpm --allocation-policy hashed --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89 --iot-hubs {iot_hub_host_name1} {iot_hub_host_name2}
Vytvoření registrace MyEnrollment se zásadami vlastního přidělení
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type symmetrickey --allocation-policy custom --webhook-url {webhook_url} --api-version {api_version}
Povinné parametry
Mechanismus ověření identity, který se používá k ověřování v DPS.
ID registrace jednotlivých zařízení.
Volitelné parametry
Typ zásady přidělování, které určují, jak se zařízení přiřadí ke službě IoT Hub. Pokud není k dispozici, zásada přidělení bude výchozí aktuální zásadou přidělování nastavenou pro instanci služby Device Provisioning.
Verze rozhraní API typů služby zřizování odesílaných v požadavku na vlastní přidělení. Minimální podporovaná verze: 2018-09-01-preview.
Určuje, jestli má operace automaticky odvodit klíč zásady, nebo použít aktuální relaci Azure AD. Pokud je typ ověřování přihlášení a zadá se název hostitele prostředku, bude vyhledávání prostředků vynecháno, pokud není potřeba. Výchozí nastavení můžete nakonfigurovat pomocí az configure --defaults iotdps-data-auth-type=<auth-type-value>
.
Cesta k souboru obsahujícímu primární certifikát. Vyžaduje se při výběru typu ověření x509 a není zadána cesta k sekundárnímu certifikátu.
ID zařízení zaregistrované ve službě IoT Hub.
Volitelné informace o zařízení.
Název nebo název hostitele služby Azure IoT Hub Device Provisioning Vyžaduje se, pokud není zadané --login.
Příznak označující povolení hraničních zařízení
Ověřovací klíč TPM pro zařízení TPM Při výběru tpm jako typu ověření identity se vyžaduje ověřovací klíč.
Název hostitele cílového ioT Hubu přidruženého k zásadám přidělování Pro více ioT Hubů použijte seznam oddělený mezerami.
Počáteční vlastnosti dvojčete zařízení.
Počáteční značky dvojčat zařízení
Tento příkaz podporuje entitu připojovací řetězec s právy k provedení akce. Použijte k tomu, abyste se vyhnuli přihlášení k relaci prostřednictvím příkazu az login. Pokud jsou připojovací řetězec i název entity zadané připojovací řetězec prioritu. Vyžaduje se, pokud není zadaný název --dps-name.
Primární symetrický sdílený přístupový klíč uložený ve formátu base64.
Povolte nebo zakažte položku registrace.
Zásady, které určují, jak se mají data zařízení zpracovávat při opětovném zřízení jiné služby IoT Hub.
Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>
.
Cesta k souboru obsahujícímu sekundární certifikát. Vyžaduje se při výběru typu ověření identity x509 a není zadána cesta k primárnímu certifikátu.
Sekundární symetrický sdílený přístupový klíč uložený ve formátu base64.
Adresa URL webhooku funkce Azure Functions používaná pro vlastní žádosti o přidělení.
Globální parametry
Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.
Zobrazte tuto zprávu nápovědy a ukončete ji.
Zobrazují se pouze chyby, potlačení upozornění.
Výstupní formát
Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.
Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID
.
Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.
az iot dps enrollment delete
Odstranění registrace jednotlivých zařízení ve službě Azure IoT Hub Device Provisioning
az iot dps enrollment delete --eid
[--auth-type {key, login}]
[--dps-name]
[--etag]
[--login]
[--resource-group]
Povinné parametry
ID registrace jednotlivých zařízení.
Volitelné parametry
Určuje, jestli má operace automaticky odvodit klíč zásady, nebo použít aktuální relaci Azure AD. Pokud je typ ověřování přihlášení a zadá se název hostitele prostředku, bude vyhledávání prostředků vynecháno, pokud není potřeba. Výchozí nastavení můžete nakonfigurovat pomocí az configure --defaults iotdps-data-auth-type=<auth-type-value>
.
Název nebo název hostitele služby Azure IoT Hub Device Provisioning Vyžaduje se, pokud není zadané --login.
Značka Etag nebo značka entity odpovídající poslednímu stavu prostředku. Pokud není k dispozici žádná značka etag, použije se hodnota *.
Tento příkaz podporuje entitu připojovací řetězec s právy k provedení akce. Použijte k tomu, abyste se vyhnuli přihlášení k relaci prostřednictvím příkazu az login. Pokud jsou připojovací řetězec i název entity zadané připojovací řetězec prioritu. Vyžaduje se, pokud není zadaný název --dps-name.
Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>
.
Globální parametry
Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.
Zobrazte tuto zprávu nápovědy a ukončete ji.
Zobrazují se pouze chyby, potlačení upozornění.
Výstupní formát
Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.
Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID
.
Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.
az iot dps enrollment list
Výpis jednotlivých registrací zařízení ve službě Azure IoT Hub Device Provisioning
az iot dps enrollment list [--auth-type {key, login}]
[--dps-name]
[--login]
[--resource-group]
[--top]
Volitelné parametry
Určuje, jestli má operace automaticky odvodit klíč zásady, nebo použít aktuální relaci Azure AD. Pokud je typ ověřování přihlášení a zadá se název hostitele prostředku, bude vyhledávání prostředků vynecháno, pokud není potřeba. Výchozí nastavení můžete nakonfigurovat pomocí az configure --defaults iotdps-data-auth-type=<auth-type-value>
.
Název nebo název hostitele služby Azure IoT Hub Device Provisioning Vyžaduje se, pokud není zadané --login.
Tento příkaz podporuje entitu připojovací řetězec s právy k provedení akce. Použijte k tomu, abyste se vyhnuli přihlášení k relaci prostřednictvím příkazu az login. Pokud jsou připojovací řetězec i název entity zadané připojovací řetězec prioritu. Vyžaduje se, pokud není zadaný název --dps-name.
Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>
.
Maximální počet prvků, které se mají vrátit. Použijte -1 pro neomezenou dobu.
Globální parametry
Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.
Zobrazte tuto zprávu nápovědy a ukončete ji.
Zobrazují se pouze chyby, potlačení upozornění.
Výstupní formát
Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.
Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID
.
Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.
az iot dps enrollment show
Získejte podrobnosti o registraci jednotlivých zařízení ve službě Azure IoT Hub Device Provisioning.
az iot dps enrollment show --eid
[--auth-type {key, login}]
[--dps-name]
[--keys {false, true}]
[--login]
[--resource-group]
Příklady
Základní použití
az iot dps enrollment show --dps-name {dps_name} -g {resource_group} --enrollment-id {enrollment_id}
Zahrnutí úplných informací o ověření identity do výsledků pro registraci symetrického klíče
az iot dps enrollment show --dps-name {dps_name} -g {resource_group} --enrollment-id {symmetric_key_enrollment_id} --show-keys
Povinné parametry
ID registrace jednotlivých zařízení.
Volitelné parametry
Určuje, jestli má operace automaticky odvodit klíč zásady, nebo použít aktuální relaci Azure AD. Pokud je typ ověřování přihlášení a zadá se název hostitele prostředku, bude vyhledávání prostředků vynecháno, pokud není potřeba. Výchozí nastavení můžete nakonfigurovat pomocí az configure --defaults iotdps-data-auth-type=<auth-type-value>
.
Název nebo název hostitele služby Azure IoT Hub Device Provisioning Vyžaduje se, pokud není zadané --login.
Do výsledků registrace zahrňte klíče a informace o ověření identity.
Tento příkaz podporuje entitu připojovací řetězec s právy k provedení akce. Použijte k tomu, abyste se vyhnuli přihlášení k relaci prostřednictvím příkazu az login. Pokud jsou připojovací řetězec i název entity zadané připojovací řetězec prioritu. Vyžaduje se, pokud není zadaný název --dps-name.
Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>
.
Globální parametry
Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.
Zobrazte tuto zprávu nápovědy a ukončete ji.
Zobrazují se pouze chyby, potlačení upozornění.
Výstupní formát
Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.
Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID
.
Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.
az iot dps enrollment update
Aktualizace registrace jednotlivých zařízení ve službě Azure IoT Hub Device Provisioning
Zadejte formát certifikátu pomocí kódování Base64 ASCII a certifikát by měl mít odpovídající segmenty BEGIN a END, například: začněte řetězcem "-----BEGIN CERTIFICATE-----" a končí na "-----END CERTIFICATE-----".
az iot dps enrollment update --eid
[--allocation-policy {custom, geoLatency, hashed, static}]
[--api-version]
[--auth-type {key, login}]
[--certificate-path]
[--device-id]
[--device-information]
[--dps-name]
[--edge-enabled {false, true}]
[--ek]
[--etag]
[--ih]
[--initial-twin-properties]
[--initial-twin-tags]
[--login]
[--pk]
[--provisioning-status {disabled, enabled}]
[--rc {false, true}]
[--remove-secondary-certificate {false, true}]
[--reprovision-policy {never, reprovisionandmigratedata, reprovisionandresetdata}]
[--resource-group]
[--scp]
[--secondary-key]
[--webhook-url]
Příklady
Aktualizujte registraci {enrollment_id} novým certifikátem x509 ve službě Azure IoT Device Provisioning {dps_name} ve skupině prostředků {resource_group_name}.
az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --certificate-path /certificates/NewCertificate.pem --etag AAAAAAAAAAA=
Aktualizujte registraci {enrollment_id} novým ověřovacím klíčem ve službě Azure IoT Device Provisioning {dps_name} ve skupině prostředků {resource_group_name}.
az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89 --etag AAAAAAAAAAA=
Aktualizujte registraci {enrollment_id} novým primárním klíčem ve službě Azure IoT Device Provisioning {dps_name} ve skupině prostředků {resource_group_name}.
az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --primary-key {new_primary_key} --etag AAAAAAAAAAA=
Aktualizujte registraci {enrollment_id} novým typem opětovného zřízení ve službě Azure IoT Device Provisioning {dps_name} ve skupině prostředků {resource_group_name}.
az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --reprovision-policy {reprovision_type} --etag AAAAAAAAAAA=
Aktualizujte registraci {enrollment_id} novou zásadou přidělování ve službě Azure IoT Device Provisioning {dps_name} ve skupině prostředků {resource_group_name}.
az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --allocation-policy geolatency --etag AAAAAAAAAAA= --iot-hubs {iot_hub_host_name1} {iot_hub_host_name2} {iot_hub_host_name3}
Aktualizujte registraci {enrollment_id} ve službě Azure IoT Device Provisioning {dps_name} ve skupině prostředků {resource_group_name} s počátečními vlastnostmi dvojčete {"location":{"region":"USA"}}", počáteční značky dvojčat {"version":"2"} a informace o zařízení {"color":"red"}".
az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --initial-twin-properties "{'location':{'region':'USA'}}" --initial-twin-tags "{'version1':'2'}" --device-info "{'color':'red'}"
Povinné parametry
ID registrace jednotlivých zařízení.
Volitelné parametry
Typ zásady přidělování, které určují, jak se zařízení přiřadí ke službě IoT Hub. Pokud není k dispozici, zásada přidělení bude výchozí aktuální zásadou přidělování nastavenou pro instanci služby Device Provisioning.
Verze rozhraní API typů služby zřizování odesílaných v požadavku na vlastní přidělení. Minimální podporovaná verze: 2018-09-01-preview.
Určuje, jestli má operace automaticky odvodit klíč zásady, nebo použít aktuální relaci Azure AD. Pokud je typ ověřování přihlášení a zadá se název hostitele prostředku, bude vyhledávání prostředků vynecháno, pokud není potřeba. Výchozí nastavení můžete nakonfigurovat pomocí az configure --defaults iotdps-data-auth-type=<auth-type-value>
.
Cesta k souboru obsahujícímu primární certifikát.
ID zařízení zaregistrované ve službě IoT Hub.
Volitelné informace o zařízení.
Název nebo název hostitele služby Azure IoT Hub Device Provisioning Vyžaduje se, pokud není zadané --login.
Příznak označující povolení hraničních zařízení
Ověřovací klíč TPM pro zařízení TPM
Značka Etag nebo značka entity odpovídající poslednímu stavu prostředku. Pokud není k dispozici žádná značka etag, použije se hodnota *.
Název hostitele cílového ioT Hubu přidruženého k zásadám přidělování Pro více ioT Hubů použijte seznam oddělený mezerami.
Počáteční vlastnosti dvojčete zařízení.
Počáteční značky dvojčat zařízení
Tento příkaz podporuje entitu připojovací řetězec s právy k provedení akce. Použijte k tomu, abyste se vyhnuli přihlášení k relaci prostřednictvím příkazu az login. Pokud jsou připojovací řetězec i název entity zadané připojovací řetězec prioritu. Vyžaduje se, pokud není zadaný název --dps-name.
Primární symetrický sdílený přístupový klíč uložený ve formátu base64.
Povolte nebo zakažte položku registrace.
Příznak pro odebrání aktuálního primárního certifikátu
Příznak pro odebrání aktuálního sekundárního certifikátu
Zásady, které určují, jak se mají data zařízení zpracovávat při opětovném zřízení jiné služby IoT Hub.
Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>
.
Cesta k souboru obsahujícímu sekundární certifikát.
Sekundární symetrický sdílený přístupový klíč uložený ve formátu base64.
Adresa URL webhooku funkce Azure Functions používaná pro vlastní žádosti o přidělení.
Globální parametry
Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.
Zobrazte tuto zprávu nápovědy a ukončete ji.
Zobrazují se pouze chyby, potlačení upozornění.
Výstupní formát
Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.
Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID
.
Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.