Sdílet prostřednictvím


az iot hub

Poznámka:

Tato skupina příkazů obsahuje příkazy, které jsou definované v Azure CLI i alespoň v jednom rozšíření. Nainstalujte každé rozšíření, abyste mohli využívat své rozšířené funkce. Přečtěte si další informace o rozšířeních.

Správa center Azure IoT

Příkazy

Name Description Typ Stav
az iot hub certificate

Správa certifikátů služby IoT Hub

Jádro a rozšíření GA
az iot hub certificate create

Vytvoření nebo nahrání certifikátu služby Azure IoT Hub

Základ GA
az iot hub certificate delete

Odstraní certifikát Azure IoT Hubu.

Základ GA
az iot hub certificate generate-verification-code

Vygeneruje ověřovací kód pro certifikát Azure IoT Hubu.

Základ GA
az iot hub certificate list

Zobrazí seznam všech certifikátů obsažených v Azure IoT Hubu.

Základ GA
az iot hub certificate root-authority

Umožňuje spravovat kořenovou autoritu certifikátu pro instanci ioT Hubu.

Rozšíření Zastaralé
az iot hub certificate root-authority set

Nastavte kořenovou autoritu certifikátu pro instanci ioT Hubu na konkrétní verzi.

Rozšíření Zastaralé
az iot hub certificate root-authority show

Zobrazí aktuální kořenovou autoritu certifikátu pro instanci ioT Hubu.

Rozšíření Zastaralé
az iot hub certificate show

Zobrazuje informace o konkrétním certifikátu služby Azure IoT Hub.

Základ GA
az iot hub certificate update

Aktualizujte certifikát služby Azure IoT Hub.

Základ GA
az iot hub certificate verify

Ověřuje certifikát služby Azure IoT Hub.

Základ GA
az iot hub configuration

Správa konfigurace automatické správy zařízení IoT ve velkém

Rozšíření GA
az iot hub configuration create

Vytvořte v cílové službě IoT Hub konfiguraci automatické správy zařízení IoT.

Rozšíření GA
az iot hub configuration delete

Odstraňte konfiguraci zařízení IoT.

Rozšíření GA
az iot hub configuration list

Výpis konfigurací automatické správy zařízení IoT ve službě IoT Hub

Rozšíření GA
az iot hub configuration show

Získejte podrobnosti o konfiguraci automatické správy zařízení IoT.

Rozšíření GA
az iot hub configuration show-metric

Vyhodnoťte cílovou metriku uživatele nebo systému definovanou v konfiguraci zařízení IoT.

Rozšíření GA
az iot hub configuration update

Aktualizujte zadané vlastnosti konfigurace automatické správy zařízení IoT.

Rozšíření GA
az iot hub connection-string

Správa připojovací řetězec ioT Hubu

Rozšíření GA
az iot hub connection-string show

Zobrazte připojovací řetězec pro zadané služby IoT Hubs s použitím daného názvu a klíče zásady.

Rozšíření GA
az iot hub consumer-group

Spravujte skupiny příjemců centra událostí centra IoT.

Základ GA
az iot hub consumer-group create

Vytvořte skupinu příjemců centra událostí.

Základ GA
az iot hub consumer-group delete

Odstraňte skupinu příjemců centra událostí.

Základ GA
az iot hub consumer-group list

Vypíše skupiny příjemců centra událostí.

Základ GA
az iot hub consumer-group show

Získejte podrobnosti o skupině příjemců centra událostí.

Základ GA
az iot hub create

Vytvořte centrum Azure IoT.

Základ GA
az iot hub delete

Odstranění ioT Hubu

Základ GA
az iot hub device-identity

Správa zařízení IoT

Rozšíření GA
az iot hub device-identity children

Správa vztahů podřízených zařízení pro hraniční zařízení IoT

Rozšíření GA
az iot hub device-identity children add

Přidejte zařízení jako podřízená zařízení do cílového hraničního zařízení.

Rozšíření GA
az iot hub device-identity children list

Vypíše kolekci přiřazených podřízených zařízení.

Rozšíření GA
az iot hub device-identity children remove

Odeberte podřízená zařízení z cílového hraničního zařízení.

Rozšíření GA
az iot hub device-identity connection-string

Správa připojovací řetězec zařízení IoT

Rozšíření GA
az iot hub device-identity connection-string show

Zobrazí danou připojovací řetězec zařízení IoT Hubu.

Rozšíření GA
az iot hub device-identity create

Vytvořte zařízení ve službě IoT Hub.

Rozšíření GA
az iot hub device-identity delete

Odstraňte zařízení IoT Hubu.

Rozšíření GA
az iot hub device-identity export

Exportujte všechny identity zařízení ze služby IoT Hub do kontejneru objektů blob služby Azure Storage.

Rozšíření GA
az iot hub device-identity import

Importujte identity zařízení do IoT Hubu z objektu blob kontejneru úložiště.

Rozšíření GA
az iot hub device-identity list

Zobrazení seznamu zařízení ve službě IoT Hub

Rozšíření GA
az iot hub device-identity parent

Správa vztahů nadřazených zařízení pro zařízení IoT

Rozšíření GA
az iot hub device-identity parent set

Nastavte nadřazené zařízení cílového zařízení.

Rozšíření GA
az iot hub device-identity parent show

Získejte nadřazené zařízení cílového zařízení.

Rozšíření GA
az iot hub device-identity renew-key

Obnovte cílové klíče zařízení IoT Hubu s ověřováním SAS.

Rozšíření GA
az iot hub device-identity show

Získejte podrobnosti o zařízení IoT Hubu.

Rozšíření GA
az iot hub device-identity update

Aktualizujte zařízení IoT Hubu.

Rozšíření GA
az iot hub device-twin

Správa konfigurace dvojčete zařízení IoT

Rozšíření GA
az iot hub device-twin list

Vypíše dvojčata zařízení ve službě IoT Hub.

Rozšíření GA
az iot hub device-twin replace

Nahraďte definici dvojčete zařízení cílovým kódem JSON.

Rozšíření GA
az iot hub device-twin show

Získejte definici dvojčete zařízení.

Rozšíření GA
az iot hub device-twin update

Aktualizujte požadované vlastnosti a značky dvojčete zařízení.

Rozšíření GA
az iot hub devicestream

Správa datových proudů zařízení centra IoT

Základ Náhled
az iot hub devicestream show

Získejte koncové body datových proudů zařízení služby IoT Hub.

Základ Náhled
az iot hub digital-twin

Manipulace s digitálním dvojčetem zařízení IoT Hub a interakce s ním

Rozšíření GA
az iot hub digital-twin invoke-command

Vyvolání příkazu na úrovni kořenového adresáře nebo komponenty zařízení digitálního dvojčete

Rozšíření GA
az iot hub digital-twin show

Zobrazení digitálního dvojčete zařízení IoT Hubu

Rozšíření GA
az iot hub digital-twin update

Aktualizujte vlastnosti pro čtení a zápis zařízení digitálního dvojčete pomocí specifikace opravy JSON.

Rozšíření GA
az iot hub distributed-tracing

Umožňuje spravovat distribuovaná nastavení pro jednotlivá zařízení.

Rozšíření Náhled
az iot hub distributed-tracing show

Získejte nastavení distribuovaného trasování pro zařízení.

Rozšíření Náhled
az iot hub distributed-tracing update

Aktualizujte možnosti distribuovaného trasování pro zařízení.

Rozšíření Náhled
az iot hub generate-sas-token

Vygenerujte token SAS pro cílový IoT Hub, zařízení nebo modul.

Rozšíření GA
az iot hub identity

Správa identit centra Azure IoT

Základ GA
az iot hub identity assign

Přiřaďte spravované identity ke službě IoT Hub.

Základ GA
az iot hub identity remove

Odeberte spravované identity ze služby IoT Hub.

Základ GA
az iot hub identity show

Zobrazí vlastnosti identity ioT Hubu.

Základ GA
az iot hub invoke-device-method

Vyvolá metodu zařízení.

Rozšíření GA
az iot hub invoke-module-method

Vyvolání metody modulu

Rozšíření GA
az iot hub job

Správa úloh IoT Hubu (v2)

Rozšíření GA
az iot hub job cancel

Zrušení úlohy IoT Hubu

Rozšíření GA
az iot hub job create

Vytvoření a naplánování úlohy IoT Hubu pro spuštění

Rozšíření GA
az iot hub job list

Výpis historických úloh ioT Hubu

Rozšíření GA
az iot hub job show

Zobrazení podrobností o existující úloze IoT Hubu

Rozšíření GA
az iot hub list

Výpis center IoT

Základ GA
az iot hub list-skus

Seznam dostupných cenových úrovní

Základ GA
az iot hub manual-failover

Zahajte ruční převzetí služeb při selhání pro IoT Hub do geograficky spárované oblasti zotavení po havárii.

Základ GA
az iot hub message-endpoint

Správa vlastních koncových bodů centra IoT

Rozšíření Náhled
az iot hub message-endpoint create

Přidání koncového bodu do IoT Hubu

Rozšíření Náhled
az iot hub message-endpoint create cosmosdb-container

Přidejte koncový bod kontejneru Cosmos DB pro IoT Hub.

Rozšíření Náhled
az iot hub message-endpoint create eventhub

Přidejte koncový bod centra událostí pro IoT Hub.

Rozšíření Náhled
az iot hub message-endpoint create servicebus-queue

Přidejte koncový bod fronty služby Service Bus pro IoT Hub.

Rozšíření Náhled
az iot hub message-endpoint create servicebus-topic

Přidání koncového bodu tématu služby Service Bus pro IoT Hub

Rozšíření Náhled
az iot hub message-endpoint create storage-container

Přidejte koncový bod kontejneru úložiště pro IoT Hub.

Rozšíření Náhled
az iot hub message-endpoint delete

Odstraňte všechny nebo konkrétní koncové body pro IoT Hub.

Rozšíření Náhled
az iot hub message-endpoint list

Získejte informace o všech koncových bodech pro IoT Hub.

Rozšíření Náhled
az iot hub message-endpoint show

Získejte informace o zmíněném koncovém bodu pro IoT Hub.

Rozšíření Náhled
az iot hub message-endpoint update

Aktualizujte vlastnosti existujícího koncového bodu pro IoT Hub.

Rozšíření Náhled
az iot hub message-endpoint update cosmosdb-container

Aktualizujte vlastnosti existujícího koncového bodu kontejneru Cosmos DB pro IoT Hub.

Rozšíření Náhled
az iot hub message-endpoint update eventhub

Aktualizujte vlastnosti existujícího koncového bodu centra událostí pro IoT Hub.

Rozšíření Náhled
az iot hub message-endpoint update servicebus-queue

Aktualizujte vlastnosti existujícího koncového bodu fronty služby Service Bus pro IoT Hub.

Rozšíření Náhled
az iot hub message-endpoint update servicebus-topic

Aktualizujte vlastnosti existujícího koncového bodu tématu služby Service Bus pro IoT Hub.

Rozšíření Náhled
az iot hub message-endpoint update storage-container

Aktualizujte vlastnosti existujícího koncového bodu kontejneru úložiště pro IoT Hub.

Rozšíření Náhled
az iot hub message-enrichment

Správa rozšiřování zpráv pro koncové body ioT Hubu

Základ GA
az iot hub message-enrichment create

Vytvořte rozšiřování zpráv pro vybrané koncové body ve službě IoT Hub.

Základ GA
az iot hub message-enrichment delete

Odstranění rozšiřování zpráv ve službě IoT Hub (podle klíče)

Základ GA
az iot hub message-enrichment list

Získejte informace o všech rozšířeních zpráv pro ioT Hub.

Základ GA
az iot hub message-enrichment update

Aktualizace rozšiřování zpráv ve službě IoT Hub (podle klíče)

Základ GA
az iot hub message-route

Správa tras centra IoT

Rozšíření Náhled
az iot hub message-route create

Přidejte trasu pro IoT Hub.

Rozšíření Náhled
az iot hub message-route delete

Odstraňte všechny trasy nebo uvedenou trasu ve službě IoT Hub.

Rozšíření Náhled
az iot hub message-route fallback

Spravujte náhradní trasu centra IoT.

Rozšíření Náhled
az iot hub message-route fallback set

Povolte nebo zakažte náhradní trasu ve službě IoT Hub.

Rozšíření Náhled
az iot hub message-route fallback show

Zobrazí náhradní trasu ioT Hubu.

Rozšíření Náhled
az iot hub message-route list

Získejte všechny trasy ve službě IoT Hub.

Rozšíření Náhled
az iot hub message-route show

Získejte informace o trase ve službě IoT Hub.

Rozšíření Náhled
az iot hub message-route test

Otestujte všechny trasy nebo uvedenou trasu ve službě IoT Hub.

Rozšíření Náhled
az iot hub message-route update

Aktualizujte trasu pro IoT Hub.

Rozšíření Náhled
az iot hub module-identity

Správa modulů zařízení IoT

Rozšíření GA
az iot hub module-identity connection-string

Správa připojovací řetězec modulu zařízení IoT

Rozšíření GA
az iot hub module-identity connection-string show

Zobrazení cílového modulu zařízení IoT připojovací řetězec

Rozšíření GA
az iot hub module-identity create

Vytvořte modul na cílovém zařízení IoT ve službě IoT Hub.

Rozšíření GA
az iot hub module-identity delete

Odstranění zařízení ve službě IoT Hub

Rozšíření GA
az iot hub module-identity list

Výpis modulů umístěných na zařízení IoT ve službě IoT Hub

Rozšíření GA
az iot hub module-identity renew-key

Obnovte cílové klíče modulu zařízení IoT Hubu s ověřováním SAS.

Rozšíření GA
az iot hub module-identity show

Získejte podrobnosti o modulu zařízení IoT ve službě IoT Hub.

Rozšíření GA
az iot hub module-identity update

Aktualizace modulu zařízení ioT Hubu

Rozšíření GA
az iot hub module-twin

Správa konfigurace dvojčete zařízení IoT

Rozšíření GA
az iot hub module-twin replace

Nahraďte definici dvojčete modulu cílovým kódem JSON.

Rozšíření GA
az iot hub module-twin show

Zobrazí definici dvojčete modulu.

Rozšíření GA
az iot hub module-twin update

Aktualizujte požadované vlastnosti a značky dvojčete modulu.

Rozšíření GA
az iot hub monitor-events

Monitorujte telemetrii zařízení a zprávy odeslané do IoT Hubu.

Rozšíření GA
az iot hub monitor-feedback

Sledujte zpětnou vazbu odesílanou zařízeními a potvrďte zprávy typu cloud-zařízení (C2D).

Rozšíření GA
az iot hub policy

Správa zásad sdíleného přístupu centra IoT

Základ GA
az iot hub policy create

Vytvořte novou zásadu sdíleného přístupu v centru IoT.

Základ GA
az iot hub policy delete

Odstraňte ze služby IoT Hub zásady sdíleného přístupu.

Základ GA
az iot hub policy list

Zobrazení seznamu zásad sdíleného přístupu centra IoT

Základ GA
az iot hub policy renew-key

Znovu vygenerujte klíče zásad sdíleného přístupu centra IoT.

Základ GA
az iot hub policy show

Získejte podrobnosti o zásadách sdíleného přístupu centra IoT.

Základ GA
az iot hub query

Dotazování ioT Hubu pomocí výkonného jazyka podobného SQL

Rozšíření GA
az iot hub route

Správa tras centra IoT

Základ Zastaralé
az iot hub route create

Vytvořte trasu ve službě IoT Hub.

Základ Zastaralé
az iot hub route delete

Odstraňte všechny nebo uvedené trasy pro službu IoT Hub.

Základ Zastaralé
az iot hub route list

Získejte všechny trasy ve službě IoT Hub.

Základ Zastaralé
az iot hub route show

Získejte informace o trase ve službě IoT Hub.

Základ Zastaralé
az iot hub route test

Otestujte všechny trasy nebo uvedenou trasu ve službě IoT Hub.

Základ Zastaralé
az iot hub route update

Aktualizujte trasu ve službě IoT Hub.

Základ Zastaralé
az iot hub routing-endpoint

Správa vlastních koncových bodů centra IoT

Základ Zastaralé
az iot hub routing-endpoint create

Přidejte koncový bod do ioT Hubu.

Základ Zastaralé
az iot hub routing-endpoint delete

Odstraňte všechny nebo uvedené koncové body pro ioT Hub.

Základ Zastaralé
az iot hub routing-endpoint list

Získejte informace ovšechch

Základ Zastaralé
az iot hub routing-endpoint show

Získejte informace o zmíněném koncovém bodu pro ioT Hub.

Základ Zastaralé
az iot hub show

Získejte podrobnosti o centru IoT.

Základ GA
az iot hub show-connection-string

Zobrazení připojovací řetězec pro centrum IoT

Základ Zastaralé
az iot hub show-quota-metrics

Získejte metriky kvót pro centrum IoT.

Základ GA
az iot hub show-stats

Získejte statistiky pro centrum IoT.

Základ GA
az iot hub state

Správa stavu IoT Hubu

Rozšíření Experimentální
az iot hub state export

Exportujte stav IoT Hubu do souboru.

Rozšíření Experimentální
az iot hub state import

Importujte stav centra ze souboru do IoT Hubu.

Rozšíření Experimentální
az iot hub state migrate

Migrujte stav jednoho centra do jiného centra bez uložení do souboru.

Rozšíření Experimentální
az iot hub update

Aktualizujte metadata pro centrum IoT.

Základ GA
az iot hub wait

Počkejte na dokončení operace v instanci IoT Hubu.

Základ GA

az iot hub create

Vytvořte centrum Azure IoT.

Úvod do Azure IoT Hubu najdete v tématu https://docs.microsoft.com/azure/iot-hub/.

az iot hub create --name
                  --resource-group
                  [--c2d-max-delivery-count]
                  [--c2d-ttl]
                  [--dds {false, true}]
                  [--disable-local-auth {false, true}]
                  [--disable-module-sas {false, true}]
                  [--edr {false, true}]
                  [--fc]
                  [--fcs]
                  [--fd]
                  [--feedback-lock-duration]
                  [--feedback-ttl]
                  [--fileupload-notification-lock-duration]
                  [--fileupload-notification-max-delivery-count]
                  [--fileupload-notification-ttl]
                  [--fileupload-notifications {false, true}]
                  [--fileupload-sas-ttl]
                  [--fileupload-storage-auth-type {identityBased, keyBased}]
                  [--fileupload-storage-identity]
                  [--location]
                  [--mi-system-assigned {false, true}]
                  [--mi-user-assigned]
                  [--min-tls-version]
                  [--no-wait]
                  [--partition-count]
                  [--rd]
                  [--role]
                  [--scopes]
                  [--sku {B1, B2, B3, F1, S1, S2, S3}]
                  [--tags]
                  [--unit]

Příklady

Vytvořte IoT Hub s cenovou úrovní Free F1 v oblasti skupiny prostředků.

az iot hub create --resource-group MyResourceGroup --name MyIotHub --sku F1 --partition-count 2

Vytvořte IoT Hub s cenovou úrovní Standard S1 a 4 oddíly v oblasti westus se značkami.

az iot hub create --resource-group MyResourceGroup --name MyIotHub --location westus --tags a=b c=d

Vytvořte IoT Hub se spravovanou identitou přiřazenou systémem a přiřaďte k účtu úložiště pro vytvořenou identitu roli a obor.

az iot hub create --resource-group MyResourceGroup --name MyIotHub --location westus --mi-system-assigned --role "Storage Blob Data Contributor" --scopes {resourceId}

Vytvoření IoT Hubu s místním ověřováním, klíči SAS zařízení a klíči SAS modulu jsou všechny zakázané.

az iot hub create --resource-group MyResourceGroup --name MyIotHub --location westus --disable-local-auth --disable-device-sas --disable-module-sas

Vytvořte IoT Hub s vynucenou rezidencí dat. Tím se zakáže zotavení po havárii mezi oblastmi.

az iot hub create --resource-group MyResourceGroup --name MyIoTHub --edr

Povinné parametry

--name -n

Název ioT Hubu

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Volitelné parametry

--c2d-max-delivery-count --cdd

Kolikrát se centrum IoT pokusí do zařízení doručit zprávu typu cloud-zařízení, mezi 1 a 100.

Default value: 10
--c2d-ttl --ct

Doba, po kterou má zařízení k dispozici, než vyprší jeho platnost službou IoT Hub, je mezi 1 a 48 hodinami k dispozici.

Default value: 1
--dds --disable-device-sas

Logická hodnota označující, jestli se mají zakázat všechna zařízení (včetně hraničních zařízení, ale s výjimkou modulů) s vymezeným oborem SAS pro ověřování.

Přípustné hodnoty: false, true
--disable-local-auth --dla

Logická hodnota označující, jestli se mají zakázat klíče SAS s vymezeným oborem služby IoT Hub pro ověřování.

Přípustné hodnoty: false, true
--disable-module-sas --dms

Logická hodnota označující, jestli se mají zakázat klíče SAS s vymezeným modulem pro ověřování.

Přípustné hodnoty: false, true
--edr --enforce-data-residency

Vynucujte rezidenci dat pro tuto službu IoT Hub zakázáním zotavení po havárii mezi oblastmi. Tato vlastnost je neměnná po nastavení prostředku. K dispozici pouze ve vybraných oblastech. Další informace najdete na adrese https://aka.ms/iothubdisabledr.

Přípustné hodnoty: false, true
--fc --fileupload-storage-container-name

Název kořenového kontejneru, do kterého nahráváte soubory. Kontejner nemusí existovat, ale měl by být creatable pomocí zadaného připojovacího řetězce.

--fcs --fileupload-storage-connectionstring

Připojovací řetězec účtu služby Azure Storage, do kterého se nahrají soubory.

--fd --feedback-max-delivery-count

Počet pokusů centra IoT o doručení zprávy do fronty zpětné vazby mezi 1 a 100.

Default value: 10
--feedback-lock-duration --fld

Doba trvání uzamčení fronty zpětné vazby mezi 5 a 300 sekundy.

Default value: 5
--feedback-ttl --ft

Doba, po kterou bude Centrum IoT uchovávat zpětnou vazbu k vypršení platnosti nebo doručování zpráv typu cloud-zařízení, mezi 1 a 48 hodinami.

Default value: 1
--fileupload-notification-lock-duration --fnld

Doba trvání uzamčení fronty oznámení nahrání souboru mezi 5 a 300 sekundy.

Default value: 5
--fileupload-notification-max-delivery-count --fnd

Kolikrát se centrum IoT pokusí doručit zprávu s oznámením o souboru v rozsahu 1 až 100.

Default value: 10
--fileupload-notification-ttl --fnt

Doba, po kterou je pro službu k dispozici oznámení o nahrání souboru, než služba IoT Hub vyprší, mezi 1 a 48 hodinami.

Default value: 1
--fileupload-notifications --fn

Logická hodnota označující, jestli se mají protokolovat informace o nahraných souborech do koncového bodu ioT Hubu pro zprávy, služby servicebound nebo filenotifications.

Přípustné hodnoty: false, true
Default value: False
--fileupload-sas-ttl --fst

Doba, po kterou je identifikátor URI SAS vygenerovaný službou IoT Hub platný před vypršením jeho platnosti, mezi 1 a 24 hodinami.

Default value: 1
--fileupload-storage-auth-type --fsa

Typ ověřování pro účet Azure Storage, do kterého se nahrají soubory.

Přípustné hodnoty: identityBased, keyBased
--fileupload-storage-identity --fsi

Spravovaná identita, která se má použít k ověřování nahrávání souborů. Pomocí [system] můžete odkazovat na spravovanou identitu přiřazenou systémem nebo ID prostředku a odkazovat na spravovanou identitu přiřazenou uživatelem.

--location -l

Umístění ioT Hubu Výchozí hodnota je umístění cílové skupiny prostředků.

--mi-system-assigned

Povolte spravovanou identitu přiřazenou systémem pro toto centrum.

Přípustné hodnoty: false, true
--mi-user-assigned

Povolte spravované identity přiřazené uživatelem pro toto centrum. Přijměte seznam ID prostředků identity oddělených mezerami.

--min-tls-version --mintls

Zadejte minimální verzi protokolu TLS, která se má pro toto centrum podporovat. Můžete nastavit na 1.2, aby klienti, kteří používají protokol TLS verze nižší než 1.2, mohli odmítnout.

--no-wait

Nečekejte na dokončení dlouhotrvající operace.

Default value: False
--partition-count

Počet oddílů backingového centra událostí pro zprávy typu zařízení-cloud

Default value: 4
--rd --retention-day

Určuje, jak dlouho bude centrum IoT udržovat události typu zařízení-cloud mezi 1 a 7 dny.

Default value: 1
--role

Role, která se přiřadí spravované identitě přiřazené systémem centra

--scopes

Seznam oborů oddělených mezerami pro přiřazení role (-role) pro spravovanou identitu přiřazenou systémem

--sku

Cenová úroveň pro Azure IoT Hub Všimněte si, že v každém předplatném je povolená pouze jedna bezplatná instance ioT Hubu (F1). Pokud volné instance překročí jednu, vyvolá se výjimka.

Přípustné hodnoty: B1, B2, B3, F1, S1, S2, S3
Default value: S1
--tags

Značky oddělené mezerami: klíč[=hodnota] [klíč[=hodnota] ...]. K vymazání existujících značek použijte "".

--unit

Jednotky ve službě IoT Hub

Default value: 1
Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az iot hub delete

Odstranění ioT Hubu

az iot hub delete [--ids]
                  [--name]
                  [--no-wait]
                  [--resource-group]
                  [--subscription]

Příklady

Odstranění ioT Hubu (automaticky vygenerováno)

az iot hub delete --name MyIoTHub --resource-group MyResourceGroup

Volitelné parametry

--ids

Jedno nebo více ID prostředků (oddělených mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat argumenty --ids nebo jiné argumenty ID prostředku.

--name -n

Název ioT Hubu

--no-wait

Nečekejte na dokončení dlouhotrvající operace.

Default value: False
--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az iot hub generate-sas-token

Vygenerujte token SAS pro cílový IoT Hub, zařízení nebo modul.

U tokenů SAS zařízení se parametr zásad používá pouze pro přístup k registru zařízení. Proto by zásady měly mít k registru přístup pro čtení. Pro tokeny IoT Hubu je zásada součástí SAS.

az iot hub generate-sas-token [--auth-type {key, login}]
                              [--connection-string]
                              [--device-id]
                              [--du]
                              [--hub-name]
                              [--key-type {primary, secondary}]
                              [--login]
                              [--module-id]
                              [--pn]
                              [--resource-group]

Příklady

Vygenerujte token SAS služby IoT Hub pomocí zásad iothubowner a primárního klíče.

az iot hub generate-sas-token -n {iothub_name}

Vygenerujte token SAS služby IoT Hub pomocí zásad registruRead a sekundárního klíče.

az iot hub generate-sas-token -n {iothub_name} --policy registryRead --key-type secondary

Vygenerujte token SAS zařízení pomocí zásad iothubowner pro přístup k registru zařízení {iothub_name}.

az iot hub generate-sas-token -d {device_id} -n {iothub_name}

Generování tokenu SAS zařízení pomocí připojovací řetězec ioT Hubu (s přístupem k registru)

az iot hub generate-sas-token -d {device_id} --login 'HostName=myhub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

Generování tokenu SAS služby Iot Hub pomocí připojovací řetězec IoT Hubu

az iot hub generate-sas-token --connection-string 'HostName=myhub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

Generování tokenu SAS zařízení pomocí připojovací řetězec zařízení

az iot hub generate-sas-token --connection-string 'HostName=myhub.azure-devices.net;DeviceId=mydevice;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

Generování tokenu SAS modulu pomocí modulu připojovací řetězec

az iot hub generate-sas-token --connection-string 'HostName=myhub.azure-devices.net;DeviceId=mydevice;ModuleId=mymodule;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

Volitelné parametry

--auth-type

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 iothub-data-auth-type=<auth-type-value>.

Přípustné hodnoty: key, login
Default value: key
--connection-string --cs

Cílová připojovací řetězec. Tento postup obchází registr služby IoT Hub a vygeneruje token SAS přímo ze zadaného symetrického klíče bez dalšího ověření. Všechny ostatní parametry příkazu kromě doby trvání budou ignorovány. Podporované typy připojovací řetězec: Iot Hub, Device, Module.

--device-id -d

ID cílového zařízení.

--du --duration

Platná doba trvání tokenu v sekundách

Default value: 3600
--hub-name -n

Název nebo název hostitele služby IoT Hub Vyžaduje se, pokud není zadané --login.

--key-type --kt

Typ klíče zásad sdíleného přístupu pro ověřování

Přípustné hodnoty: primary, secondary
Default value: primary
--login -l

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 --hub-name.

--module-id -m

ID cílového modulu.

--pn --policy-name

Zásady sdíleného přístupu s oprávněními operace pro cílovou entitu IoT Hubu

Default value: iothubowner
--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az iot hub invoke-device-method

Vyvolá metodu zařízení.

az iot hub invoke-device-method --device-id
                                --method-name
                                [--auth-type {key, login}]
                                [--hub-name]
                                [--login]
                                [--method-payload]
                                [--resource-group]
                                [--timeout]

Příklady

Vyvolá přímou metodu na zařízení.

az iot hub invoke-device-method --hub-name {iothub_name} --device-id {device_id} --method-name Reboot --method-payload '{"version":"1.0"}'

Povinné parametry

--device-id -d

ID cílového zařízení.

--method-name --mn

Cílová metoda pro vyvolání

Volitelné parametry

--auth-type

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 iothub-data-auth-type=<auth-type-value>.

Přípustné hodnoty: key, login
Default value: key
--hub-name -n

Název nebo název hostitele služby IoT Hub Vyžaduje se, pokud není zadané --login.

--login -l

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 --hub-name.

--method-payload --mp

Datová část JSON, která se má předat metodě. Musí to být cesta k souboru nebo nezpracovaný json.

Default value: {}
--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--timeout --to

Maximální počet sekund čekání na výsledek metody zařízení

Default value: 30
Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az iot hub invoke-module-method

Vyvolání metody modulu

Tento příkaz podporuje moduly hraničních i jiných zařízení.

az iot hub invoke-module-method --device-id
                                --method-name
                                --module-id
                                [--auth-type {key, login}]
                                [--hub-name]
                                [--login]
                                [--method-payload]
                                [--resource-group]
                                [--timeout]

Příklady

Vyvolá přímou metodu v modulu hraničního zařízení.

az iot hub invoke-module-method -n {iothub_name} -d {device_id} -m '$edgeAgent' --method-name 'RestartModule' --method-payload '{"schemaVersion": "1.0"}'

Povinné parametry

--device-id -d

ID cílového zařízení.

--method-name --mn

Cílová metoda pro vyvolání

--module-id -m

ID cílového modulu.

Volitelné parametry

--auth-type

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 iothub-data-auth-type=<auth-type-value>.

Přípustné hodnoty: key, login
Default value: key
--hub-name -n

Název nebo název hostitele služby IoT Hub Vyžaduje se, pokud není zadané --login.

--login -l

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 --hub-name.

--method-payload --mp

Datová část JSON, která se má předat metodě. Musí to být cesta k souboru nebo nezpracovaný json.

Default value: {}
--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--timeout --to

Maximální počet sekund čekání na výsledek metody modulu

Default value: 30
Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az iot hub list

Výpis center IoT

az iot hub list [--resource-group]

Příklady

Zobrazí seznam všech center IoT v předplatném.

az iot hub list

Výpis všech center IoT ve skupině prostředků MyGroup

az iot hub list --resource-group MyGroup

Volitelné parametry

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az iot hub list-skus

Seznam dostupných cenových úrovní

az iot hub list-skus [--ids]
                     [--name]
                     [--resource-group]
                     [--subscription]

Příklady

Seznam dostupných cenových úrovní (automaticky vygenerováno)

az iot hub list-skus --name MyIoTHub

Volitelné parametry

--ids

Jedno nebo více ID prostředků (oddělených mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat argumenty --ids nebo jiné argumenty ID prostředku.

--name -n

Název ioT Hubu

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az iot hub manual-failover

Zahajte ruční převzetí služeb při selhání pro IoT Hub do geograficky spárované oblasti zotavení po havárii.

az iot hub manual-failover [--ids]
                           [--name]
                           [--no-wait]
                           [--resource-group]
                           [--subscription]

Příklady

Zahájení převzetí služeb při selhání z primární do sekundární oblasti

az iot hub manual-failover -n myhub

Volitelné parametry

--ids

Jedno nebo více ID prostředků (oddělených mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat argumenty --ids nebo jiné argumenty ID prostředku.

--name -n

Název ioT Hubu

--no-wait

Nečekejte na dokončení dlouhotrvající operace.

Default value: False
--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az iot hub monitor-events

Monitorujte telemetrii zařízení a zprávy odeslané do IoT Hubu.

Tento příkaz spoléhá na závislý balíček Cython (uamqp) a při prvním spuštění může nainstalovat závislý balíček Cython. https://github.com/Azure/azure-uamqp-python

Poznámka: Událost se zobrazí i v případě, že text zprávy není dekódovatelný, v tomto případě se část datové části události zobrazí jako {{nekódovatelná datová část}} se zbývajícími dostupnými vlastnostmi události.

az iot hub monitor-events [--cg]
                          [--content-type]
                          [--device-id]
                          [--device-query]
                          [--enqueued-time]
                          [--hub-name]
                          [--interface]
                          [--login]
                          [--mc]
                          [--module-id]
                          [--properties {all, anno, app, sys}]
                          [--repair {false, true}]
                          [--resource-group]
                          [--timeout]
                          [--yes {false, true}]

Příklady

Základní použití

az iot hub monitor-events -n {iothub_name}

Základní použití se službou IoT Hub připojovací řetězec

az iot hub monitor-events -n {iothub_name} --login 'HostName=myhub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

Základní použití při filtrování na cílovém zařízení

az iot hub monitor-events -n {iothub_name} -d {device_id}

Základní použití při filtrování cílových zařízení se zástupným znakem v ID

az iot hub monitor-events -n {iothub_name} -d Device*

Filtrování zařízení pomocí dotazovacího jazyka služby IoT Hub

az iot hub monitor-events -n {iothub_name} -q "select * from devices where tags.location.region = 'US'"

Vyfiltrujte zařízení a zadejte skupinu příjemců centra událostí, ke které se má vytvořit vazba.

az iot hub monitor-events -n {iothub_name} -d {device_id} --cg {consumer_group_name}

Příjem poznámek ke zprávám (záhlaví zpráv)

az iot hub monitor-events -n {iothub_name} -d {device_id} --properties anno

Příjem poznámek zpráv + systémových vlastností Nikdy nevypadá časový limit.

az iot hub monitor-events -n {iothub_name} -d {device_id} --properties anno sys --timeout 0

Příjem všech atributů zpráv ze všech zpráv zařízení

az iot hub monitor-events -n {iothub_name} --props all

Příjem všech zpráv a analýza datové části zpráv jako JSON

az iot hub monitor-events -n {iothub_name} --content-type application/json

Přijme zadaný počet zpráv z centra a vypne se.

az iot hub monitor-events -n {iothub_name} --message-count {message_count}

Volitelné parametry

--cg --consumer-group -c

Zadejte skupinu příjemců, která se má použít při připojování ke koncovému bodu centra událostí.

Default value: $Default
--content-type --ct

Zadejte typ obsahu datové části zprávy, který automaticky naformátuje výstup na tento typ.

--device-id -d

ID cílového zařízení.

--device-query -q

Zadejte vlastní dotaz pro filtrování zařízení.

--enqueued-time --et -e

Označuje čas, který se má použít jako výchozí bod pro čtení zpráv z oddílů. Jednotky jsou milisekundy od epochy unixu. Pokud není čas označený jako "nyní".

--hub-name -n

Název nebo název hostitele služby IoT Hub Vyžaduje se, pokud není zadané --login.

--interface -i

Identifikátor cílového rozhraní pro filtrování. Příklad: dtmi:com:example:TemperatureController;1.

--login -l

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 --hub-name.

--mc --message-count

Počet zpráv telemetrie, které se mají zachytit před ukončením monitorování Pokud není zadaný, monitor se pořád spouští, dokud nedosahuje prahové hodnoty časového limitu příjmu zpráv z centra.

--module-id -m

ID cílového modulu.

--properties --props -p

Označte vlastnosti klíčové zprávy k výstupu. sys = systémové vlastnosti, app = vlastnosti aplikace, anno = poznámky.

Přípustné hodnoty: all, anno, app, sys
--repair -r

Přeinstalujte závislost uamqp kompatibilní s verzí rozšíření. Výchozí hodnota: false.

Přípustné hodnoty: false, true
Default value: False
--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--timeout --to -t

Maximální počet sekund pro zachování připojení bez přijetí zprávy Použijte 0 pro nekonečno.

Default value: 300
--yes -y

Přeskočte výzvy uživatele. Označuje přijetí akce. Používá se především pro scénáře automatizace. Výchozí hodnota: false.

Přípustné hodnoty: false, true
Default value: False
Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az iot hub monitor-feedback

Sledujte zpětnou vazbu odesílanou zařízeními a potvrďte zprávy typu cloud-zařízení (C2D).

Tento příkaz spoléhá na závislý balíček Cython (uamqp) a při prvním spuštění může nainstalovat závislý balíček Cython. https://github.com/Azure/azure-uamqp-python.

az iot hub monitor-feedback [--auth-type {key, login}]
                            [--device-id]
                            [--hub-name]
                            [--login]
                            [--repair {false, true}]
                            [--resource-group]
                            [--wait-on-msg]
                            [--yes {false, true}]

Příklady

Základní použití

az iot hub monitor-feedback -n {iothub_name}

Základní použití se službou IoT Hub připojovací řetězec

az iot hub monitor-feedback -n {iothub_name} --login 'HostName=myhub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

Základní použití při filtrování na cílovém zařízení

az iot hub monitor-feedback -n {iothub_name} -d {device_id}

Ukončení monitorování zpětné vazby při přijetí zprávy s konkrétním ID (uuid)

az iot hub monitor-feedback -n {iothub_name} -d {device_id} -w {message_id}

Volitelné parametry

--auth-type

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 iothub-data-auth-type=<auth-type-value>.

Přípustné hodnoty: key, login
Default value: key
--device-id -d

ID cílového zařízení.

--hub-name -n

Název nebo název hostitele služby IoT Hub Vyžaduje se, pokud není zadané --login.

--login -l

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 --hub-name.

--repair -r

Přeinstalujte závislost uamqp kompatibilní s verzí rozšíření. Výchozí hodnota: false.

Přípustné hodnoty: false, true
Default value: False
--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--wait-on-msg -w

Monitorování zpětné vazby se zablokuje, dokud se neobdrží zpráva s konkrétním ID (uuid).

--yes -y

Přeskočte výzvy uživatele. Označuje přijetí akce. Používá se především pro scénáře automatizace. Výchozí hodnota: false.

Přípustné hodnoty: false, true
Default value: False
Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az iot hub query

Dotazování ioT Hubu pomocí výkonného jazyka podobného SQL

Načtěte informace týkající se dvojčat zařízení a modulů, úloh a směrování zpráv. Další informace naleznete v tématu https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language.

az iot hub query --query-command
                 [--auth-type {key, login}]
                 [--hub-name]
                 [--login]
                 [--resource-group]
                 [--top]

Příklady

Dotazování na všechna data dvojčete zařízení v Azure IoT Hubu

az iot hub query -n {iothub_name} -q "select * from devices"

Dotazování na všechna data dvojčete modulu na cílovém zařízení

az iot hub query -n {iothub_name} -q "select * from devices.modules where devices.deviceId = '{device_id}'"

Povinné parametry

--query-command -q

Uživatelský dotaz, který se má spustit.

Volitelné parametry

--auth-type

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 iothub-data-auth-type=<auth-type-value>.

Přípustné hodnoty: key, login
Default value: key
--hub-name -n

Název nebo název hostitele služby IoT Hub Vyžaduje se, pokud není zadané --login.

--login -l

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 --hub-name.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--top

Maximální počet prvků, které se mají vrátit. Ve výchozím nastavení dotaz nemá žádný limit.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az iot hub show

Získejte podrobnosti o centru IoT.

az iot hub show [--ids]
                [--name]
                [--resource-group]
                [--subscription]

Příklady

Získejte podrobnosti o centru IoT. (automaticky vygenerováno)

az iot hub show --name MyIoTHub

Volitelné parametry

--ids

Jedno nebo více ID prostředků (oddělených mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat argumenty --ids nebo jiné argumenty ID prostředku.

--name -n

Název ioT Hubu

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az iot hub show-connection-string

Zastaralé

Tento příkaz je zastaralý a v budoucí verzi se odebere. Místo toho použijte příkaz connection-string rozšíření IoT (azure-iot) (az iot hub connection-string show).

Zobrazení připojovací řetězec pro centrum IoT

az iot hub show-connection-string [--all]
                                  [--hub-name]
                                  [--ids]
                                  [--key {primary, secondary}]
                                  [--policy-name]
                                  [--resource-group]
                                  [--subscription]

Příklady

Zobrazení připojovací řetězec centra IoT pomocí výchozích zásad a primárního klíče

az iot hub show-connection-string --name MyIotHub

Zobrazení připojovací řetězec ioT Hubu pomocí zásad service a sekundárního klíče

az iot hub show-connection-string --name MyIotHub --policy-name service --key secondary

Zobrazení připojovací řetězec pro všechny centra IoT ve skupině prostředků.

az iot hub show-connection-string --resource-group MyResourceGroup

Zobrazí připojovací řetězec pro všechna centra IoT v předplatném.

az iot hub show-connection-string

Zobrazení připojovací řetězec pro centrum IoT (automaticky vygenerováno)

az iot hub show-connection-string --key primary --policy-name MyPolicy

Volitelné parametry

--all

Povolit zobrazení všech zásad sdíleného přístupu

Default value: False
--hub-name --name -n

Název ioT Hubu

--ids

Jedno nebo více ID prostředků (oddělených mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat argumenty --ids nebo jiné argumenty ID prostředku.

--key

Klíč, který se má použít.

Přípustné hodnoty: primary, secondary
Default value: primary
--policy-name

Zásady sdíleného přístupu, které se mají použít.

Default value: iothubowner
--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az iot hub show-quota-metrics

Získejte metriky kvót pro centrum IoT.

az iot hub show-quota-metrics [--ids]
                              [--name]
                              [--resource-group]
                              [--subscription]

Příklady

Získejte metriky kvót pro centrum IoT. (automaticky vygenerováno)

az iot hub show-quota-metrics --ids {ids}

Získejte metriky kvót pro centrum IoT. (automaticky vygenerováno)

az iot hub show-quota-metrics --name MyIoTHub

Volitelné parametry

--ids

Jedno nebo více ID prostředků (oddělených mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat argumenty --ids nebo jiné argumenty ID prostředku.

--name -n

Název ioT Hubu

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az iot hub show-stats

Získejte statistiky pro centrum IoT.

az iot hub show-stats [--ids]
                      [--name]
                      [--resource-group]
                      [--subscription]

Příklady

Získejte statistiky pro centrum IoT. (automaticky vygenerováno)

az iot hub show-stats --name MyIoTHub

Volitelné parametry

--ids

Jedno nebo více ID prostředků (oddělených mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat argumenty --ids nebo jiné argumenty ID prostředku.

--name -n

Název ioT Hubu

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az iot hub update

Aktualizujte metadata pro centrum IoT.

az iot hub update [--add]
                  [--c2d-max-delivery-count]
                  [--c2d-ttl]
                  [--dds {false, true}]
                  [--disable-local-auth {false, true}]
                  [--disable-module-sas {false, true}]
                  [--fc]
                  [--fcs]
                  [--fd]
                  [--feedback-lock-duration]
                  [--feedback-ttl]
                  [--fileupload-notification-lock-duration]
                  [--fileupload-notification-max-delivery-count]
                  [--fileupload-notification-ttl]
                  [--fileupload-notifications {false, true}]
                  [--fileupload-sas-ttl]
                  [--fileupload-storage-auth-type {identityBased, keyBased}]
                  [--fileupload-storage-identity]
                  [--force-string]
                  [--ids]
                  [--name]
                  [--rd]
                  [--remove]
                  [--resource-group]
                  [--set]
                  [--sku {B1, B2, B3, F1, S1, S2, S3}]
                  [--subscription]
                  [--tags]
                  [--unit]

Příklady

Přidání nastavení kontejneru úložiště k nahrání souboru

az iot hub update --name MyIotHub --fileupload-storage-connectionstring "connection-string" \ --fileupload-storage-container-name "container_name"

Přidejte pravidlo filtru brány firewall pro příjem provozu z masky IP adresy 127.0.0.0/31.

az iot hub update --name MyIotHub --add properties.ipFilterRules filter_name=test-rule action=Accept ip_mask=127.0.0.0/31

Aktualizujte metadata pro centrum IoT. (automaticky vygenerováno)

az iot hub update --name MyIotHub --set properties.allocationPolicy="GeoLatency"

Aktualizace jednotek ioT Hubu na 2 a přidání značek

az iot hub update -n MyIotHub --unit 2 --tags a=b c=d

Aktualizace cenové úrovně pro IoT Hub jako S2

az iot hub update -n MyIotHub --sku S2

Aktualizace dnů uchovávání událostí ioT Hubu typu zařízení-cloud jako 3 dny

az iot hub update -n MyIotHub --retention-day 3

Aktualizace nastavení zasílání zpráv cloud-zařízení ve službě IoT Hub

az iot hub update --name MyIotHub --c2d-max-delivery-count 30 --c2d-ttl 5

Aktualizace nastavení fronty zpětné vazby služby IoT Hub

az iot hub update --name MyIoTHub --feedback-max-delivery-count 20 --feedback-lock-duration 100 --feedback-ttl 4

Aktualizace nastavení nahrávání souborů ioT Hubu a přiřazení spravované identity pro nahrání souboru uživateli

az iot hub update -n MyIoTHub --fileupload-sas-ttl 5 --fileupload-storage-auth-type identityBased --fileupload-storage-identity [system]

Aktualizace nastavení oznámení nahrání souboru IoT Hubu a doby trvání uzamčení fronty

az iot hub update -n MyIoTHub --fileupload-notification-max-delivery-count 50 --fileupload-notification-ttl 48 --fileupload-notifications --fileupload-notification-lock-duration 10

Aktualizace místního ověřování ioT Hubu, SAS zařízení a nastavení SAS modulu

az iot hub update -n MyIoTHub --disable-local-auth --disable-device-sas false --disable-module-sas true

Volitelné parametry

--add

Přidejte objekt do seznamu objektů zadáním párů cest a klíč-hodnota. Příklad: --add property.listProperty <key=value, string or JSON string>.

Default value: []
--c2d-max-delivery-count --cdd

Kolikrát se centrum IoT pokusí do zařízení doručit zprávu typu cloud-zařízení, mezi 1 a 100.

--c2d-ttl --ct

Doba, po kterou má zařízení k dispozici, než vyprší jeho platnost službou IoT Hub, je mezi 1 a 48 hodinami k dispozici.

--dds --disable-device-sas

Logická hodnota označující, jestli se mají zakázat všechna zařízení (včetně hraničních zařízení, ale s výjimkou modulů) s vymezeným oborem SAS pro ověřování.

Přípustné hodnoty: false, true
--disable-local-auth --dla

Logická hodnota označující, jestli se mají zakázat klíče SAS s vymezeným oborem služby IoT Hub pro ověřování.

Přípustné hodnoty: false, true
--disable-module-sas --dms

Logická hodnota označující, jestli se mají zakázat klíče SAS s vymezeným modulem pro ověřování.

Přípustné hodnoty: false, true
--fc --fileupload-storage-container-name

Název kořenového kontejneru, do kterého nahráváte soubory. Kontejner nemusí existovat, ale měl by být creatable pomocí zadaného připojovacího řetězce.

--fcs --fileupload-storage-connectionstring

Připojovací řetězec účtu služby Azure Storage, do kterého se nahrají soubory.

--fd --feedback-max-delivery-count

Počet pokusů centra IoT o doručení zprávy do fronty zpětné vazby mezi 1 a 100.

--feedback-lock-duration --fld

Doba trvání uzamčení fronty zpětné vazby mezi 5 a 300 sekundy.

--feedback-ttl --ft

Doba, po kterou bude Centrum IoT uchovávat zpětnou vazbu k vypršení platnosti nebo doručování zpráv typu cloud-zařízení, mezi 1 a 48 hodinami.

--fileupload-notification-lock-duration --fnld

Doba trvání uzamčení fronty oznámení nahrání souboru mezi 5 a 300 sekundy.

--fileupload-notification-max-delivery-count --fnd

Kolikrát se centrum IoT pokusí doručit zprávu s oznámením o souboru v rozsahu 1 až 100.

--fileupload-notification-ttl --fnt

Doba, po kterou je pro službu k dispozici oznámení o nahrání souboru, než služba IoT Hub vyprší, mezi 1 a 48 hodinami.

--fileupload-notifications --fn

Logická hodnota označující, jestli se mají protokolovat informace o nahraných souborech do koncového bodu ioT Hubu pro zprávy, služby servicebound nebo filenotifications.

Přípustné hodnoty: false, true
--fileupload-sas-ttl --fst

Doba, po kterou je identifikátor URI SAS vygenerovaný službou IoT Hub platný před vypršením jeho platnosti, mezi 1 a 24 hodinami.

--fileupload-storage-auth-type --fsa

Typ ověřování pro účet Azure Storage, do kterého se nahrají soubory.

Přípustné hodnoty: identityBased, keyBased
--fileupload-storage-identity --fsi

Spravovaná identita, která se má použít k ověřování nahrávání souborů. Pomocí [system] můžete odkazovat na spravovanou identitu přiřazenou systémem nebo ID prostředku a odkazovat na spravovanou identitu přiřazenou uživatelem.

--force-string

Při použití set nebo add zachovávejte řetězcové literály místo pokusu o převod na JSON.

Default value: False
--ids

Jedno nebo více ID prostředků (oddělených mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat argumenty --ids nebo jiné argumenty ID prostředku.

--name -n

Název ioT Hubu

--rd --retention-day

Určuje, jak dlouho bude centrum IoT udržovat události typu zařízení-cloud mezi 1 a 7 dny.

--remove

Odeberte vlastnost nebo prvek ze seznamu. Příklad: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Default value: []
--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--set

Aktualizujte objekt zadáním cesty vlastnosti a hodnoty, která se má nastavit. Příklad: --set property1.property2=<value>.

Default value: []
--sku

Cenová úroveň pro Azure IoT Hub Všimněte si, že v každém předplatném je povolená pouze jedna bezplatná instance ioT Hubu (F1). Pokud volné instance překročí jednu, vyvolá se výjimka.

Přípustné hodnoty: B1, B2, B3, F1, S1, S2, S3
--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--tags

Značky oddělené mezerami: klíč[=hodnota] [klíč[=hodnota] ...]. K vymazání existujících značek použijte "".

--unit

Jednotky ve službě IoT Hub

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az iot hub wait

Počkejte na dokončení operace v instanci IoT Hubu.

az iot hub wait [--created]
                [--custom]
                [--deleted]
                [--exists]
                [--ids]
                [--interval]
                [--name]
                [--resource-group]
                [--subscription]
                [--timeout]
                [--updated]

Příklady

Počkejte, až se vytvoří existující instance IoT Hubu.

az iot hub wait -n MyIoTHub --created

Počkejte, až se instance ioT Hubu odstraní.

az iot hub wait -n MyIoTHub --deleted

Počkejte, až má existující instance IoT Hubu aktivní stav.

az iot hub wait -n MyIoTHub --custom "properties.state=='Active'"

Volitelné parametry

--created

Počkejte na vytvoření s 'provisioningState' v 'Succeeded'.

Default value: False
--custom

Počkejte, až podmínka splňuje vlastní dotaz JMESPath. Například provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Počkejte na odstranění.

Default value: False
--exists

Počkejte, až prostředek existuje.

Default value: False
--ids

Jedno nebo více ID prostředků (oddělených mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat argumenty --ids nebo jiné argumenty ID prostředku.

--interval

Interval dotazování v sekundách

Default value: 30
--name -n

Název ioT Hubu

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--timeout

Maximální čekání v sekundách.

Default value: 3600
--updated

Počkejte, dokud se neaktualizuje stav zřizování ve stavu Úspěch.

Default value: False
Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.