Dela via

az iot hub module-identity

Note

Den här referensen är en del av azure-iot-tillägget för Azure CLI (version 2.59.0 eller senare). Tillägget installeras automatiskt första gången du kör ett kommandot az iot hub module-identity. Läs mer om tillägg.

Hantera IoT-enhetsmoduler.

Kommandon

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

Hantera IoT-enhetsmodulens anslutningssträng.

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

Visa en IoT-målenhetsmodul anslutningssträng.

 Extension GA
az iot hub module-identity create

Skapa en modul på en IoT-målenhet i en IoT Hub.

 Extension GA
az iot hub module-identity delete

Ta bort en enhet i en IoT Hub.

 Extension GA
az iot hub module-identity list

Lista moduler som finns på en IoT-enhet i en IoT Hub.

 Extension GA
az iot hub module-identity renew-key

Förnya målnycklarna för IoT Hub-enhetsmoduler med sas-autentisering.

 Extension GA
az iot hub module-identity show

Hämta information om en IoT-enhetsmodul i en IoT Hub.

 Extension GA
az iot hub module-identity update

Uppdatera en IoT Hub-enhetsmodul.

 Extension GA

az iot hub module-identity create

Skapa en modul på en IoT-målenhet i en IoT Hub.

När du använder autentiseringsmetoden för shared_private_key (kallas även symmetriska nycklar) genererar tjänsten dem för modulen om inga anpassade nycklar tillhandahålls.

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]

Obligatoriska parametrar

--device-id -d

Målenhets-ID.

--module-id -m

Målmodul-ID.

Valfria parametrar

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--am --auth-method

Auktoriseringsmetoden som en entitet ska skapas med.

Egenskap Värde
Standardvärde: shared_private_key
Godkända värden: shared_private_key, x509_ca, x509_thumbprint
--auth-type

Anger om åtgärden ska automatiskt härleda en principnyckel eller använda den aktuella Azure AD-sessionen. Om autentiseringstypen är inloggning och resursens värdnamn anges hoppas resurssökningen över om det inte behövs. Du kan konfigurera standardinställningen med .az configure --defaults iothub-data-auth-type={auth-type-value}

Egenskap Värde
Parameter group: Access Control Arguments
Standardvärde: key
Godkända värden: key, login
--hub-name -n

IoT Hub-namn eller värdnamn. Krävs om --login inte har angetts.

Egenskap Värde
Parameter group: IoT Hub Identifier Arguments
--login -l

Det här kommandot stöder en entitet anslutningssträng med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet anslutningssträng och namn anges prioriteras anslutningssträng. Krävs om --hub-name inte anges.

Egenskap Värde
Parameter group: IoT Hub Identifier Arguments
--od --output-dir

Generera självsignerat certifikat och använd tumavtrycket. Utdata till angiven målkatalog.

Egenskap Värde
Parameter group: X.509 Arguments
--pk --primary-key

Den primära symmetriska delade åtkomstnyckeln som lagras i base64-format.

Egenskap Värde
Parameter group: Symmetric Key Arguments
--primary-thumbprint --ptp

Självsignerat tumavtryck för certifikat som ska användas för det primära tumavtrycket.

Egenskap Värde
Parameter group: X.509 Arguments
--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

--secondary-key --sk

Den sekundära symmetriska delade åtkomstnyckeln som lagras i base64-format.

Egenskap Värde
Parameter group: Symmetric Key Arguments
--secondary-thumbprint --stp

Självsignerat tumavtryck för certifikat som ska användas för det sekundära tumavtrycket.

Egenskap Värde
Parameter group: X.509 Arguments
--valid-days --vd

Generera självsignerat certifikat och använd tumavtrycket. Giltigt för angivet antal dagar. Standardinställning: 365.

Egenskap Värde
Parameter group: X.509 Arguments
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az iot hub module-identity delete

Ta bort en enhet i en IoT Hub.

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

Obligatoriska parametrar

--device-id -d

Målenhets-ID.

--module-id -m

Målmodul-ID.

Valfria parametrar

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--auth-type

Anger om åtgärden ska automatiskt härleda en principnyckel eller använda den aktuella Azure AD-sessionen. Om autentiseringstypen är inloggning och resursens värdnamn anges hoppas resurssökningen över om det inte behövs. Du kan konfigurera standardinställningen med .az configure --defaults iothub-data-auth-type={auth-type-value}

Egenskap Värde
Parameter group: Access Control Arguments
Standardvärde: key
Godkända värden: key, login
--etag -e

Etag eller entitetstagg som motsvarar resursens sista tillstånd. Om ingen etag anges används värdet *.

--hub-name -n

IoT Hub-namn eller värdnamn. Krävs om --login inte har angetts.

Egenskap Värde
Parameter group: IoT Hub Identifier Arguments
--login -l

Det här kommandot stöder en entitet anslutningssträng med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet anslutningssträng och namn anges prioriteras anslutningssträng. Krävs om --hub-name inte anges.

Egenskap Värde
Parameter group: IoT Hub Identifier Arguments
--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az iot hub module-identity list

Lista moduler som finns på en IoT-enhet i en IoT Hub.

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

Obligatoriska parametrar

--device-id -d

Målenhets-ID.

Valfria parametrar

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--auth-type

Anger om åtgärden ska automatiskt härleda en principnyckel eller använda den aktuella Azure AD-sessionen. Om autentiseringstypen är inloggning och resursens värdnamn anges hoppas resurssökningen över om det inte behövs. Du kan konfigurera standardinställningen med .az configure --defaults iothub-data-auth-type={auth-type-value}

Egenskap Värde
Parameter group: Access Control Arguments
Standardvärde: key
Godkända värden: key, login
--hub-name -n

IoT Hub-namn eller värdnamn. Krävs om --login inte har angetts.

Egenskap Värde
Parameter group: IoT Hub Identifier Arguments
--login -l

Det här kommandot stöder en entitet anslutningssträng med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet anslutningssträng och namn anges prioriteras anslutningssträng. Krävs om --hub-name inte anges.

Egenskap Värde
Parameter group: IoT Hub Identifier Arguments
--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

--top

Maximalt antal element som ska returneras. Använd -1 för obegränsat.

Egenskap Värde
Standardvärde: 1000
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az iot hub module-identity renew-key

Förnya målnycklarna för IoT Hub-enhetsmoduler med sas-autentisering.

För närvarande stöds inte etags och nyckeltyp swap för massåtergenerering. Bulk Key-regenerering kommer att använda ett annat utdataformat än en modulnyckelförnyelse.

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]

Exempel

Förnya primärnyckeln.

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

Växla de primära och sekundära nycklarna.

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

Förnya den sekundära nyckeln för två moduler.

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

Förnya båda nycklarna för alla moduler på enheten.

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

Obligatoriska parametrar

--device-id -d

Målenhets-ID.

--hub-name -n

IoT Hub-namn eller värdnamn. Krävs om --login inte har angetts.

Egenskap Värde
Parameter group: IoT Hub Identifier Arguments
--key-type --kt

Målnyckeltyp som ska återskapas.

Egenskap Värde
Godkända värden: both, primary, secondary, swap
--module-id -m

Utrymmessepererad lista över målmodul-ID:t. Använd * för alla moduler.

Valfria parametrar

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--auth-type

Anger om åtgärden ska automatiskt härleda en principnyckel eller använda den aktuella Azure AD-sessionen. Om autentiseringstypen är inloggning och resursens värdnamn anges hoppas resurssökningen över om det inte behövs. Du kan konfigurera standardinställningen med .az configure --defaults iothub-data-auth-type={auth-type-value}

Egenskap Värde
Parameter group: Access Control Arguments
Standardvärde: key
Godkända värden: key, login
--etag -e

Etag eller entitetstagg som motsvarar resursens sista tillstånd. Om ingen etag anges används värdet *. Det här argumentet gäller endast för swap.

--login -l

Det här kommandot stöder en entitet anslutningssträng med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet anslutningssträng och namn anges prioriteras anslutningssträng. Krävs om --hub-name inte anges.

Egenskap Värde
Parameter group: IoT Hub Identifier Arguments
--no-progress

Dölj förloppsindikatorn för massåtergenerering av nycklar.

Egenskap Värde
Godkända värden: false, true
--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az iot hub module-identity show

Hämta information om en IoT-enhetsmodul i en IoT Hub.

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

Obligatoriska parametrar

--device-id -d

Målenhets-ID.

--module-id -m

Målmodul-ID.

Valfria parametrar

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--auth-type

Anger om åtgärden ska automatiskt härleda en principnyckel eller använda den aktuella Azure AD-sessionen. Om autentiseringstypen är inloggning och resursens värdnamn anges hoppas resurssökningen över om det inte behövs. Du kan konfigurera standardinställningen med .az configure --defaults iothub-data-auth-type={auth-type-value}

Egenskap Värde
Parameter group: Access Control Arguments
Standardvärde: key
Godkända värden: key, login
--hub-name -n

IoT Hub-namn eller värdnamn. Krävs om --login inte har angetts.

Egenskap Värde
Parameter group: IoT Hub Identifier Arguments
--login -l

Det här kommandot stöder en entitet anslutningssträng med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet anslutningssträng och namn anges prioriteras anslutningssträng. Krävs om --hub-name inte anges.

Egenskap Värde
Parameter group: IoT Hub Identifier Arguments
--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az iot hub module-identity update

Uppdatera en IoT Hub-enhetsmodul.

Använd --set följt av egenskapstilldelningar för uppdatering av en modul. Utnyttja egenskaper som returneras från "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]

Exempel

Återskapa symmetriska autentiseringsnycklar för modul

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

Obligatoriska parametrar

--device-id -d

Målenhets-ID.

--module-id -m

Målmodul-ID.

Valfria parametrar

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

Lägg till ett objekt i en lista över objekt genom att ange en sökväg och nyckelvärdepar. Exempel: --add property.listProperty <key=value, string or JSON string>.

Egenskap Värde
Parameter group: Generic Update Arguments
Standardvärde: []
--auth-type

Anger om åtgärden ska automatiskt härleda en principnyckel eller använda den aktuella Azure AD-sessionen. Om autentiseringstypen är inloggning och resursens värdnamn anges hoppas resurssökningen över om det inte behövs. Du kan konfigurera standardinställningen med .az configure --defaults iothub-data-auth-type={auth-type-value}

Egenskap Värde
Parameter group: Access Control Arguments
Standardvärde: key
Godkända värden: key, login
--etag -e

Etag eller entitetstagg som motsvarar resursens sista tillstånd. Om ingen etag anges används värdet *.

--force-string

När du använder "set" eller "add" bevarar du strängliteraler i stället för att försöka konvertera till JSON.

Egenskap Värde
Parameter group: Generic Update Arguments
Standardvärde: False
--hub-name -n

IoT Hub-namn eller värdnamn. Krävs om --login inte har angetts.

Egenskap Värde
Parameter group: IoT Hub Identifier Arguments
--login -l

Det här kommandot stöder en entitet anslutningssträng med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet anslutningssträng och namn anges prioriteras anslutningssträng. Krävs om --hub-name inte anges.

Egenskap Värde
Parameter group: IoT Hub Identifier Arguments
--remove

Ta bort en egenskap eller ett element från en lista. Exempel: --remove property.list <indexToRemove> ELLER --remove propertyToRemove.

Egenskap Värde
Parameter group: Generic Update Arguments
Standardvärde: []
--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

--set

Uppdatera ett objekt genom att ange en egenskapssökväg och ett värde som ska anges. Exempel: --set property1.property2=<value>.

Egenskap Värde
Parameter group: Generic Update Arguments
Standardvärde: []
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False