Delen via

az iot hub module-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 module-identity opdracht uitvoert. Meer informatie over uitbreidingen.

IoT-apparaatmodules beheren.

Opdracht

Name Description Type Status
az iot hub module-identity connection-string

Beheer de verbindingsreeks van de IoT-apparaatmodule.

 Extension GA
az iot hub module-identity connection-string show

Een ioT-doelapparaatmodule weergeven verbindingsreeks.

 Extension GA
az iot hub module-identity create

Maak een module op een IoT-doelapparaat in een IoT Hub.

 Extension GA
az iot hub module-identity delete

Een apparaat verwijderen in een IoT Hub.

 Extension GA
az iot hub module-identity list

Modules weergeven die zich op een IoT-apparaat in een IoT Hub bevinden.

 Extension GA
az iot hub module-identity renew-key

Vernieuw doelsleutels van IoT Hub-apparaatmodules met SAS-verificatie.

 Extension GA
az iot hub module-identity show

Haal de details van een IoT-apparaatmodule op in een IoT Hub.

 Extension GA
az iot hub module-identity update

Een IoT Hub-apparaatmodule bijwerken.

 Extension GA

az iot hub module-identity create

Maak een module op een IoT-doelapparaat 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 de module.

az iot hub module-identity create --device-id
                                  --module-id
                                  [--am --auth-method {shared_private_key, x509_ca, x509_thumbprint}]
                                  [--auth-type {key, login}]
                                  [--hub-name]
                                  [--login]
                                  [--od --output-dir]
                                  [--pk --primary-key]
                                  [--primary-thumbprint --ptp]
                                  [--resource-group]
                                  [--secondary-key --sk]
                                  [--secondary-thumbprint --stp]
                                  [--valid-days --vd]

Vereiste parameters

--device-id -d

Doelapparaat-id.

--module-id -m

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

--am --auth-method

De autorisatiemethode waarmee een entiteit moet worden gemaakt.

Eigenschap Waarde
Default value: shared_private_key
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}.

Eigenschap Waarde
Parametergroep: Access Control Arguments
Default value: key
Geaccepteerde waarden: key, login
--hub-name -n

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

Eigenschap Waarde
Parametergroep: IoT Hub Identifier Arguments
--login -l

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
--od --output-dir

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

Eigenschap Waarde
Parametergroep: X.509 Arguments
--pk --primary-key

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

Eigenschap Waarde
Parametergroep: Symmetric Key Arguments
--primary-thumbprint --ptp

Zelfondertekende certificaatvingerafdruk voor de primaire vingerafdruk.

Eigenschap Waarde
Parametergroep: X.509 Arguments
--resource-group -g

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

Eigenschap Waarde
Parametergroep: Symmetric Key Arguments
--secondary-thumbprint --stp

Zelfondertekende certificaatvingerafdruk voor de secundaire vingerafdruk.

Eigenschap Waarde
Parametergroep: X.509 Arguments
--valid-days --vd

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

Eigenschap Waarde
Parametergroep: X.509 Arguments
Globale parameters
--debug

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

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

Naam of id van 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.

Eigenschap Waarde
Default value: False

az iot hub module-identity delete

Een apparaat verwijderen in een IoT Hub.

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

Vereiste parameters

--device-id -d

Doelapparaat-id.

--module-id -m

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

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

Eigenschap Waarde
Parametergroep: Access Control Arguments
Default value: key
Geaccepteerde waarden: key, login
--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.

Eigenschap Waarde
Parametergroep: IoT Hub Identifier Arguments
--login -l

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
--resource-group -g

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

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

Naam of id van 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.

Eigenschap Waarde
Default value: False

az iot hub module-identity list

Modules weergeven die zich op een IoT-apparaat in een IoT Hub bevinden.

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

Vereiste parameters

--device-id -d

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.

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

Eigenschap Waarde
Parametergroep: Access Control Arguments
Default value: key
Geaccepteerde waarden: key, login
--hub-name -n

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

Eigenschap Waarde
Parametergroep: IoT Hub Identifier Arguments
--login -l

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
--resource-group -g

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

--top

Maximum aantal elementen dat moet worden geretourneerd. Gebruik -1 onbeperkt.

Eigenschap Waarde
Default value: 1000
Globale parameters
--debug

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

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

Naam of id van 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.

Eigenschap Waarde
Default value: False

az iot hub module-identity renew-key

Vernieuw doelsleutels van IoT Hub-apparaatmodules met SAS-verificatie.

Momenteel worden etags en sleuteltype swap niet ondersteund voor het opnieuw genereren van bulksleutels. Bulksgewijze sleutelregeneratie heeft een andere uitvoerindeling dan het genereren van één modulesleutel.

az iot hub module-identity renew-key --device-id
                                     --hub-name
                                     --key-type --kt {both, primary, secondary, swap}
                                     --module-id
                                     [--auth-type {key, login}]
                                     [--etag]
                                     [--login]
                                     [--no-progress {false, true}]
                                     [--resource-group]

Voorbeelden

Vernieuw de primaire sleutel.

az iot hub module-identity renew-key -m {module_name} -d {device_id} -n {iothub_name} --kt primary

Vervang de primaire en secundaire sleutels.

az iot hub module-identity renew-key -m {module_name} -d {device_id} -n {iothub_name} --kt swap

Vernieuw de secundaire sleutel voor twee modules.

az iot hub module-identity renew-key -m {module_name} {module_name} -d {device_id} -n {iothub_name} --kt secondary

Vernieuw beide sleutels voor alle modules op het apparaat.

az iot hub module-identity renew-key -m * -d {device_id} -n {iothub_name} --kt both

Vereiste parameters

--device-id -d

Doelapparaat-id.

--hub-name -n

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

Eigenschap Waarde
Parametergroep: IoT Hub Identifier Arguments
--key-type --kt

Doelsleuteltype om opnieuw te genereren.

Eigenschap Waarde
Geaccepteerde waarden: both, primary, secondary, swap
--module-id -m

Ruimte gescheiden lijst met doelmodule-id's. Gebruik * voor alle modules.

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.

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

Eigenschap Waarde
Parametergroep: Access Control Arguments
Default value: key
Geaccepteerde waarden: key, login
--etag -e

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.

--login -l

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

Verberg de voortgangsbalk voor het opnieuw genereren van bulksleutels.

Eigenschap Waarde
Geaccepteerde waarden: false, true
--resource-group -g

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

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

Naam of id van 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.

Eigenschap Waarde
Default value: False

az iot hub module-identity show

Haal de details van een IoT-apparaatmodule op in een IoT Hub.

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

Vereiste parameters

--device-id -d

Doelapparaat-id.

--module-id -m

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

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

Eigenschap Waarde
Parametergroep: Access Control Arguments
Default value: key
Geaccepteerde waarden: key, login
--hub-name -n

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

Eigenschap Waarde
Parametergroep: IoT Hub Identifier Arguments
--login -l

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
--resource-group -g

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

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

Naam of id van 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.

Eigenschap Waarde
Default value: False

az iot hub module-identity update

Een IoT Hub-apparaatmodule bijwerken.

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

az iot hub module-identity update --device-id
                                  --module-id
                                  [--add]
                                  [--auth-type {key, login}]
                                  [--etag]
                                  [--force-string]
                                  [--hub-name]
                                  [--login]
                                  [--remove]
                                  [--resource-group]
                                  [--set]

Voorbeelden

Module symmetrische verificatiesleutels opnieuw genereren

az iot hub module-identity update -m {module_name} -d {device_id} -n {iothub_name} --set authentication.symmetricKey.primaryKey="" authentication.symmetricKey.secondaryKey=""

Vereiste parameters

--device-id -d

Doelapparaat-id.

--module-id -m

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

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

Eigenschap Waarde
Parametergroep: Generic Update Arguments
Default value: []
--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}.

Eigenschap Waarde
Parametergroep: Access Control Arguments
Default value: key
Geaccepteerde waarden: key, login
--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.

Eigenschap Waarde
Parametergroep: Generic Update Arguments
Default value: False
--hub-name -n

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

Eigenschap Waarde
Parametergroep: IoT Hub Identifier Arguments
--login -l

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

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

Eigenschap Waarde
Parametergroep: Generic Update Arguments
Default value: []
--resource-group -g

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

--set

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

Eigenschap Waarde
Parametergroep: Generic Update Arguments
Default value: []
Globale parameters
--debug

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

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

Naam of id van 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.

Eigenschap Waarde
Default value: False