az iot hub module-identity
Notitie
Deze referentie 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 module-identity voor het eerst gebruikt. Meer informatie over extensies.
IoT-apparaatmodules beheren.
Opdracht
| az iot hub module-identity connection-string |
Beheer de connection string van IoT-connection string. |
| az iot hub module-identity connection-string show |
Een doel-IoT-apparaatmodule connection string. |
| az iot hub module-identity create |
Maak een module op een doel-IoT-apparaat in een IoT Hub. |
| az iot hub module-identity delete |
Verwijder een apparaat in een IoT Hub. |
| az iot hub module-identity list |
Een lijst met modules op een IoT-apparaat in een IoT Hub. |
| az iot hub module-identity renew-key |
Vernieuw de doelsleutels van IoT Hub apparaatmodule met SAS-verificatie. |
| az iot hub module-identity show |
De details van een IoT-apparaatmodule in een IoT Hub. |
| az iot hub module-identity update |
Werk een IoT Hub apparaatmodule bij. |
az iot hub module-identity create
Maak een module op een doel-IoT-apparaat in een IoT Hub.
az iot hub module-identity create --device-id
--module-id
[--am {shared_private_key, x509_ca, x509_thumbprint}]
[--auth-type {key, login}]
[--hub-name]
[--login]
[--od]
[--primary-thumbprint]
[--resource-group]
[--secondary-thumbprint]
[--valid-days]
Vereiste parameters
Doelapparaat.
Doelmodule.
Optionele parameters
Het autorisatietype dat een entiteit moet maken.
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 .
IoT Hub naam.
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.
Genereer een zelf-ondertekend certificaat en gebruik de vingerafdruk. Uitvoer naar opgegeven doelmap.
Expliciete zelf-ondertekende certificaatvingerafdruk die moet worden gebruikt voor de primaire sleutel.
De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .
Expliciete zelf-ondertekende certificaatvingerafdruk die moet worden gebruikt voor de secundaire sleutel.
Genereer een zelf-ondertekend certificaat en gebruik de vingerafdruk. Geldig voor het opgegeven aantal dagen. Standaardinstelling: 365.
Vergroot de logboekregistratie om alle logboeken voor foutopsporing weer te geven.
Laat dit Help-bericht zien en sluit af.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Vergroot de logboekverkenbaarheid. Gebruik --debug voor volledige logboeken voor foutopsporing.
az iot hub module-identity delete
Verwijder een apparaat 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
Doelapparaat.
Doelmodule.
Optionele parameters
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 .
Etag of entiteitstag die overeenkomt met de laatste status van de resource. Als er geen etag wordt opgegeven, wordt de waarde * ' ' gebruikt.
IoT Hub naam.
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.
De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .
Vergroot de logboekregistratie om alle logboeken voor foutopsporing weer te geven.
Laat dit Help-bericht zien en sluit af.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Vergroot de logboekverkenbaarheid. Gebruik --debug voor volledige logboeken voor foutopsporing.
az iot hub module-identity list
Een lijst met modules op een IoT-apparaat in een IoT Hub.
az iot hub module-identity list --device-id
[--auth-type {key, login}]
[--hub-name]
[--login]
[--resource-group]
[--top]
Vereiste parameters
Doelapparaat.
Optionele parameters
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 .
IoT Hub naam.
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.
De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .
Maximum aantal elementen dat moet worden retourneren. Gebruik -1 voor onbeperkt.
Vergroot de logboekregistratie om alle logboeken voor foutopsporing weer te geven.
Laat dit Help-bericht zien en sluit af.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Vergroot de logboekverkenbaarheid. Gebruik --debug voor volledige logboeken voor foutopsporing.
az iot hub module-identity renew-key
Vernieuw de doelsleutels van IoT Hub apparaatmodule met SAS-verificatie.
az iot hub module-identity renew-key --device-id
--hub-name
--key-type {primary, secondary, swap}
--module-id
[--auth-type {key, login}]
[--etag]
[--login]
[--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
De primaire en secundaire sleutels wisselen.
az iot hub module-identity renew-key -m {module_name} -d {device_id} -n {iothub_name} --kt swap
Vereiste parameters
Doelapparaat.
IoT Hub naam.
Doelsleuteltype dat opnieuw moet worden ge regenereren.
Doelmodule.
Optionele parameters
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 .
Etag of entiteitstag die overeenkomt met de laatste status van de resource. Als er geen etag wordt opgegeven, wordt de waarde * ' ' gebruikt.
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.
De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .
Vergroot de logboekregistratie om alle logboeken voor foutopsporing weer te geven.
Laat dit Help-bericht zien en sluit af.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Vergroot de logboekverkenbaarheid. Gebruik --debug voor volledige logboeken voor foutopsporing.
az iot hub module-identity show
De details van een IoT-apparaatmodule 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
Doelapparaat.
Doelmodule.
Optionele parameters
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 .
IoT Hub naam.
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.
De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .
Vergroot de logboekregistratie om alle logboeken voor foutopsporing weer te geven.
Laat dit Help-bericht zien en sluit af.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Vergroot de logboekverkenbaarheid. Gebruik --debug voor volledige logboeken voor foutopsporing.
az iot hub module-identity update
Werk een IoT Hub apparaatmodule bij.
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 activeren
az iot hub module-identity update -m {module_name} -d {device_id} -n {iothub_name} --set authentication.symmetricKey.primaryKey="" authentication.symmetricKey.secondaryKey=""
Vereiste parameters
Doelapparaat.
Doelmodule.
Optionele parameters
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>.
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 .
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 'add' gebruikt, moet u letterlijke tekenreeksen bewaren in plaats van te proberen te converteren naar JSON.
IoT Hub naam.
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.
Verwijder een eigenschap of een element uit een lijst. Voorbeeld: --remove property.list OR --remove propertyToRemove.
De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .
Werk een object bij door een eigenschapspad en waarde op te geven die moeten worden ingesteld. Voorbeeld: --set property1.property2=.
Vergroot de logboekregistratie om alle logboeken voor foutopsporing weer te geven.
Laat dit Help-bericht zien en sluit af.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Vergroot de logboekverkenbaarheid. Gebruik --debug voor volledige logboeken voor foutopsporing.