az iot hub device-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 device-identity. Läs mer om tillägg.
Hantera IoT-enheter.
Kommandon
| Name | Description | Typ | Status |
|---|---|---|---|
| az iot hub device-identity children |
Hantera underordnade enhetsrelationer för IoT Edge-enheter. |
Extension | GA |
| az iot hub device-identity children add |
Lägg till enheter som underordnade till en målgränsenhet. |
Extension | GA |
| az iot hub device-identity children list |
Matar ut samlingen med tilldelade underordnade enheter. |
Extension | GA |
| az iot hub device-identity children remove |
Ta bort underordnade enheter från en målgränsenhet. |
Extension | GA |
| az iot hub device-identity connection-string |
Hantera IoT-enhetens anslutningssträng. |
Extension | GA |
| az iot hub device-identity connection-string show |
Visa en viss IoT Hub-enhet anslutningssträng. |
Extension | GA |
| az iot hub device-identity create |
Skapa en enhet i en IoT Hub. |
Extension | GA |
| az iot hub device-identity delete |
Ta bort en IoT Hub-enhet. |
Extension | GA |
| az iot hub device-identity export |
Exportera alla enhetsidentiteter från en IoT Hub till en Azure Storage-blobcontainer. |
Extension | GA |
| az iot hub device-identity import |
Importera enhetsidentiteter till en IoT Hub från en lagringscontainerblob. |
Extension | GA |
| az iot hub device-identity list |
Lista enheter i en IoT Hub. |
Extension | GA |
| az iot hub device-identity parent |
Hantera överordnade enhetsrelationer för IoT-enheter. |
Extension | GA |
| az iot hub device-identity parent set |
Ange den överordnade enheten för en målenhet. |
Extension | GA |
| az iot hub device-identity parent show |
Hämta den överordnade enheten för en målenhet. |
Extension | GA |
| az iot hub device-identity renew-key |
Förnya målnycklarna för IoT Hub-enheter med sas-autentisering. |
Extension | GA |
| az iot hub device-identity show |
Hämta information om en IoT Hub-enhet. |
Extension | GA |
| az iot hub device-identity update |
Uppdatera en IoT Hub-enhet. |
Extension | GA |
az iot hub device-identity create
Skapa en enhet 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 enheten om inga anpassade nycklar tillhandahålls.
Om ett enhetsomfång anges för en gränsenhet konverteras värdet automatiskt till ett överordnat omfång.
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]
Exempel
Skapa en edge-aktiverad IoT-enhet med standardauktorisering (delad privat nyckel).
az iot hub device-identity create -n {iothub_name} -d {device_id} --ee
Skapa en IoT-enhet med självsignerad certifikatauktorisering, generera ett certifikat som är giltigt i 10 dagar och använd sedan tumavtrycket.
az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_thumbprint --valid-days 10
Skapa en IoT-enhet med självsignerad certifikatauktorisering, generera ett certifikat för standardförfallotid (365 dagar) och utdata till målkatalogen.
az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_thumbprint --output-dir /path/to/output
Skapa en IoT-enhet med självsignerad certifikatauktorisering och ange explicit primära och sekundära tumavtryck.
az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_thumbprint --ptp {thumbprint_1} --stp {thumbprint_2}
Skapa en IoT-enhet med rotcertifikatutfärdarauktorisering med inaktiverad status och orsak.
az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_ca --status disabled --status-reason 'for reasons'
Skapa en IoT-enhet med ett enhetsomfång.
az iot hub device-identity create -n {iothub_name} -d {device_id} --device-scope 'ms-azure-iot-edge://edge0-123456789123456789'
Obligatoriska parametrar
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.
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 |
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 |
Enhetens omfång. För gränsenheter genereras detta automatiskt och kan inte ändras. För lövenheter anger du detta för att skapa en underordnad/överordnad relation.
| Egenskap | Värde |
|---|---|
| Parameter group: | Device Scope Arguments |
Flagga som anger kantaktivering.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
| Godkända värden: | false, true |
IoT Hub-namn eller värdnamn. Krävs om --login inte har angetts.
| Egenskap | Värde |
|---|---|
| Parameter group: | IoT Hub Identifier Arguments |
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 |
Generera självsignerat certifikat och använd tumavtrycket. Utdata till angiven målkatalog.
| Egenskap | Värde |
|---|---|
| Parameter group: | X.509 Arguments |
Den primära symmetriska delade åtkomstnyckeln som lagras i base64-format.
| Egenskap | Värde |
|---|---|
| Parameter group: | Symmetric Key Arguments |
Självsignerat tumavtryck för certifikat som ska användas för det primära tumavtrycket.
| Egenskap | Värde |
|---|---|
| Parameter group: | X.509 Arguments |
Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.
Den sekundära symmetriska delade åtkomstnyckeln som lagras i base64-format.
| Egenskap | Värde |
|---|---|
| Parameter group: | Symmetric Key Arguments |
Självsignerat tumavtryck för certifikat som ska användas för det sekundära tumavtrycket.
| Egenskap | Värde |
|---|---|
| Parameter group: | X.509 Arguments |
Ange enhetsstatus när du skapar den.
| Egenskap | Värde |
|---|---|
| Standardvärde: | enabled |
| Godkända värden: | disabled, enabled |
Beskrivning av enhetsstatus.
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
Öka loggningsverositeten för att visa alla felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Visa det här hjälpmeddelandet och avsluta.
Visa bara fel och ignorera varningar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Utdataformat.
| Egenskap | Värde |
|---|---|
| Standardvärde: | json |
| Godkända värden: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.
Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.
Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
az iot hub device-identity delete
Ta bort en IoT Hub-enhet.
az iot hub device-identity delete --device-id
[--auth-type {key, login}]
[--etag]
[--hub-name]
[--login]
[--resource-group]
Obligatoriska parametrar
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.
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 eller entitetstagg som motsvarar resursens sista tillstånd. Om ingen etag anges används värdet *.
IoT Hub-namn eller värdnamn. Krävs om --login inte har angetts.
| Egenskap | Värde |
|---|---|
| Parameter group: | IoT Hub Identifier Arguments |
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 |
Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.
Globala parametrar
Öka loggningsverositeten för att visa alla felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Visa det här hjälpmeddelandet och avsluta.
Visa bara fel och ignorera varningar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Utdataformat.
| Egenskap | Värde |
|---|---|
| Standardvärde: | json |
| Godkända värden: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.
Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.
Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
az iot hub device-identity export
Exportera alla enhetsidentiteter från en IoT Hub till en Azure Storage-blobcontainer.
Utdatabloben som innehåller enhetsidentiteter är en textfil med namnet "devices.txt".
Behörigheter som krävs – antingen IoT Hub-princip för delad åtkomst som stöder "Registerläsning och registerskrivning" eller ett huvudnamn med rollen "IoT Hub-datadeltagare" på IoT Hub.
Parametrar för lagringskontonamn och blobcontainernamn kan bara användas när lagringskontot finns i samma prenumeration som indata-IoT Hub. För inbyggda SAS-uri-indata för blobcontainer läser du indatareglerna för din miljö.
Mer information finns i https://aka.ms/iothub-device-exportimport.
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]
Exempel
Exportera alla enhetsidentiteter till en konfigurerad blobcontainer och inkludera enhetsnycklar. Namnet på blobcontainern och lagringskontot anges som parametrar för kommandot.
az iot hub device-identity export -n {iothub_name} --ik --bc {blob_container_name} --sa {storage_account_name}
Exportera alla enhetsidentiteter till en konfigurerad blobcontainer och inkludera enhetsnycklar. Använder ett infogat SAS-uri-exempel.
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'
Exportera alla enhetsidentiteter till en konfigurerad blobcontainer med hjälp av en filsökväg som innehåller SAS-URI:n.
az iot hub device-identity export -n {iothub_name} --bcu {sas_uri_filepath}
Exportera alla enhetsidentiteter till en konfigurerad blobcontainer och inkludera enhetsnycklar. Använder systemtilldelad identitet som har rollerna Storage Blob Data Contributor för lagringskontot. Namnet på blobcontainern och lagringskontot anges som parametrar för kommandot.
az iot hub device-identity export -n {iothub_name} --ik --bc {blob_container_name} --sa {storage_account_name} --identity [system]
Exportera alla enhetsidentiteter till en konfigurerad blobcontainer och inkludera enhetsnycklar. Använder systemtilldelad identitet som har rollerna Storage Blob Data Contributor för lagringskontot. Blobcontainer-URI:n behöver inte blob-SAS-token.
az iot hub device-identity export -n {iothub_name} --ik --bcu 'https://mystorageaccount.blob.core.windows.net/devices' --identity [system]
Exportera alla enhetsidentiteter till en konfigurerad blobcontainer och inkludera enhetsnycklar. Använder användartilldelad hanterad identitet som har rollen Storage Blob Data Contributor för lagringskontot. Namnet på blobcontainern och lagringskontot anges som parametrar för kommandot.
az iot hub device-identity export -n {iothub_name} --ik --bc {blob_container_name} --sa {storage_account_name} --identity {managed_identity_resource_id}
Exportera alla enhetsidentiteter till en konfigurerad blobcontainer och inkludera enhetsnycklar. Använder användartilldelad hanterad identitet som har rollen Storage Blob Data Contributor för lagringskontot. Blobcontainer-URI:n behöver inte blob-SAS-token.
az iot hub device-identity export -n {iothub_name} --ik --bcu 'https://mystorageaccount.blob.core.windows.net/devices' --identity {managed_identity_resource_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.
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 |
Den här blobcontainern används för att mata ut status för enhetsidentitetsimportjobbet och resultaten. Parametern ignoreras när blob_container_uri anges. Skriv-, läs- och borttagningsåtkomst krävs för den här blobcontainern.
URI för signatur för blobdelad åtkomst med skriv-, läs- och borttagningsåtkomst till en blobcontainer. Detta används för att mata ut status för jobbet och resultatet. Obs! När du använder identitetsbaserad autentisering krävs fortfarande en https:// URI , men ingen SAS-token krävs. Indata för det här argumentet kan vara infogade eller från en filsökväg.
IoT Hub-namn eller värdnamn. Krävs om --login inte har angetts.
| Egenskap | Värde |
|---|---|
| Parameter group: | IoT Hub Identifier Arguments |
Hanterad identitetstyp för att avgöra om systemtilldelad hanterad identitet eller användartilldelad hanterad identitet används. För systemtilldelad hanterad identitet använder du [system]. För användartilldelad hanterad identitet anger du det användartilldelade resurs-ID:t för hanterad identitet. Den här identiteten kräver rollerna Storage Blob Data Contributor för lagringskontot.
Om värdet anges exporteras nycklarna normalt. Annars är nycklarna inställda på null i exportutdata.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
| Godkända värden: | false, true |
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 |
Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.
Namnet på Azure Storage-kontot som innehåller blobcontainern för utdata. Parametern ignoreras när blob_container_uri anges. Skriv-, läs- och borttagningsåtkomst krävs.
Globala parametrar
Öka loggningsverositeten för att visa alla felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Visa det här hjälpmeddelandet och avsluta.
Visa bara fel och ignorera varningar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Utdataformat.
| Egenskap | Värde |
|---|---|
| Standardvärde: | json |
| Godkända värden: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.
Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.
Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
az iot hub device-identity import
Importera enhetsidentiteter till en IoT Hub från en lagringscontainerblob.
Den förväntade indatafilen som innehåller enhetsidentiteter ska ha namnet "devices.txt". Utdataloggfilen "importErrors.log" är tom när importen lyckas och innehåller felloggar om importen misslyckas.
Behörigheter som krävs – antingen IoT Hub-princip för delad åtkomst som stöder "Registerläsning och registerskrivning" eller ett huvudnamn med rollen "IoT Hub-datadeltagare" på IoT Hub.
Parametrar för lagringskontonamn och blobcontainernamn kan bara användas när lagringskontot finns i samma prenumeration som indata-IoT Hub. För inbyggda SAS-uri-indata för blobcontainer läser du indatareglerna för din miljö.
Mer information finns i https://aka.ms/iothub-device-exportimport.
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]
Exempel
Importera alla enhetsidentiteter från en blob genom att ange kommandoparametrar för indatablobcontainer och lagringskonto samt utdatablobcontainer och lagringskonto.
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}
Importera alla enhetsidentiteter från en blob med hjälp av en infogad SAS-uri.
az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri} --obcu {output_sas_uri}
Importera alla enhetsidentiteter från en blob med hjälp av en filsökväg som innehåller SAS-URI.
az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri_filepath} --obcu {output_sas_uri_filepath}
Importera alla enhetsidentiteter från en blob med hjälp av systemtilldelad identitet som har rollerna Storage Blob Data Contributor för båda lagringskontona. Indatablobcontainern och lagringskontot samt utdatablobcontainern och lagringskontot tillhandahålls som parametrar till kommandot
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]
Importera alla enhetsidentiteter från en blob med hjälp av systemtilldelad identitet som har rollerna Storage Blob Data Contributor för båda lagringskontona. Blobcontainer-URI:n behöver inte blob-SAS-token.
az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri} --obcu {output_sas_uri} --identity [system]
Importera alla enhetsidentiteter från en blob med användartilldelad hanterad identitet som har rollerna Storage Blob Data Contributor för båda lagringskontona. Indatablobcontainern och lagringskontot samt utdatablobcontainern och lagringskontot tillhandahålls som parametrar till kommandot
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}
Importera alla enhetsidentiteter från en blob med användartilldelad hanterad identitet som har rollerna Storage Blob Data Contributor för båda lagringskontona. Blobcontainer-URI:n behöver inte blob-SAS-token.
az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri} --obcu {output_sas_uri} --identity {managed_identity_resource_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.
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 |
IoT Hub-namn eller värdnamn. Krävs om --login inte har angetts.
| Egenskap | Värde |
|---|---|
| Parameter group: | IoT Hub Identifier Arguments |
Den här blobcontainern lagrar filen som definierar åtgärder som ska utföras i identitetsregistret. Parametern ignoreras när input_blob_container_uri anges. Läsbehörighet krävs för den här blobcontainern.
Signatur-URI för blobdelad åtkomst med läsåtkomst till en blobcontainer. Den här bloben innehåller de åtgärder som ska utföras i identitetsregistret. Obs! När du använder identitetsbaserad autentisering krävs fortfarande en https:// URI , men ingen SAS-token krävs. Indata för det här argumentet kan vara infogade eller från en filsökväg.
Hanterad identitetstyp för att avgöra om systemtilldelad hanterad identitet eller användartilldelad hanterad identitet används. För systemtilldelad hanterad identitet använder du [system]. För användartilldelad hanterad identitet anger du det användartilldelade resurs-ID:t för hanterad identitet. Den här identiteten kräver rollen Storage Blob Data Contributor för mållagringskontot och deltagarrollen för IoT Hub.
Namnet på Azure Storage-kontot som innehåller indatablobcontainern. Krävs endast när input_blob_container_uri inte anges. Läsbehörighet krävs.
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 |
Den här blobcontainern används för att mata ut status för enhetsidentitetsimportjobbet och resultaten. Krävs endast när input_blob_container_uri inte anges. Skrivåtkomst krävs för den här blobcontainern.
Signatur-URI för blobdelad åtkomst med skrivåtkomst till en blobcontainer. Detta används för att mata ut status för jobbet och resultatet. Obs! När du använder identitetsbaserad autentisering krävs fortfarande en https:// URI utan SAS-token. Indata för det här argumentet kan vara infogade eller från en filsökväg.
Namnet på Azure Storage-kontot som innehåller blobcontainern för utdata. Parametern ignoreras när output_blob_container_uri anges. Skrivåtkomst krävs.
Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.
Globala parametrar
Öka loggningsverositeten för att visa alla felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Visa det här hjälpmeddelandet och avsluta.
Visa bara fel och ignorera varningar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Utdataformat.
| Egenskap | Värde |
|---|---|
| Standardvärde: | json |
| Godkända värden: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.
Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.
Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
az iot hub device-identity list
Lista enheter i en IoT Hub.
Det här kommandot är ett alias för az iot hub device-twin list, som rekommenderas starkt för det här kommandot. I framtiden kan det här az iot hub device-identity list kommandot ändras eller vara inaktuellt.
az iot hub device-identity list [--auth-type {key, login}]
[--edge-enabled --ee {false, true}]
[--hub-name]
[--login]
[--resource-group]
[--top]
Valfria parametrar
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 |
Flagga som anger kantaktivering.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
| Godkända värden: | false, true |
IoT Hub-namn eller värdnamn. Krävs om --login inte har angetts.
| Egenskap | Värde |
|---|---|
| Parameter group: | IoT Hub Identifier Arguments |
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 |
Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.
Maximalt antal element som ska returneras. Använd -1 för obegränsat.
| Egenskap | Värde |
|---|---|
| Standardvärde: | 1000 |
Globala parametrar
Öka loggningsverositeten för att visa alla felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Visa det här hjälpmeddelandet och avsluta.
Visa bara fel och ignorera varningar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Utdataformat.
| Egenskap | Värde |
|---|---|
| Standardvärde: | json |
| Godkända värden: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.
Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.
Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
az iot hub device-identity renew-key
Förnya målnycklarna för IoT Hub-enheter med sas-autentisering.
För närvarande stöds inte etags och nyckeltyp swap för massåtergenerering.
Massnyckelförnyelse kommer att skapa ett annat utdataformat än återskapande av en enhetsnyckel.
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]
Exempel
Förnya primärnyckeln.
az iot hub device-identity renew-key -d {device_id} -n {iothub_name} --kt primary
Växla de primära och sekundära nycklarna.
az iot hub device-identity renew-key -d {device_id} -n {iothub_name} --kt swap
Förnya den sekundära nyckeln för två enheter och deras moduler.
az iot hub device-identity renew-key -d {device_id} {device_id} -n {iothub_name} --kt secondary --include-modules
Förnya båda nycklarna för alla enheter i hubben.
az iot hub device-identity renew-key -d * -n {iothub_name} --kt both
Obligatoriska parametrar
Utrymmessepererad lista över målenhets-ID:n. Använd * för alla enheter.
IoT Hub-namn eller värdnamn. Krävs om --login inte har angetts.
| Egenskap | Värde |
|---|---|
| Parameter group: | IoT Hub Identifier Arguments |
Målnyckeltyp som ska återskapas.
| Egenskap | Värde |
|---|---|
| Godkända värden: | both, primary, secondary, swap |
Valfria parametrar
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 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.
Flagga för att inkludera enhetsmoduler under nyckelåtergenerering.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
| Godkända värden: | false, true |
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 |
Dölj förloppsindikatorn för massåtergenerering av nycklar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
| Godkända värden: | false, true |
Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.
Globala parametrar
Öka loggningsverositeten för att visa alla felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Visa det här hjälpmeddelandet och avsluta.
Visa bara fel och ignorera varningar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Utdataformat.
| Egenskap | Värde |
|---|---|
| Standardvärde: | json |
| Godkända värden: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.
Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.
Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
az iot hub device-identity show
Hämta information om en IoT Hub-enhet.
az iot hub device-identity show --device-id
[--auth-type {key, login}]
[--hub-name]
[--login]
[--resource-group]
Obligatoriska parametrar
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.
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 |
IoT Hub-namn eller värdnamn. Krävs om --login inte har angetts.
| Egenskap | Värde |
|---|---|
| Parameter group: | IoT Hub Identifier Arguments |
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 |
Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.
Globala parametrar
Öka loggningsverositeten för att visa alla felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Visa det här hjälpmeddelandet och avsluta.
Visa bara fel och ignorera varningar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Utdataformat.
| Egenskap | Värde |
|---|---|
| Standardvärde: | json |
| Godkända värden: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.
Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.
Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
az iot hub device-identity update
Uppdatera en IoT Hub-enhet.
Använd --set följt av egenskapstilldelningar för uppdatering av en enhet. Utnyttja parametrar som returneras från "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]
Exempel
Aktivera gränsfunktioner för enheten
az iot hub device-identity update -d {device_id} -n {iothub_name} --set capabilities.iotEdge=true
Aktivera gränsfunktioner för enheten med hjälp av bekvämlighetsargument.
az iot hub device-identity update -d {device_id} -n {iothub_name} --ee
Inaktivera enhetsstatus
az iot hub device-identity update -d {device_id} -n {iothub_name} --set status=disabled
Inaktivera enhetsstatus med hjälp av bekvämlighetsargument.
az iot hub device-identity update -d {device_id} -n {iothub_name} --status disabled
I ett kommando
az iot hub device-identity update -d {device_id} -n {iothub_name} --set status=disabled capabilities.iotEdge=true
Obligatoriska parametrar
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.
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: | [] |
Auktoriseringsmetoden som en entitet ska skapas med.
| Egenskap | Värde |
|---|---|
| Godkända värden: | shared_private_key, x509_ca, x509_thumbprint |
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 |
Flagga som anger kantaktivering.
| Egenskap | Värde |
|---|---|
| Godkända värden: | false, true |
Etag eller entitetstagg som motsvarar resursens sista tillstånd. Om ingen etag anges används värdet *.
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 |
IoT Hub-namn eller värdnamn. Krävs om --login inte har angetts.
| Egenskap | Värde |
|---|---|
| Parameter group: | IoT Hub Identifier Arguments |
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 |
Den primära symmetriska delade åtkomstnyckeln som lagras i base64-format.
| Egenskap | Värde |
|---|---|
| Parameter group: | Symmetric Key Arguments |
Självsignerat tumavtryck för certifikat som ska användas för det primära tumavtrycket.
| Egenskap | Värde |
|---|---|
| Parameter group: | X.509 Arguments |
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: | [] |
Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.
Den sekundära symmetriska delade åtkomstnyckeln som lagras i base64-format.
| Egenskap | Värde |
|---|---|
| Parameter group: | Symmetric Key Arguments |
Självsignerat tumavtryck för certifikat som ska användas för det sekundära tumavtrycket.
| Egenskap | Värde |
|---|---|
| Parameter group: | X.509 Arguments |
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: | [] |
Ange enhetsstatus när du skapar den.
| Egenskap | Värde |
|---|---|
| Godkända värden: | disabled, enabled |
Beskrivning av enhetsstatus.
Globala parametrar
Öka loggningsverositeten för att visa alla felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Visa det här hjälpmeddelandet och avsluta.
Visa bara fel och ignorera varningar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Utdataformat.
| Egenskap | Värde |
|---|---|
| Standardvärde: | json |
| Godkända värden: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.
Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.
Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |