az iot hub

Azure IoT-hubs beheren.

Opdracht

az iot hub certificate

Beheer IoT Hub certificaten.

az iot hub certificate create

Een certificaat voor Azure IoT Hub maken/uploaden.

az iot hub certificate delete

Hiermee verwijdert u een Azure IoT Hub certificaat.

az iot hub certificate generate-verification-code

Genereert een verificatiecode voor een Azure IoT Hub certificaat.

az iot hub certificate list

Een lijst met alle certificaten in een Azure IoT Hub.

az iot hub certificate show

Geeft informatie weer over een bepaald Azure IoT Hub certificaat.

az iot hub certificate update

Werk een Azure IoT Hub certificaat bij.

az iot hub certificate verify

Verifieert een Azure IoT Hub certificaat.

az iot hub configuration

Automatische configuratie van IoT-apparaatbeheer op schaal beheren.

az iot hub configuration create

Maak een automatische IoT-configuratie voor apparaatbeheer in een IoT Hub.

az iot hub configuration delete

Een IoT-apparaatconfiguratie verwijderen.

az iot hub configuration list

IoT-configuraties voor automatisch apparaatbeheer in een IoT Hub.

az iot hub configuration show

De details van een automatische IoT-configuratie voor apparaatbeheer op halen.

az iot hub configuration show-metric

Evalueer de metrische gegevens van een doelgebruiker of -systeem die zijn gedefinieerd in een IoT-apparaatconfiguratie.

az iot hub configuration update

De opgegeven eigenschappen van een automatische IoT-apparaatbeheerconfiguratie bijwerken.

Gebruik --set gevolgd door eigenschapstoewijzingen voor het bijwerken van een configuratie.

Opmerking: Configuratie-inhoud is onveranderbaar. Configuratie-eigenschappen die kunnen worden bijgewerkt, zijn 'labels', 'metrische gegevens', 'prioriteit' en 'targetCondition'.

az iot hub connection-string

Beheer IoT Hub verbindingsreeksen.

az iot hub connection-string show

De verbindingsreeksen voor de opgegeven IoT Hubs met behulp van de opgegeven beleidsnaam en -sleutel.

az iot hub consumer-group

De Event Hub-consumentengroepen van een IoT-hub beheren.

az iot hub consumer-group create

Maak een Event Hub-consumentengroep.

az iot hub consumer-group delete

Een Event Hub-consumentengroep verwijderen.

az iot hub consumer-group list

Event Hub-consumentengroepen op een lijst zetten.

az iot hub consumer-group show

Haal de details op voor een Event Hub-consumentengroep.

az iot hub create

Een Azure IoT-hub maken.

az iot hub delete

Een IoT-hub verwijderen.

az iot hub device-identity

IoT-apparaten beheren.

az iot hub device-identity children

Beheer het apparaat met de kinderen van het IoT-apparaat.

az iot hub device-identity children add

Opgegeven door spaties gescheiden lijst met apparaat-id's toevoegen als kinderen van opgegeven edge-apparaat.

az iot hub device-identity children list

Uitvoerlijst met toegewezen onderliggende apparaten.

az iot hub device-identity children remove

Apparaten verwijderen als kinderen van opgegeven edge-apparaat.

az iot hub device-identity connection-string

Beheer de IoT-connection string.

az iot hub device-identity connection-string show

Een bepaald IoT Hub apparaat connection string.

az iot hub device-identity create

Maak een apparaat in een IoT Hub.

az iot hub device-identity delete

Een IoT Hub verwijderen.

az iot hub device-identity export

Exporteert alle apparaat-id's van een IoT Hub naar een Azure Storage blobcontainer. Raadpleeg de invoerregels van uw omgeving voor sas-uri-invoer in een inline-blobcontainer.

az iot hub device-identity import

Apparaat-id's importeren in een IoT Hub van een blob. Raadpleeg de invoerregels van uw omgeving voor sas-uri-invoer in een inline-blobcontainer.

az iot hub device-identity list

Apparaten in een IoT Hub.

az iot hub device-identity parent

Het bovenliggende apparaat van het IoT-apparaat beheren.

az iot hub device-identity parent set

Stel het bovenliggende apparaat van het opgegeven apparaat in.

az iot hub device-identity parent show

Haal het bovenliggende apparaat van het opgegeven apparaat op.

az iot hub device-identity renew-key

Vernieuw de doelsleutels van IoT Hub apparaat met SAS-verificatie.

az iot hub device-identity show

De details van een IoT Hub apparaat.

az iot hub device-identity update

Werk een IoT Hub apparaat bij.

az iot hub devicestream

Apparaatstreams van een IoT-hub beheren.

az iot hub devicestream show

Haal IoT Hub van de apparaatstreams op.

az iot hub device-twin

Configuratie van IoT-apparaattwee beheren.

az iot hub device-twin replace

Vervang de definitie van de apparaattwee door de doel-json.

az iot hub device-twin show

Haal een definitie van een apparaattweeling op.

az iot hub device-twin update

Werk de gewenste eigenschappen en tags van de apparaattweeling bij.

az iot hub digital-twin

De digitale dubbel van een apparaat met IoT Hub bewerken en gebruiken.

az iot hub digital-twin invoke-command

Roep een opdracht op hoofd- of onderdeelniveau aan van een digital twin-apparaat.

az iot hub digital-twin show

De digitale dubbel van een IoT Hub apparaat.

az iot hub digital-twin update

Werk de lees-/schrijfeigenschappen van een digital twin-apparaat bij via de JSON-patchspecificatie.

az iot hub distributed-tracing

Gedistribueerde instellingen per apparaat beheren.

az iot hub distributed-tracing show

Haal de gedistribueerde traceringsinstellingen voor een apparaat op.

az iot hub distributed-tracing update

Werk de gedistribueerde traceringsopties voor een apparaat bij.

az iot hub generate-sas-token

Genereer een SAS-token voor een IoT Hub, apparaat of module.

az iot hub identity

Identiteiten van een Azure IoT-hub beheren.

az iot hub identity assign

Beheerde identiteiten toewijzen aan een IoT Hub.

az iot hub identity remove

Beheerde identiteiten uit een IoT Hub.

az iot hub identity show

De identiteitseigenschappen van een IoT Hub.

az iot hub invoke-device-method

Roep een apparaatmethode aan.

az iot hub invoke-module-method

Roep een Edge-modulemethode aan.

az iot hub job

Beheer IoT Hub taken (v2).

az iot hub job cancel

Annuleer een IoT Hub taak.

az iot hub job create

Maak en plan een IoT Hub taak voor uitvoering.

az iot hub job list

De historische taken van een IoT Hub.

az iot hub job show

Details van een bestaande IoT Hub taak.

az iot hub list

Lijst met IoT-hubs.

az iot hub list-skus

Lijst met beschikbare prijslagen.

az iot hub manual-failover

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

az iot hub message-enrichment

Berichtverrijkingen voor eindpunten van een IoT Hub.

az iot hub message-enrichment create

Maak een berichtverrijking voor de gekozen eindpunten in uw IoT Hub.

az iot hub message-enrichment delete

Verwijder een berichtverrijking in uw IoT-hub (op sleutel).

az iot hub message-enrichment list

Informatie over alle berichtverrijkingen voor uw IoT Hub.

az iot hub message-enrichment update

Werk een berichtverrijking bij in uw IoT-hub (op sleutel).

az iot hub module-identity

IoT-apparaatmodules beheren.

az iot hub module-identity connection-string

Beheer de connection string van IoT-connection string.

az iot hub module-identity connection-string show

Een doel-IoT-apparaatmodule connection string.

az iot hub module-identity create

Maak een module op een doel-IoT-apparaat in een IoT Hub.

az iot hub module-identity delete

Verwijder een apparaat in een IoT Hub.

az iot hub module-identity list

Een lijst met modules op een IoT-apparaat in een IoT Hub.

az iot hub module-identity renew-key

Vernieuw de doelsleutels van IoT Hub apparaatmodule met SAS-verificatie.

az iot hub module-identity show

De details van een IoT-apparaatmodule in een IoT Hub.

az iot hub module-identity update

Werk een IoT Hub apparaatmodule bij.

az iot hub module-twin

Configuratie van IoT-apparaatmodule dubbel beheren.

az iot hub module-twin replace

Vervang de definitie van een module twin door de doel-json.

az iot hub module-twin show

Een definitie van een module-dubbel tonen.

az iot hub module-twin update

Werk de gewenste eigenschappen en tags van module twin bij.

az iot hub monitor-events

Telemetrie van apparaten bewaken & verzonden berichten naar een IoT Hub.

az iot hub monitor-feedback

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

az iot hub policy

Beleid voor gedeelde toegang van een IoT-hub beheren.

az iot hub policy create

Maak een nieuw beleid voor gedeelde toegang in een IoT-hub.

az iot hub policy delete

Een beleid voor gedeelde toegang verwijderen uit een IoT-hub.

az iot hub policy list

Lijst met beleidsregels voor gedeelde toegang van een IoT-hub.

az iot hub policy renew-key

Sleutels van een beleid voor gedeelde toegang van een IoT-hub opnieuw maken.

az iot hub policy show

Haal de details op van een beleid voor gedeelde toegang van een IoT-hub.

az iot hub query

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

az iot hub route

Routes van een IoT-hub beheren.

az iot hub route create

Maak een route in IoT Hub.

az iot hub route delete

Verwijder alle of genoemde route voor uw IoT Hub.

az iot hub route list

Haal alle routes in IoT Hub.

az iot hub route show

Informatie over de route in IoT Hub.

az iot hub route test

Test alle routes of de vermelde route in IoT Hub.

az iot hub route update

Een route bijwerken in IoT Hub.

az iot hub routing-endpoint

Aangepaste eindpunten van een IoT-hub beheren.

az iot hub routing-endpoint create

Voeg een eindpunt toe aan uw IoT Hub.

az iot hub routing-endpoint delete

Verwijder alle of genoemde eindpunten voor uw IoT Hub.

az iot hub routing-endpoint list

Informatie over alle eindpunten voor uw IoT Hub.

az iot hub routing-endpoint show

Informatie over het vermelde eindpunt voor uw IoT Hub.

az iot hub show

De details van een IoT-hub op te halen.

az iot hub show-connection-string

De verbindingsreeksen voor een IoT-hub tonen.

az iot hub show-quota-metrics

De metrische quotumgegevens voor een IoT-hub op te halen.

az iot hub show-stats

De statistieken voor een IoT-hub op te halen.

az iot hub update

Metagegevens voor een IoT-hub bijwerken.

az iot hub create

Een Azure IoT-hub maken.

Zie voor een inleiding tot https://docs.microsoft.com/azure/iot-hub/ Azure IoT Hub.

az iot hub create --name
                  --resource-group
                  [--c2d-max-delivery-count]
                  [--c2d-ttl]
                  [--fc]
                  [--fcs]
                  [--fcu]
                  [--fd]
                  [--feedback-lock-duration]
                  [--feedback-ttl]
                  [--fileupload-notification-max-delivery-count]
                  [--fileupload-notification-ttl]
                  [--fileupload-notifications {false, true}]
                  [--fileupload-sas-ttl]
                  [--fileupload-storage-auth-type]
                  [--fileupload-storage-identity]
                  [--location]
                  [--mi-system-assigned {false, true}]
                  [--mi-user-assigned]
                  [--min-tls-version]
                  [--partition-count]
                  [--rd]
                  [--role]
                  [--scopes]
                  [--sku {B1, B2, B3, F1, S1, S2, S3}]
                  [--subscription]
                  [--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}

Vereiste parameters

--name -n

IoT Hub naam.

--resource-group -g

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

Optionele parameters

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

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

standaardwaarde: 10
--c2d-ttl --ct

Hoe lang een bericht beschikbaar is om het apparaat te gebruiken voordat het door IoT Hub verloopt, tussen 1 en 48 uur.

standaardwaarde: 1
--fc --fileupload-storage-container-name

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

--fcs --fileupload-storage-connectionstring

De connection string voor het Azure Storage-account naar welke bestanden worden geüpload.

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

De container-URI voor het Azure Storage account naar welke 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.

standaardwaarde: 10
--feedback-lock-duration --fld

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

standaardwaarde: 5
--feedback-ttl --ft

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

standaardwaarde: 1
--fileupload-notification-max-delivery-count --fnd

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

standaardwaarde: 10
--fileupload-notification-ttl --fnt

Hoe lang een melding over het uploaden van bestanden beschikbaar is voor de service voordat deze is verlopen door IoT Hub, tussen 1 en 48 uur.

standaardwaarde: 1
--fileupload-notifications --fn

Een booleaanse tekst die aangeeft of informatie over geüploade bestanden moet worden geüpload naar de berichten/servicebound/filenotifications IoT Hub eindpunt.

geaccepteerde waarden: false, true
--fileupload-sas-ttl --fst

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

standaardwaarde: 1
--fileupload-storage-auth-type --fsa

Het verificatietype voor het Azure Storage account naar welke bestanden worden geüpload. Mogelijke waarden zijn keyBased en identityBased.

--fileupload-storage-identity --fsi

De beheerde identiteit die moet worden gebruikt voor verificatie bij 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 een 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 een door spatie 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.

--partition-count

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

standaardwaarde: 4
--rd --retention-day

Hiermee geeft u op hoelang deze IoT-hub apparaat-naar-cloud-gebeurtenissen onderhoudt, tussen 1 en 7 dagen.

standaardwaarde: 1
--role

Rol voor het toewijzen aan de door het systeem toegewezen beheerde identiteit van de hub.

--scopes

Door spatie gescheiden lijst met scopes voor het toewijzen van de rol (--role) 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 gemaakt als gratis exemplaren er één overschrijden.

geaccepteerde waarden: B1, B2, B3, F1, S1, S2, S3
standaardwaarde: S1
--subscription

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

--tags

Door spatie gescheiden tags: sleutel[=waarde] [sleutel[=waarde] ...]. Gebruik '' om bestaande tags te verwijderen.

--unit

Eenheden in uw IoT Hub.

standaardwaarde: 1

az iot hub delete

Een IoT-hub verwijderen.

az iot hub delete [--ids]
                  [--name]
                  [--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 (door spaties scheidingstekens). Dit moet een volledige resource-id zijn die alle gegevens van de argumenten 'Resource-id' bevat. U moet --id's of andere argumenten voor resource-id's verstrekken.

--name -n

IoT Hub naam.

--resource-group -g

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

--subscription

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

az iot hub generate-sas-token

Genereer een SAS-token voor een IoT Hub, apparaat of module.

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 beleid iothubowner 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 het apparaat met behulp van het iothubowner-beleid voor toegang tot het {iothub_name}-apparaatregister.

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

Een SAS-token voor een apparaat genereren met behulp van IoT Hub connection string (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 connection string

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

Een SAS-apparaat-token genereren met behulp van een Device connection string

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

Een SAS-token voor modules genereren met behulp van een module-connection string

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

Geeft aan of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. U kunt de standaardinstelling configureren met az configure --defaults iothub-data-auth-type=<auth-type-value> behulp van .

geaccepteerde waarden: key, login
standaardwaarde: key
--connection-string --cs

Doel connection string. Hiermee wordt het IoT Hub omzeild en wordt het SAS-token rechtstreeks vanuit de opgegeven symmetrische sleutel gegenereerd zonder verdere validatie. Alle andere opdrachtparameters, afgezien van de duur, worden genegeerd. Ondersteunde connection string: IoT Hub, Apparaat, Module.

--device-id -d

Doelapparaat.

--du --duration

Geldige tokenduur in seconden.

standaardwaarde: 3600
--hub-name -n

IoT Hub naam.

--key-type --kt

Sleuteltype voor beleid voor gedeelde toegang voor verificatie.

geaccepteerde waarden: primary, secondary
standaardwaarde: primary
--login -l

Deze opdracht ondersteunt een entiteitsgroep connection string rechten om actie uit te voeren. Gebruik om sessie-aanmelding via 'az login' te voorkomen. Als zowel een entiteits-connection string als de naam zijn opgegeven, heeft connection string prioriteit.

--module-id -m

Doelmodule.

--pn --policy-name

Beleid voor gedeelde toegang met bewerkingsmachtigingen voor de IoT Hub entiteit.

standaardwaarde: iothubowner
--resource-group -g

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

az iot hub invoke-device-method

Roep een apparaatmethode aan.

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 op het apparaat aan vanuit de cloud.

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.

--method-name --mn

Doelmethode voor aanroepen.

Optionele parameters

--auth-type

Geeft aan of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. U kunt de standaardinstelling configureren met az configure --defaults iothub-data-auth-type=<auth-type-value> behulp van .

geaccepteerde waarden: key, login
standaardwaarde: key
--hub-name -n

IoT Hub naam.

--login -l

Deze opdracht ondersteunt een entiteitsgroep connection string rechten om actie uit te voeren. Gebruik om sessie-aanmelding via 'az login' te voorkomen. Als zowel een entiteits-connection string als de naam zijn opgegeven, heeft connection string prioriteit.

--method-payload --mp

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

standaardwaarde: {}
--resource-group -g

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

--timeout --to

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

standaardwaarde: 30

az iot hub invoke-module-method

Roep een Edge-modulemethode aan.

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-apparaat met behulp van een module vanuit de cloud.

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.

--method-name --mn

Doelmethode voor aanroepen.

--module-id -m

Doelmodule.

Optionele parameters

--auth-type

Geeft aan of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. U kunt de standaardinstelling configureren met az configure --defaults iothub-data-auth-type=<auth-type-value> behulp van .

geaccepteerde waarden: key, login
standaardwaarde: key
--hub-name -n

IoT Hub naam.

--login -l

Deze opdracht ondersteunt een entiteitsgroep connection string rechten om actie uit te voeren. Gebruik om sessie-aanmelding via 'az login' te voorkomen. Als zowel een entiteits-connection string als de naam zijn opgegeven, heeft connection string prioriteit.

--method-payload --mp

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

standaardwaarde: {}
--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.

standaardwaarde: 30

az iot hub list

Lijst met IoT-hubs.

az iot hub list [--query-examples]
                [--resource-group]
                [--subscription]

Voorbeelden

Vermeld alle IoT-hubs in een abonnement.

az iot hub list

Alle IoT-hubs in de resourcegroep 'MyGroup'

az iot hub list --resource-group MyGroup

Optionele parameters

--query-examples

JMESPath-tekenreeks voor u aanbevelen. U kunt een van de query's kopiëren en plakken na de parameter --query tussen dubbele aanhalingstekens om de resultaten te bekijken. U kunt een of meer positionele trefwoorden toevoegen, zodat we suggesties kunnen geven op basis van deze sleutelwoorden.

--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 az account set -s NAME_OR_ID behulp van .

az iot hub list-skus

Lijst met beschikbare prijslagen.

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

Voorbeelden

Lijst met beschikbare prijslagen. (automatisch gegenereerd)

az iot hub list-skus --name MyIoTHub

Optionele parameters

--ids

Een of meer resource-ID's (door spaties scheidingstekens). Dit moet een volledige resource-id zijn die alle gegevens van de argumenten 'Resource-id' bevat. U moet --id's of andere argumenten voor resource-id's verstrekken.

--name -n

IoT Hub naam.

--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 az account set -s NAME_OR_ID behulp van .

az iot hub manual-failover

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

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

Voorbeelden

Start de failover 'myhub' van de primaire naar de secundaire regio.

az iot hub manual-failover -n myhub

Optionele parameters

--ids

Een of meer resource-ID's (door spaties scheidingstekens). Dit moet een volledige resource-id zijn die alle gegevens van de argumenten 'Resource-id' bevat. U moet --id's of andere argumenten voor resource-id's verstrekken.

--name -n

IoT Hub naam.

--no-wait

Wacht niet tot de langlopende bewerking is uitgevoerd.

--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 az account set -s NAME_OR_ID behulp van .

az iot hub monitor-events

Telemetrie van apparaten bewaken & verzonden berichten naar een IoT Hub.

EXPERIMENTAL vereist Python 3.5+ 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-events [--cg]
                          [--content-type]
                          [--device-id]
                          [--device-query]
                          [--enqueued-time]
                          [--hub-name]
                          [--interface]
                          [--login]
                          [--module-id]
                          [--properties {all, anno, app, sys}]
                          [--repair {false, true}]
                          [--resource-group]
                          [--timeout]
                          [--yes {false, true}]

Voorbeelden

Basisgebruik

az iot hub monitor-events -n {iothub_name}

Basisgebruik met een IoT Hub connection string

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 behulp 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 om aan te binden.

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

Berichtaantekeningen ontvangen (berichtheaders)

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

Berichtaantekeningen en systeemeigenschappen ontvangen. Nooit een time-out.

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

Alle berichtkenmerken van alle apparaatberichten ontvangen

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

Optionele parameters

--cg --consumer-group -c

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

standaardwaarde: $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.

--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 voor het lezen van berichten uit de partities. Eenheden zijn milliseconden sinds unix-epoche. Als er geen tijd wordt aangegeven 'nu' wordt gebruikt.

--hub-name -n

IoT Hub naam.

--interface -i

Doelinterface-id om op te filteren. Bijvoorbeeld: dtmi:com:example:TemperatureController;1.

--login -l

Deze opdracht ondersteunt een entiteitsgroep connection string rechten om actie uit te voeren. Gebruik om sessie-aanmelding via 'az login' te voorkomen. Als zowel een entiteits-connection string als de naam zijn opgegeven, heeft connection string prioriteit.

--module-id -m

Doelmodule.

--properties --props -p

Geef de belangrijkste berichteigenschappen aan die moeten worden uitgevoerd. sys = systeemeigenschappen, app = toepassingseigenschappen, anno = aantekeningen.

geaccepteerde waarden: all, anno, app, sys
--repair -r

Uamqp-afhankelijkheid opnieuw installeren die compatibel is met de extensieversie. Standaard: onwaar.

geaccepteerde waarden: false, true
--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 oneindig.

standaardwaarde: 300
--yes -y

Gebruikersprompts overslaan. Geeft aan dat de installatie van afhankelijkheden is geaccepteerd (indien nodig). Voornamelijk gebruikt voor automatiseringsscenario's. Standaard: onwaar.

geaccepteerde waarden: false, true

az iot hub monitor-feedback

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

EXPERIMENTAL vereist Python 3.4+ 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

Basisgebruik

az iot hub monitor-feedback -n {iothub_name}

Basisgebruik met een IoT Hub connection string

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

Geeft aan of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. U kunt de standaardinstelling configureren met az configure --defaults iothub-data-auth-type=<auth-type-value> behulp van .

geaccepteerde waarden: key, login
standaardwaarde: key
--device-id -d

Doelapparaat.

--hub-name -n

IoT Hub naam.

--login -l

Deze opdracht ondersteunt een entiteitsgroep connection string rechten om actie uit te voeren. Gebruik om sessie-aanmelding via 'az login' te voorkomen. Als zowel een entiteits-connection string als de naam zijn opgegeven, heeft connection string prioriteit.

--repair -r

Uamqp-afhankelijkheid opnieuw installeren die compatibel is met de extensieversie. Standaard: onwaar.

geaccepteerde waarden: false, true
--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

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

--yes -y

Gebruikersprompts overslaan. Geeft aan dat de installatie van afhankelijkheden is geaccepteerd (indien nodig). Voornamelijk gebruikt voor automatiseringsscenario's. Standaard: onwaar.

geaccepteerde waarden: false, true

az iot hub query

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

Een query IoT Hub met behulp van een krachtige SQL-achtige taal om informatie op te halen met betrekking tot apparaat- en module-tweelingen, 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

Query's uitvoeren op alle apparaatgegevens in een Azure IoT Hub.

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

Query's uitvoeren op alle module twin-gegevens 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

Geeft aan of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. U kunt de standaardinstelling configureren met az configure --defaults iothub-data-auth-type=<auth-type-value> behulp van .

geaccepteerde waarden: key, login
standaardwaarde: key
--hub-name -n

IoT Hub naam.

--login -l

Deze opdracht ondersteunt een entiteitsgroep connection string rechten om actie uit te voeren. Gebruik om sessie-aanmelding via 'az login' te voorkomen. Als zowel een entiteits-connection string als de naam zijn opgegeven, heeft connection string prioriteit.

--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 retourneren. Standaard heeft de query geen limiet.

az iot hub show

De details van een IoT-hub op te halen.

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

Voorbeelden

De details van een IoT-hub op te halen. (automatisch gegenereerd)

az iot hub show --name MyIoTHub

Optionele parameters

--ids

Een of meer resource-ID's (door spaties scheidingstekens). Dit moet een volledige resource-id zijn die alle gegevens van de argumenten 'Resource-id' bevat. U moet --id's of andere argumenten voor resource-id's verstrekken.

--name -n

IoT Hub naam.

--query-examples

JMESPath-tekenreeks voor u aanbevelen. U kunt een van de query's kopiëren en plakken na de parameter --query tussen dubbele aanhalingstekens om de resultaten te bekijken. U kunt een of meer positionele trefwoorden toevoegen, zodat we suggesties kunnen geven op basis van deze sleutelwoorden.

--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 az account set -s NAME_OR_ID behulp van .

az iot hub show-connection-string

De verbindingsreeksen voor een IoT-hub tonen.

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

Voorbeelden

De connection string van een IoT-hub met behulp van standaardbeleid en primaire sleutel.

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

De connection string van een IoT Hub 'service' en secundaire sleutel.

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

De verbindingsreeksen voor alle IoT-hubs in een resourcegroep tonen.

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

De verbindingsreeksen voor alle IoT-hubs in een abonnement tonen.

az iot hub show-connection-string

De verbindingsreeksen voor een IoT-hub tonen. (automatisch gegenereerd)

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

Optionele parameters

--all

Toestaan om alle beleidsregels voor gedeelde toegang weer te geven.

--hub-name --name -n

IoT Hub naam.

--ids

Een of meer resource-ID's (door spaties scheidingstekens). Dit moet een volledige resource-id zijn die alle gegevens van de argumenten 'Resource-id' bevat. U moet --id's of andere argumenten voor resource-id's verstrekken.

--key

De sleutel die moet worden gebruikt.

geaccepteerde waarden: primary, secondary
standaardwaarde: primary
--policy-name

Beleid voor gedeelde toegang dat moet worden gebruikt.

standaardwaarde: 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 az account set -s NAME_OR_ID behulp van .

az iot hub show-quota-metrics

De metrische quotumgegevens voor een IoT-hub op te halen.

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

Voorbeelden

De metrische quotumgegevens voor een IoT-hub op te halen. (automatisch gegenereerd)

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

De metrische quotumgegevens voor een IoT-hub op te halen. (automatisch gegenereerd)

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

Optionele parameters

--ids

Een of meer resource-ID's (door spaties scheidingstekens). Dit moet een volledige resource-id zijn die alle gegevens van de argumenten 'Resource-id' bevat. U moet --id's of andere argumenten voor resource-id's verstrekken.

--name -n

IoT Hub naam.

--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 az account set -s NAME_OR_ID behulp van .

az iot hub show-stats

De statistieken voor een IoT-hub op te halen.

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

Voorbeelden

De statistieken voor een IoT-hub op te halen. (automatisch gegenereerd)

az iot hub show-stats --name MyIoTHub

Optionele parameters

--ids

Een of meer resource-ID's (door spaties scheidingstekens). Dit moet een volledige resource-id zijn die alle gegevens van de argumenten 'Resource-id' bevat. U moet --id's of andere argumenten voor resource-id's verstrekken.

--name -n

IoT Hub naam.

--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 az account set -s NAME_OR_ID behulp van .

az iot hub update

Metagegevens voor een IoT-hub bijwerken.

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

Voorbeelden

Instellingen voor een opslagcontainer toevoegen

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 naar 2 en tags toevoegen

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

Prijscategorie bijwerken voor een IoT Hub als S2

az iot hub update -n MyIotHub --sku S2

Werk de bewaarperiode van IoT Hub apparaat-naar-cloud-gebeurtenissen bij naar 3 dagen

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

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

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

De instellingen voor IoT Hub feedbackwachtrij bijwerken

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

Werk de instellingen IoT Hub bestandsupload 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 IoT Hub upload van bestanden bijwerken

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

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 of JSON string>.

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

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

--c2d-ttl --ct

Hoe lang een bericht beschikbaar is voor het apparaat voordat het is verlopen door IoT Hub, tussen 1 en 48 uur.

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

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

--fcs --fileupload-storage-connectionstring

De connection string voor het Azure Storage-account naar welke bestanden worden geüpload.

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

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

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

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

--feedback-lock-duration --fld

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

--feedback-ttl --ft

De periode waarin de IoT-hub de feedback voor de vervaldatum of levering van cloud-naar-apparaat-berichten onderhoudt, tussen 1 en 48 uur.

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

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

--fileupload-notification-ttl --fnt

De hoeveelheid tijd die de service nodig heeft om een melding over het uploaden van bestanden te gebruiken voordat deze verloopt IoT Hub, tussen 1 en 48 uur.

--fileupload-notifications --fn

Een booleaanse tekst die aangeeft of informatie over geüploade bestanden moet worden geüpload naar de berichten/servicebound/filenotifications IoT Hub eindpunt.

geaccepteerde waarden: false, true
--fileupload-sas-ttl --fst

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

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

Het verificatietype voor het Azure Storage account naar welke bestanden worden geüpload. Mogelijke waarden zijn keyBased en identityBased.

--fileupload-storage-identity --fsi

De beheerde identiteit die moet worden gebruikt voor verificatie bij 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.

--force-string

Wanneer u 'set' of 'add' gebruikt, moet u letterlijke tekenreeksen bewaren in plaats van te proberen te converteren naar JSON.

--ids

Een of meer resource-ID's (door spaties scheidingstekens). Dit moet een volledige resource-id zijn die alle gegevens van de argumenten 'Resource-id' bevat. U moet --id's of andere argumenten voor resource-id's verstrekken.

--name -n

IoT Hub naam.

--rd --retention-day

Hiermee geeft u op hoelang deze IoT-hub apparaat-naar-cloud-gebeurtenissen onderhoudt, tussen 1 en 7 dagen.

--remove

Verwijder een eigenschap of een element uit een lijst. Voorbeeld: --remove property.list OR --remove propertyToRemove.

--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 moeten worden ingesteld. Voorbeeld: --set property1.property2=.

--sku

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

geaccepteerde waarden: B1, B2, B3, F1, S1, S2, S3
--subscription

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

--tags

Door ruimte gescheiden tags: sleutel[=waarde] [sleutel[=waarde] ...]. Gebruik '' om bestaande tags te verwijderen.

--unit

Eenheden in uw IoT Hub.