az iot hub device-identity

Notitie

Deze verwijzing maakt deel uit van de Azure-iot-extensie voor de Azure CLI (versie 2.37.0 of hoger). De extensie installeert automatisch de eerste keer dat u een opdracht az iot hub device-identity uitvoert. Meer informatie over extensies.

IoT-apparaten beheren.

Opdracht

Name	Description	Type	Status
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 de doelsleutels van een IoT Hub-apparaat 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-identity create

Maak een apparaat in een IoT Hub.

Wanneer u de verificatiemethode van shared_private_key (ook wel symmetrische sleutels genoemd) gebruikt, worden deze gegenereerd door de service als er geen aangepaste sleutels worden geleverd voor het apparaat.

Als een apparaatbereik is opgegeven voor een edge-apparaat, wordt de waarde automatisch geconverteerd naar een bovenliggend bereik.

az iot hub device-identity create --device-id
                                  [--am {shared_private_key, x509_ca, x509_thumbprint}]
                                  [--auth-type {key, login}]
                                  [--device-scope]
                                  [--edge-enabled {false, true}]
                                  [--hub-name]
                                  [--login]
                                  [--od]
                                  [--pk]
                                  [--primary-thumbprint]
                                  [--resource-group]
                                  [--secondary-key]
                                  [--secondary-thumbprint]
                                  [--sta {disabled, enabled}]
                                  [--star]
                                  [--valid-days]

Voorbeelden

Een IoT-apparaat met edge maken met standaardautorisatie (gedeelde persoonlijke sleutel).

az iot hub device-identity create -n {iothub_name} -d {device_id} --ee

Maak een IoT-apparaat met zelfondertekende certificaatautorisatie, genereer een certificaat dat 10 dagen geldig is en gebruik vervolgens de vingerafdruk.

az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_thumbprint --valid-days 10

Maak een IoT-apparaat met zelfondertekende certificaatautorisatie, genereer een standaardverloopcertificaat (365 dagen) en uitvoer naar de doelmap.

az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_thumbprint --output-dir /path/to/output

Maak een IoT-apparaat met zelfondertekende certificaatautorisatie en geef expliciet primaire en secundaire vingerafdrukken op.

az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_thumbprint --ptp {thumbprint_1} --stp {thumbprint_2}

Maak een IoT-apparaat met ca-basisautorisatie met uitgeschakelde status en reden.

az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_ca --status disabled --status-reason 'for reasons'

Maak een IoT-apparaat met een apparaatbereik.

az iot hub device-identity create -n {iothub_name} -d {device_id} --device-scope 'ms-azure-iot-edge://edge0-123456789123456789'

Vereiste parameters

--device-id -d

Doelapparaat-id.

Optionele parameters

--am --auth-method

De autorisatiemethode waarmee een entiteit moet worden gemaakt.

geaccepteerde waarden: shared_private_key, x509_ca, x509_thumbprint

standaardwaarde: shared_private_key

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

standaardwaarde: key

--device-scope

Het bereik van het apparaat. Voor edge-apparaten is dit automatisch gegenereerd en onveranderbaar. Stel dit in voor leaf-apparaten om een onderliggende/bovenliggende relatie te maken.

--edge-enabled --ee

Vlag die aangeeft dat edge is ingeschakeld.

geaccepteerde waarden: false, true

standaardwaarde: False

--hub-name -n

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

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

--od --output-dir

Genereer zelfondertekend certificaat en gebruik de vingerafdruk. Uitvoer naar de opgegeven doelmap.

--pk --primary-key

De primaire symmetrische gedeelde toegangssleutel die is opgeslagen in base64-indeling.

--primary-thumbprint --ptp

Zelfondertekende certificaatvingerafdruk voor de primaire vingerafdruk.

--resource-group -g

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

--secondary-key --sk

De secundaire symmetrische gedeelde toegangssleutel die is opgeslagen in base64-indeling.

--secondary-thumbprint --stp

Zelfondertekende certificaatvingerafdruk voor de secundaire vingerafdruk.

--sta --status

Stel de apparaatstatus in bij het maken.

geaccepteerde waarden: disabled, enabled

standaardwaarde: enabled

--star --status-reason

Beschrijving voor apparaatstatus.

--valid-days --vd

Genereer zelfondertekend certificaat en gebruik de vingerafdruk. Geldig voor het opgegeven aantal dagen. Standaard: 365.

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

standaardwaarde: 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 device-identity delete

Een IoT Hub-apparaat verwijderen.

az iot hub device-identity delete --device-id
                                  [--auth-type {key, login}]
                                  [--etag]
                                  [--hub-name]
                                  [--login]
                                  [--resource-group]

Vereiste parameters

--device-id -d

Doelapparaat-id.

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

standaardwaarde: key

--etag -e

Etag of entiteitstag die overeenkomt met de laatste status van de resource. Als er geen etag wordt opgegeven, wordt de waarde *gebruikt.

--hub-name -n

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

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

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

standaardwaarde: 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 device-identity export

Exporteer alle apparaat-id's van een IoT Hub naar een Azure Storage-blobcontainer.

De uitvoerblob met apparaatidentiteiten is een tekstbestand met de naam 'devices.txt'.

Vereiste machtigingen: gedeeld toegangsbeleid van IoT Hub dat ondersteuning biedt voor Register lezen en schrijven van register of een principal met de rol 'Inzender voor IoT Hub-gegevens' in de IoT Hub.

Parameters voor de naam van het opslagaccount en de blobcontainernaam kunnen alleen worden gebruikt wanneer het opslagaccount zich in hetzelfde abonnement bevindt als de invoer-IoT Hub. Raadpleeg de invoerregels van uw omgeving voor inline-blobcontainer-SAS-URI-invoer.

Voor meer informatie raadpleegt u https://aka.ms/iothub-device-exportimport.

az iot hub device-identity export [--auth-type {key, login}]
                                  [--bc]
                                  [--bcu]
                                  [--hub-name]
                                  [--identity]
                                  [--ik {false, true}]
                                  [--login]
                                  [--resource-group]
                                  [--sa]

Voorbeelden

Exporteer alle apparaat-id's naar een geconfigureerde blobcontainer en neem apparaatsleutels op. De naam van de blobcontainer en de naam van het opslagaccount worden opgegeven als parameters voor de opdracht.

az iot hub device-identity export -n {iothub_name} --ik --bc {blob_container_name} --sa {storage_account_name}

Exporteer alle apparaat-id's naar een geconfigureerde blobcontainer en neem apparaatsleutels op. Maakt gebruik van een inline SAS-URI-voorbeeld.

az iot hub device-identity export -n {iothub_name} --ik --bcu 'https://mystorageaccount.blob.core.windows.net/devices?sv=2019-02-02&st=2020-08-23T22%3A35%3A00Z&se=2020-08-24T22%3A35%3A00Z&sr=c&sp=rwd&sig=VrmJ5sQtW3kLzYg10VqmALGCp4vtYKSLNjZDDJBSh9s%3D'

Exporteer alle apparaat-id's naar een geconfigureerde blobcontainer met behulp van een bestandspad dat de SAS-URI bevat.

az iot hub device-identity export -n {iothub_name} --bcu {sas_uri_filepath}

Exporteer alle apparaat-id's naar een geconfigureerde blobcontainer en neem apparaatsleutels op. Maakt gebruik van door het systeem toegewezen identiteit met de rol Inzender voor opslagblobgegevens voor het opslagaccount. De naam van de blobcontainer en de naam van het opslagaccount worden opgegeven als parameters voor de opdracht.

az iot hub device-identity export -n {iothub_name} --ik --bc {blob_container_name} --sa {storage_account_name} --identity [system]

Exporteer alle apparaat-id's naar een geconfigureerde blobcontainer en neem apparaatsleutels op. Maakt gebruik van door het systeem toegewezen identiteit met de rol Inzender voor opslagblobgegevens voor het opslagaccount. De blobcontainer-URI heeft het SAS-token voor de blob niet nodig.

az iot hub device-identity export -n {iothub_name} --ik --bcu 'https://mystorageaccount.blob.core.windows.net/devices' --identity [system]

Exporteer alle apparaat-id's naar een geconfigureerde blobcontainer en neem apparaatsleutels op. Maakt gebruik van door de gebruiker toegewezen beheerde identiteit met de rol Inzender voor opslagblobgegevens voor het opslagaccount. De naam van de blobcontainer en de naam van het opslagaccount worden opgegeven als parameters voor de opdracht.

az iot hub device-identity export -n {iothub_name} --ik --bc {blob_container_name} --sa {storage_account_name} --identity {managed_identity_resource_id}

Exporteer alle apparaat-id's naar een geconfigureerde blobcontainer en neem apparaatsleutels op. Maakt gebruik van door de gebruiker toegewezen beheerde identiteit met de rol Inzender voor opslagblobgegevens voor het opslagaccount. De blobcontainer-URI heeft het SAS-token voor de blob niet nodig.

az iot hub device-identity export -n {iothub_name} --ik --bcu 'https://mystorageaccount.blob.core.windows.net/devices' --identity {managed_identity_resource_id}

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

standaardwaarde: key

--bc --blob-container

Deze blobcontainer wordt gebruikt om de status van de importtaak voor apparaatidentiteiten en de resultaten uit te voeren. De parameter wordt genegeerd wanneer blob_container_uri wordt opgegeven. Schrijf-, lees- en verwijdertoegang is vereist voor deze blobcontainer.

--bcu --blob-container-uri

Blob Shared Access Signature-URI met schrijf-, lees- en verwijdertoegang tot een blobcontainer. Dit wordt gebruikt om de status van de taak en de resultaten uit te voeren. Opmerking: wanneer u verificatie op basis van identiteit gebruikt, is een https:// URI nog steeds vereist, maar is er geen SAS-token nodig. Invoer voor dit argument kan inline of vanuit een bestandspad zijn.

--hub-name -n

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

--identity

Type beheerde identiteit om te bepalen of door het systeem toegewezen beheerde identiteit of door de gebruiker toegewezen beheerde identiteit wordt gebruikt. Gebruik [system] voor door het systeem toegewezen beheerde identiteit. Geef voor door de gebruiker toegewezen beheerde identiteit de resource-id van de door de gebruiker toegewezen beheerde identiteit op. Voor deze identiteit zijn de rollen Inzender voor opslagblobgegevens vereist voor het opslagaccount.

--ik --include-keys

Indien ingesteld, worden sleutels normaal geëxporteerd. Anders worden sleutels ingesteld op null in exportuitvoer.

geaccepteerde waarden: false, true

standaardwaarde: False

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

--resource-group -g

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

--sa --storage-account

De naam van het Azure Storage-account met de uitvoerblobcontainer. De parameter wordt genegeerd wanneer blob_container_uri wordt opgegeven. Schrijf-, lees- en verwijdertoegang is vereist.

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

standaardwaarde: 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 device-identity import

Apparaat-id's importeren in een IoT Hub vanuit een opslagcontainer-blob.

Het verwachte invoerbestand met apparaatidentiteiten moet de naam 'devices.txt' hebben. Het uitvoerlogboekbestand 'importErrors.log' is leeg wanneer het importeren is geslaagd en bevat foutenlogboeken in het geval van een importfout.

Vereiste machtigingen: gedeeld toegangsbeleid van IoT Hub dat ondersteuning biedt voor Register lezen en schrijven van register of een principal met de rol 'Inzender voor IoT Hub-gegevens' in de IoT Hub.

Parameters voor de naam van het opslagaccount en de blobcontainernaam kunnen alleen worden gebruikt wanneer het opslagaccount zich in hetzelfde abonnement bevindt als de invoer-IoT Hub. Raadpleeg de invoerregels van uw omgeving voor inline-blobcontainer-SAS-URI-invoer.

Voor meer informatie raadpleegt u https://aka.ms/iothub-device-exportimport.

az iot hub device-identity import [--auth-type {key, login}]
                                  [--hub-name]
                                  [--ibc]
                                  [--ibcu]
                                  [--identity]
                                  [--input-storage-account]
                                  [--login]
                                  [--obc]
                                  [--obcu]
                                  [--osa]
                                  [--resource-group]

Voorbeelden

Importeer alle apparaat-id's uit een blob door opdrachtparameters op te geven voor invoerblobcontainer en opslagaccount, evenals uitvoerblobcontainer en opslagaccount.

az iot hub device-identity import -n {iothub_name} --ibc {input_blob_container_name} --isa {input_storage_account_name} --obc {output_blob_container_name} --osa {output_storage_account_name}

Importeer alle apparaat-id's uit een blob met behulp van een inline SAS-URI.

az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri} --obcu {output_sas_uri}

Importeer alle apparaat-id's uit een blob met behulp van een bestandspad dat SAS-URI bevat.

az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri_filepath} --obcu {output_sas_uri_filepath}

Importeer alle apparaat-id's uit een blob met de door het systeem toegewezen identiteit met de rollen Inzender voor opslagblobgegevens voor beide opslagaccounts. De invoer-blobcontainer en het opslagaccount en het uitvoer-blobcontainer en het opslagaccount worden geleverd als parameters voor de opdracht

az iot hub device-identity import -n {iothub_name} --ibc {input_blob_container_name} --isa {input_storage_account_name} --obc {output_blob_container_name} --osa {output_storage_account_name} --identity [system]

Importeer alle apparaat-id's uit een blob met de door het systeem toegewezen identiteit met de rollen Inzender voor opslagblobgegevens voor beide opslagaccounts. De blobcontainer-URI heeft het SAS-token voor de blob niet nodig.

az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri} --obcu {output_sas_uri} --identity [system]

Importeer alle apparaat-id's uit een blob met door de gebruiker toegewezen beheerde identiteit met de rollen Inzender voor opslagblobgegevens voor beide opslagaccounts. De invoer-blobcontainer en het opslagaccount en het uitvoer-blobcontainer en het opslagaccount worden geleverd als parameters voor de opdracht

az iot hub device-identity import -n {iothub_name} --ibc {input_blob_container_name} --isa {input_storage_account_name} --obc {output_blob_container_name} --osa {output_storage_account_name} --identity {managed_identity_resource_id}

Importeer alle apparaat-id's uit een blob met door de gebruiker toegewezen beheerde identiteit met de rollen Inzender voor opslagblobgegevens voor beide opslagaccounts. De blobcontainer-URI heeft het SAS-token voor de blob niet nodig.

az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri} --obcu {output_sas_uri} --identity {managed_identity_resource_id}

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

standaardwaarde: key

--hub-name -n

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

--ibc --input-blob-container

Deze blobcontainer slaat het bestand op dat bewerkingen definieert die moeten worden uitgevoerd in het identiteitsregister. De parameter wordt genegeerd wanneer input_blob_container_uri wordt opgegeven. Leestoegang is vereist voor deze blobcontainer.

--ibcu --input-blob-container-uri

Blob Shared Access Signature-URI met leestoegang tot een blobcontainer. Deze blob bevat de bewerkingen die moeten worden uitgevoerd in het identiteitsregister. Opmerking: wanneer u verificatie op basis van identiteit gebruikt, is een https:// URI nog steeds vereist, maar is er geen SAS-token nodig. Invoer voor dit argument kan inline of vanuit een bestandspad zijn.

--identity

Type beheerde identiteit om te bepalen of door het systeem toegewezen beheerde identiteit of door de gebruiker toegewezen beheerde identiteit wordt gebruikt. Gebruik [system] voor door het systeem toegewezen beheerde identiteit. Geef voor door de gebruiker toegewezen beheerde identiteit de resource-id van de door de gebruiker toegewezen beheerde identiteit op. Voor deze identiteit is een rol inzender voor opslagblobgegevens vereist voor het doelopslagaccount en de rol Inzender voor de IoT Hub.

--input-storage-account --isa

De naam van het Azure Storage-account met de invoerblobcontainer. Alleen vereist wanneer input_blob_container_uri niet is opgegeven. Leestoegang is vereist.

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

--obc --output-blob-container

Deze blobcontainer wordt gebruikt om de status van de importtaak voor apparaatidentiteiten en de resultaten uit te voeren. Alleen vereist wanneer input_blob_container_uri niet is opgegeven. Schrijftoegang is vereist voor deze blobcontainer.

--obcu --output-blob-container-uri

Blob Shared Access Signature-URI met schrijftoegang tot een blobcontainer. Dit wordt gebruikt om de status van de taak en de resultaten uit te voeren. Opmerking: wanneer u verificatie op basis van identiteit gebruikt, is een https:// URI zonder het SAS-token nog steeds vereist. Invoer voor dit argument kan inline of vanuit een bestandspad zijn.

--osa --output-storage-account

De naam van het Azure Storage-account met de uitvoerblobcontainer. De parameter wordt genegeerd wanneer output_blob_container_uri wordt opgegeven. Schrijftoegang is vereist.

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

standaardwaarde: 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 device-identity list

Apparaten weergeven in een IoT Hub.

Deze opdracht is een alias voor az iot hub device-twin list, die ten zeerste wordt aanbevolen voor deze opdracht. In de toekomst kan deze az iot hub device-identity list opdracht worden gewijzigd of afgeschaft.

az iot hub device-identity list [--auth-type {key, login}]
                                [--edge-enabled {false, true}]
                                [--hub-name]
                                [--login]
                                [--resource-group]
                                [--top]

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

standaardwaarde: key

--edge-enabled --ee

Vlag die aangeeft dat edge is ingeschakeld.

geaccepteerde waarden: false, true

standaardwaarde: False

--hub-name -n

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

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

--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. Gebruik -1 voor onbeperkt.

standaardwaarde: 1000

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

standaardwaarde: 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 device-identity renew-key

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

az iot hub device-identity renew-key --device-id
                                     --hub-name
                                     --key-type {primary, secondary, swap}
                                     [--auth-type {key, login}]
                                     [--etag]
                                     [--login]
                                     [--resource-group]

Voorbeelden

Vernieuw de primaire sleutel.

az iot hub device-identity renew-key -d {device_id} -n {iothub_name} --kt primary

Vervang de primaire en secundaire sleutels.

az iot hub device-identity renew-key -d {device_id} -n {iothub_name} --kt swap

Vereiste parameters

--device-id -d

Doelapparaat-id.

--hub-name -n

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

--key-type --kt

Doelsleuteltype om opnieuw te genereren.

geaccepteerde waarden: primary, secondary, swap

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

standaardwaarde: key

--etag -e

Etag of entiteitstag die overeenkomt met de laatste status van de resource. Als er geen etag wordt opgegeven, wordt de waarde *gebruikt.

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

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

standaardwaarde: 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 device-identity show

De details van een IoT Hub-apparaat ophalen.

az iot hub device-identity show --device-id
                                [--auth-type {key, login}]
                                [--hub-name]
                                [--login]
                                [--resource-group]

Vereiste parameters

--device-id -d

Doelapparaat-id.

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

standaardwaarde: key

--hub-name -n

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

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

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

standaardwaarde: 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 device-identity update

Een IoT Hub-apparaat bijwerken.

Gebruik --set gevolgd door eigenschapstoewijzingen voor het bijwerken van een apparaat. Maak gebruik van parameters die worden geretourneerd door 'iot hub device-identity show'.

az iot hub device-identity update --device-id
                                  [--add]
                                  [--am {shared_private_key, x509_ca, x509_thumbprint}]
                                  [--auth-type {key, login}]
                                  [--edge-enabled {false, true}]
                                  [--etag]
                                  [--force-string]
                                  [--hub-name]
                                  [--login]
                                  [--pk]
                                  [--primary-thumbprint]
                                  [--remove]
                                  [--resource-group]
                                  [--secondary-key]
                                  [--secondary-thumbprint]
                                  [--set]
                                  [--sta {disabled, enabled}]
                                  [--star]

Voorbeelden

Edge-mogelijkheden voor apparaat inschakelen

az iot hub device-identity update -d {device_id} -n {iothub_name} --set capabilities.iotEdge=true

Schakel edge-mogelijkheden in voor het apparaat met behulp van het argument gemak.

az iot hub device-identity update -d {device_id} -n {iothub_name} --ee

Apparaatstatus uitschakelen

az iot hub device-identity update -d {device_id} -n {iothub_name} --set status=disabled

Schakel de apparaatstatus uit met behulp van het argument gemak.

az iot hub device-identity update -d {device_id} -n {iothub_name} --status disabled

In één opdracht

az iot hub device-identity update -d {device_id} -n {iothub_name} --set status=disabled capabilities.iotEdge=true

Vereiste parameters

--device-id -d

Doelapparaat-id.

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

standaardwaarde: []

--am --auth-method

De autorisatiemethode waarmee een entiteit moet worden gemaakt.

geaccepteerde waarden: shared_private_key, x509_ca, x509_thumbprint

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

standaardwaarde: key

--edge-enabled --ee

Vlag die aangeeft dat edge is ingeschakeld.

geaccepteerde waarden: false, true

--etag -e

Etag of entiteitstag die overeenkomt met de laatste status van de resource. Als er geen etag wordt opgegeven, wordt de waarde *gebruikt.

--force-string

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

standaardwaarde: False

--hub-name -n

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

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

--pk --primary-key

De primaire symmetrische gedeelde toegangssleutel die is opgeslagen in base64-indeling.

--primary-thumbprint --ptp

Zelfondertekende certificaatvingerafdruk voor de primaire vingerafdruk.

--remove

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

standaardwaarde: []

--resource-group -g

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

--secondary-key --sk

De secundaire symmetrische gedeelde toegangssleutel die is opgeslagen in base64-indeling.

--secondary-thumbprint --stp

Zelfondertekende certificaatvingerafdruk voor de secundaire vingerafdruk.

--set

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

standaardwaarde: []

--sta --status

Stel de apparaatstatus in bij het maken.

geaccepteerde waarden: disabled, enabled

--star --status-reason

Beschrijving voor apparaatstatus.

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

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