az iot hub device-identity

Note

Tento odkaz je součástí rozšíření azure-iot pro Azure CLI (verze 2.67.0 nebo vyšší). Rozšíření se automaticky nainstaluje při prvním spuštění příkazu az iot hub device-identity. Přečtěte si další informace o rozšířeních.

Správa zařízení IoT

Příkazy

Name Description Typ Stav
az iot hub device-identity children

Správa vztahů podřízených zařízení pro hraniční zařízení IoT

Extension GA
az iot hub device-identity children add

Přidejte zařízení jako podřízená zařízení do cílového hraničního zařízení.

Extension GA
az iot hub device-identity children list

Vypíše kolekci přiřazených podřízených zařízení.

Extension GA
az iot hub device-identity children remove

Odeberte podřízená zařízení z cílového hraničního zařízení.

Extension GA
az iot hub device-identity connection-string

Správa connection string zařízení IoT

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

Zobrazí connection string daného zařízení IoT Hub.

Extension GA
az iot hub device-identity create

Vytvořte zařízení v IoT Hub.

Extension GA
az iot hub device-identity delete

Odstraňte IoT Hub zařízení.

Extension GA
az iot hub device-identity export

Exportujte všechny identity zařízení z IoT Hub do kontejneru objektů blob Azure Storage.

Extension GA
az iot hub device-identity import

Importujte identity zařízení do IoT Hub z objektu blob kontejneru úložiště.

Extension GA
az iot hub device-identity list

Zobrazení seznamu zařízení v IoT Hub

Extension GA
az iot hub device-identity parent

Správa vztahů nadřazených zařízení pro zařízení IoT

Extension GA
az iot hub device-identity parent set

Nastavte nadřazené zařízení cílového zařízení.

Extension GA
az iot hub device-identity parent show

Získejte nadřazené zařízení cílového zařízení.

Extension GA
az iot hub device-identity renew-key

Obnovte cílové klíče IoT Hub zařízení s ověřováním SAS.

Extension GA
az iot hub device-identity show

Získejte podrobnosti o IoT Hub zařízení.

Extension GA
az iot hub device-identity update

Aktualizujte IoT Hub zařízení.

Extension GA

az iot hub device-identity create

Vytvořte zařízení v IoT Hub.

Při použití metody ověřování shared_private_key (označované také jako symetrické klíče), pokud nejsou k dispozici žádné vlastní klíče, služba je pro zařízení vygeneruje.

Pokud je pro hraniční zařízení zadaný obor zařízení, hodnota se automaticky převede na nadřazený obor.

az iot hub device-identity create --device-id
                                  [--acquire-policy-token]
                                  [--am --auth-method {shared_private_key, x509_ca, x509_thumbprint}]
                                  [--auth-type {key, login}]
                                  [--change-reference]
                                  [--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]

Příklady

Vytvořte zařízení IoT s podporou Edge s výchozí autorizací (sdílený privátní klíč).

az iot hub device-identity create -n {iothub_name} -d {device_id} --ee

Vytvořte zařízení IoT s autorizací certifikátu podepsaného svým držitelem, vygenerujte certifikát platný po dobu 10 dnů a pak použijte kryptografický otisk.

az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_thumbprint --valid-days 10

Vytvořte zařízení IoT s autorizací certifikátu podepsaného svým držitelem, vygenerujte certifikát výchozího vypršení platnosti (365 dnů) a výstup do cílového adresáře.

az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_thumbprint --output-dir /path/to/output

Vytvořte zařízení IoT s autorizací certifikátu podepsaného svým držitelem a explicitně poskytněte primární a sekundární kryptografické otisky.

az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_thumbprint --ptp {thumbprint_1} --stp {thumbprint_2}

Vytvořte zařízení IoT s autorizací kořenové certifikační autority se zakázaným stavem a důvodem.

az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_ca --status disabled --status-reason 'for reasons'

Vytvořte zařízení IoT s oborem zařízení.

az iot hub device-identity create -n {iothub_name} -d {device_id} --device-scope 'ms-azure-iot-edge://edge0-123456789123456789'

Povinné parametry

--device-id -d

ID cílového zařízení.

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--acquire-policy-token

Získání tokenu Azure Policy automaticky pro tuto operaci prostředku

Vlastnost Hodnota
Skupina parametrů: Global Policy Arguments
--am --auth-method

Metoda autorizace, se kterou se entita vytvoří.

Vlastnost Hodnota
Default value: shared_private_key
Přípustné hodnoty: shared_private_key, x509_ca, x509_thumbprint
--auth-type

Určuje, jestli má operace automaticky odvodit klíč zásady, nebo použít aktuální relaci Azure AD. Pokud je typ ověřování přihlášení a zadá se název hostitele prostředku, bude vyhledávání prostředků vynecháno, pokud není potřeba. Výchozí nastavení můžete nakonfigurovat pomocí az configure --defaults iothub-data-auth-type={auth-type-value}.

Vlastnost Hodnota
Skupina parametrů: Access Control Arguments
Default value: key
Přípustné hodnoty: key, login
--change-reference

Související referenční ID odkazu na změnu pro tuto operaci prostředku.

Vlastnost Hodnota
Skupina parametrů: Global Policy Arguments
--device-scope

Rozsah zařízení. U hraničních zařízení je to automaticky generované a neměnné. U zařízení typu list nastavte tuto možnost tak, aby se vytvořila podřízená nebo nadřazená relace.

Vlastnost Hodnota
Skupina parametrů: Device Scope Arguments
--edge-enabled --ee

Příznak označující povolení hraničních zařízení

Vlastnost Hodnota
Default value: False
Přípustné hodnoty: false, true
--hub-name -n

IoT Hub název nebo název hostitele. Vyžaduje se, pokud není zadané --login.

Vlastnost Hodnota
Skupina parametrů: IoT Hub Identifier Arguments
--login -l

Tento příkaz podporuje entitu connection string s právy k provedení akce. Použijte k tomu, abyste se vyhnuli přihlášení k relaci prostřednictvím příkazu az login. Pokud je connection string i název entity zadané connection string prioritu. Vyžaduje se, pokud není zadaný název --hub-name.

Vlastnost Hodnota
Skupina parametrů: IoT Hub Identifier Arguments
--od --output-dir

Vygenerujte certifikát podepsaný svým držitelem a použijte jeho kryptografický otisk. Výstup do zadaného cílového adresáře

Vlastnost Hodnota
Skupina parametrů: X.509 Arguments
--pk --primary-key

Primární symetrický sdílený přístupový klíč uložený ve formátu base64.

Vlastnost Hodnota
Skupina parametrů: Symmetric Key Arguments
--primary-thumbprint --ptp

Kryptografický otisk certifikátu podepsaný svým držitelem, který se má použít pro primární kryptografický otisk.

Vlastnost Hodnota
Skupina parametrů: X.509 Arguments
--resource-group -g

Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--secondary-key --sk

Sekundární symetrický sdílený přístupový klíč uložený ve formátu base64.

Vlastnost Hodnota
Skupina parametrů: Symmetric Key Arguments
--secondary-thumbprint --stp

Kryptografický otisk certifikátu podepsaný svým držitelem, který se má použít pro sekundární kryptografický otisk.

Vlastnost Hodnota
Skupina parametrů: X.509 Arguments
--sta --status

Po vytvoření nastavte stav zařízení.

Vlastnost Hodnota
Default value: enabled
Přípustné hodnoty: disabled, enabled
--star --status-reason

Popis stavu zařízení

--valid-days --vd

Vygenerujte certifikát podepsaný svým držitelem a použijte jeho kryptografický otisk. Platné pro zadaný počet dní. Výchozí hodnota: 365.

Vlastnost Hodnota
Skupina parametrů: X.509 Arguments
Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost Hodnota
Default value: False
--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost Hodnota
Default value: False
--output -o

Výstupní formát

Vlastnost Hodnota
Default value: json
Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost Hodnota
Default value: False

az iot hub device-identity delete

Odstraňte IoT Hub zařízení.

az iot hub device-identity delete --device-id
                                  [--acquire-policy-token]
                                  [--auth-type {key, login}]
                                  [--change-reference]
                                  [--etag]
                                  [--hub-name]
                                  [--login]
                                  [--resource-group]

Povinné parametry

--device-id -d

ID cílového zařízení.

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--acquire-policy-token

Získání tokenu Azure Policy automaticky pro tuto operaci prostředku

Vlastnost Hodnota
Skupina parametrů: Global Policy Arguments
--auth-type

Určuje, jestli má operace automaticky odvodit klíč zásady, nebo použít aktuální relaci Azure AD. Pokud je typ ověřování přihlášení a zadá se název hostitele prostředku, bude vyhledávání prostředků vynecháno, pokud není potřeba. Výchozí nastavení můžete nakonfigurovat pomocí az configure --defaults iothub-data-auth-type={auth-type-value}.

Vlastnost Hodnota
Skupina parametrů: Access Control Arguments
Default value: key
Přípustné hodnoty: key, login
--change-reference

Související referenční ID odkazu na změnu pro tuto operaci prostředku.

Vlastnost Hodnota
Skupina parametrů: Global Policy Arguments
--etag -e

Značka Etag nebo značka entity odpovídající poslednímu stavu prostředku. Pokud není k dispozici žádná značka etag, použije se hodnota *.

--hub-name -n

IoT Hub název nebo název hostitele. Vyžaduje se, pokud není zadané --login.

Vlastnost Hodnota
Skupina parametrů: IoT Hub Identifier Arguments
--login -l

Tento příkaz podporuje entitu connection string s právy k provedení akce. Použijte k tomu, abyste se vyhnuli přihlášení k relaci prostřednictvím příkazu az login. Pokud je connection string i název entity zadané connection string prioritu. Vyžaduje se, pokud není zadaný název --hub-name.

Vlastnost Hodnota
Skupina parametrů: IoT Hub Identifier Arguments
--resource-group -g

Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost Hodnota
Default value: False
--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost Hodnota
Default value: False
--output -o

Výstupní formát

Vlastnost Hodnota
Default value: json
Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost Hodnota
Default value: False

az iot hub device-identity export

Exportujte všechny identity zařízení z IoT Hub do kontejneru objektů blob Azure Storage.

Výstupní objekt blob obsahující identity zařízení je textový soubor s názvem "devices.txt".

Požadovaná oprávnění – buď IoT Hub zásady sdíleného přístupu podporující čtení registru a čtení Zápis registru nebo objekt zabezpečení s rolí přispěvatel dat IoT Hub v IoT Hub.

Název účtu úložiště a parametry názvu kontejneru objektů blob je možné použít pouze v případech, kdy je účet úložiště ve stejném předplatném jako vstupní IoT Hub. Pro vstup identifikátoru URI SAS vloženého kontejneru objektů blob si projděte vstupní pravidla vašeho prostředí.

Další informace najdete v tématu https://aka.ms/iothub-device-exportimport.

az iot hub device-identity export [--acquire-policy-token]
                                  [--auth-type {key, login}]
                                  [--bc --blob-container]
                                  [--bcu --blob-container-uri]
                                  [--change-reference]
                                  [--hub-name]
                                  [--identity]
                                  [--ik --include-keys {false, true}]
                                  [--login]
                                  [--resource-group]
                                  [--sa --storage-account]

Příklady

Exportujte všechny identity zařízení do nakonfigurovaného kontejneru objektů blob a zahrňte klíče zařízení. Název kontejneru objektů blob a název účtu úložiště se zadají jako parametry příkazu.

az iot hub device-identity export -n {iothub_name} --ik --bc {blob_container_name} --sa {storage_account_name}

Exportujte všechny identity zařízení do nakonfigurovaného kontejneru objektů blob a zahrňte klíče zařízení. Používá příklad vloženého identifikátoru URI SAS.

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'

Exportujte všechny identity zařízení do nakonfigurovaného kontejneru objektů blob pomocí cesty k souboru, který obsahuje identifikátor URI SAS.

az iot hub device-identity export -n {iothub_name} --bcu {sas_uri_filepath}

Exportujte všechny identity zařízení do nakonfigurovaného kontejneru objektů blob a zahrňte klíče zařízení. Používá identitu přiřazenou systémem, která má pro účet úložiště role Přispěvatel dat objektů blob služby Storage. Název kontejneru objektů blob a název účtu úložiště se zadají jako parametry příkazu.

az iot hub device-identity export -n {iothub_name} --ik --bc {blob_container_name} --sa {storage_account_name} --identity [system]

Exportujte všechny identity zařízení do nakonfigurovaného kontejneru objektů blob a zahrňte klíče zařízení. Používá identitu přiřazenou systémem, která má pro účet úložiště role Přispěvatel dat objektů blob služby Storage. Identifikátor URI kontejneru objektů blob nepotřebuje token SAS objektu blob.

az iot hub device-identity export -n {iothub_name} --ik --bcu 'https://mystorageaccount.blob.core.windows.net/devices' --identity [system]

Exportujte všechny identity zařízení do nakonfigurovaného kontejneru objektů blob a zahrňte klíče zařízení. Používá spravovanou identitu přiřazenou uživatelem, která má pro účet úložiště roli Přispěvatel dat objektů blob služby Storage. Název kontejneru objektů blob a název účtu úložiště se zadají jako parametry příkazu.

az iot hub device-identity export -n {iothub_name} --ik --bc {blob_container_name} --sa {storage_account_name} --identity {managed_identity_resource_id}

Exportujte všechny identity zařízení do nakonfigurovaného kontejneru objektů blob a zahrňte klíče zařízení. Používá spravovanou identitu přiřazenou uživatelem, která má pro účet úložiště roli Přispěvatel dat objektů blob služby Storage. Identifikátor URI kontejneru objektů blob nepotřebuje token SAS objektu blob.

az iot hub device-identity export -n {iothub_name} --ik --bcu 'https://mystorageaccount.blob.core.windows.net/devices' --identity {managed_identity_resource_id}

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--acquire-policy-token

Získání tokenu Azure Policy automaticky pro tuto operaci prostředku

Vlastnost Hodnota
Skupina parametrů: Global Policy Arguments
--auth-type

Určuje, jestli má operace automaticky odvodit klíč zásady, nebo použít aktuální relaci Azure AD. Pokud je typ ověřování přihlášení a zadá se název hostitele prostředku, bude vyhledávání prostředků vynecháno, pokud není potřeba. Výchozí nastavení můžete nakonfigurovat pomocí az configure --defaults iothub-data-auth-type={auth-type-value}.

Vlastnost Hodnota
Skupina parametrů: Access Control Arguments
Default value: key
Přípustné hodnoty: key, login
--bc --blob-container

Tento kontejner objektů blob slouží k výstupu stavu úlohy importu identity zařízení a výsledků. Parametr se při zadání blob_container_uri ignoruje. Pro tento kontejner objektů blob se vyžaduje přístup pro zápis, čtení a odstranění.

--bcu --blob-container-uri

Identifikátor URI sdíleného přístupového podpisu objektu blob se zápisem, čtením a odstraněním přístupu ke kontejneru objektů blob Slouží k výstupu stavu úlohy a výsledků. Poznámka: Při použití ověřování na základě identity se stále vyžaduje identifikátor URI https:// , ale není nutný žádný token SAS. Vstup pro tento argument může být vložený nebo z cesty k souboru.

--change-reference

Související referenční ID odkazu na změnu pro tuto operaci prostředku.

Vlastnost Hodnota
Skupina parametrů: Global Policy Arguments
--hub-name -n

IoT Hub název nebo název hostitele. Vyžaduje se, pokud není zadané --login.

Vlastnost Hodnota
Skupina parametrů: IoT Hub Identifier Arguments
--identity

Typ spravované identity k určení, jestli se používá spravovaná identita přiřazená systémem nebo spravovaná identita přiřazená uživatelem. Pro spravovanou identitu přiřazenou systémem použijte [systém]. Pro spravovanou identitu přiřazenou uživatelem zadejte ID prostředku spravované identity přiřazené uživatelem. Tato identita vyžaduje pro účet úložiště role Přispěvatel dat objektů blob úložiště.

--ik --include-keys

Pokud je tato sada nastavená, klíče se exportují normálně. V opačném případě jsou klíče ve výstupu exportu nastaveny na hodnotu null.

Vlastnost Hodnota
Default value: False
Přípustné hodnoty: false, true
--login -l

Tento příkaz podporuje entitu connection string s právy k provedení akce. Použijte k tomu, abyste se vyhnuli přihlášení k relaci prostřednictvím příkazu az login. Pokud je connection string i název entity zadané connection string prioritu. Vyžaduje se, pokud není zadaný název --hub-name.

Vlastnost Hodnota
Skupina parametrů: IoT Hub Identifier Arguments
--resource-group -g

Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--sa --storage-account

Název účtu Azure Storage obsahujícího výstupní kontejner objektů blob. Parametr se při zadání blob_container_uri ignoruje. Vyžaduje se zápis, čtení a odstranění přístupu.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost Hodnota
Default value: False
--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost Hodnota
Default value: False
--output -o

Výstupní formát

Vlastnost Hodnota
Default value: json
Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost Hodnota
Default value: False

az iot hub device-identity import

Importujte identity zařízení do IoT Hub z objektu blob kontejneru úložiště.

Očekávaný vstupní soubor obsahující identity zařízení by měl mít název "devices.txt". Výstupní soubor protokolu importErrors.log je prázdný, pokud je import úspěšný a obsahuje protokoly chyb v případě selhání importu.

Požadovaná oprávnění – buď IoT Hub zásady sdíleného přístupu podporující čtení registru a čtení Zápis registru nebo objekt zabezpečení s rolí přispěvatel dat IoT Hub v IoT Hub.

Název účtu úložiště a parametry názvu kontejneru objektů blob je možné použít pouze v případech, kdy je účet úložiště ve stejném předplatném jako vstupní IoT Hub. Pro vstup identifikátoru URI SAS vloženého kontejneru objektů blob si projděte vstupní pravidla vašeho prostředí.

Další informace najdete v tématu https://aka.ms/iothub-device-exportimport.

az iot hub device-identity import [--acquire-policy-token]
                                  [--auth-type {key, login}]
                                  [--change-reference]
                                  [--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]

Příklady

Importujte všechny identity zařízení z objektu blob tak, že zadáte parametry příkazů pro vstupní kontejner objektů blob a účet úložiště a také výstupní kontejner objektů blob a účet úložiště.

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}

Importujte všechny identity zařízení z objektu blob pomocí vloženého identifikátoru URI SAS.

az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri} --obcu {output_sas_uri}

Importujte všechny identity zařízení z objektu blob pomocí cesty k souboru, která obsahuje identifikátor URI SAS.

az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri_filepath} --obcu {output_sas_uri_filepath}

Importujte všechny identity zařízení z objektu blob pomocí identity přiřazené systémem, která má pro oba účty úložiště role Přispěvatel dat objektů blob služby Storage. Vstupní kontejner objektů blob a účet úložiště i výstupní kontejner objektů blob a účet úložiště jsou k dispozici jako parametry příkazu.

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]

Importujte všechny identity zařízení z objektu blob pomocí identity přiřazené systémem, která má pro oba účty úložiště role Přispěvatel dat objektů blob služby Storage. Identifikátor URI kontejneru objektů blob nepotřebuje token SAS objektu blob.

az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri} --obcu {output_sas_uri} --identity [system]

Importujte všechny identity zařízení z objektu blob pomocí spravované identity přiřazené uživatelem, která má role Přispěvatel dat objektů blob služby Storage pro oba účty úložiště. Vstupní kontejner objektů blob a účet úložiště i výstupní kontejner objektů blob a účet úložiště jsou k dispozici jako parametry příkazu.

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}

Importujte všechny identity zařízení z objektu blob pomocí spravované identity přiřazené uživatelem, která má role Přispěvatel dat objektů blob služby Storage pro oba účty úložiště. Identifikátor URI kontejneru objektů blob nepotřebuje token SAS objektu blob.

az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri} --obcu {output_sas_uri} --identity {managed_identity_resource_id}

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--acquire-policy-token

Získání tokenu Azure Policy automaticky pro tuto operaci prostředku

Vlastnost Hodnota
Skupina parametrů: Global Policy Arguments
--auth-type

Určuje, jestli má operace automaticky odvodit klíč zásady, nebo použít aktuální relaci Azure AD. Pokud je typ ověřování přihlášení a zadá se název hostitele prostředku, bude vyhledávání prostředků vynecháno, pokud není potřeba. Výchozí nastavení můžete nakonfigurovat pomocí az configure --defaults iothub-data-auth-type={auth-type-value}.

Vlastnost Hodnota
Skupina parametrů: Access Control Arguments
Default value: key
Přípustné hodnoty: key, login
--change-reference

Související referenční ID odkazu na změnu pro tuto operaci prostředku.

Vlastnost Hodnota
Skupina parametrů: Global Policy Arguments
--hub-name -n

IoT Hub název nebo název hostitele. Vyžaduje se, pokud není zadané --login.

Vlastnost Hodnota
Skupina parametrů: IoT Hub Identifier Arguments
--ibc --input-blob-container

Tento kontejner objektů blob ukládá soubor, který definuje operace, které se mají provádět v registru identit. Parametr se při zadání input_blob_container_uri ignoruje. Pro tento kontejner objektů blob se vyžaduje přístup pro čtení.

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

Identifikátor URI sdíleného přístupového podpisu objektu blob s přístupem pro čtení ke kontejneru objektů blob Tento objekt blob obsahuje operace, které se mají provést v registru identit. Poznámka: Při použití ověřování na základě identity se stále vyžaduje identifikátor URI https:// , ale není nutný žádný token SAS. Vstup pro tento argument může být vložený nebo z cesty k souboru.

--identity

Typ spravované identity k určení, jestli se používá spravovaná identita přiřazená systémem nebo spravovaná identita přiřazená uživatelem. Pro spravovanou identitu přiřazenou systémem použijte [systém]. Pro spravovanou identitu přiřazenou uživatelem zadejte ID prostředku spravované identity přiřazené uživatelem. Tato identita vyžaduje roli Přispěvatel dat objektů blob úložiště pro cílovou roli účtu úložiště a přispěvatele pro IoT Hub.

--input-storage-account --isa

Název účtu Azure Storage obsahujícího vstupní kontejner objektů blob. Vyžaduje se pouze v případě, že není zadaný input_blob_container_uri. Vyžaduje se přístup pro čtení.

--login -l

Tento příkaz podporuje entitu connection string s právy k provedení akce. Použijte k tomu, abyste se vyhnuli přihlášení k relaci prostřednictvím příkazu az login. Pokud je connection string i název entity zadané connection string prioritu. Vyžaduje se, pokud není zadaný název --hub-name.

Vlastnost Hodnota
Skupina parametrů: IoT Hub Identifier Arguments
--obc --output-blob-container

Tento kontejner objektů blob slouží k výstupu stavu úlohy importu identity zařízení a výsledků. Vyžaduje se pouze v případě, že není zadaný input_blob_container_uri. Pro tento kontejner objektů blob se vyžaduje přístup k zápisu.

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

Identifikátor URI sdíleného přístupového podpisu objektu blob s přístupem k zápisu do kontejneru objektů blob Slouží k výstupu stavu úlohy a výsledků. Poznámka: Při použití ověřování na základě identity se stále vyžaduje identifikátor URI https:// bez tokenu SAS. Vstup pro tento argument může být vložený nebo z cesty k souboru.

--osa --output-storage-account

Název účtu Azure Storage obsahujícího výstupní kontejner objektů blob. Parametr se při zadání output_blob_container_uri ignoruje. Vyžaduje se přístup k zápisu.

--resource-group -g

Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost Hodnota
Default value: False
--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost Hodnota
Default value: False
--output -o

Výstupní formát

Vlastnost Hodnota
Default value: json
Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost Hodnota
Default value: False

az iot hub device-identity list

Zobrazení seznamu zařízení v IoT Hub

Tento příkaz je alias pro az iot hub device-twin list, který se důrazně doporučuje pro tento příkaz. V budoucnu může být tento az iot hub device-identity list příkaz změněn nebo zastaralý.

az iot hub device-identity list [--auth-type {key, login}]
                                [--edge-enabled --ee {false, true}]
                                [--hub-name]
                                [--login]
                                [--resource-group]
                                [--top]

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--auth-type

Určuje, jestli má operace automaticky odvodit klíč zásady, nebo použít aktuální relaci Azure AD. Pokud je typ ověřování přihlášení a zadá se název hostitele prostředku, bude vyhledávání prostředků vynecháno, pokud není potřeba. Výchozí nastavení můžete nakonfigurovat pomocí az configure --defaults iothub-data-auth-type={auth-type-value}.

Vlastnost Hodnota
Skupina parametrů: Access Control Arguments
Default value: key
Přípustné hodnoty: key, login
--edge-enabled --ee

Příznak označující povolení hraničních zařízení

Vlastnost Hodnota
Default value: False
Přípustné hodnoty: false, true
--hub-name -n

IoT Hub název nebo název hostitele. Vyžaduje se, pokud není zadané --login.

Vlastnost Hodnota
Skupina parametrů: IoT Hub Identifier Arguments
--login -l

Tento příkaz podporuje entitu connection string s právy k provedení akce. Použijte k tomu, abyste se vyhnuli přihlášení k relaci prostřednictvím příkazu az login. Pokud je connection string i název entity zadané connection string prioritu. Vyžaduje se, pokud není zadaný název --hub-name.

Vlastnost Hodnota
Skupina parametrů: IoT Hub Identifier Arguments
--resource-group -g

Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--top

Maximální počet prvků, které se mají vrátit. Použijte -1 pro neomezenou dobu.

Vlastnost Hodnota
Default value: 1000
Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost Hodnota
Default value: False
--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost Hodnota
Default value: False
--output -o

Výstupní formát

Vlastnost Hodnota
Default value: json
Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost Hodnota
Default value: False

az iot hub device-identity renew-key

Obnovte cílové klíče IoT Hub zařízení s ověřováním SAS.

V současné době nejsou značky etag a typ klíče swap podporovány pro hromadnou regeneraci klíčů. Hromadná regenerace klíčů bude zdvojovat jiný výstupní formát od regenerace jednoho klíče zařízení.

az iot hub device-identity renew-key --device-id
                                     --hub-name
                                     --key-type --kt {both, primary, secondary, swap}
                                     [--acquire-policy-token]
                                     [--auth-type {key, login}]
                                     [--change-reference]
                                     [--etag]
                                     [--im --include-modules {false, true}]
                                     [--login]
                                     [--no-progress {false, true}]
                                     [--resource-group]

Příklady

Obnovte primární klíč.

az iot hub device-identity renew-key -d {device_id} -n {iothub_name} --kt primary

Prohození primárních a sekundárních klíčů

az iot hub device-identity renew-key -d {device_id} -n {iothub_name} --kt swap

Obnovte sekundární klíč pro dvě zařízení a jejich moduly.

az iot hub device-identity renew-key -d {device_id} {device_id} -n {iothub_name} --kt secondary --include-modules

Obnovte oba klíče pro všechna zařízení v centru.

az iot hub device-identity renew-key -d * -n {iothub_name} --kt both

Povinné parametry

--device-id -d

Seznam id cílového zařízení s hodnocením místa Použijte * pro všechna zařízení.

--hub-name -n

IoT Hub název nebo název hostitele. Vyžaduje se, pokud není zadané --login.

Vlastnost Hodnota
Skupina parametrů: IoT Hub Identifier Arguments
--key-type --kt

Cílový typ klíče, který se má znovu vygenerovat.

Vlastnost Hodnota
Přípustné hodnoty: both, primary, secondary, swap

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--acquire-policy-token

Získání tokenu Azure Policy automaticky pro tuto operaci prostředku

Vlastnost Hodnota
Skupina parametrů: Global Policy Arguments
--auth-type

Určuje, jestli má operace automaticky odvodit klíč zásady, nebo použít aktuální relaci Azure AD. Pokud je typ ověřování přihlášení a zadá se název hostitele prostředku, bude vyhledávání prostředků vynecháno, pokud není potřeba. Výchozí nastavení můžete nakonfigurovat pomocí az configure --defaults iothub-data-auth-type={auth-type-value}.

Vlastnost Hodnota
Skupina parametrů: Access Control Arguments
Default value: key
Přípustné hodnoty: key, login
--change-reference

Související referenční ID odkazu na změnu pro tuto operaci prostředku.

Vlastnost Hodnota
Skupina parametrů: Global Policy Arguments
--etag -e

Značka Etag nebo značka entity odpovídající poslednímu stavu prostředku. Pokud není k dispozici žádná značka etag, použije se hodnota *. Tento argument platí pouze pro swap.

--im --include-modules

Příznak pro zahrnutí modulů zařízení během regenerace klíčů

Vlastnost Hodnota
Default value: False
Přípustné hodnoty: false, true
--login -l

Tento příkaz podporuje entitu connection string s právy k provedení akce. Použijte k tomu, abyste se vyhnuli přihlášení k relaci prostřednictvím příkazu az login. Pokud je connection string i název entity zadané connection string prioritu. Vyžaduje se, pokud není zadaný název --hub-name.

Vlastnost Hodnota
Skupina parametrů: IoT Hub Identifier Arguments
--no-progress

Skryjte indikátor průběhu pro regeneraci hromadných klíčů.

Vlastnost Hodnota
Default value: False
Přípustné hodnoty: false, true
--resource-group -g

Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost Hodnota
Default value: False
--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost Hodnota
Default value: False
--output -o

Výstupní formát

Vlastnost Hodnota
Default value: json
Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost Hodnota
Default value: False

az iot hub device-identity show

Získejte podrobnosti o IoT Hub zařízení.

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

Povinné parametry

--device-id -d

ID cílového zařízení.

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--auth-type

Určuje, jestli má operace automaticky odvodit klíč zásady, nebo použít aktuální relaci Azure AD. Pokud je typ ověřování přihlášení a zadá se název hostitele prostředku, bude vyhledávání prostředků vynecháno, pokud není potřeba. Výchozí nastavení můžete nakonfigurovat pomocí az configure --defaults iothub-data-auth-type={auth-type-value}.

Vlastnost Hodnota
Skupina parametrů: Access Control Arguments
Default value: key
Přípustné hodnoty: key, login
--hub-name -n

IoT Hub název nebo název hostitele. Vyžaduje se, pokud není zadané --login.

Vlastnost Hodnota
Skupina parametrů: IoT Hub Identifier Arguments
--login -l

Tento příkaz podporuje entitu connection string s právy k provedení akce. Použijte k tomu, abyste se vyhnuli přihlášení k relaci prostřednictvím příkazu az login. Pokud je connection string i název entity zadané connection string prioritu. Vyžaduje se, pokud není zadaný název --hub-name.

Vlastnost Hodnota
Skupina parametrů: IoT Hub Identifier Arguments
--resource-group -g

Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost Hodnota
Default value: False
--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost Hodnota
Default value: False
--output -o

Výstupní formát

Vlastnost Hodnota
Default value: json
Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost Hodnota
Default value: False

az iot hub device-identity update

Aktualizujte IoT Hub zařízení.

K aktualizaci zařízení použijte parametr --set následovaný přiřazením vlastností. Využijte parametry vrácené ze služby Iot Hub device-identity show.

az iot hub device-identity update --device-id
                                  [--acquire-policy-token]
                                  [--add]
                                  [--am --auth-method {shared_private_key, x509_ca, x509_thumbprint}]
                                  [--auth-type {key, login}]
                                  [--change-reference]
                                  [--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]

Příklady

Zapnutí možností edge pro zařízení

az iot hub device-identity update -d {device_id} -n {iothub_name} --set capabilities.iotEdge=true

Zapněte možnosti edge pro zařízení pomocí argumentu pohodlí.

az iot hub device-identity update -d {device_id} -n {iothub_name} --ee

Zakázání stavu zařízení

az iot hub device-identity update -d {device_id} -n {iothub_name} --set status=disabled

Zakažte stav zařízení pomocí argumentu pohodlí.

az iot hub device-identity update -d {device_id} -n {iothub_name} --status disabled

V jednom příkazu

az iot hub device-identity update -d {device_id} -n {iothub_name} --set status=disabled capabilities.iotEdge=true

Povinné parametry

--device-id -d

ID cílového zařízení.

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--acquire-policy-token

Získání tokenu Azure Policy automaticky pro tuto operaci prostředku

Vlastnost Hodnota
Skupina parametrů: Global Policy Arguments
--add

Přidejte objekt do seznamu objektů zadáním párů cest a klíč-hodnota. Příklad: --add property.listProperty <key=value, string or JSON string>.

Vlastnost Hodnota
Skupina parametrů: Generic Update Arguments
Default value: []
--am --auth-method

Metoda autorizace, se kterou se entita vytvoří.

Vlastnost Hodnota
Přípustné hodnoty: shared_private_key, x509_ca, x509_thumbprint
--auth-type

Určuje, jestli má operace automaticky odvodit klíč zásady, nebo použít aktuální relaci Azure AD. Pokud je typ ověřování přihlášení a zadá se název hostitele prostředku, bude vyhledávání prostředků vynecháno, pokud není potřeba. Výchozí nastavení můžete nakonfigurovat pomocí az configure --defaults iothub-data-auth-type={auth-type-value}.

Vlastnost Hodnota
Skupina parametrů: Access Control Arguments
Default value: key
Přípustné hodnoty: key, login
--change-reference

Související referenční ID odkazu na změnu pro tuto operaci prostředku.

Vlastnost Hodnota
Skupina parametrů: Global Policy Arguments
--edge-enabled --ee

Příznak označující povolení hraničních zařízení

Vlastnost Hodnota
Přípustné hodnoty: false, true
--etag -e

Značka Etag nebo značka entity odpovídající poslednímu stavu prostředku. Pokud není k dispozici žádná značka etag, použije se hodnota *.

--force-string

Při použití set nebo add zachovávejte řetězcové literály místo pokusu o převod na JSON.

Vlastnost Hodnota
Skupina parametrů: Generic Update Arguments
Default value: False
--hub-name -n

IoT Hub název nebo název hostitele. Vyžaduje se, pokud není zadané --login.

Vlastnost Hodnota
Skupina parametrů: IoT Hub Identifier Arguments
--login -l

Tento příkaz podporuje entitu connection string s právy k provedení akce. Použijte k tomu, abyste se vyhnuli přihlášení k relaci prostřednictvím příkazu az login. Pokud je connection string i název entity zadané connection string prioritu. Vyžaduje se, pokud není zadaný název --hub-name.

Vlastnost Hodnota
Skupina parametrů: IoT Hub Identifier Arguments
--pk --primary-key

Primární symetrický sdílený přístupový klíč uložený ve formátu base64.

Vlastnost Hodnota
Skupina parametrů: Symmetric Key Arguments
--primary-thumbprint --ptp

Kryptografický otisk certifikátu podepsaný svým držitelem, který se má použít pro primární kryptografický otisk.

Vlastnost Hodnota
Skupina parametrů: X.509 Arguments
--remove

Odeberte vlastnost nebo prvek ze seznamu. Příklad: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Vlastnost Hodnota
Skupina parametrů: Generic Update Arguments
Default value: []
--resource-group -g

Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--secondary-key --sk

Sekundární symetrický sdílený přístupový klíč uložený ve formátu base64.

Vlastnost Hodnota
Skupina parametrů: Symmetric Key Arguments
--secondary-thumbprint --stp

Kryptografický otisk certifikátu podepsaný svým držitelem, který se má použít pro sekundární kryptografický otisk.

Vlastnost Hodnota
Skupina parametrů: X.509 Arguments
--set

Aktualizujte objekt zadáním cesty vlastnosti a hodnoty, která se má nastavit. Příklad: --set property1.property2=<value>.

Vlastnost Hodnota
Skupina parametrů: Generic Update Arguments
Default value: []
--sta --status

Po vytvoření nastavte stav zařízení.

Vlastnost Hodnota
Přípustné hodnoty: disabled, enabled
--star --status-reason

Popis stavu zařízení

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost Hodnota
Default value: False
--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost Hodnota
Default value: False
--output -o

Výstupní formát

Vlastnost Hodnota
Default value: json
Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost Hodnota
Default value: False