az iot hub

Referentie

Notitie

Deze opdrachtgroep bevat opdrachten die zijn gedefinieerd in zowel Azure CLI als ten minste één extensie. Installeer elke extensie om te profiteren van de uitgebreide mogelijkheden. Meer informatie over extensies.

Azure IoT-hubs beheren.

Opdracht

Name	Description	Type	Status
az iot hub certificate	IoT Hub-certificaten beheren.	Kern en extensie	GA
az iot hub certificate create	Een Azure IoT Hub-certificaat maken/uploaden.	Basis	GA
az iot hub certificate delete	Hiermee verwijdert u een Azure IoT Hub-certificaat.	Basis	GA
az iot hub certificate generate-verification-code	Hiermee wordt een verificatiecode gegenereerd voor een Azure IoT Hub-certificaat.	Basis	GA
az iot hub certificate list	Geeft een lijst weer van alle certificaten die zijn opgenomen in een Azure IoT Hub.	Basis	GA
az iot hub certificate root-authority	Beheer de basisinstantie van het certificaat voor een IoT Hub-exemplaar.	Toestel	Afgeschaft
az iot hub certificate root-authority set	Stel de basisinstantie van het certificaat voor een IoT Hub-exemplaar in op een specifieke versie.	Toestel	Afgeschaft
az iot hub certificate root-authority show	De huidige basisinstantie van het certificaat voor een IoT Hub-exemplaar weergeven.	Toestel	Afgeschaft
az iot hub certificate show	Toont informatie over een bepaald Azure IoT Hub-certificaat.	Basis	GA
az iot hub certificate update	Een Azure IoT Hub-certificaat bijwerken.	Basis	GA
az iot hub certificate verify	Controleert een Azure IoT Hub-certificaat.	Basis	GA
az iot hub configuration	Automatische configuratie van IoT-apparaatbeheer op schaal beheren.	Toestel	GA
az iot hub configuration create	Maak een configuratie voor automatisch IoT-apparaatbeheer in een IoT-doel-IoT Hub.	Toestel	GA
az iot hub configuration delete	Een IoT-apparaatconfiguratie verwijderen.	Toestel	GA
az iot hub configuration list	Maak een lijst met configuraties voor automatisch apparaatbeheer van IoT in een IoT Hub.	Toestel	GA
az iot hub configuration show	De details van een configuratie voor automatisch apparaatbeheer van IoT ophalen.	Toestel	GA
az iot hub configuration show-metric	Evalueer een doelgebruiker of systeemmetriek die is gedefinieerd in een IoT-apparaatconfiguratie.	Toestel	GA
az iot hub configuration update	De opgegeven eigenschappen van een configuratie voor automatisch apparaatbeheer van IoT bijwerken.	Toestel	GA
az iot hub connection-string	IoT Hub-verbindingsreeks s beheren.	Toestel	GA
az iot hub connection-string show	De verbindingsreeks s voor de opgegeven IoT Hubs weergeven met behulp van de opgegeven beleidsnaam en -sleutel.	Toestel	GA
az iot hub consumer-group	Beheer de Event Hub-consumentengroepen van een IoT-hub.	Basis	GA
az iot hub consumer-group create	Maak een Event Hub-consumentengroep.	Basis	GA
az iot hub consumer-group delete	Een Event Hub-consumentengroep verwijderen.	Basis	GA
az iot hub consumer-group list	Event Hub-consumentengroepen weergeven.	Basis	GA
az iot hub consumer-group show	Haal de details op voor een Event Hub-consumentengroep.	Basis	GA
az iot hub create	Een Azure IoT-hub maken.	Basis	GA
az iot hub delete	Een IoT-hub verwijderen.	Basis	GA
az iot hub device-identity	IoT-apparaten beheren.	Toestel	GA
az iot hub device-identity children	Onderliggende apparaatrelaties voor IoT Edge-apparaten beheren.	Toestel	GA
az iot hub device-identity children add	Voeg apparaten toe als onderliggende elementen aan een edge-doelapparaat.	Toestel	GA
az iot hub device-identity children list	Hiermee wordt de verzameling toegewezen onderliggende apparaten uitgevoerd.	Toestel	GA
az iot hub device-identity children remove	Onderliggende apparaten verwijderen van een doelrandapparaat.	Toestel	GA
az iot hub device-identity connection-string	Beheer de verbindingsreeks van het IoT-apparaat.	Toestel	GA
az iot hub device-identity connection-string show	Een bepaald IoT Hub-apparaat weergeven verbindingsreeks.	Toestel	GA
az iot hub device-identity create	Maak een apparaat in een IoT Hub.	Toestel	GA
az iot hub device-identity delete	Een IoT Hub-apparaat verwijderen.	Toestel	GA
az iot hub device-identity export	Exporteer alle apparaat-id's van een IoT Hub naar een Azure Storage-blobcontainer.	Toestel	GA
az iot hub device-identity import	Apparaat-id's importeren in een IoT Hub vanuit een opslagcontainer-blob.	Toestel	GA
az iot hub device-identity list	Apparaten weergeven in een IoT Hub.	Toestel	GA
az iot hub device-identity parent	Relaties tussen bovenliggende apparaten voor IoT-apparaten beheren.	Toestel	GA
az iot hub device-identity parent set	Stel het bovenliggende apparaat van een doelapparaat in.	Toestel	GA
az iot hub device-identity parent show	Haal het bovenliggende apparaat van een doelapparaat op.	Toestel	GA
az iot hub device-identity renew-key	Vernieuw doelsleutels van IoT Hub-apparaten met SAS-verificatie.	Toestel	GA
az iot hub device-identity show	De details van een IoT Hub-apparaat ophalen.	Toestel	GA
az iot hub device-identity update	Een IoT Hub-apparaat bijwerken.	Toestel	GA
az iot hub device-twin	Configuratie van IoT-apparaatdubbel beheren.	Toestel	GA
az iot hub device-twin list	Apparaatdubbels weergeven in een IoT Hub.	Toestel	GA
az iot hub device-twin replace	Vervang de definitie van de apparaatdubbel door de doel-json.	Toestel	GA
az iot hub device-twin show	Een definitie van een apparaatdubbel ophalen.	Toestel	GA
az iot hub device-twin update	Werk de gewenste eigenschappen en tags van apparaatdubbels bij.	Toestel	GA
az iot hub devicestream	Apparaatstreams van een IoT-hub beheren.	Basis	Preview uitvoeren
az iot hub devicestream show	Haal de apparaatstreams van IoT Hub op.	Basis	Preview uitvoeren
az iot hub digital-twin	De digitale dubbel van een IoT Hub-apparaat manipuleren en ermee werken.	Toestel	GA
az iot hub digital-twin invoke-command	Roep een opdracht op hoofd- of onderdeelniveau van een digital twin-apparaat aan.	Toestel	GA
az iot hub digital-twin show	De digitale dubbel van een IoT Hub-apparaat weergeven.	Toestel	GA
az iot hub digital-twin update	Werk de eigenschappen voor lezen/schrijven van een digital twin-apparaat bij via de JSON-patchspecificatie.	Toestel	GA
az iot hub distributed-tracing	Gedistribueerde instellingen per apparaat beheren.	Toestel	Preview uitvoeren
az iot hub distributed-tracing show	Haal de instellingen voor gedistribueerde tracering voor een apparaat op.	Toestel	Preview uitvoeren
az iot hub distributed-tracing update	Werk de gedistribueerde traceringsopties voor een apparaat bij.	Toestel	Preview uitvoeren
az iot hub generate-sas-token	Genereer een SAS-token voor een IoT Hub- of -doelmodule.	Toestel	GA
az iot hub identity	Identiteiten van een Azure IoT-hub beheren.	Basis	GA
az iot hub identity assign	Beheerde identiteiten toewijzen aan een IoT Hub.	Basis	GA
az iot hub identity remove	Beheerde identiteiten verwijderen uit een IoT Hub.	Basis	GA
az iot hub identity show	De identiteitseigenschappen van een IoT Hub weergeven.	Basis	GA
az iot hub invoke-device-method	Een apparaatmethode aanroepen.	Toestel	GA
az iot hub invoke-module-method	Roep een modulemethode aan.	Toestel	GA
az iot hub job	IoT Hub-taken (v2) beheren.	Toestel	GA
az iot hub job cancel	Een IoT Hub-taak annuleren.	Toestel	GA
az iot hub job create	Een IoT Hub-taak maken en plannen voor uitvoering.	Toestel	GA
az iot hub job list	Vermeld de historische taken van een IoT Hub.	Toestel	GA
az iot hub job show	Details van een bestaande IoT Hub-taak weergeven.	Toestel	GA
az iot hub list	IoT-hubs vermelden.	Basis	GA
az iot hub list-skus	Lijst met beschikbare prijscategorieën.	Basis	GA
az iot hub manual-failover	Start een handmatige failover voor de IoT Hub naar de geografisch gekoppelde regio voor herstel na noodgevallen.	Basis	GA
az iot hub message-endpoint	Aangepaste eindpunten van een IoT-hub beheren.	Toestel	Preview uitvoeren
az iot hub message-endpoint create	Voeg een eindpunt toe aan een IoT Hub.	Toestel	Preview uitvoeren
az iot hub message-endpoint create cosmosdb-container	Voeg een Cosmos DB-containereindpunt toe voor een IoT Hub.	Toestel	Preview uitvoeren
az iot hub message-endpoint create eventhub	Voeg een Event Hub-eindpunt toe voor een IoT Hub.	Toestel	Preview uitvoeren
az iot hub message-endpoint create servicebus-queue	Voeg een Service Bus-wachtrij-eindpunt toe voor een IoT Hub.	Toestel	Preview uitvoeren
az iot hub message-endpoint create servicebus-topic	Voeg een Service Bus-onderwerpeindpunt toe voor een IoT Hub.	Toestel	Preview uitvoeren
az iot hub message-endpoint create storage-container	Een opslagcontainereindpunt toevoegen voor een IoT Hub.	Toestel	Preview uitvoeren
az iot hub message-endpoint delete	Verwijder alle of een specifiek eindpunt voor een IoT Hub.	Toestel	Preview uitvoeren
az iot hub message-endpoint list	Informatie ophalen over alle eindpunten voor een IoT Hub.	Toestel	Preview uitvoeren
az iot hub message-endpoint show	Informatie ophalen over het vermelde eindpunt voor een IoT Hub.	Toestel	Preview uitvoeren
az iot hub message-endpoint update	Werk de eigenschappen van een bestaand eindpunt voor een IoT Hub bij.	Toestel	Preview uitvoeren
az iot hub message-endpoint update cosmosdb-container	Werk de eigenschappen van een bestaand Cosmos DB-containereindpunt voor een IoT Hub bij.	Toestel	Preview uitvoeren
az iot hub message-endpoint update eventhub	Werk de eigenschappen van een bestaand Event Hub-eindpunt voor een IoT Hub bij.	Toestel	Preview uitvoeren
az iot hub message-endpoint update servicebus-queue	Werk de eigenschappen van een bestaand Service Bus-wachtrij-eindpunt voor een IoT Hub bij.	Toestel	Preview uitvoeren
az iot hub message-endpoint update servicebus-topic	Werk de eigenschappen van een bestaand Service Bus-onderwerpeindpunt voor een IoT Hub bij.	Toestel	Preview uitvoeren
az iot hub message-endpoint update storage-container	Werk de eigenschappen van een bestaand opslagcontainereindpunt voor een IoT Hub bij.	Toestel	Preview uitvoeren
az iot hub message-enrichment	Berichtverrijkingen voor eindpunten van een IoT Hub beheren.	Basis	GA
az iot hub message-enrichment create	Maak een berichtverrijking voor gekozen eindpunten in uw IoT Hub.	Basis	GA
az iot hub message-enrichment delete	Een berichtverrijking verwijderen in uw IoT-hub (op sleutel).	Basis	GA
az iot hub message-enrichment list	Krijg informatie over alle berichtverrijkingen voor uw IoT Hub.	Basis	GA
az iot hub message-enrichment update	Werk een berichtverrijking bij in uw IoT-hub (per sleutel).	Basis	GA
az iot hub message-route	Routes van een IoT-hub beheren.	Toestel	Preview uitvoeren
az iot hub message-route create	Voeg een route toe voor een IoT Hub.	Toestel	Preview uitvoeren
az iot hub message-route delete	Verwijder alle routes of een vermelde route in een IoT Hub.	Toestel	Preview uitvoeren
az iot hub message-route fallback	Beheer de terugvalroute van een IoT-hub.	Toestel	Preview uitvoeren
az iot hub message-route fallback set	Schakel de terugvalroute in of uit in een IoT Hub.	Toestel	Preview uitvoeren
az iot hub message-route fallback show	De terugvalroute van een IoT Hub weergeven.	Toestel	Preview uitvoeren
az iot hub message-route list	Haal alle routes op in een IoT Hub.	Toestel	Preview uitvoeren
az iot hub message-route show	Informatie over de route in een IoT Hub ophalen.	Toestel	Preview uitvoeren
az iot hub message-route test	Test alle routes of een vermelde route in een IoT Hub.	Toestel	Preview uitvoeren
az iot hub message-route update	Werk een route voor een IoT Hub bij.	Toestel	Preview uitvoeren
az iot hub module-identity	IoT-apparaatmodules beheren.	Toestel	GA
az iot hub module-identity connection-string	Beheer de verbindingsreeks van de IoT-apparaatmodule.	Toestel	GA
az iot hub module-identity connection-string show	Een ioT-doelapparaatmodule weergeven verbindingsreeks.	Toestel	GA
az iot hub module-identity create	Maak een module op een IoT-doelapparaat in een IoT Hub.	Toestel	GA
az iot hub module-identity delete	Een apparaat verwijderen in een IoT Hub.	Toestel	GA
az iot hub module-identity list	Modules weergeven die zich op een IoT-apparaat in een IoT Hub bevinden.	Toestel	GA
az iot hub module-identity renew-key	Vernieuw doelsleutels van IoT Hub-apparaatmodules met SAS-verificatie.	Toestel	GA
az iot hub module-identity show	Haal de details van een IoT-apparaatmodule op in een IoT Hub.	Toestel	GA
az iot hub module-identity update	Een IoT Hub-apparaatmodule bijwerken.	Toestel	GA
az iot hub module-twin	Configuratie van IoT-apparaatmoduledubbel beheren.	Toestel	GA
az iot hub module-twin replace	Vervang een definitie van een moduledubbel door doel-json.	Toestel	GA
az iot hub module-twin show	Een definitie van een moduledubbel weergeven.	Toestel	GA
az iot hub module-twin update	De gewenste eigenschappen en tags van de moduledubbel bijwerken.	Toestel	GA
az iot hub monitor-events	Telemetrie en berichten van apparaten bewaken die naar een IoT Hub worden verzonden.	Toestel	GA
az iot hub monitor-feedback	Controleer feedback die door apparaten wordt verzonden om C2D-berichten (cloud-to-device) te bevestigen.	Toestel	GA
az iot hub policy	Beleid voor gedeelde toegang van een IoT-hub beheren.	Basis	GA
az iot hub policy create	Maak een nieuw beleid voor gedeelde toegang in een IoT-hub.	Basis	GA
az iot hub policy delete	Een beleid voor gedeelde toegang verwijderen uit een IoT-hub.	Basis	GA
az iot hub policy list	Beleid voor gedeelde toegang van een IoT-hub weergeven.	Basis	GA
az iot hub policy renew-key	Sleutels van een gedeeld toegangsbeleid van een IoT-hub opnieuw genereren.	Basis	GA
az iot hub policy show	Krijg de details van een beleid voor gedeelde toegang van een IoT-hub.	Basis	GA
az iot hub query	Een query uitvoeren op een IoT Hub met behulp van een krachtige SQL-achtige taal.	Toestel	GA
az iot hub route	Routes van een IoT-hub beheren.	Basis	Afgeschaft
az iot hub route create	Maak een route in IoT Hub.	Basis	Afgeschaft
az iot hub route delete	Verwijder alle of vermelde route voor uw IoT Hub.	Basis	Afgeschaft
az iot hub route list	Haal alle routes op in IoT Hub.	Basis	Afgeschaft
az iot hub route show	Informatie ophalen over de route in IoT Hub.	Basis	Afgeschaft
az iot hub route test	Test alle routes of vermelde route in IoT Hub.	Basis	Afgeschaft
az iot hub route update	Een route bijwerken in IoT Hub.	Basis	Afgeschaft
az iot hub routing-endpoint	Aangepaste eindpunten van een IoT-hub beheren.	Basis	Afgeschaft
az iot hub routing-endpoint create	Voeg een eindpunt toe aan uw IoT Hub.	Basis	Afgeschaft
az iot hub routing-endpoint delete	Verwijder alle of vermelde eindpunten voor uw IoT Hub.	Basis	Afgeschaft
az iot hub routing-endpoint list	Informatie ophalen over alle eindpunten voor uw IoT Hub.	Basis	Afgeschaft
az iot hub routing-endpoint show	Informatie ophalen over het vermelde eindpunt voor uw IoT Hub.	Basis	Afgeschaft
az iot hub show	De details van een IoT-hub ophalen.	Basis	GA
az iot hub show-connection-string	De verbindingsreeks s voor een IoT-hub weergeven.	Basis	Afgeschaft
az iot hub show-quota-metrics	Haal de metrische quotumgegevens voor een IoT-hub op.	Basis	GA
az iot hub show-stats	Haal de statistieken voor een IoT-hub op.	Basis	GA
az iot hub state	De status van een IoT Hub beheren.	Toestel	Experimenteel
az iot hub state export	Exporteer de status van een IoT Hub naar een bestand.	Toestel	Experimenteel
az iot hub state import	Importeer een hubstatus van een bestand naar een IoT Hub.	Toestel	Experimenteel
az iot hub state migrate	Migreer de status van de ene hub naar een andere hub zonder op te slaan in een bestand.	Toestel	Experimenteel
az iot hub update	Metagegevens voor een IoT-hub bijwerken.	Basis	GA
az iot hub wait	Wacht totdat een bewerking op een IoT Hub-exemplaar is voltooid.	Basis	GA

az iot hub create

Bewerken

Een Azure IoT-hub maken.

Zie voor een inleiding tot Azure IoT Hub https://learn.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]

Voorbeelden

Maak een IoT Hub met de gratis prijscategorie F1 in de regio van de resourcegroep.

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

Maak een IoT Hub met de standard-prijscategorie S1 en 4 partities, in de regio Westus, met tags.

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

Maak een IoT Hub met een door het systeem toegewezen beheerde identiteit en wijs een rol en bereik toe aan een opslagaccount voor de gemaakte identiteit.

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

Een IoT Hub maken met lokale verificatie, SAS-sleutels voor apparaten en module-SAS-sleutels die allemaal zijn uitgeschakeld

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

Maak een IoT Hub met afgedwongen gegevenslocatie. Hierdoor wordt herstel na noodgevallen in meerdere regio's uitgeschakeld.

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

Vereiste parameters

--name -n

Naam van IoT Hub.

--resource-group -g

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

Optionele parameters

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

Het aantal keren dat de IoT-hub probeert een cloud-naar-apparaat-bericht te verzenden naar een apparaat, tussen 1 en 100.

Default value: 10

--c2d-ttl --ct

De hoeveelheid tijd die een bericht beschikbaar is voor gebruik door het apparaat voordat het is verlopen door IoT Hub, tussen 1 en 48 uur.

Default value: 1

--dds --disable-device-sas

Een Booleaanse waarde die aangeeft of alle apparaten (inclusief Edge-apparaten, maar met uitzondering van modules) sas-sleutels binnen het bereik van de verificatie moeten worden uitgeschakeld.

Geaccepteerde waarden: false, true

--disable-local-auth --dla

Een Booleaanse waarde die aangeeft of sas-sleutels binnen het bereik van ioT Hub moeten worden uitgeschakeld voor verificatie.

Geaccepteerde waarden: false, true

--disable-module-sas --dms

Een Booleaanse waarde die aangeeft of sas-sleutels met modulebereik moeten worden uitgeschakeld voor verificatie.

Geaccepteerde waarden: false, true

--edr --enforce-data-residency

Dwing gegevenslocatie voor deze IoT Hub af door herstel na noodgevallen tussen regio's uit te schakelen. Deze eigenschap is onveranderbaar zodra deze is ingesteld op de resource. Alleen beschikbaar in bepaalde regio's. Meer informatie op https://aka.ms/iothubdisabledr.

Geaccepteerde waarden: false, true

--fc --fileupload-storage-container-name

De naam van de hoofdcontainer waar u bestanden uploadt. De container hoeft niet te bestaan, maar moet worden gemaakt met behulp van de connectionString opgegeven.

--fcs --fileupload-storage-connectionstring

De verbindingsreeks voor het Azure Storage-account waarnaar bestanden worden geüpload.

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

Het aantal keren dat de IoT-hub een bericht probeert te bezorgen in de feedbackwachtrij, tussen 1 en 100.

Default value: 10

--feedback-lock-duration --fld

De vergrendelingsduur voor de feedbackwachtrij, tussen 5 en 300 seconden.

Default value: 5

--feedback-ttl --ft

De periode waarvoor de IoT-hub de feedback voor het verlopen of leveren van cloud-naar-apparaat-berichten tussen 1 en 48 uur behoudt.

Default value: 1

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

De vergrendelingsduur voor de wachtrij voor het uploaden van bestanden, tussen 5 en 300 seconden.

Default value: 5

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

Het aantal keren dat de IoT-hub probeert een meldingsbericht over bestanden te verzenden, tussen 1 en 100.

Default value: 10

--fileupload-notification-ttl --fnt

De hoeveelheid tijd die een melding voor het uploaden van bestanden beschikbaar is voordat de service wordt gebruikt voordat deze is verlopen door IoT Hub, tussen 1 en 48 uur.

Default value: 1

--fileupload-notifications --fn

Een Booleaanse waarde die aangeeft of er informatie moet worden geregistreerd over geüploade bestanden naar het IoT Hub-eindpunt voor berichten/servicebound/filenotifications.

Geaccepteerde waarden: false, true

Default value: False

--fileupload-sas-ttl --fst

De hoeveelheid tijd die een SAS-URI die door IoT Hub wordt gegenereerd, is geldig voordat deze verloopt, tussen 1 en 24 uur.

Default value: 1

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

Het verificatietype voor het Azure Storage-account waarnaar bestanden worden geüpload.

Geaccepteerde waarden: identityBased, keyBased

--fileupload-storage-identity --fsi

De beheerde identiteit die moet worden gebruikt voor het uploaden van bestanden. Gebruik [system]om te verwijzen naar de door het systeem toegewezen beheerde identiteit of een resource-id om te verwijzen naar een door de gebruiker toegewezen beheerde identiteit.

--location -l

Locatie van uw IoT Hub. Standaard is de locatie van de doelresourcegroep.

--mi-system-assigned

Schakel door het systeem toegewezen beheerde identiteit in voor deze hub.

Geaccepteerde waarden: false, true

--mi-user-assigned

Door de gebruiker toegewezen beheerde identiteiten inschakelen voor deze hub. Accepteer door spaties gescheiden lijst met id's van identiteitsresources.

--min-tls-version --mintls

Geef de minimale TLS-versie op die moet worden ondersteund voor deze hub. Kan worden ingesteld op '1.2' om clients te hebben die een TLS-versie lager dan 1.2 gebruiken om te worden geweigerd.

--no-wait

Wacht niet totdat de langdurige bewerking is voltooid.

Default value: False

--partition-count

Het aantal partities van de Backing Event Hub voor apparaat-naar-cloud-berichten.

Default value: 4

--rd --retention-day

Hiermee geeft u op hoe lang deze IoT-hub apparaat-naar-cloudgebeurtenissen onderhoudt, tussen 1 en 7 dagen.

Default value: 1

--role

Rol die moet worden toegewezen aan de door het systeem toegewezen beheerde identiteit van de hub.

--scopes

Door ruimte gescheiden lijst met bereiken om de rol (--role) toe te wijzen voor de door het systeem toegewezen beheerde identiteit.

--sku

Prijscategorie voor Azure IoT Hub. Houd er rekening mee dat slechts één gratis IoT Hub-exemplaar (F1) is toegestaan in elk abonnement. Er wordt een uitzondering gegenereerd als de gratis exemplaren groter zijn dan één exemplaar.

Geaccepteerde waarden: B1, B2, B3, F1, S1, S2, S3

Default value: S1

--tags

Door spaties gescheiden tags: key[=value] [key[=value] ...]. Gebruik '' om bestaande tags te wissen.

--unit

Eenheden in uw IoT Hub.

Default value: 1

Globale parameters

--debug

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

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

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

--verbose

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

az iot hub delete

Bewerken

Een IoT-hub verwijderen.

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

Voorbeelden

Een IoT-hub verwijderen. (automatisch gegenereerd)

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

Optionele parameters

--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. Geef de argumenten --id's of andere resource-id's op.

--name -n

Naam van IoT Hub.

--no-wait

Wacht niet totdat de langdurige bewerking is voltooid.

Default value: False

--resource-group -g

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

--subscription

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

Globale parameters

--debug

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

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

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

--verbose

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

az iot hub generate-sas-token

Genereer een SAS-token voor een IoT Hub- of -doelmodule.

Voor SAS-tokens voor apparaten wordt de beleidsparameter alleen gebruikt voor toegang tot het apparaatregister. Daarom moet het beleid leestoegang tot het register hebben. Voor IoT Hub-tokens maakt het beleid deel uit van de 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]

Voorbeelden

Genereer een IOT Hub SAS-token met behulp van het iothubowner-beleid en de primaire sleutel.

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

Genereer een IOT Hub SAS-token met behulp van het registryRead-beleid en de secundaire sleutel.

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

Genereer een SAS-token voor apparaten met behulp van het iothubowner-beleid voor toegang tot het apparaatregister van {iothub_name}.

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

Een SAS-token voor apparaten genereren met behulp van een IoT Hub-verbindingsreeks (met registertoegang)

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

Een IOT Hub SAS-token genereren met behulp van een IoT Hub-verbindingsreeks

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

Een SAS-token voor apparaten genereren met behulp van een apparaat verbindingsreeks

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

Een MODULE-SAS-token genereren met behulp van een module-verbindingsreeks

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

Optionele parameters

--auth-type

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

Geaccepteerde waarden: key, login

Default value: key

--connection-string --cs

Doel verbindingsreeks. Hierdoor wordt het IoT Hub-register omzeild en wordt het SAS-token rechtstreeks vanaf de opgegeven symmetrische sleutel gegenereerd zonder verdere validatie. Alle andere opdrachtparameters naast de duur worden genegeerd. Ondersteunde verbindingsreeks typen: IoT Hub, Apparaat, Module.

--device-id -d

Doelapparaat-id.

--du --duration

Geldige tokenduur in seconden.

Default value: 3600

--hub-name -n

Naam of hostnaam van IoT Hub. Vereist als --login niet is opgegeven.

--key-type --kt

Sleuteltype voor gedeeld toegangsbeleid voor verificatie.

Geaccepteerde waarden: primary, secondary

Default value: primary

--login -l

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

--module-id -m

Doelmodule-id.

--pn --policy-name

Gedeeld toegangsbeleid met bewerkingsmachtigingen voor de IoT Hub-doelentiteit.

Default value: iothubowner

--resource-group -g

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

Globale parameters

--debug

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

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

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

--verbose

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

az iot hub invoke-device-method

Een apparaatmethode aanroepen.

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

Voorbeelden

Roep een directe methode aan op een apparaat.

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

Vereiste parameters

--device-id -d

Doelapparaat-id.

--method-name --mn

Doelmethode voor aanroepen.

Optionele parameters

--auth-type

Geaccepteerde waarden: key, login

Default value: key

--hub-name -n

Naam of hostnaam van IoT Hub. Vereist als --login niet is opgegeven.

--login -l

--method-payload --mp

Json-nettolading die moet worden doorgegeven aan de methode. Moet een bestandspad of onbewerkte json zijn.

Default value: {}

--resource-group -g

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

--timeout --to

Maximum aantal seconden dat moet worden gewacht op het resultaat van de apparaatmethode.

Default value: 30

Globale parameters

--debug

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

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

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

--verbose

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

az iot hub invoke-module-method

Roep een modulemethode aan.

Deze opdracht ondersteunt zowel edge- als niet-edge-apparaatmodules.

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

Voorbeelden

Roep een directe methode aan op een edge-apparaatmodule.

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

Vereiste parameters

--device-id -d

Doelapparaat-id.

--method-name --mn

Doelmethode voor aanroepen.

--module-id -m

Doelmodule-id.

Optionele parameters

--auth-type

Geaccepteerde waarden: key, login

Default value: key

--hub-name -n

Naam of hostnaam van IoT Hub. Vereist als --login niet is opgegeven.

--login -l

--method-payload --mp

Json-nettolading die moet worden doorgegeven aan de methode. Moet een bestandspad of onbewerkte json zijn.

Default value: {}

--resource-group -g

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

--timeout --to

Maximum aantal seconden dat moet worden gewacht op het resultaat van de modulemethode.

Default value: 30

Globale parameters

--debug

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

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

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

--verbose

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

az iot hub list

Bewerken

IoT-hubs vermelden.

az iot hub list [--resource-group]

Voorbeelden

Vermeld alle IoT-hubs in een abonnement.

az iot hub list

Alle IoT-hubs weergeven in de resourcegroep 'MyGroup'

az iot hub list --resource-group MyGroup

Optionele parameters

--resource-group -g

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

Globale parameters

--debug

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

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

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

--verbose

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

az iot hub list-skus

Bewerken

Lijst met beschikbare prijscategorieën.

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

Voorbeelden

Lijst met beschikbare prijscategorieën. (automatisch gegenereerd)

az iot hub list-skus --name MyIoTHub

Optionele parameters

--ids

--name -n

Naam van IoT Hub.

--resource-group -g

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

--subscription

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

Globale parameters

--debug

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

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

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

--verbose

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

az iot hub manual-failover

Bewerken

Start een handmatige failover voor de IoT Hub naar de geografisch gekoppelde regio voor herstel na noodgevallen.

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

Voorbeelden

Start failover 'myhub' van primaire naar secundaire regio.

az iot hub manual-failover -n myhub

Optionele parameters

--ids

--name -n

Naam van IoT Hub.

--no-wait

Wacht niet totdat de langdurige bewerking is voltooid.

Default value: False

--resource-group -g

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

--subscription

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

Globale parameters

--debug

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

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

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

--verbose

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

az iot hub monitor-events

Telemetrie en berichten van apparaten bewaken die naar een IoT Hub worden verzonden.

Deze opdracht is afhankelijk van en kan afhankelijk Cython-pakket (uamqp) installeren bij de eerste uitvoering. https://github.com/Azure/azure-uamqp-python

Opmerking: de gebeurtenis wordt weergegeven, zelfs als de berichttekst niet-Unicode-decodering is, in dit geval wordt het gedeelte van de nettolading van de gebeurtenis weergegeven als {{niet-decoderingsbare nettolading}} met de rest van de beschikbare gebeurteniseigenschappen.

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

Voorbeelden

Basaal gebruik

az iot hub monitor-events -n {iothub_name}

Basisgebruik met een IoT Hub-verbindingsreeks

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

Basisgebruik bij filteren op doelapparaat

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

Basisgebruik bij het filteren van doelapparaten met een jokerteken in de id

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

Apparaten filteren met ioT Hub-querytaal

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

Filter het apparaat en geef een Event Hub-consumentengroep op waarmee u verbinding wilt maken.

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

Berichtaantekeningen ontvangen (berichtkoppen)

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

Ontvang berichtaantekeningen + systeemeigenschappen. Geen time-out.

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

Alle berichtkenmerken ontvangen van alle apparaatberichten

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

Alle berichten ontvangen en nettolading van berichten parseren als JSON

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

Ontvang het opgegeven aantal berichten van de hub en sluit het vervolgens af.

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

Optionele parameters

--cg --consumer-group -c

Geef de consumentengroep op die moet worden gebruikt bij het maken van verbinding met het Event Hub-eindpunt.

Default value: $Default

--content-type --ct

Geef het inhoudstype van de nettolading van het bericht op om de uitvoer automatisch op te maken voor dat type.

--device-id -d

Doelapparaat-id.

--device-query -q

Geef een aangepaste query op om apparaten te filteren.

--enqueued-time --et -e

Geeft de tijd aan die moet worden gebruikt als uitgangspunt om berichten van de partities te lezen. Eenheden zijn milliseconden sinds unix-epoch. Als er geen tijd wordt aangegeven dat 'nu' wordt gebruikt.

--hub-name -n

Naam of hostnaam van IoT Hub. Vereist als --login niet is opgegeven.

--interface -i

Doelinterface-id waarop moet worden gefilterd. Bijvoorbeeld: dtmi:com:example:TemperatureController;1.

--login -l

--mc --message-count

Aantal telemetrieberichten dat moet worden vastgelegd voordat de monitor wordt beëindigd. Als dit niet is opgegeven, blijft de monitor actief totdat de time-outdrempel wordt bereikt voor het niet ontvangen van berichten van de hub.

--module-id -m

Doelmodule-id.

--properties --props -p

Geef de eigenschappen van het sleutelbericht op die moeten worden uitgevoerd. sys = systeemeigenschappen, app = toepassingseigenschappen, anno = aantekeningen.

Geaccepteerde waarden: all, anno, app, sys

--repair -r

Installeer de uamqp-afhankelijkheid opnieuw die compatibel is met de extensieversie. Standaard: onwaar.

Geaccepteerde waarden: false, true

Default value: False

--resource-group -g

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

--timeout --to -t

Maximum aantal seconden om verbinding te houden zonder bericht te ontvangen. Gebruik 0 voor oneindigheid.

Default value: 300

--yes -y

Gebruikersprompts overslaan. Geeft de acceptatie van de actie aan. Wordt voornamelijk gebruikt voor automatiseringsscenario's. Standaard: onwaar.

Geaccepteerde waarden: false, true

Default value: False

Globale parameters

--debug

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

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

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

--verbose

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

az iot hub monitor-feedback

Controleer feedback die door apparaten wordt verzonden om C2D-berichten (cloud-to-device) te bevestigen.

Deze opdracht is afhankelijk van en kan afhankelijk Cython-pakket (uamqp) installeren bij de eerste uitvoering. 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}]

Voorbeelden

Basaal gebruik

az iot hub monitor-feedback -n {iothub_name}

Basisgebruik met een IoT Hub-verbindingsreeks

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

Basisgebruik bij filteren op doelapparaat

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

Feedbackmonitor afsluiten bij het ontvangen van een bericht met een specifieke id (uuid)

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

Optionele parameters

--auth-type

Geaccepteerde waarden: key, login

Default value: key

--device-id -d

Doelapparaat-id.

--hub-name -n

Naam of hostnaam van IoT Hub. Vereist als --login niet is opgegeven.

--login -l

--repair -r

Installeer de uamqp-afhankelijkheid opnieuw die compatibel is met de extensieversie. Standaard: onwaar.

Geaccepteerde waarden: false, true

Default value: False

--resource-group -g

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

--wait-on-msg -w

De feedbackmonitor wordt geblokkeerd totdat een bericht met een specifieke id (uuid) wordt ontvangen.

--yes -y

Gebruikersprompts overslaan. Geeft de acceptatie van de actie aan. Wordt voornamelijk gebruikt voor automatiseringsscenario's. Standaard: onwaar.

Geaccepteerde waarden: false, true

Default value: False

Globale parameters

--debug

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

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

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

--verbose

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

az iot hub query

Een query uitvoeren op een IoT Hub met behulp van een krachtige SQL-achtige taal.

Informatie ophalen met betrekking tot apparaat- en moduledubbels, taken en berichtroutering. Zie https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language voor meer informatie.

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

Voorbeelden

Voer een query uit op alle apparaatdubbelgegevens in een Azure IoT Hub.

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

Voer een query uit op alle moduledubbelgegevens op het doelapparaat.

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

Vereiste parameters

--query-command -q

Gebruikersquery die moet worden uitgevoerd.

Optionele parameters

--auth-type

Geaccepteerde waarden: key, login

Default value: key

--hub-name -n

Naam of hostnaam van IoT Hub. Vereist als --login niet is opgegeven.

--login -l

--resource-group -g

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

--top

Maximum aantal elementen dat moet worden geretourneerd. De query heeft standaard geen limiet.

Globale parameters

--debug

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

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

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

--verbose

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

az iot hub show

Bewerken

De details van een IoT-hub ophalen.

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

Voorbeelden

De details van een IoT-hub ophalen. (automatisch gegenereerd)

az iot hub show --name MyIoTHub

Optionele parameters

--ids

--name -n

Naam van IoT Hub.

--resource-group -g

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

--subscription

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

Globale parameters

--debug

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

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

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

--verbose

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

az iot hub show-connection-string

Bewerken

Afgeschaft

Deze opdracht is afgeschaft en wordt verwijderd in een toekomstige release. Gebruik in plaats daarvan de opdracht 'IoT Extension (azure-iot) connection-string (az iot hub connection-string show)'.

De verbindingsreeks s voor een IoT-hub weergeven.

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

Voorbeelden

De verbindingsreeks van een IoT-hub weergeven met behulp van standaardbeleid en primaire sleutel.

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

De verbindingsreeks van een IoT Hub weergeven met behulp van beleidsservice en secundaire sleutel.

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

De verbindingsreeks s voor alle IoT-hubs in een resourcegroep weergeven.

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

De verbindingsreeks s voor alle IoT-hubs in een abonnement weergeven.

az iot hub show-connection-string

De verbindingsreeks s voor een IoT-hub weergeven. (automatisch gegenereerd)

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

Optionele parameters

--all

Toestaan dat alle beleidsregels voor gedeelde toegang worden weergegeven.

Default value: False

--hub-name --name -n

Naam van IoT Hub.

--ids

--key

De sleutel die moet worden gebruikt.

Geaccepteerde waarden: primary, secondary

Default value: primary

--policy-name

Beleid voor gedeelde toegang dat moet worden gebruikt.

Default value: iothubowner

--resource-group -g

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

--subscription

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

Globale parameters

--debug

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

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

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

--verbose

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

az iot hub show-quota-metrics

Bewerken

Haal de metrische quotumgegevens voor een IoT-hub op.

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

Voorbeelden

Haal de metrische quotumgegevens voor een IoT-hub op. (automatisch gegenereerd)

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

Haal de metrische quotumgegevens voor een IoT-hub op. (automatisch gegenereerd)

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

Optionele parameters

--ids

--name -n

Naam van IoT Hub.

--resource-group -g

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

--subscription

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

Globale parameters

--debug

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

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

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

--verbose

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

az iot hub show-stats

Bewerken

Haal de statistieken voor een IoT-hub op.

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

Voorbeelden

Haal de statistieken voor een IoT-hub op. (automatisch gegenereerd)

az iot hub show-stats --name MyIoTHub

Optionele parameters

--ids

--name -n

Naam van IoT Hub.

--resource-group -g

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

--subscription

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

Globale parameters

--debug

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

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

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

--verbose

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

az iot hub update

Bewerken

Metagegevens voor een IoT-hub bijwerken.

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]
                  [--fcu]
                  [--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]

Voorbeelden

Opslagcontainerinstellingen toevoegen voor het uploaden van bestanden

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

Voeg een firewallfilterregel toe om verkeer van het IP-masker 127.0.0.0/31 te accepteren.

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

Metagegevens voor een IoT-hub bijwerken. (automatisch gegenereerd)

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

Eenheden van een IoT Hub bijwerken naar 2 en tags toevoegen

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

Prijscategorie voor een IoT Hub bijwerken als S2

az iot hub update -n MyIotHub --sku S2

De retentiedagen van IoT Hub-apparaat-naar-cloudgebeurtenissen bijwerken als 3 dagen

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

De instellingen voor cloud-naar-apparaat-berichten voor IoT Hub bijwerken

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

De instellingen voor de feedbackwachtrij van IoT Hub bijwerken

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

Werk de uploadinstellingen van het IoT Hub-bestand bij en wijs een beheerde identiteit toe aan de gebruiker voor het uploaden van bestanden

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

De instellingen voor het uploaden van ioT Hub-bestanden en de duur van de wachtrijvergrendeling bijwerken

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

De lokale verificatie, apparaat-SAS en module-SAS-instellingen voor IoT Hub bijwerken

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

Optionele parameters

--add

Voeg een object toe aan een lijst met objecten door een pad- en sleutelwaardeparen op te geven. Voorbeeld: --add property.listProperty <key=value, string or JSON string>.

Default value: []

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

Het aantal keren dat de IoT-hub probeert een cloud-naar-apparaat-bericht te verzenden naar een apparaat, tussen 1 en 100.

--c2d-ttl --ct

De hoeveelheid tijd die een bericht beschikbaar is voor gebruik door het apparaat voordat het is verlopen door IoT Hub, tussen 1 en 48 uur.

--dds --disable-device-sas

Een Booleaanse waarde die aangeeft of alle apparaten (inclusief Edge-apparaten, maar met uitzondering van modules) sas-sleutels binnen het bereik van de verificatie moeten worden uitgeschakeld.

Geaccepteerde waarden: false, true

--disable-local-auth --dla

Een Booleaanse waarde die aangeeft of sas-sleutels binnen het bereik van ioT Hub moeten worden uitgeschakeld voor verificatie.

Geaccepteerde waarden: false, true

--disable-module-sas --dms

Een Booleaanse waarde die aangeeft of sas-sleutels met modulebereik moeten worden uitgeschakeld voor verificatie.

Geaccepteerde waarden: false, true

--fc --fileupload-storage-container-name

De naam van de hoofdcontainer waar u bestanden uploadt. De container hoeft niet te bestaan, maar moet worden gemaakt met behulp van de connectionString opgegeven.

--fcs --fileupload-storage-connectionstring

De verbindingsreeks voor het Azure Storage-account waarnaar bestanden worden geüpload.

--fcu --fileupload-storage-container-uri

Afgeschaft

Het argument 'fileupload_storage_container_uri' is afgeschaft en wordt verwijderd in een toekomstige release.

De container-URI voor het Azure Storage-account waarnaar bestanden worden geüpload.

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

Het aantal keren dat de IoT-hub een bericht probeert te bezorgen in de feedbackwachtrij, tussen 1 en 100.

--feedback-lock-duration --fld

De vergrendelingsduur voor de feedbackwachtrij, tussen 5 en 300 seconden.

--feedback-ttl --ft

De periode waarvoor de IoT-hub de feedback voor het verlopen of leveren van cloud-naar-apparaat-berichten tussen 1 en 48 uur behoudt.

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

De vergrendelingsduur voor de wachtrij voor het uploaden van bestanden, tussen 5 en 300 seconden.

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

Het aantal keren dat de IoT-hub probeert een meldingsbericht over bestanden te verzenden, tussen 1 en 100.

--fileupload-notification-ttl --fnt

De hoeveelheid tijd die een melding voor het uploaden van bestanden beschikbaar is voordat de service wordt gebruikt voordat deze is verlopen door IoT Hub, tussen 1 en 48 uur.

--fileupload-notifications --fn

Een Booleaanse waarde die aangeeft of er informatie moet worden geregistreerd over geüploade bestanden naar het IoT Hub-eindpunt voor berichten/servicebound/filenotifications.

Geaccepteerde waarden: false, true

--fileupload-sas-ttl --fst

De hoeveelheid tijd die een SAS-URI die door IoT Hub wordt gegenereerd, is geldig voordat deze verloopt, tussen 1 en 24 uur.

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

Het verificatietype voor het Azure Storage-account waarnaar bestanden worden geüpload.

Geaccepteerde waarden: identityBased, keyBased

--fileupload-storage-identity --fsi

--force-string

Wanneer u 'set' of 'toevoegen' gebruikt, behoudt u letterlijke tekenreeksen in plaats van te converteren naar JSON.

Default value: False

--ids

--name -n

Naam van IoT Hub.

--rd --retention-day

Hiermee geeft u op hoe lang deze IoT-hub apparaat-naar-cloudgebeurtenissen onderhoudt, tussen 1 en 7 dagen.

--remove

Een eigenschap of element uit een lijst verwijderen. Voorbeeld: --remove property.list <indexToRemove> OF --remove propertyToRemove.

Default value: []

--resource-group -g

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

--set

Werk een object bij door een eigenschapspad en waarde op te geven die u wilt instellen. Voorbeeld: --set property1.property2=<value>.

Default value: []

--sku

Geaccepteerde waarden: B1, B2, B3, F1, S1, S2, S3

--subscription

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

--tags

Door spaties gescheiden tags: key[=value] [key[=value] ...]. Gebruik '' om bestaande tags te wissen.

--unit

Eenheden in uw IoT Hub.

Globale parameters

--debug

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

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

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

--verbose

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

az iot hub wait

Bewerken

Wacht totdat een bewerking op een IoT Hub-exemplaar is voltooid.

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

Voorbeelden

Wacht totdat een bestaand IoT Hub-exemplaar is gemaakt

az iot hub wait -n MyIoTHub --created

Wacht totdat een IoT Hub-exemplaar is verwijderd

az iot hub wait -n MyIoTHub --deleted

Wacht totdat een bestaand IoT Hub-exemplaar de status Actief heeft

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

Optionele parameters

--created

Wacht totdat u 'provisioningState' hebt gemaakt bij 'Succeeded'.

Default value: False

--custom

Wacht tot de voorwaarde voldoet aan een aangepaste JMESPath-query. Bijvoorbeeld provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wacht totdat deze is verwijderd.

Default value: False

--exists

Wacht tot de resource bestaat.

Default value: False

--ids

--interval

Polling-interval in seconden.

Default value: 30

--name -n

Naam van IoT Hub.

--resource-group -g

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

--subscription

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

--timeout

Maximale wachttijd in seconden.

Default value: 3600

--updated

Wacht totdat deze is bijgewerkt met provisioningState op 'Succeeded'.

Default value: False

Globale parameters

--debug

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

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

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

--verbose

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

Delen via

az iot hub

Opdracht

az iot hub create

Voorbeelden

Vereiste parameters

Optionele parameters

az iot hub delete

Voorbeelden

Optionele parameters

az iot hub generate-sas-token

Voorbeelden

Optionele parameters

az iot hub invoke-device-method

Voorbeelden

Vereiste parameters

Optionele parameters

az iot hub invoke-module-method

Voorbeelden

Vereiste parameters

Optionele parameters

az iot hub list

Voorbeelden

Optionele parameters

az iot hub list-skus

Voorbeelden

Optionele parameters

az iot hub manual-failover

Voorbeelden

Optionele parameters

az iot hub monitor-events

Voorbeelden

Optionele parameters

az iot hub monitor-feedback

Voorbeelden

Optionele parameters

az iot hub query

Voorbeelden

Vereiste parameters

Optionele parameters

az iot hub show

Voorbeelden

Optionele parameters

az iot hub show-connection-string

Voorbeelden

Optionele parameters

az iot hub show-quota-metrics

Voorbeelden

Optionele parameters

az iot hub show-stats

Voorbeelden

Optionele parameters

az iot hub update

Voorbeelden

Optionele parameters

az iot hub wait

Voorbeelden

Optionele parameters

Aanvullende resources