az iot hub

Kommentar

Den här kommandogruppen har kommandon som definieras i både Azure CLI och minst ett tillägg. Installera varje tillägg för att dra nytta av dess utökade funktioner. Läs mer om tillägg.

Hantera Azure IoT-hubbar.

Kommandon

Name Description Typ Status
az iot hub certificate

Hantera IoT Hub-certifikat.

Kärna och tillägg Allmän tillgänglighet
az iot hub certificate create

Skapa/ladda upp ett Azure IoT Hub-certifikat.

Kärna Allmän tillgänglighet
az iot hub certificate delete

Tar bort ett Azure IoT Hub-certifikat.

Kärna Allmän tillgänglighet
az iot hub certificate generate-verification-code

Genererar en verifieringskod för ett Azure IoT Hub-certifikat.

Kärna Allmän tillgänglighet
az iot hub certificate list

Visar en lista över alla certifikat som finns i en Azure IoT Hub.

Kärna Allmän tillgänglighet
az iot hub certificate root-authority

Hantera certifikatets rotutfärdare för en IoT Hub-instans.

Anknytning Inaktuell
az iot hub certificate root-authority set

Ange certifikatets rotutfärdare för en IoT Hub-instans till en viss version.

Anknytning Inaktuell
az iot hub certificate root-authority show

Visa det aktuella certifikatets rotutfärdare för en IoT Hub-instans.

Anknytning Inaktuell
az iot hub certificate show

Visar information om ett visst Azure IoT Hub-certifikat.

Kärna Allmän tillgänglighet
az iot hub certificate update

Uppdatera ett Azure IoT Hub-certifikat.

Kärna Allmän tillgänglighet
az iot hub certificate verify

Verifierar ett Azure IoT Hub-certifikat.

Kärna Allmän tillgänglighet
az iot hub configuration

Hantera IoT-automatisk konfiguration av enhetshantering i stor skala.

Anknytning Allmän tillgänglighet
az iot hub configuration create

Skapa en IoT-konfiguration för automatisk enhetshantering i en mål-IoT Hub.

Anknytning Allmän tillgänglighet
az iot hub configuration delete

Ta bort en IoT-enhetskonfiguration.

Anknytning Allmän tillgänglighet
az iot hub configuration list

Lista IoT-konfigurationer för automatisk enhetshantering i en IoT Hub.

Anknytning Allmän tillgänglighet
az iot hub configuration show

Hämta information om en konfiguration för automatisk IoT-enhetshantering.

Anknytning Allmän tillgänglighet
az iot hub configuration show-metric

Utvärdera en målanvändare eller ett systemmått som definierats i en IoT-enhetskonfiguration.

Anknytning Allmän tillgänglighet
az iot hub configuration update

Uppdatera angivna egenskaper för en IoT-konfiguration för automatisk enhetshantering.

Anknytning Allmän tillgänglighet
az iot hub connection-string

Hantera IoT Hub-anslutningssträng.

Anknytning Allmän tillgänglighet
az iot hub connection-string show

Visa anslutningssträng för angivna IoT Hubs med det angivna principnamnet och nyckeln.

Anknytning Allmän tillgänglighet
az iot hub consumer-group

Hantera händelsehubbens konsumentgrupper för en IoT-hubb.

Kärna Allmän tillgänglighet
az iot hub consumer-group create

Skapa en händelsehubbkonsumentgrupp.

Kärna Allmän tillgänglighet
az iot hub consumer-group delete

Ta bort en händelsehubbkonsumentgrupp.

Kärna Allmän tillgänglighet
az iot hub consumer-group list

Visa en lista över konsumentgrupper för händelsehubben.

Kärna Allmän tillgänglighet
az iot hub consumer-group show

Hämta information för en händelsehubbkonsumentgrupp.

Kärna Allmän tillgänglighet
az iot hub create

Skapa en Azure IoT-hubb.

Kärna Allmän tillgänglighet
az iot hub delete

Ta bort en IoT-hubb.

Kärna Allmän tillgänglighet
az iot hub device-identity

Hantera IoT-enheter.

Anknytning Allmän tillgänglighet
az iot hub device-identity children

Hantera underordnade enhetsrelationer för IoT Edge-enheter.

Anknytning Allmän tillgänglighet
az iot hub device-identity children add

Lägg till enheter som underordnade till en målgränsenhet.

Anknytning Allmän tillgänglighet
az iot hub device-identity children list

Matar ut samlingen med tilldelade underordnade enheter.

Anknytning Allmän tillgänglighet
az iot hub device-identity children remove

Ta bort underordnade enheter från en målgränsenhet.

Anknytning Allmän tillgänglighet
az iot hub device-identity connection-string

Hantera IoT-enhetens anslutningssträng.

Anknytning Allmän tillgänglighet
az iot hub device-identity connection-string show

Visa en viss IoT Hub-enhet anslutningssträng.

Anknytning Allmän tillgänglighet
az iot hub device-identity create

Skapa en enhet i en IoT Hub.

Anknytning Allmän tillgänglighet
az iot hub device-identity delete

Ta bort en IoT Hub-enhet.

Anknytning Allmän tillgänglighet
az iot hub device-identity export

Exportera alla enhetsidentiteter från en IoT Hub till en Azure Storage-blobcontainer.

Anknytning Allmän tillgänglighet
az iot hub device-identity import

Importera enhetsidentiteter till en IoT Hub från en lagringscontainerblob.

Anknytning Allmän tillgänglighet
az iot hub device-identity list

Lista enheter i en IoT Hub.

Anknytning Allmän tillgänglighet
az iot hub device-identity parent

Hantera överordnade enhetsrelationer för IoT-enheter.

Anknytning Allmän tillgänglighet
az iot hub device-identity parent set

Ange den överordnade enheten för en målenhet.

Anknytning Allmän tillgänglighet
az iot hub device-identity parent show

Hämta den överordnade enheten för en målenhet.

Anknytning Allmän tillgänglighet
az iot hub device-identity renew-key

Förnya målnycklarna för en IoT Hub-enhet med sas-autentisering.

Anknytning Allmän tillgänglighet
az iot hub device-identity show

Hämta information om en IoT Hub-enhet.

Anknytning Allmän tillgänglighet
az iot hub device-identity update

Uppdatera en IoT Hub-enhet.

Anknytning Allmän tillgänglighet
az iot hub device-twin

Hantera konfiguration av IoT-enhetstvillingar.

Anknytning Allmän tillgänglighet
az iot hub device-twin list

Lista enhetstvillingar i en IoT Hub.

Anknytning Allmän tillgänglighet
az iot hub device-twin replace

Ersätt enhetstvillingdefinitionen med mål-json.

Anknytning Allmän tillgänglighet
az iot hub device-twin show

Hämta en enhetstvillingdefinition.

Anknytning Allmän tillgänglighet
az iot hub device-twin update

Uppdatera önskade egenskaper och taggar för enhetstvillingar.

Anknytning Allmän tillgänglighet
az iot hub devicestream

Hantera enhetsströmmar för en IoT-hubb.

Kärna Förhandsgranska
az iot hub devicestream show

Hämta slutpunkter för IoT Hub-enhetsströmmar.

Kärna Förhandsgranska
az iot hub digital-twin

Manipulera och interagera med den digitala tvillingen för en IoT Hub-enhet.

Anknytning Allmän tillgänglighet
az iot hub digital-twin invoke-command

Anropa ett kommando på rot- eller komponentnivå för en digital tvillingenhet.

Anknytning Allmän tillgänglighet
az iot hub digital-twin show

Visa den digitala tvillingen för en IoT Hub-enhet.

Anknytning Allmän tillgänglighet
az iot hub digital-twin update

Uppdatera skrivskyddade egenskaper för en digital tvillingenhet via JSON-korrigeringsspecifikationen.

Anknytning Allmän tillgänglighet
az iot hub distributed-tracing

Hantera distribuerade inställningar per enhet.

Anknytning Förhandsgranska
az iot hub distributed-tracing show

Hämta inställningarna för distribuerad spårning för en enhet.

Anknytning Förhandsgranska
az iot hub distributed-tracing update

Uppdatera alternativen för distribuerad spårning för en enhet.

Anknytning Förhandsgranska
az iot hub generate-sas-token

Generera en SAS-token för en mål-IoT Hub, enhet eller modul.

Anknytning Allmän tillgänglighet
az iot hub identity

Hantera identiteter för en Azure IoT-hubb.

Kärna Allmän tillgänglighet
az iot hub identity assign

Tilldela hanterade identiteter till en IoT Hub.

Kärna Allmän tillgänglighet
az iot hub identity remove

Ta bort hanterade identiteter från en IoT Hub.

Kärna Allmän tillgänglighet
az iot hub identity show

Visa identitetsegenskaperna för en IoT Hub.

Kärna Allmän tillgänglighet
az iot hub invoke-device-method

Anropa en enhetsmetod.

Anknytning Allmän tillgänglighet
az iot hub invoke-module-method

Anropa en modulmetod.

Anknytning Allmän tillgänglighet
az iot hub job

Hantera IoT Hub-jobb (v2).

Anknytning Allmän tillgänglighet
az iot hub job cancel

Avbryt ett IoT Hub-jobb.

Anknytning Allmän tillgänglighet
az iot hub job create

Skapa och schemalägga ett IoT Hub-jobb för körning.

Anknytning Allmän tillgänglighet
az iot hub job list

Visa en lista över historiska jobb för en IoT Hub.

Anknytning Allmän tillgänglighet
az iot hub job show

Visa information om ett befintligt IoT Hub-jobb.

Anknytning Allmän tillgänglighet
az iot hub list

Lista IoT-hubbar.

Kärna Allmän tillgänglighet
az iot hub list-skus

Lista tillgängliga prisnivåer.

Kärna Allmän tillgänglighet
az iot hub manual-failover

Initiera en manuell redundansväxling för IoT Hub till den geo-kopplade haveriberedskapsregionen.

Kärna Allmän tillgänglighet
az iot hub message-endpoint

Hantera anpassade slutpunkter för en IoT-hubb.

Anknytning Förhandsgranska
az iot hub message-endpoint create

Lägg till en slutpunkt i en IoT Hub.

Anknytning Förhandsgranska
az iot hub message-endpoint create cosmosdb-container

Lägg till en Cosmos DB-containerslutpunkt för en IoT Hub.

Anknytning Förhandsgranska
az iot hub message-endpoint create eventhub

Lägg till en Event Hub-slutpunkt för en IoT Hub.

Anknytning Förhandsgranska
az iot hub message-endpoint create servicebus-queue

Lägg till en Service Bus-köslutpunkt för en IoT Hub.

Anknytning Förhandsgranska
az iot hub message-endpoint create servicebus-topic

Lägg till en Service Bus Topic-slutpunkt för en IoT Hub.

Anknytning Förhandsgranska
az iot hub message-endpoint create storage-container

Lägg till en slutpunkt för lagringscontainer för en IoT Hub.

Anknytning Förhandsgranska
az iot hub message-endpoint delete

Ta bort alla eller en specifik slutpunkt för en IoT Hub.

Anknytning Förhandsgranska
az iot hub message-endpoint list

Hämta information om alla slutpunkter för en IoT Hub.

Anknytning Förhandsgranska
az iot hub message-endpoint show

Hämta information om den angivna slutpunkten för en IoT Hub.

Anknytning Förhandsgranska
az iot hub message-endpoint update

Uppdatera egenskaperna för en befintlig slutpunkt för en IoT Hub.

Anknytning Förhandsgranska
az iot hub message-endpoint update cosmosdb-container

Uppdatera egenskaperna för en befintlig Cosmos DB-containerslutpunkt för en IoT Hub.

Anknytning Förhandsgranska
az iot hub message-endpoint update eventhub

Uppdatera egenskaperna för en befintlig Event Hub-slutpunkt för en IoT Hub.

Anknytning Förhandsgranska
az iot hub message-endpoint update servicebus-queue

Uppdatera egenskaperna för en befintlig Service Bus-köslutpunkt för en IoT Hub.

Anknytning Förhandsgranska
az iot hub message-endpoint update servicebus-topic

Uppdatera egenskaperna för en befintlig Service Bus Topic-slutpunkt för en IoT Hub.

Anknytning Förhandsgranska
az iot hub message-endpoint update storage-container

Uppdatera egenskaperna för en befintlig slutpunkt för lagringscontainer för en IoT Hub.

Anknytning Förhandsgranska
az iot hub message-enrichment

Hantera meddelandeberikningar för slutpunkter för en IoT Hub.

Kärna Allmän tillgänglighet
az iot hub message-enrichment create

Skapa en meddelandeberikning för valda slutpunkter i din IoT Hub.

Kärna Allmän tillgänglighet
az iot hub message-enrichment delete

Ta bort en meddelandeberikning i din IoT-hubb (efter nyckel).

Kärna Allmän tillgänglighet
az iot hub message-enrichment list

Få information om alla meddelande berikanden för din IoT Hub.

Kärna Allmän tillgänglighet
az iot hub message-enrichment update

Uppdatera en meddelandeberikning i din IoT-hubb (efter nyckel).

Kärna Allmän tillgänglighet
az iot hub message-route

Hantera vägar för en IoT-hubb.

Anknytning Förhandsgranska
az iot hub message-route create

Lägg till en väg för en IoT Hub.

Anknytning Förhandsgranska
az iot hub message-route delete

Ta bort alla vägar eller en nämnda väg i en IoT Hub.

Anknytning Förhandsgranska
az iot hub message-route fallback

Hantera återställningsvägen för en IoT-hubb.

Anknytning Förhandsgranska
az iot hub message-route fallback set

Aktivera eller inaktivera återställningsvägen i en IoT Hub.

Anknytning Förhandsgranska
az iot hub message-route fallback show

Visa återställningsvägen för en IoT Hub.

Anknytning Förhandsgranska
az iot hub message-route list

Hämta alla vägar i en IoT Hub.

Anknytning Förhandsgranska
az iot hub message-route show

Hämta information om vägen i en IoT Hub.

Anknytning Förhandsgranska
az iot hub message-route test

Testa alla vägar eller en nämnda väg i en IoT Hub.

Anknytning Förhandsgranska
az iot hub message-route update

Uppdatera en väg för en IoT Hub.

Anknytning Förhandsgranska
az iot hub module-identity

Hantera IoT-enhetsmoduler.

Anknytning Allmän tillgänglighet
az iot hub module-identity connection-string

Hantera IoT-enhetsmodulens anslutningssträng.

Anknytning Allmän tillgänglighet
az iot hub module-identity connection-string show

Visa en IoT-målenhetsmodul anslutningssträng.

Anknytning Allmän tillgänglighet
az iot hub module-identity create

Skapa en modul på en IoT-målenhet i en IoT Hub.

Anknytning Allmän tillgänglighet
az iot hub module-identity delete

Ta bort en enhet i en IoT Hub.

Anknytning Allmän tillgänglighet
az iot hub module-identity list

Lista moduler som finns på en IoT-enhet i en IoT Hub.

Anknytning Allmän tillgänglighet
az iot hub module-identity renew-key

Förnya målnycklarna för en IoT Hub-enhetsmodul med sas-autentisering.

Anknytning Allmän tillgänglighet
az iot hub module-identity show

Hämta information om en IoT-enhetsmodul i en IoT Hub.

Anknytning Allmän tillgänglighet
az iot hub module-identity update

Uppdatera en IoT Hub-enhetsmodul.

Anknytning Allmän tillgänglighet
az iot hub module-twin

Hantera konfiguration av IoT-enhetsmodultvillingar.

Anknytning Allmän tillgänglighet
az iot hub module-twin replace

Ersätt en modultvillingdefinition med mål-json.

Anknytning Allmän tillgänglighet
az iot hub module-twin show

Visa en modultvillingdefinition.

Anknytning Allmän tillgänglighet
az iot hub module-twin update

Uppdatera önskade egenskaper och taggar för modultvillingar.

Anknytning Allmän tillgänglighet
az iot hub monitor-events

Övervaka enhetens telemetri och meddelanden som skickas till en IoT Hub.

Anknytning Allmän tillgänglighet
az iot hub monitor-feedback

Övervaka feedback som skickas av enheter för att bekräfta meddelanden från moln till enhet (C2D).

Anknytning Allmän tillgänglighet
az iot hub policy

Hantera principer för delad åtkomst för en IoT-hubb.

Kärna Allmän tillgänglighet
az iot hub policy create

Skapa en ny princip för delad åtkomst i en IoT-hubb.

Kärna Allmän tillgänglighet
az iot hub policy delete

Ta bort en princip för delad åtkomst från en IoT-hubb.

Kärna Allmän tillgänglighet
az iot hub policy list

Lista principer för delad åtkomst för en IoT-hubb.

Kärna Allmän tillgänglighet
az iot hub policy renew-key

Återskapa nycklar för en princip för delad åtkomst för en IoT-hubb.

Kärna Allmän tillgänglighet
az iot hub policy show

Hämta information om en princip för delad åtkomst för en IoT-hubb.

Kärna Allmän tillgänglighet
az iot hub query

Fråga en IoT Hub med ett kraftfullt SQL-liknande språk.

Anknytning Allmän tillgänglighet
az iot hub route

Hantera vägar för en IoT-hubb.

Kärna Inaktuell
az iot hub route create

Skapa en väg i IoT Hub.

Kärna Inaktuell
az iot hub route delete

Ta bort alla eller nämnda vägar för din IoT Hub.

Kärna Inaktuell
az iot hub route list

Hämta alla vägar i IoT Hub.

Kärna Inaktuell
az iot hub route show

Hämta information om vägen i IoT Hub.

Kärna Inaktuell
az iot hub route test

Testa alla vägar eller nämnda vägar i IoT Hub.

Kärna Inaktuell
az iot hub route update

Uppdatera en väg i IoT Hub.

Kärna Inaktuell
az iot hub routing-endpoint

Hantera anpassade slutpunkter för en IoT-hubb.

Kärna Inaktuell
az iot hub routing-endpoint create

Lägg till en slutpunkt i din IoT Hub.

Kärna Inaktuell
az iot hub routing-endpoint delete

Ta bort alla eller nämnda slutpunkter för din IoT Hub.

Kärna Inaktuell
az iot hub routing-endpoint list

Hämta information om alla slutpunkter för din IoT Hub.

Kärna Inaktuell
az iot hub routing-endpoint show

Hämta information om den angivna slutpunkten för din IoT Hub.

Kärna Inaktuell
az iot hub show

Hämta information om en IoT-hubb.

Kärna Allmän tillgänglighet
az iot hub show-connection-string

Visa anslutningssträng för en IoT-hubb.

Kärna Inaktuell
az iot hub show-quota-metrics

Hämta kvotmåtten för en IoT-hubb.

Kärna Allmän tillgänglighet
az iot hub show-stats

Hämta statistiken för en IoT-hubb.

Kärna Allmän tillgänglighet
az iot hub state

Hantera tillståndet för en IoT Hub.

Anknytning Experimentell
az iot hub state export

Exportera tillståndet för en IoT Hub till en fil.

Anknytning Experimentell
az iot hub state import

Importera ett hubbtillstånd från en fil till en IoT Hub.

Anknytning Experimentell
az iot hub state migrate

Migrera tillståndet för en hubb till en annan hubb utan att spara till en fil.

Anknytning Experimentell
az iot hub update

Uppdatera metadata för en IoT-hubb.

Kärna Allmän tillgänglighet
az iot hub wait

Vänta tills en åtgärd på en IoT Hub-instans har slutförts.

Kärna Allmän tillgänglighet

az iot hub create

Skapa en Azure IoT-hubb.

En introduktion till Azure IoT Hub finns i 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]

Exempel

Skapa en IoT Hub med den kostnadsfria prisnivån F1 i resursgruppens region.

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

Skapa en IoT Hub med standardprisnivån S1 och 4 partitioner i regionen "westus" med taggar.

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

Skapa en IoT Hub med en systemtilldelad hanterad identitet och tilldela en roll och ett omfång till ett lagringskonto för den skapade identiteten.

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

Skapa en IoT Hub med lokal autentisering, enhets-SAS-nycklar och modul-SAS-nycklar inaktiverade

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

Skapa en IoT Hub med datahemvist framtvingat. Detta inaktiverar haveriberedskap mellan regioner.

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

Obligatoriska parametrar

--name -n

IoT Hub-namn.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Valfria parametrar

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

Antalet gånger som IoT-hubben försöker leverera ett meddelande från moln till enhet till en enhet, mellan 1 och 100.

standardvärde: 10
--c2d-ttl --ct

Hur lång tid ett meddelande är tillgängligt för enheten att förbruka innan det upphör att gälla av IoT Hub, mellan 1 och 48 timmar.

standardvärde: 1
--dds --disable-device-sas

Ett booleskt värde som anger om du vill inaktivera alla enheter (inklusive Edge-enheter men exklusive moduler) begränsade SAS-nycklar för autentisering.

accepterade värden: false, true
--disable-local-auth --dla

Ett booleskt värde som anger om IoT Hub-begränsade SAS-nycklar för autentisering ska inaktiveras eller inte.

accepterade värden: false, true
--disable-module-sas --dms

Ett booleskt värde som anger om SAS-nycklar med modulomfattning ska inaktiveras för autentisering.

accepterade värden: false, true
--edr --enforce-data-residency

Framtvinga datahemvist för den här IoT Hub genom att inaktivera haveriberedskap mellan regioner. Den här egenskapen är oföränderlig när den har angetts för resursen. Endast tillgängligt i utvalda regioner. Läs mer på https://aka.ms/iothubdisabledr.

accepterade värden: false, true
--fc --fileupload-storage-container-name

Namnet på rotcontainern där du laddar upp filer. Containern behöver inte finnas men bör vara kreatabell med hjälp av den angivna connectionString.the container need not exist but should be creatable using the connectionString specified.

--fcs --fileupload-storage-connectionstring

Anslutningssträng för Azure Storage-kontot som filer laddas upp till.

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

Antalet gånger som IoT-hubben försöker leverera ett meddelande i feedbackkön, mellan 1 och 100.

standardvärde: 10
--feedback-lock-duration --fld

Låsvaraktigheten för feedbackkön, mellan 5 och 300 sekunder.

standardvärde: 5
--feedback-ttl --ft

Den tidsperiod för vilken IoT-hubben behåller feedbacken för förfallotid eller leverans av meddelanden från moln till enhet, mellan 1 och 48 timmar.

standardvärde: 1
--fileupload-notification-lock-duration --fnld

Låsvaraktigheten för kön för filuppladdningsmeddelanden, mellan 5 och 300 sekunder.

standardvärde: 5
--fileupload-notification-max-delivery-count --fnd

Antalet gånger som IoT-hubben försöker leverera ett filmeddelande mellan 1 och 100.

standardvärde: 10
--fileupload-notification-ttl --fnt

Hur lång tid en filuppladdningsavisering är tillgänglig för tjänsten att använda innan den upphör att gälla av IoT Hub, mellan 1 och 48 timmar.

standardvärde: 1
--fileupload-notifications --fn

Ett booleskt värde som anger om du vill logga information om uppladdade filer till IoT Hub-slutpunkten messages/servicebound/filenotifications.

accepterade värden: false, true
standardvärde: False
--fileupload-sas-ttl --fst

Hur lång tid en SAS-URI som genereras av IoT Hub är giltig innan den upphör att gälla, mellan 1 och 24 timmar.

standardvärde: 1
--fileupload-storage-auth-type --fsa

Autentiseringstypen för det Azure Storage-konto som filerna laddas upp till.

accepterade värden: identityBased, keyBased
--fileupload-storage-identity --fsi

Den hanterade identitet som ska användas för filuppladdningsautentisering. Använd [system] för att referera till den systemtilldelade hanterade identiteten eller ett resurs-ID för att referera till en användartilldelad hanterad identitet.

--location -l

Plats för din IoT Hub. Standardvärdet är platsen för målresursgruppen.

--mi-system-assigned

Aktivera systemtilldelad hanterad identitet för den här hubben.

accepterade värden: false, true
--mi-user-assigned

Aktivera användartilldelade hanterade identiteter för den här hubben. Acceptera utrymmesavgränsad lista över identitetsresurs-ID:er.

--min-tls-version --mintls

Ange den lägsta TLS-version som ska stödjas för den här hubben. Kan anges till "1.2" så att klienter som använder en TLS-version under 1.2 avvisas.

--no-wait

Vänta inte tills den långvariga åtgärden har slutförts.

standardvärde: False
--partition-count

Antalet partitioner i säkerhetskopieringshändelsehubben för meddelanden från enhet till moln.

standardvärde: 4
--rd --retention-day

Anger hur länge den här IoT-hubben ska underhålla händelser från enhet till moln, mellan 1 och 7 dagar.

standardvärde: 1
--role

Roll att tilldela till hubbens systemtilldelade hanterade identitet.

--scopes

Utrymmesavgränsad lista över omfång för att tilldela rollen (--roll) för den systemtilldelade hanterade identiteten.

--sku

Prisnivå för Azure IoT Hub. Observera att endast en kostnadsfri IoT Hub-instans (F1) tillåts i varje prenumeration. Ett undantag utlöses om de kostnadsfria instanserna överskrider en.

accepterade värden: B1, B2, B3, F1, S1, S2, S3
standardvärde: S1
--tags

Blankstegsavgränsade taggar: key[=value] [key[=value] ...]. Använd "" för att rensa befintliga taggar.

--unit

Enheter i din IoT Hub.

standardvärde: 1
Globala parametrar
--debug

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

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

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

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

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

az iot hub delete

Ta bort en IoT-hubb.

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

Exempel

Ta bort en IoT-hubb. (automatiskt genererad)

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

Valfria parametrar

--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om argumenten "Resurs-ID". Du bör ange antingen --id eller andra "Resurs-ID"-argument.

--name -n

IoT Hub-namn.

--no-wait

Vänta inte tills den långvariga åtgärden har slutförts.

standardvärde: False
--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

Globala parametrar
--debug

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

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

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

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

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

az iot hub generate-sas-token

Generera en SAS-token för en mål-IoT Hub, enhet eller modul.

För ENHETS-SAS-token används principparametern endast för åtkomst till enhetsregistret. Därför bör principen ha läsbehörighet till registret. För IoT Hub-token är principen en del av 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]

Exempel

Generera en SAS-token för IoT Hub med iothubowner-principen och primärnyckeln.

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

Generera en SAS-token för IoT Hub med hjälp av registryRead-principen och den sekundära nyckeln.

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

Generera en ENHETS-SAS-token med iothubowner-principen för att få åtkomst till enhetsregistret {iothub_name}.

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

Generera en ENHETS-SAS-token med hjälp av en IoT Hub-anslutningssträng (med registeråtkomst)

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

Generera en SAS-token för Iot Hub med hjälp av en IoT Hub-anslutningssträng

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

Generera en ENHETS-SAS-token med hjälp av en anslutningssträng

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

Generera en SAS-modultoken med hjälp av en modul anslutningssträng

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

Valfria parametrar

--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>

accepterade värden: key, login
standardvärde: key
--connection-string --cs

Mål anslutningssträng. Detta kringgår IoT Hub-registret och genererar SAS-token direkt från den angivna symmetriska nyckeln utan ytterligare verifiering. Alla andra kommandoparametrar förutom varaktighet ignoreras. Anslutningssträng typer som stöds: Iot Hub, Device, Module.

--device-id -d

Målenhets-ID.

--du --duration

Giltig tokenvaraktighet i sekunder.

standardvärde: 3600
--hub-name -n

IoT Hub-namn eller värdnamn. Krävs om --login inte har angetts.

--key-type --kt

Nyckeltyp för princip för delad åtkomst för autentisering.

accepterade värden: primary, secondary
standardvärde: primary
--login -l

Det här kommandot stöder en entitet anslutningssträng med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet anslutningssträng och namn anges prioriteras anslutningssträng. Krävs om --hub-name inte anges.

--module-id -m

Målmodul-ID.

--pn --policy-name

Princip för delad åtkomst med åtgärdsbehörigheter för mål-IoT Hub-entiteten.

standardvärde: iothubowner
--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Globala parametrar
--debug

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

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

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

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

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

az iot hub invoke-device-method

Anropa en enhetsmetod.

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

Exempel

Anropa en direktmetod på en enhet.

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

Obligatoriska parametrar

--device-id -d

Målenhets-ID.

--method-name --mn

Målmetod för anrop.

Valfria parametrar

--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>

accepterade värden: key, login
standardvärde: key
--hub-name -n

IoT Hub-namn eller värdnamn. Krävs om --login inte har angetts.

--login -l

Det här kommandot stöder en entitet anslutningssträng med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet anslutningssträng och namn anges prioriteras anslutningssträng. Krävs om --hub-name inte anges.

--method-payload --mp

Json-nyttolast som ska skickas till metoden. Måste vara filsökväg eller rå json.

standardvärde: {}
--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--timeout --to

Maximalt antal sekunder att vänta på resultatet av enhetsmetoden.

standardvärde: 30
Globala parametrar
--debug

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

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

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

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

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

az iot hub invoke-module-method

Anropa en modulmetod.

Det här kommandot har stöd för både enhetsmoduler som inte är gränsenheter.

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

Exempel

Anropa en direktmetod på en edge-enhetsmodul.

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

Obligatoriska parametrar

--device-id -d

Målenhets-ID.

--method-name --mn

Målmetod för anrop.

--module-id -m

Målmodul-ID.

Valfria parametrar

--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>

accepterade värden: key, login
standardvärde: key
--hub-name -n

IoT Hub-namn eller värdnamn. Krävs om --login inte har angetts.

--login -l

Det här kommandot stöder en entitet anslutningssträng med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet anslutningssträng och namn anges prioriteras anslutningssträng. Krävs om --hub-name inte anges.

--method-payload --mp

Json-nyttolast som ska skickas till metoden. Måste vara filsökväg eller rå json.

standardvärde: {}
--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--timeout --to

Maximalt antal sekunder att vänta på modulmetodens resultat.

standardvärde: 30
Globala parametrar
--debug

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

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

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

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

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

az iot hub list

Lista IoT-hubbar.

az iot hub list [--resource-group]

Exempel

Visa en lista över alla IoT-hubbar i en prenumeration.

az iot hub list

Visa en lista över alla IoT-hubbar i resursgruppen "MyGroup"

az iot hub list --resource-group MyGroup

Valfria parametrar

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Globala parametrar
--debug

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

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

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

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

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

az iot hub list-skus

Lista tillgängliga prisnivåer.

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

Exempel

Lista tillgängliga prisnivåer. (automatiskt genererad)

az iot hub list-skus --name MyIoTHub

Valfria parametrar

--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om argumenten "Resurs-ID". Du bör ange antingen --id eller andra "Resurs-ID"-argument.

--name -n

IoT Hub-namn.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

Globala parametrar
--debug

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

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

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

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

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

az iot hub manual-failover

Initiera en manuell redundansväxling för IoT Hub till den geo-kopplade haveriberedskapsregionen.

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

Exempel

Initiera redundansväxlingen "myhub" från den primära till den sekundära regionen.

az iot hub manual-failover -n myhub

Valfria parametrar

--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om argumenten "Resurs-ID". Du bör ange antingen --id eller andra "Resurs-ID"-argument.

--name -n

IoT Hub-namn.

--no-wait

Vänta inte tills den långvariga åtgärden har slutförts.

standardvärde: False
--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

Globala parametrar
--debug

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

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

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

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

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

az iot hub monitor-events

Övervaka enhetens telemetri och meddelanden som skickas till en IoT Hub.

Det här kommandot förlitar sig på och kan installera beroende Cython-paket (uamqp) vid första körningen. https://github.com/Azure/azure-uamqp-python

Obs! Händelsen visas även om meddelandetexten inte kan avkodas, i det här fallet visas händelsenyttolasten som {{icke-avkodbar nyttolast}} med resten av de händelseegenskaper som är tillgängliga.

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}]

Exempel

Grundläggande användning

az iot hub monitor-events -n {iothub_name}

Grundläggande användning med en IoT Hub-anslutningssträng

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

Grundläggande användning vid filtrering på målenhet

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

Grundläggande användning vid filtrering av målenheter med jokertecken i ID:t

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

Filtrera enheter med IoT Hub-frågespråk

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

Filtrera enheten och ange en händelsehubbkonsumentgrupp som ska bindas till.

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

Ta emot meddelandeanteckningar (meddelandehuvuden)

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

Ta emot meddelandeanteckningar + systemegenskaper. Överskrid aldrig tidsgränsen.

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

Ta emot alla meddelandeattribut från alla enhetsmeddelanden

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

Ta emot alla meddelanden och parsa meddelandenyttolasten som JSON

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

Ta emot det angivna antalet meddelanden från hubben och stäng sedan av.

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

Valfria parametrar

--cg --consumer-group -c

Ange den konsumentgrupp som ska användas när du ansluter till händelsehubbens slutpunkt.

standardvärde: $Default
--content-type --ct

Ange innehållstypen för meddelandenyttolasten för att automatiskt formatera utdata till den typen.

--device-id -d

Målenhets-ID.

--device-query -q

Ange en anpassad fråga för att filtrera enheter.

--enqueued-time --et -e

Anger den tid som ska användas som utgångspunkt för att läsa meddelanden från partitionerna. Enheterna är millisekunder sedan unix-epoken. Om ingen tid anges används "nu".

--hub-name -n

IoT Hub-namn eller värdnamn. Krävs om --login inte har angetts.

--interface -i

Målgränssnittsidentifierare att filtrera på. Till exempel: dtmi:com:example:TemperatureController;1.

--login -l

Det här kommandot stöder en entitet anslutningssträng med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet anslutningssträng och namn anges prioriteras anslutningssträng. Krävs om --hub-name inte anges.

--mc --message-count

Antal telemetrimeddelanden som ska hämtas innan övervakaren avslutas. Om det inte anges fortsätter övervakningen att köras tills tidsgränströskeln för att inte ta emot meddelanden från hubben uppfylls.

--module-id -m

Målmodul-ID.

--properties --props -p

Ange nyckelmeddelandeegenskaper för utdata. sys = systemegenskaper, app = programegenskaper, anno = anteckningar.

accepterade värden: all, anno, app, sys
--repair -r

Installera om uamqp-beroende som är kompatibelt med tilläggsversionen. Standard: falskt.

accepterade värden: false, true
standardvärde: False
--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--timeout --to -t

Maximalt antal sekunder för att upprätthålla anslutningen utan att ta emot meddelandet. Använd 0 för oändlighet.

standardvärde: 300
--yes -y

Hoppa över användarprompter. Anger godkännande av åtgärd. Används främst för automatiseringsscenarier. Standard: falskt.

accepterade värden: false, true
standardvärde: False
Globala parametrar
--debug

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

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

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

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

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

az iot hub monitor-feedback

Övervaka feedback som skickas av enheter för att bekräfta meddelanden från moln till enhet (C2D).

Det här kommandot förlitar sig på och kan installera beroende Cython-paket (uamqp) vid första körningen. 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}]

Exempel

Grundläggande användning

az iot hub monitor-feedback -n {iothub_name}

Grundläggande användning med en IoT Hub-anslutningssträng

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

Grundläggande användning vid filtrering på målenhet

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

Avsluta feedbackövervakaren när du tar emot ett meddelande med specifikt ID (uuid)

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

Valfria parametrar

--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>

accepterade värden: key, login
standardvärde: key
--device-id -d

Målenhets-ID.

--hub-name -n

IoT Hub-namn eller värdnamn. Krävs om --login inte har angetts.

--login -l

Det här kommandot stöder en entitet anslutningssträng med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet anslutningssträng och namn anges prioriteras anslutningssträng. Krävs om --hub-name inte anges.

--repair -r

Installera om uamqp-beroende som är kompatibelt med tilläggsversionen. Standard: falskt.

accepterade värden: false, true
standardvärde: False
--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--wait-on-msg -w

Feedbackövervakaren blockeras tills ett meddelande med specifikt ID (uuid) tas emot.

--yes -y

Hoppa över användarprompter. Anger godkännande av åtgärd. Används främst för automatiseringsscenarier. Standard: falskt.

accepterade värden: false, true
standardvärde: False
Globala parametrar
--debug

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

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

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

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

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

az iot hub query

Fråga en IoT Hub med ett kraftfullt SQL-liknande språk.

Hämta information om enhets- och modultvillingar, jobb och meddelanderoutning. Mer information finns i 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]

Exempel

Fråga alla enhetstvillingdata i en Azure IoT Hub.

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

Fråga alla modultvillingdata på målenheten.

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

Obligatoriska parametrar

--query-command -q

Användarfråga som ska köras.

Valfria parametrar

--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>

accepterade värden: key, login
standardvärde: key
--hub-name -n

IoT Hub-namn eller värdnamn. Krävs om --login inte har angetts.

--login -l

Det här kommandot stöder en entitet anslutningssträng med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet anslutningssträng och namn anges prioriteras anslutningssträng. Krävs om --hub-name inte anges.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--top

Maximalt antal element som ska returneras. Som standard har frågan ingen gräns.

Globala parametrar
--debug

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

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

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

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

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

az iot hub show

Hämta information om en IoT-hubb.

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

Exempel

Hämta information om en IoT-hubb. (automatiskt genererad)

az iot hub show --name MyIoTHub

Valfria parametrar

--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om argumenten "Resurs-ID". Du bör ange antingen --id eller andra "Resurs-ID"-argument.

--name -n

IoT Hub-namn.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

Globala parametrar
--debug

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

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

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

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

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

az iot hub show-connection-string

Inaktuell

Det här kommandot är inaktuellt och tas bort i en framtida version. Använd anslutningssträngkommandot "IoT Extension (azure-iot) (az iot hub connection-string show)" i stället.

Visa anslutningssträng för en IoT-hubb.

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

Exempel

Visa anslutningssträng för en IoT-hubb med hjälp av standardprincip och primärnyckel.

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

Visa anslutningssträng för en IoT Hub med principen "tjänst" och sekundär nyckel.

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

Visa anslutningssträng för alla IoT-hubbar i en resursgrupp.

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

Visa anslutningssträng för alla IoT-hubbar i en prenumeration.

az iot hub show-connection-string

Visa anslutningssträng för en IoT-hubb. (automatiskt genererad)

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

Valfria parametrar

--all

Tillåt att alla principer för delad åtkomst visas.

standardvärde: False
--hub-name --name -n

IoT Hub-namn.

--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om argumenten "Resurs-ID". Du bör ange antingen --id eller andra "Resurs-ID"-argument.

--key

Nyckeln som ska användas.

accepterade värden: primary, secondary
standardvärde: primary
--policy-name

Princip för delad åtkomst som ska användas.

standardvärde: iothubowner
--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

Globala parametrar
--debug

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

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

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

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

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

az iot hub show-quota-metrics

Hämta kvotmåtten för en IoT-hubb.

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

Exempel

Hämta kvotmåtten för en IoT-hubb. (automatiskt genererad)

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

Hämta kvotmåtten för en IoT-hubb. (automatiskt genererad)

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

Valfria parametrar

--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om argumenten "Resurs-ID". Du bör ange antingen --id eller andra "Resurs-ID"-argument.

--name -n

IoT Hub-namn.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

Globala parametrar
--debug

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

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

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

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

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

az iot hub show-stats

Hämta statistiken för en IoT-hubb.

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

Exempel

Hämta statistiken för en IoT-hubb. (automatiskt genererad)

az iot hub show-stats --name MyIoTHub

Valfria parametrar

--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om argumenten "Resurs-ID". Du bör ange antingen --id eller andra "Resurs-ID"-argument.

--name -n

IoT Hub-namn.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

Globala parametrar
--debug

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

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

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

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

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

az iot hub update

Uppdatera metadata för en IoT-hubb.

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]

Exempel

Lägga till inställningar för lagringscontainer i filuppladdning

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

Lägg till en brandväggsfilterregel för att acceptera trafik från IP-masken 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

Uppdatera metadata för en IoT-hubb. (automatiskt genererad)

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

Uppdatera enheter för en IoT Hub till 2 och lägg till taggar

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

Uppdatera prisnivån för en IoT Hub som S2

az iot hub update -n MyIotHub --sku S2

Uppdatera kvarhållningsdagarna för IoT Hub-händelser från enhet till moln som 3 dagar

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

Uppdatera meddelandeinställningarna för IoT Hub från moln till enhet

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

Uppdatera inställningarna för IoT Hub-feedbackkö

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

Uppdatera inställningarna för filuppladdning av IoT Hub och tilldela en hanterad identitet till användaren för filuppladdning

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

Uppdatera meddelandeinställningarna för IoT Hub-filuppladdning och varaktigheten för kölås

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

Uppdatera sas-inställningarna för lokal IoT Hub-autentisering, enhetens SAS och modul

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

Valfria parametrar

--add

Lägg till ett objekt i en lista över objekt genom att ange en sökväg och nyckelvärdepar. Exempel: --add property.listProperty <key=value, string or JSON string>.

standardvärde: []
--c2d-max-delivery-count --cdd

Antalet gånger som IoT-hubben försöker leverera ett meddelande från moln till enhet till en enhet, mellan 1 och 100.

--c2d-ttl --ct

Hur lång tid ett meddelande är tillgängligt för enheten att förbruka innan det upphör att gälla av IoT Hub, mellan 1 och 48 timmar.

--dds --disable-device-sas

Ett booleskt värde som anger om du vill inaktivera alla enheter (inklusive Edge-enheter men exklusive moduler) begränsade SAS-nycklar för autentisering.

accepterade värden: false, true
--disable-local-auth --dla

Ett booleskt värde som anger om IoT Hub-begränsade SAS-nycklar för autentisering ska inaktiveras eller inte.

accepterade värden: false, true
--disable-module-sas --dms

Ett booleskt värde som anger om SAS-nycklar med modulomfattning ska inaktiveras för autentisering.

accepterade värden: false, true
--fc --fileupload-storage-container-name

Namnet på rotcontainern där du laddar upp filer. Containern behöver inte finnas men bör vara kreatabell med hjälp av den angivna connectionString.the container need not exist but should be creatable using the connectionString specified.

--fcs --fileupload-storage-connectionstring

Anslutningssträng för Azure Storage-kontot som filer laddas upp till.

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

Antalet gånger som IoT-hubben försöker leverera ett meddelande i feedbackkön, mellan 1 och 100.

--feedback-lock-duration --fld

Låsvaraktigheten för feedbackkön, mellan 5 och 300 sekunder.

--feedback-ttl --ft

Den tidsperiod för vilken IoT-hubben behåller feedbacken för förfallotid eller leverans av meddelanden från moln till enhet, mellan 1 och 48 timmar.

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

Låsvaraktigheten för kön för filuppladdningsmeddelanden, mellan 5 och 300 sekunder.

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

Antalet gånger som IoT-hubben försöker leverera ett filmeddelande mellan 1 och 100.

--fileupload-notification-ttl --fnt

Hur lång tid en filuppladdningsavisering är tillgänglig för tjänsten att använda innan den upphör att gälla av IoT Hub, mellan 1 och 48 timmar.

--fileupload-notifications --fn

Ett booleskt värde som anger om du vill logga information om uppladdade filer till IoT Hub-slutpunkten messages/servicebound/filenotifications.

accepterade värden: false, true
--fileupload-sas-ttl --fst

Hur lång tid en SAS-URI som genereras av IoT Hub är giltig innan den upphör att gälla, mellan 1 och 24 timmar.

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

Autentiseringstypen för det Azure Storage-konto som filerna laddas upp till.

accepterade värden: identityBased, keyBased
--fileupload-storage-identity --fsi

Den hanterade identitet som ska användas för filuppladdningsautentisering. Använd [system] för att referera till den systemtilldelade hanterade identiteten eller ett resurs-ID för att referera till en användartilldelad hanterad identitet.

--force-string

När du använder "set" eller "add" bevarar du strängliteraler i stället för att försöka konvertera till JSON.

standardvärde: False
--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om argumenten "Resurs-ID". Du bör ange antingen --id eller andra "Resurs-ID"-argument.

--name -n

IoT Hub-namn.

--rd --retention-day

Anger hur länge den här IoT-hubben ska underhålla händelser från enhet till moln, mellan 1 och 7 dagar.

--remove

Ta bort en egenskap eller ett element från en lista. Exempel: --remove property.list <indexToRemove> ELLER --remove propertyToRemove.

standardvärde: []
--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--set

Uppdatera ett objekt genom att ange en egenskapssökväg och ett värde som ska anges. Exempel: --set property1.property2=<value>.

standardvärde: []
--sku

Prisnivå för Azure IoT Hub. Observera att endast en kostnadsfri IoT Hub-instans (F1) tillåts i varje prenumeration. Ett undantag utlöses om de kostnadsfria instanserna överskrider en.

accepterade värden: B1, B2, B3, F1, S1, S2, S3
--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--tags

Blankstegsavgränsade taggar: key[=value] [key[=value] ...]. Använd "" för att rensa befintliga taggar.

--unit

Enheter i din IoT Hub.

Globala parametrar
--debug

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

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

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

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

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

az iot hub wait

Vänta tills en åtgärd på en IoT Hub-instans har slutförts.

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

Exempel

Vänta tills en befintlig IoT Hub-instans har skapats

az iot hub wait -n MyIoTHub --created

Vänta tills en IoT Hub-instans har tagits bort

az iot hub wait -n MyIoTHub --deleted

Vänta tills en befintlig IoT Hub-instans har ett aktivt tillstånd

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

Valfria parametrar

--created

Vänta tills du har skapat med "provisioningState" på "Lyckades".

standardvärde: False
--custom

Vänta tills villkoret uppfyller en anpassad JMESPath-fråga. T.ex. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Vänta tills den har tagits bort.

standardvärde: False
--exists

Vänta tills resursen finns.

standardvärde: False
--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om argumenten "Resurs-ID". Du bör ange antingen --id eller andra "Resurs-ID"-argument.

--interval

Avsökningsintervall i sekunder.

standardvärde: 30
--name -n

IoT Hub-namn.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--timeout

Maximal väntetid i sekunder.

standardvärde: 3600
--updated

Vänta tills det har uppdaterats med provisioningState på Lyckades.

standardvärde: False
Globala parametrar
--debug

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

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

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

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

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