az iot hub device-identity

Kommentar

Den här referensen är en del av azure-iot-tillägget för Azure CLI (version 2.37.0 eller senare). Tillägget installeras automatiskt första gången du kör ett az iot hub device-identity-kommando . 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.	Anknytning	Allmän tillgänglighet
az iot hub device-identity children add	Lägg till enheter som underordnade till en målgränsenhet.	Anknytning	Allmän tillgänglighet
az iot hub device-identity children list	Matar ut samlingen med tilldelade underordnade enheter.	Anknytning	Allmän tillgänglighet
az iot hub device-identity children remove	Ta bort underordnade enheter från en målgränsenhet.	Anknytning	Allmän tillgänglighet
az iot hub device-identity connection-string	Hantera IoT-enhetens anslutningssträng.	Anknytning	Allmän tillgänglighet
az iot hub device-identity connection-string show	Visa en viss IoT Hub-enhet anslutningssträng.	Anknytning	Allmän tillgänglighet
az iot hub device-identity create	Skapa en enhet i en IoT Hub.	Anknytning	Allmän tillgänglighet
az iot hub device-identity delete	Ta bort en IoT Hub-enhet.	Anknytning	Allmän tillgänglighet
az iot hub device-identity export	Exportera alla enhetsidentiteter från en IoT Hub till en Azure Storage-blobcontainer.	Anknytning	Allmän tillgänglighet
az iot hub device-identity import	Importera enhetsidentiteter till en IoT Hub från en lagringscontainerblob.	Anknytning	Allmän tillgänglighet
az iot hub device-identity list	Lista enheter i en IoT Hub.	Anknytning	Allmän tillgänglighet
az iot hub device-identity parent	Hantera överordnade enhetsrelationer för IoT-enheter.	Anknytning	Allmän tillgänglighet
az iot hub device-identity parent set	Ange den överordnade enheten för en målenhet.	Anknytning	Allmän tillgänglighet
az iot hub device-identity parent show	Hämta den överordnade enheten för en målenhet.	Anknytning	Allmän tillgänglighet
az iot hub device-identity renew-key	Förnya målnycklarna för en IoT Hub-enhet med sas-autentisering.	Anknytning	Allmän tillgänglighet
az iot hub device-identity show	Hämta information om en IoT Hub-enhet.	Anknytning	Allmän tillgänglighet
az iot hub device-identity update	Uppdatera en IoT Hub-enhet.	Anknytning	Allmän tillgänglighet

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 {shared_private_key, x509_ca, x509_thumbprint}]
                                  [--auth-type {key, login}]
                                  [--device-scope]
                                  [--edge-enabled {false, true}]
                                  [--hub-name]
                                  [--login]
                                  [--od]
                                  [--pk]
                                  [--primary-thumbprint]
                                  [--resource-group]
                                  [--secondary-key]
                                  [--secondary-thumbprint]
                                  [--sta {disabled, enabled}]
                                  [--star]
                                  [--valid-days]

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

--device-id -d

Målenhets-ID.

Valfria parametrar

--am --auth-method

Auktoriseringsmetoden som en entitet ska skapas med.

accepterade värden: shared_private_key, x509_ca, x509_thumbprint

standardvärde: shared_private_key

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

accepterade värden: key, login

standardvärde: key

--device-scope

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.

--edge-enabled --ee

Flagga som anger kantaktivering.

accepterade värden: false, true

standardvärde: False

--hub-name -n

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

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

--od --output-dir

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

--pk --primary-key

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

--primary-thumbprint --ptp

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

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--secondary-key --sk

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

--secondary-thumbprint --stp

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

--sta --status

Ange enhetsstatus när du skapar den.

accepterade värden: disabled, enabled

standardvärde: enabled

--star --status-reason

Beskrivning av enhetsstatus.

--valid-days --vd

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

Globala parametrar

--debug

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

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc

standardvärde: json

--query

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

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

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

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

--device-id -d

Målenhets-ID.

Valfria parametrar

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

accepterade värden: key, login

standardvärde: key

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

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

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Globala parametrar

--debug

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

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc

standardvärde: json

--query

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

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

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

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]
                                  [--bcu]
                                  [--hub-name]
                                  [--identity]
                                  [--ik {false, true}]
                                  [--login]
                                  [--resource-group]
                                  [--sa]

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

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

accepterade värden: key, login

standardvärde: key

--bc --blob-container

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.

--bcu --blob-container-uri

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.

--hub-name -n

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

--identity

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.

--ik --include-keys

Om värdet anges exporteras nycklarna normalt. Annars är nycklarna inställda på null i exportutdata.

accepterade värden: false, true

standardvärde: False

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

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--sa --storage-account

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

--debug

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

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc

standardvärde: json

--query

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

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

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

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]
                                  [--ibcu]
                                  [--identity]
                                  [--input-storage-account]
                                  [--login]
                                  [--obc]
                                  [--obcu]
                                  [--osa]
                                  [--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

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

accepterade värden: key, login

standardvärde: key

--hub-name -n

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

--ibc --input-blob-container

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.

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

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.

--identity

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.

--input-storage-account --isa

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.

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

--obc --output-blob-container

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.

--obcu --output-blob-container-uri

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.

--osa --output-storage-account

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.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Globala parametrar

--debug

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

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc

standardvärde: json

--query

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

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

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

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 {false, true}]
                                [--hub-name]
                                [--login]
                                [--resource-group]
                                [--top]

Valfria parametrar

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

accepterade värden: key, login

standardvärde: key

--edge-enabled --ee

Flagga som anger kantaktivering.

accepterade värden: false, true

standardvärde: False

--hub-name -n

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

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

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--top

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

standardvärde: 1000

Globala parametrar

--debug

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

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc

standardvärde: json

--query

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

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

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

az iot hub device-identity renew-key

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

az iot hub device-identity renew-key --device-id
                                     --hub-name
                                     --key-type {primary, secondary, swap}
                                     [--auth-type {key, login}]
                                     [--etag]
                                     [--login]
                                     [--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

Obligatoriska parametrar

--device-id -d

Målenhets-ID.

--hub-name -n

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

--key-type --kt

Målnyckeltyp som ska återskapas.

accepterade värden: primary, secondary, swap

Valfria parametrar

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

accepterade värden: key, login

standardvärde: key

--etag -e

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

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

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Globala parametrar

--debug

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

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc

standardvärde: json

--query

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

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

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

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

--device-id -d

Målenhets-ID.

Valfria parametrar

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

accepterade värden: key, login

standardvärde: key

--hub-name -n

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

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

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Globala parametrar

--debug

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

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc

standardvärde: json

--query

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

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

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

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 {shared_private_key, x509_ca, x509_thumbprint}]
                                  [--auth-type {key, login}]
                                  [--edge-enabled {false, true}]
                                  [--etag]
                                  [--force-string]
                                  [--hub-name]
                                  [--login]
                                  [--pk]
                                  [--primary-thumbprint]
                                  [--remove]
                                  [--resource-group]
                                  [--secondary-key]
                                  [--secondary-thumbprint]
                                  [--set]
                                  [--sta {disabled, enabled}]
                                  [--star]

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

--device-id -d

Målenhets-ID.

Valfria parametrar

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

standardvärde: []

--am --auth-method

Auktoriseringsmetoden som en entitet ska skapas med.

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

accepterade värden: key, login

standardvärde: key

--edge-enabled --ee

Flagga som anger kantaktivering.

accepterade värden: false, true

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

standardvärde: False

--hub-name -n

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

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

--pk --primary-key

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

--primary-thumbprint --ptp

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

--remove

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

standardvärde: []

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--secondary-key --sk

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

--secondary-thumbprint --stp

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

--set

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

standardvärde: []

--sta --status

Ange enhetsstatus när du skapar den.

accepterade värden: disabled, enabled

--star --status-reason

Beskrivning av enhetsstatus.

Globala parametrar

--debug

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

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc

standardvärde: json

--query

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

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

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