az iot hub device-identity
Note
Deze verwijzing maakt deel uit van de Azure-iot-extensie voor de Azure CLI (versie 2.67.0 of hoger). De extensie installeert automatisch de eerste keer dat u een az iot hub device-identity opdracht uitvoert. Meer informatie over uitbreidingen.
IoT-apparaten beheren.
Opdracht
| Name | Description | Type | Status |
|---|---|---|---|
| az iot hub device-identity children |
Onderliggende apparaatrelaties voor IoT Edge-apparaten beheren. |
Extension | GA |
| az iot hub device-identity children add |
Voeg apparaten toe als onderliggende elementen aan een edge-doelapparaat. |
Extension | GA |
| az iot hub device-identity children list |
Hiermee wordt de verzameling toegewezen onderliggende apparaten uitgevoerd. |
Extension | GA |
| az iot hub device-identity children remove |
Onderliggende apparaten verwijderen van een doelrandapparaat. |
Extension | GA |
| az iot hub device-identity connection-string |
Beheer de verbindingsreeks van het IoT-apparaat. |
Extension | GA |
| az iot hub device-identity connection-string show |
Een bepaald IoT Hub-apparaat weergeven verbindingsreeks. |
Extension | GA |
| az iot hub device-identity create |
Maak een apparaat in een IoT Hub. |
Extension | GA |
| az iot hub device-identity delete |
Een IoT Hub-apparaat verwijderen. |
Extension | GA |
| az iot hub device-identity export |
Exporteer alle apparaat-id's van een IoT Hub naar een Azure Storage-blobcontainer. |
Extension | GA |
| az iot hub device-identity import |
Apparaat-id's importeren in een IoT Hub vanuit een opslagcontainer-blob. |
Extension | GA |
| az iot hub device-identity list |
Apparaten weergeven in een IoT Hub. |
Extension | GA |
| az iot hub device-identity parent |
Relaties tussen bovenliggende apparaten voor IoT-apparaten beheren. |
Extension | GA |
| az iot hub device-identity parent set |
Stel het bovenliggende apparaat van een doelapparaat in. |
Extension | GA |
| az iot hub device-identity parent show |
Haal het bovenliggende apparaat van een doelapparaat op. |
Extension | GA |
| az iot hub device-identity renew-key |
Vernieuw doelsleutels van IoT Hub-apparaten met SAS-verificatie. |
Extension | GA |
| az iot hub device-identity show |
De details van een IoT Hub-apparaat ophalen. |
Extension | GA |
| az iot hub device-identity update |
Een IoT Hub-apparaat bijwerken. |
Extension | 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 --auth-method {shared_private_key, x509_ca, x509_thumbprint}]
[--auth-type {key, login}]
[--device-scope]
[--edge-enabled --ee {false, true}]
[--hub-name]
[--login]
[--od --output-dir]
[--pk --primary-key]
[--primary-thumbprint --ptp]
[--resource-group]
[--secondary-key --sk]
[--secondary-thumbprint --stp]
[--sta --status {disabled, enabled}]
[--star --status-reason]
[--valid-days --vd]
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
Doelapparaat-id.
Optionele parameters
De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.
De autorisatiemethode waarmee een entiteit moet worden gemaakt.
| Eigenschap | Waarde |
|---|---|
| Default value: | shared_private_key |
| Geaccepteerde waarden: | shared_private_key, x509_ca, x509_thumbprint |
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}.
| Eigenschap | Waarde |
|---|---|
| Parametergroep: | Access Control Arguments |
| Default value: | key |
| Geaccepteerde waarden: | key, login |
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.
| Eigenschap | Waarde |
|---|---|
| Parametergroep: | Device Scope Arguments |
Vlag die aangeeft dat edge is ingeschakeld.
| Eigenschap | Waarde |
|---|---|
| Default value: | False |
| Geaccepteerde waarden: | false, true |
Naam of hostnaam van IoT Hub. Vereist als --login niet is opgegeven.
| Eigenschap | Waarde |
|---|---|
| Parametergroep: | IoT Hub Identifier Arguments |
Deze opdracht ondersteunt een entiteitsverbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteitsverbindingsreeks als de naam worden opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --hub-name niet is opgegeven.
| Eigenschap | Waarde |
|---|---|
| Parametergroep: | IoT Hub Identifier Arguments |
Genereer zelfondertekend certificaat en gebruik de vingerafdruk. Uitvoer naar de opgegeven doelmap.
| Eigenschap | Waarde |
|---|---|
| Parametergroep: | X.509 Arguments |
De primaire symmetrische gedeelde toegangssleutel die is opgeslagen in base64-indeling.
| Eigenschap | Waarde |
|---|---|
| Parametergroep: | Symmetric Key Arguments |
Zelfondertekende certificaatvingerafdruk voor de primaire vingerafdruk.
| Eigenschap | Waarde |
|---|---|
| Parametergroep: | X.509 Arguments |
Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.
De secundaire symmetrische gedeelde toegangssleutel die is opgeslagen in base64-indeling.
| Eigenschap | Waarde |
|---|---|
| Parametergroep: | Symmetric Key Arguments |
Zelfondertekende certificaatvingerafdruk voor de secundaire vingerafdruk.
| Eigenschap | Waarde |
|---|---|
| Parametergroep: | X.509 Arguments |
Stel de apparaatstatus in bij het maken.
| Eigenschap | Waarde |
|---|---|
| Default value: | enabled |
| Geaccepteerde waarden: | disabled, enabled |
Beschrijving voor apparaatstatus.
Genereer zelfondertekend certificaat en gebruik de vingerafdruk. Geldig voor het opgegeven aantal dagen. Standaard: 365.
| Eigenschap | Waarde |
|---|---|
| Parametergroep: | X.509 Arguments |
Globale parameters
Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.
| Eigenschap | Waarde |
|---|---|
| Default value: | False |
Dit Help-bericht weergeven en afsluiten.
Alleen fouten weergeven, waarschuwingen onderdrukken.
| Eigenschap | Waarde |
|---|---|
| Default value: | False |
Uitvoerindeling.
| Eigenschap | Waarde |
|---|---|
| Default value: | json |
| Geaccepteerde waarden: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.
Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.
| Eigenschap | Waarde |
|---|---|
| Default value: | False |
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
Doelapparaat-id.
Optionele parameters
De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.
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}.
| Eigenschap | Waarde |
|---|---|
| Parametergroep: | Access Control Arguments |
| Default value: | key |
| Geaccepteerde waarden: | key, login |
Etag of entiteitstag die overeenkomt met de laatste status van de resource. Als er geen etag wordt opgegeven, wordt de waarde *gebruikt.
Naam of hostnaam van IoT Hub. Vereist als --login niet is opgegeven.
| Eigenschap | Waarde |
|---|---|
| Parametergroep: | IoT Hub Identifier Arguments |
Deze opdracht ondersteunt een entiteitsverbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteitsverbindingsreeks als de naam worden opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --hub-name niet is opgegeven.
| Eigenschap | Waarde |
|---|---|
| Parametergroep: | IoT Hub Identifier Arguments |
Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.
Globale parameters
Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.
| Eigenschap | Waarde |
|---|---|
| Default value: | False |
Dit Help-bericht weergeven en afsluiten.
Alleen fouten weergeven, waarschuwingen onderdrukken.
| Eigenschap | Waarde |
|---|---|
| Default value: | False |
Uitvoerindeling.
| Eigenschap | Waarde |
|---|---|
| Default value: | json |
| Geaccepteerde waarden: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.
Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.
| Eigenschap | Waarde |
|---|---|
| Default value: | False |
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.
Zie https://aka.ms/iothub-device-exportimport voor meer informatie.
az iot hub device-identity export [--auth-type {key, login}]
[--bc --blob-container]
[--bcu --blob-container-uri]
[--hub-name]
[--identity]
[--ik --include-keys {false, true}]
[--login]
[--resource-group]
[--sa --storage-account]
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
De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.
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}.
| Eigenschap | Waarde |
|---|---|
| Parametergroep: | Access Control Arguments |
| Default value: | key |
| Geaccepteerde waarden: | key, login |
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.
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.
Naam of hostnaam van IoT Hub. Vereist als --login niet is opgegeven.
| Eigenschap | Waarde |
|---|---|
| Parametergroep: | IoT Hub Identifier Arguments |
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.
Indien ingesteld, worden sleutels normaal geëxporteerd. Anders worden sleutels ingesteld op null in exportuitvoer.
| Eigenschap | Waarde |
|---|---|
| Default value: | False |
| Geaccepteerde waarden: | false, true |
Deze opdracht ondersteunt een entiteitsverbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteitsverbindingsreeks als de naam worden opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --hub-name niet is opgegeven.
| Eigenschap | Waarde |
|---|---|
| Parametergroep: | IoT Hub Identifier Arguments |
Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.
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
Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.
| Eigenschap | Waarde |
|---|---|
| Default value: | False |
Dit Help-bericht weergeven en afsluiten.
Alleen fouten weergeven, waarschuwingen onderdrukken.
| Eigenschap | Waarde |
|---|---|
| Default value: | False |
Uitvoerindeling.
| Eigenschap | Waarde |
|---|---|
| Default value: | json |
| Geaccepteerde waarden: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.
Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.
| Eigenschap | Waarde |
|---|---|
| Default value: | False |
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.
Zie https://aka.ms/iothub-device-exportimport voor meer informatie.
az iot hub device-identity import [--auth-type {key, login}]
[--hub-name]
[--ibc --input-blob-container]
[--ibcu --input-blob-container-uri]
[--identity]
[--input-storage-account --isa]
[--login]
[--obc --output-blob-container]
[--obcu --output-blob-container-uri]
[--osa --output-storage-account]
[--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
De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.
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}.
| Eigenschap | Waarde |
|---|---|
| Parametergroep: | Access Control Arguments |
| Default value: | key |
| Geaccepteerde waarden: | key, login |
Naam of hostnaam van IoT Hub. Vereist als --login niet is opgegeven.
| Eigenschap | Waarde |
|---|---|
| Parametergroep: | IoT Hub Identifier Arguments |
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.
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.
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.
De naam van het Azure Storage-account met de invoerblobcontainer. Alleen vereist wanneer input_blob_container_uri niet is opgegeven. Leestoegang is vereist.
Deze opdracht ondersteunt een entiteitsverbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteitsverbindingsreeks als de naam worden opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --hub-name niet is opgegeven.
| Eigenschap | Waarde |
|---|---|
| Parametergroep: | IoT Hub Identifier Arguments |
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.
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.
De naam van het Azure Storage-account met de uitvoerblobcontainer. De parameter wordt genegeerd wanneer output_blob_container_uri wordt opgegeven. Schrijftoegang is vereist.
Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.
Globale parameters
Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.
| Eigenschap | Waarde |
|---|---|
| Default value: | False |
Dit Help-bericht weergeven en afsluiten.
Alleen fouten weergeven, waarschuwingen onderdrukken.
| Eigenschap | Waarde |
|---|---|
| Default value: | False |
Uitvoerindeling.
| Eigenschap | Waarde |
|---|---|
| Default value: | json |
| Geaccepteerde waarden: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.
Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.
| Eigenschap | Waarde |
|---|---|
| Default value: | False |
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 --ee {false, true}]
[--hub-name]
[--login]
[--resource-group]
[--top]
Optionele parameters
De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.
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}.
| Eigenschap | Waarde |
|---|---|
| Parametergroep: | Access Control Arguments |
| Default value: | key |
| Geaccepteerde waarden: | key, login |
Vlag die aangeeft dat edge is ingeschakeld.
| Eigenschap | Waarde |
|---|---|
| Default value: | False |
| Geaccepteerde waarden: | false, true |
Naam of hostnaam van IoT Hub. Vereist als --login niet is opgegeven.
| Eigenschap | Waarde |
|---|---|
| Parametergroep: | IoT Hub Identifier Arguments |
Deze opdracht ondersteunt een entiteitsverbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteitsverbindingsreeks als de naam worden opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --hub-name niet is opgegeven.
| Eigenschap | Waarde |
|---|---|
| Parametergroep: | IoT Hub Identifier Arguments |
Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.
Maximum aantal elementen dat moet worden geretourneerd. Gebruik -1 onbeperkt.
| Eigenschap | Waarde |
|---|---|
| Default value: | 1000 |
Globale parameters
Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.
| Eigenschap | Waarde |
|---|---|
| Default value: | False |
Dit Help-bericht weergeven en afsluiten.
Alleen fouten weergeven, waarschuwingen onderdrukken.
| Eigenschap | Waarde |
|---|---|
| Default value: | False |
Uitvoerindeling.
| Eigenschap | Waarde |
|---|---|
| Default value: | json |
| Geaccepteerde waarden: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.
Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.
| Eigenschap | Waarde |
|---|---|
| Default value: | False |
az iot hub device-identity renew-key
Vernieuw doelsleutels van IoT Hub-apparaten met SAS-verificatie.
Momenteel worden etags en sleuteltype swap niet ondersteund voor het opnieuw genereren van bulksleutels.
Bulksgewijs opnieuw genereren van sleutel zorgt voor een andere uitvoerindeling dan het opnieuw genereren van één apparaatsleutel.
az iot hub device-identity renew-key --device-id
--hub-name
--key-type --kt {both, primary, secondary, swap}
[--auth-type {key, login}]
[--etag]
[--im --include-modules {false, true}]
[--login]
[--no-progress {false, true}]
[--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
Vernieuw de secundaire sleutel voor twee apparaten en hun modules.
az iot hub device-identity renew-key -d {device_id} {device_id} -n {iothub_name} --kt secondary --include-modules
Vernieuw de beide sleutels voor alle apparaten in de hub.
az iot hub device-identity renew-key -d * -n {iothub_name} --kt both
Vereiste parameters
Ruimte gescheiden lijst met doelapparaat-id's. Gebruik * voor alle apparaten.
Naam of hostnaam van IoT Hub. Vereist als --login niet is opgegeven.
| Eigenschap | Waarde |
|---|---|
| Parametergroep: | IoT Hub Identifier Arguments |
Doelsleuteltype om opnieuw te genereren.
| Eigenschap | Waarde |
|---|---|
| Geaccepteerde waarden: | both, primary, secondary, swap |
Optionele parameters
De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.
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}.
| Eigenschap | Waarde |
|---|---|
| Parametergroep: | Access Control Arguments |
| Default value: | key |
| Geaccepteerde waarden: | key, login |
Etag of entiteitstag die overeenkomt met de laatste status van de resource. Als er geen etag wordt opgegeven, wordt de waarde *gebruikt. Dit argument is alleen van toepassing op swap.
Vlag voor het opnemen van apparaatmodules tijdens het genereren van de sleutel.
| Eigenschap | Waarde |
|---|---|
| Default value: | False |
| Geaccepteerde waarden: | false, true |
Deze opdracht ondersteunt een entiteitsverbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteitsverbindingsreeks als de naam worden opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --hub-name niet is opgegeven.
| Eigenschap | Waarde |
|---|---|
| Parametergroep: | IoT Hub Identifier Arguments |
Verberg de voortgangsbalk voor het opnieuw genereren van bulksleutels.
| Eigenschap | Waarde |
|---|---|
| Default value: | False |
| Geaccepteerde waarden: | false, true |
Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.
Globale parameters
Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.
| Eigenschap | Waarde |
|---|---|
| Default value: | False |
Dit Help-bericht weergeven en afsluiten.
Alleen fouten weergeven, waarschuwingen onderdrukken.
| Eigenschap | Waarde |
|---|---|
| Default value: | False |
Uitvoerindeling.
| Eigenschap | Waarde |
|---|---|
| Default value: | json |
| Geaccepteerde waarden: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.
Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.
| Eigenschap | Waarde |
|---|---|
| Default value: | False |
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
Doelapparaat-id.
Optionele parameters
De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.
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}.
| Eigenschap | Waarde |
|---|---|
| Parametergroep: | Access Control Arguments |
| Default value: | key |
| Geaccepteerde waarden: | key, login |
Naam of hostnaam van IoT Hub. Vereist als --login niet is opgegeven.
| Eigenschap | Waarde |
|---|---|
| Parametergroep: | IoT Hub Identifier Arguments |
Deze opdracht ondersteunt een entiteitsverbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteitsverbindingsreeks als de naam worden opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --hub-name niet is opgegeven.
| Eigenschap | Waarde |
|---|---|
| Parametergroep: | IoT Hub Identifier Arguments |
Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.
Globale parameters
Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.
| Eigenschap | Waarde |
|---|---|
| Default value: | False |
Dit Help-bericht weergeven en afsluiten.
Alleen fouten weergeven, waarschuwingen onderdrukken.
| Eigenschap | Waarde |
|---|---|
| Default value: | False |
Uitvoerindeling.
| Eigenschap | Waarde |
|---|---|
| Default value: | json |
| Geaccepteerde waarden: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.
Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.
| Eigenschap | Waarde |
|---|---|
| Default value: | False |
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 --auth-method {shared_private_key, x509_ca, x509_thumbprint}]
[--auth-type {key, login}]
[--edge-enabled --ee {false, true}]
[--etag]
[--force-string]
[--hub-name]
[--login]
[--pk --primary-key]
[--primary-thumbprint --ptp]
[--remove]
[--resource-group]
[--secondary-key --sk]
[--secondary-thumbprint --stp]
[--set]
[--sta --status {disabled, enabled}]
[--star --status-reason]
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
Doelapparaat-id.
Optionele parameters
De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.
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>.
| Eigenschap | Waarde |
|---|---|
| Parametergroep: | Generic Update Arguments |
| Default value: | [] |
De autorisatiemethode waarmee een entiteit moet worden gemaakt.
| Eigenschap | Waarde |
|---|---|
| Geaccepteerde waarden: | shared_private_key, x509_ca, x509_thumbprint |
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}.
| Eigenschap | Waarde |
|---|---|
| Parametergroep: | Access Control Arguments |
| Default value: | key |
| Geaccepteerde waarden: | key, login |
Vlag die aangeeft dat edge is ingeschakeld.
| Eigenschap | Waarde |
|---|---|
| Geaccepteerde waarden: | false, true |
Etag of entiteitstag die overeenkomt met de laatste status van de resource. Als er geen etag wordt opgegeven, wordt de waarde *gebruikt.
Wanneer u 'set' of 'toevoegen' gebruikt, behoudt u letterlijke tekenreeksen in plaats van te converteren naar JSON.
| Eigenschap | Waarde |
|---|---|
| Parametergroep: | Generic Update Arguments |
| Default value: | False |
Naam of hostnaam van IoT Hub. Vereist als --login niet is opgegeven.
| Eigenschap | Waarde |
|---|---|
| Parametergroep: | IoT Hub Identifier Arguments |
Deze opdracht ondersteunt een entiteitsverbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteitsverbindingsreeks als de naam worden opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --hub-name niet is opgegeven.
| Eigenschap | Waarde |
|---|---|
| Parametergroep: | IoT Hub Identifier Arguments |
De primaire symmetrische gedeelde toegangssleutel die is opgeslagen in base64-indeling.
| Eigenschap | Waarde |
|---|---|
| Parametergroep: | Symmetric Key Arguments |
Zelfondertekende certificaatvingerafdruk voor de primaire vingerafdruk.
| Eigenschap | Waarde |
|---|---|
| Parametergroep: | X.509 Arguments |
Een eigenschap of element uit een lijst verwijderen. Voorbeeld: --remove property.list <indexToRemove> OF --remove propertyToRemove.
| Eigenschap | Waarde |
|---|---|
| Parametergroep: | Generic Update Arguments |
| Default value: | [] |
Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.
De secundaire symmetrische gedeelde toegangssleutel die is opgeslagen in base64-indeling.
| Eigenschap | Waarde |
|---|---|
| Parametergroep: | Symmetric Key Arguments |
Zelfondertekende certificaatvingerafdruk voor de secundaire vingerafdruk.
| Eigenschap | Waarde |
|---|---|
| Parametergroep: | X.509 Arguments |
Werk een object bij door een eigenschapspad en waarde op te geven die u wilt instellen. Voorbeeld: --set property1.property2=<value>.
| Eigenschap | Waarde |
|---|---|
| Parametergroep: | Generic Update Arguments |
| Default value: | [] |
Stel de apparaatstatus in bij het maken.
| Eigenschap | Waarde |
|---|---|
| Geaccepteerde waarden: | disabled, enabled |
Beschrijving voor apparaatstatus.
Globale parameters
Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.
| Eigenschap | Waarde |
|---|---|
| Default value: | False |
Dit Help-bericht weergeven en afsluiten.
Alleen fouten weergeven, waarschuwingen onderdrukken.
| Eigenschap | Waarde |
|---|---|
| Default value: | False |
Uitvoerindeling.
| Eigenschap | Waarde |
|---|---|
| Default value: | json |
| Geaccepteerde waarden: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.
Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.
| Eigenschap | Waarde |
|---|---|
| Default value: | False |