az iot hub device-identity

Notitie

Deze verwijzing maakt deel uit van de azure-iot-extensie voor Azure CLI en vereist versie 2.17.1 of hoger. De extensie wordt automatisch geĆÆnstalleerd wanneer u de opdracht az iot hub device-identity voor het eerst gebruikt. Meer informatie over extensies.

IoT-apparaten beheren.

Opdracht

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 device-identity create

Maak een apparaat in een IoT Hub.

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

Voorbeelden

Maak een IoT-apparaat met edge-functie met standaardautorisatie (gedeelde persoonlijke sleutel).

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

Maak een IoT-apparaat met zelf-ondertekende certificaatautorisatie, genereer een certificaat dat tien 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 zelf-ondertekende certificaatautorisatie, genereer een certificaat met standaardverlooptijd (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 zelf-ondertekende certificaatautorisatie en geef expliciet primaire en secundaire vingerafdruk op.

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

Een IoT-apparaat maken met basis-CA-autorisatie met de status uitgeschakeld en reden

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

Vereiste parameters

--device-id -d

Doelapparaat.

Optionele parameters

--am --auth-method

Het autorisatietype dat een entiteit moet maken.

geaccepteerde waarden: shared_private_key, x509_ca, x509_thumbprint
standaardwaarde: shared_private_key
--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
--edge-enabled --ee

Vlag die edge-inschakelen aangeeft.

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

--od --output-dir

Genereer een zelf-ondertekend certificaat en gebruik de vingerafdruk. Uitvoer naar opgegeven doelmap.

--primary-thumbprint --ptp

Expliciete zelf-ondertekende certificaatvingerafdruk die moet worden gebruikt voor de primaire sleutel.

--resource-group -g

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

--secondary-thumbprint --stp

Expliciete zelf-ondertekende certificaatvingerafdruk die moet worden gebruikt voor de secundaire sleutel.

--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 een zelf-ondertekend certificaat en gebruik de vingerafdruk. Geldig voor het opgegeven aantal dagen. Standaardinstelling: 365.

az iot hub device-identity delete

Een IoT Hub 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.

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

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

--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 az configure --defaults group=<name> behulp van .

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.

Voor meer informatie raadpleegt u https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

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

Voorbeelden

Alle apparaat-id's exporteren naar een geconfigureerde blobcontainer en apparaatsleutels opnemen. Maakt gebruik van een voorbeeld van een inline SAS-URI.

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'

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

Alle apparaat-id's exporteren naar een geconfigureerde blobcontainer en apparaatsleutels opnemen. Maakt gebruik van een door het systeem toegewezen identiteit met Storage inzendersrollen voor blobgegevens 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' --auth-type identity --identity [system]

Alle apparaat-id's exporteren naar een geconfigureerde blobcontainer en apparaatsleutels opnemen. Maakt gebruik van een door de gebruiker toegewezen beheerde identiteit met Storage inzendersrollen voor blobgegevens voor het opslagaccount en inzender voor de IoT-hub. 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' --auth-type identity --identity {managed_identity_resource_id}

Vereiste parameters

--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 geven. Opmerking: bij het gebruik van verificatie op basis van identiteit is https:// URI vereist, maar er is geen SAS-token nodig. Invoer voor dit argument kan inline zijn of van een bestandspad.

--hub-name -n

IoT Hub naam.

Optionele parameters

--auth-type --storage-authentication-type

Verificatietype voor communicatie met de opslagcontainer.

geaccepteerde waarden: identity, key
--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 Storage blobgegevensbijdrager vereist voor het Storage account.

--ik --include-keys

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

geaccepteerde waarden: false, true
--resource-group -g

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

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.

Voor meer informatie raadpleegt u https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

az iot hub device-identity import --hub-name
                                  --ibcu
                                  --obcu
                                  [--auth-type {identity, key}]
                                  [--identity]
                                  [--resource-group]

Voorbeelden

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 behulp van een door het systeem toegewezen identiteit met de Storage inzendersrollen voor blobgegevens 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} --auth-type identity --identity [system]

Importeer alle apparaat-id's uit een blob met een door de gebruiker toegewezen beheerde identiteit met Storage Blob Data Contributor-rollen voor zowel opslagaccounts als inzenders voor de IoT-hub. 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} --auth-type identity --identity {managed_identity_resource_id}

Vereiste parameters

--hub-name -n

IoT Hub naam.

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

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

--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 geven. Opmerking: wanneer u verificatie op basis van identiteit gebruikt, https:// URI zonder het SAS-token nog steeds vereist. Invoer voor dit argument kan inline zijn of van een bestandspad.

Optionele parameters

--auth-type --storage-authentication-type

Verificatietype voor communicatie met de opslagcontainer.

geaccepteerde waarden: identity, key
--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 Storage blobgegevensbijdrager vereist voor het doelaccount Storage de rol Inzender voor de IoT Hub.

--resource-group -g

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

az iot hub device-identity list

Apparaten in een IoT Hub.

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

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
--edge-enabled --ee

Vlag die edge-inschakelen aangeeft.

geaccepteerde waarden: false, true
--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. Gebruik -1 voor onbeperkt.

standaardwaarde: 1000

az iot hub device-identity renew-key

Vernieuw de doelsleutels van 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

De primaire en secundaire sleutels wisselen.

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

Vereiste parameters

--device-id -d

Doelapparaat.

--hub-name -n

IoT Hub naam.

--key-type --kt

Doelsleuteltype dat opnieuw moet worden ge regenereren.

geaccepteerde waarden: primary, secondary, swap

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

az iot hub device-identity show

De details van een IoT Hub apparaat.

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

Vereiste parameters

--device-id -d

Doelapparaat.

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

az iot hub device-identity update

Werk een IoT Hub apparaat bij.

Gebruik --set gevolgd door eigenschapstoewijzingen voor het bijwerken van een apparaat. Gebruik 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 het apparaat in te zetten

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

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

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

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

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

--am --auth-method

Het autorisatietype dat een entiteit moet maken.

geaccepteerde waarden: shared_private_key, x509_ca, x509_thumbprint
--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
--edge-enabled --ee

Vlag waarmee edge-inschakelen wordt aangegeven.

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 'add' gebruikt, moet u letterlijke tekenreeksen bewaren in plaats van te proberen te converteren naar JSON.

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

--pk --primary-key

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

--primary-thumbprint --ptp

Expliciete zelf-ondertekende certificaatvingerafdruk die moet worden gebruikt voor de primaire sleutel.

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

--secondary-key --sk

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

--secondary-thumbprint --stp

Expliciete zelf-ondertekende certificaatvingerafdruk die moet worden gebruikt voor de secundaire sleutel.

--set

Werk een object bij door een eigenschapspad en waarde op te geven die moeten worden ingesteld. Voorbeeld: --set property1.property2=.

--sta --status

Stel de apparaatstatus in bij het maken.

geaccepteerde waarden: disabled, enabled
--star --status-reason

Beschrijving voor apparaatstatus.