az iot hub device-identity

Note

Эта ссылка является частью расширения Azure-iot для Azure CLI (версия 2.67.0 или более поздней). Расширение будет автоматически устанавливаться при первом запуске команды az iot hub device-identity. Подробнее о расширениях.

Управление устройствами Интернета вещей.

Команды

Имя	Описание	Тип	Состояние
az iot hub device-identity children	Управление связями дочерних устройств для устройств IoT edge.	Extension	GA
az iot hub device-identity children add	Добавьте устройства в качестве дочерних устройств в целевое пограничное устройство.	Extension	GA
az iot hub device-identity children list	Выводит коллекцию назначенных дочерних устройств.	Extension	GA
az iot hub device-identity children remove	Удалите дочерние устройства с целевого пограничного устройства.	Extension	GA
az iot hub device-identity connection-string	Управление connection string устройства Интернета вещей.	Extension	GA
az iot hub device-identity connection-string show	Отображение заданного IoT Hub устройства connection string.	Extension	GA
az iot hub device-identity create	Создайте устройство в IoT Hub.	Extension	GA
az iot hub device-identity delete	Удаление устройства IoT Hub.	Extension	GA
az iot hub device-identity export	Экспортируйте все удостоверения устройств из IoT Hub в контейнер больших двоичных объектов Azure Storage.	Extension	GA
az iot hub device-identity import	Импорт удостоверений устройства в IoT Hub из большого двоичного объекта контейнера хранилища.	Extension	GA
az iot hub device-identity list	Вывод списка устройств в IoT Hub.	Extension	GA
az iot hub device-identity parent	Управление отношениями родительского устройства для устройств Интернета вещей.	Extension	GA
az iot hub device-identity parent set	Задайте родительское устройство целевого устройства.	Extension	GA
az iot hub device-identity parent show	Получите родительское устройство целевого устройства.	Extension	GA
az iot hub device-identity renew-key	Продление целевых ключей устройств IoT Hub с проверкой подлинности SAS.	Extension	GA
az iot hub device-identity show	Получение сведений об устройстве IoT Hub.	Extension	GA
az iot hub device-identity update	Обновите устройство IoT Hub.	Extension	GA

az iot hub device-identity create

Создайте устройство в IoT Hub.

При использовании метода проверки подлинности shared_private_key (также называемого симметричными ключами), если пользовательские ключи не предоставляются, служба создаст их для устройства.

Если область устройства предоставляется для пограничного устройства, значение автоматически преобразуется в родительскую область.

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]

Примеры

Создайте IoT-устройство с поддержкой периферийных устройств с авторизацией по умолчанию (закрытый ключ общего пользования).

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

Создайте устройство Интернета вещей с самозаверяющей авторизацией сертификата, создайте сертификат, действительный в течение 10 дней, а затем используйте отпечаток.

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

Создайте устройство Интернета вещей с самозаверяющей авторизацией сертификата, создайте сертификат срока действия по умолчанию (365 дней) и выходные данные в целевой каталог.

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

Создайте устройство Интернета вещей с самозаверяющей авторизацией сертификата и явно предоставьте первичные и вторичные отпечатки.

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

Создайте устройство Интернета вещей с авторизацией корневого ЦС с отключенным состоянием и причиной.

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

Создайте устройство Интернета вещей с областью устройства.

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

Обязательные параметры

--device-id -d

Идентификатор целевого устройства.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Azure Policy для этой операции ресурса.

Свойство	Значение
Группа параметров:	Global Policy Arguments

--am --auth-method

Метод авторизации, с которым необходимо создать сущность.

Свойство	Значение
Default value:	shared_private_key
Допустимые значения:	shared_private_key, x509_ca, x509_thumbprint

--auth-type

Указывает, должна ли операция автоматически наследовать ключ политики или использовать текущий сеанс Azure AD. Если тип проверки подлинности является именем входа, а имя узла ресурса указано, поиск ресурсов будет пропущен, если это не требуется. Можно настроить значение по умолчанию с помощью az configure --defaults iothub-data-auth-type={auth-type-value}.

Свойство	Значение
Группа параметров:	Access Control Arguments
Default value:	key
Допустимые значения:	key, login

--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство	Значение
Группа параметров:	Global Policy Arguments

--device-scope

Область действия устройства. Для пограничных устройств это автоматически создается и неизменяемо. Для конечных устройств задайте для этого значение, чтобы создать дочерние или родительские отношения.

Свойство	Значение
Группа параметров:	Device Scope Arguments

--edge-enabled --ee

Флаг, указывающий включение ребра.

Свойство	Значение
Default value:	False
Допустимые значения:	false, true

--hub-name -n

IoT Hub имя или имя узла. Требуется, если --login не указан.

Свойство	Значение
Группа параметров:	IoT Hub Identifier Arguments

--login -l

Эта команда поддерживает сущность connection string с правами на выполнение действия. Используйте для предотвращения входа сеанса с помощью az login. Если connection string сущности и имя указаны, connection string имеет приоритет. Требуется, если имя --hub-name не указано.

Свойство	Значение
Группа параметров:	IoT Hub Identifier Arguments

--od --output-dir

Создайте самозаверяющий сертификат и используйте его отпечаток. Выходные данные в указанный целевой каталог.

Свойство	Значение
Группа параметров:	X.509 Arguments

--pk --primary-key

Первичный симметричный общий ключ доступа, хранящийся в формате Base64.

Свойство	Значение
Группа параметров:	Symmetric Key Arguments

--primary-thumbprint --ptp

Самозаверяющий отпечаток сертификата, используемый для первичного отпечатка.

Свойство	Значение
Группа параметров:	X.509 Arguments

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--secondary-key --sk

Вторичный симметричный общий ключ доступа, хранящийся в формате Base64.

Свойство	Значение
Группа параметров:	Symmetric Key Arguments

--secondary-thumbprint --stp

Самозаверяющий отпечаток сертификата, используемый для вторичного отпечатка.

Свойство	Значение
Группа параметров:	X.509 Arguments

--sta --status

Задайте состояние устройства при создании.

Свойство	Значение
Default value:	enabled
Допустимые значения:	disabled, enabled

--star --status-reason

Описание состояния устройства.

--valid-days --vd

Создайте самозаверяющий сертификат и используйте его отпечаток. Допустимо для указанного количества дней. Значение по умолчанию: 365.

Свойство	Значение
Группа параметров:	X.509 Arguments

Глобальные параметры

--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство	Значение
Default value:	False

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство	Значение
Default value:	False

--output -o

Формат вывода.

Свойство	Значение
Default value:	json
Допустимые значения:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство	Значение
Default value:	False

az iot hub device-identity delete

Удаление устройства IoT Hub.

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

Обязательные параметры

--device-id -d

Идентификатор целевого устройства.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Azure Policy для этой операции ресурса.

Свойство	Значение
Группа параметров:	Global Policy Arguments

--auth-type

Указывает, должна ли операция автоматически наследовать ключ политики или использовать текущий сеанс Azure AD. Если тип проверки подлинности является именем входа, а имя узла ресурса указано, поиск ресурсов будет пропущен, если это не требуется. Можно настроить значение по умолчанию с помощью az configure --defaults iothub-data-auth-type={auth-type-value}.

Свойство	Значение
Группа параметров:	Access Control Arguments
Default value:	key
Допустимые значения:	key, login

--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство	Значение
Группа параметров:	Global Policy Arguments

--etag -e

Тег Etag или сущности, соответствующий последнему состоянию ресурса. Если etag не указан, используется значение "*".

--hub-name -n

IoT Hub имя или имя узла. Требуется, если --login не указан.

Свойство	Значение
Группа параметров:	IoT Hub Identifier Arguments

--login -l

Эта команда поддерживает сущность connection string с правами на выполнение действия. Используйте для предотвращения входа сеанса с помощью az login. Если connection string сущности и имя указаны, connection string имеет приоритет. Требуется, если имя --hub-name не указано.

Свойство	Значение
Группа параметров:	IoT Hub Identifier Arguments

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Глобальные параметры

--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство	Значение
Default value:	False

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство	Значение
Default value:	False

--output -o

Формат вывода.

Свойство	Значение
Default value:	json
Допустимые значения:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство	Значение
Default value:	False

az iot hub device-identity export

Экспортируйте все удостоверения устройств из IoT Hub в контейнер больших двоичных объектов Azure Storage.

Выходной BLOB-объект, содержащий удостоверения устройства, является текстовым файлом с именем "devices.txt".

Необходимые разрешения: либо IoT Hub политика общего доступа, поддерживающая "Чтение и чтение реестра" Запись реестра или субъект с ролью "участник данных IoT Hub" в IoT Hub.

Параметры имени учетной записи хранения и имени контейнера BLOB-объектов можно использовать только в том случае, если учетная запись хранения находится в той же подписке, что и входные IoT Hub. Чтобы получить встроенные входные данные URI контейнера BLOB-объектов, ознакомьтесь с правилами ввода среды.

Дополнительные сведения см. в разделе 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]

Примеры

Экспортируйте все удостоверения устройства в настроенный контейнер BLOB-объектов и включите ключи устройства. Имя контейнера BLOB-объектов и имя учетной записи хранения предоставляются в качестве параметров для команды.

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

Экспортируйте все удостоверения устройства в настроенный контейнер BLOB-объектов и включите ключи устройства. Использует встроенный пример 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'

Экспортируйте все удостоверения устройства в настроенный контейнер BLOB-объектов с помощью пути к файлу, который содержит универсальный код ресурса (URI SAS).

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

Экспортируйте все удостоверения устройства в настроенный контейнер BLOB-объектов и включите ключи устройства. Использует назначенное системой удостоверение с ролями участника данных BLOB-объектов хранилища для учетной записи хранения. Имя контейнера BLOB-объектов и имя учетной записи хранения предоставляются в качестве параметров для команды.

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

Экспортируйте все удостоверения устройства в настроенный контейнер BLOB-объектов и включите ключи устройства. Использует назначенное системой удостоверение с ролями участника данных BLOB-объектов хранилища для учетной записи хранения. Универсальный код ресурса (URI) контейнера BLOB-объектов не требует маркера SAS большого двоичного объекта.

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

Экспортируйте все удостоверения устройства в настроенный контейнер BLOB-объектов и включите ключи устройства. Использует управляемое удостоверение, назначаемое пользователем, с ролью участника данных BLOB-объектов хранилища для учетной записи хранения. Имя контейнера BLOB-объектов и имя учетной записи хранения предоставляются в качестве параметров для команды.

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

Экспортируйте все удостоверения устройства в настроенный контейнер BLOB-объектов и включите ключи устройства. Использует управляемое удостоверение, назначаемое пользователем, с ролью участника данных BLOB-объектов хранилища для учетной записи хранения. Универсальный код ресурса (URI) контейнера BLOB-объектов не требует маркера SAS большого двоичного объекта.

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

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Azure Policy для этой операции ресурса.

Свойство	Значение
Группа параметров:	Global Policy Arguments

--auth-type

Указывает, должна ли операция автоматически наследовать ключ политики или использовать текущий сеанс Azure AD. Если тип проверки подлинности является именем входа, а имя узла ресурса указано, поиск ресурсов будет пропущен, если это не требуется. Можно настроить значение по умолчанию с помощью az configure --defaults iothub-data-auth-type={auth-type-value}.

Свойство	Значение
Группа параметров:	Access Control Arguments
Default value:	key
Допустимые значения:	key, login

--bc --blob-container

Этот контейнер BLOB-объектов используется для вывода состояния задания импорта удостоверений устройства и результатов. Параметр игнорируется при предоставлении blob_container_uri. Для этого контейнера BLOB-объектов требуется доступ на запись, чтение и удаление.

--bcu --blob-container-uri

URI подписанного URL-адреса url-объекта BLOB-объектов с помощью URI записи, чтения и удаления доступа к контейнеру BLOB-объектов. Используется для вывода состояния задания и результатов. Примечание. При использовании проверки подлинности на основе удостоверений требуется https:// URI, но маркер SAS не требуется. Входные данные для этого аргумента могут быть встроенными или из пути к файлу.

--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство	Значение
Группа параметров:	Global Policy Arguments

--hub-name -n

IoT Hub имя или имя узла. Требуется, если --login не указан.

Свойство	Значение
Группа параметров:	IoT Hub Identifier Arguments

--identity

Тип управляемого удостоверения, чтобы определить, используется ли назначенное системой управляемое удостоверение или назначаемое пользователем управляемое удостоверение. Для управляемого удостоверения, назначаемого системой, используйте [system]. Для управляемого удостоверения, назначаемого пользователем, укажите идентификатор ресурса управляемого удостоверения, назначаемого пользователем. Для этого удостоверения требуются роли участника данных BLOB-объектов хранилища для учетной записи хранения.

--ik --include-keys

Если задано, ключи экспортируются обычно. В противном случае ключи имеют значение NULL в выходных данных экспорта.

Свойство	Значение
Default value:	False
Допустимые значения:	false, true

--login -l

Эта команда поддерживает сущность connection string с правами на выполнение действия. Используйте для предотвращения входа сеанса с помощью az login. Если connection string сущности и имя указаны, connection string имеет приоритет. Требуется, если имя --hub-name не указано.

Свойство	Значение
Группа параметров:	IoT Hub Identifier Arguments

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--sa --storage-account

Имя учетной записи Azure Storage, содержащей выходной контейнер BLOB-объектов. Параметр игнорируется при предоставлении blob_container_uri. Требуется доступ на запись, чтение и удаление.

Глобальные параметры

--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство	Значение
Default value:	False

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство	Значение
Default value:	False

--output -o

Формат вывода.

Свойство	Значение
Default value:	json
Допустимые значения:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство	Значение
Default value:	False

az iot hub device-identity import

Импорт удостоверений устройства в IoT Hub из большого двоичного объекта контейнера хранилища.

Ожидаемый входной файл, содержащий удостоверения устройства, должен называться "devices.txt". Выходной файл журнала "importErrors.log" пуст при успешном импорте и содержит журналы ошибок в случае сбоя импорта.

Необходимые разрешения: либо IoT Hub политика общего доступа, поддерживающая "Чтение и чтение реестра" Запись реестра или субъект с ролью "участник данных IoT Hub" в IoT Hub.

Параметры имени учетной записи хранения и имени контейнера BLOB-объектов можно использовать только в том случае, если учетная запись хранения находится в той же подписке, что и входные IoT Hub. Чтобы получить встроенные входные данные URI контейнера BLOB-объектов, ознакомьтесь с правилами ввода среды.

Дополнительные сведения см. в разделе 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]

Примеры

Импортируйте все удостоверения устройства из большого двоичного объекта, предоставляя параметры команды для входного контейнера BLOB-объектов и учетной записи хранения, а также выходного контейнера BLOB-объектов и учетной записи хранения.

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}

Импортируйте все удостоверения устройства из большого двоичного объекта с помощью встроенного URI SAS.

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

Импортируйте все удостоверения устройства из большого двоичного объекта с помощью пути к файлу, который содержит URI SAS.

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

Импортируйте все удостоверения устройства из большого двоичного объекта с помощью назначенного системой удостоверения, в том виде, в который имеются роли участника данных BLOB-объектов хранилища для обеих учетных записей хранения. Входной контейнер BLOB-объектов и учетная запись хранения, а также выходной контейнер BLOB-объектов и учетная запись хранения предоставляются в качестве параметров для команды.

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]

Импортируйте все удостоверения устройства из большого двоичного объекта с помощью назначенного системой удостоверения, в том виде, в который имеются роли участника данных BLOB-объектов хранилища для обеих учетных записей хранения. Универсальный код ресурса (URI) контейнера BLOB-объектов не требует маркера SAS большого двоичного объекта.

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

Импортируйте все удостоверения устройства из большого двоичного объекта с помощью управляемого удостоверения, назначаемого пользователем, с ролями участника данных BLOB-объектов хранилища для обеих учетных записей хранения. Входной контейнер BLOB-объектов и учетная запись хранения, а также выходной контейнер BLOB-объектов и учетная запись хранения предоставляются в качестве параметров для команды.

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}

Импортируйте все удостоверения устройства из большого двоичного объекта с помощью управляемого удостоверения, назначаемого пользователем, с ролями участника данных BLOB-объектов хранилища для обеих учетных записей хранения. Универсальный код ресурса (URI) контейнера BLOB-объектов не требует маркера SAS большого двоичного объекта.

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

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Azure Policy для этой операции ресурса.

Свойство	Значение
Группа параметров:	Global Policy Arguments

--auth-type

Указывает, должна ли операция автоматически наследовать ключ политики или использовать текущий сеанс Azure AD. Если тип проверки подлинности является именем входа, а имя узла ресурса указано, поиск ресурсов будет пропущен, если это не требуется. Можно настроить значение по умолчанию с помощью az configure --defaults iothub-data-auth-type={auth-type-value}.

Свойство	Значение
Группа параметров:	Access Control Arguments
Default value:	key
Допустимые значения:	key, login

--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство	Значение
Группа параметров:	Global Policy Arguments

--hub-name -n

IoT Hub имя или имя узла. Требуется, если --login не указан.

Свойство	Значение
Группа параметров:	IoT Hub Identifier Arguments

--ibc --input-blob-container

Этот контейнер BLOB-объектов хранит файл, определяющий операции, выполняемые в реестре удостоверений. Параметр игнорируется при предоставлении input_blob_container_uri. Для этого контейнера BLOB-объектов требуется доступ на чтение.

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

URI подписанного URL-адреса url-объекта BLOB-объектов с доступом на чтение к контейнеру BLOB-объектов. Этот большой двоичный объект содержит операции, выполняемые в реестре удостоверений. Примечание. При использовании проверки подлинности на основе удостоверений требуется https:// URI, но маркер SAS не требуется. Входные данные для этого аргумента могут быть встроенными или из пути к файлу.

--identity

Тип управляемого удостоверения, чтобы определить, используется ли назначенное системой управляемое удостоверение или назначаемое пользователем управляемое удостоверение. Для управляемого удостоверения, назначаемого системой, используйте [system]. Для управляемого удостоверения, назначаемого пользователем, укажите идентификатор ресурса управляемого удостоверения, назначаемого пользователем. Для этого удостоверения требуется роль участника данных BLOB-объектов хранилища для целевой учетной записи хранения и участника для IoT Hub.

--input-storage-account --isa

Имя учетной записи Azure Storage, содержащей входной контейнер BLOB-объектов. Требуется только в том случае, если input_blob_container_uri не предоставляется. Требуется доступ на чтение.

--login -l

Эта команда поддерживает сущность connection string с правами на выполнение действия. Используйте для предотвращения входа сеанса с помощью az login. Если connection string сущности и имя указаны, connection string имеет приоритет. Требуется, если имя --hub-name не указано.

Свойство	Значение
Группа параметров:	IoT Hub Identifier Arguments

--obc --output-blob-container

Этот контейнер BLOB-объектов используется для вывода состояния задания импорта удостоверений устройства и результатов. Требуется только в том случае, если input_blob_container_uri не предоставляется. Для этого контейнера BLOB-объектов требуется доступ на запись.

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

Универсальный код ресурса (URI) подписанного URL-объекта BLOB-объектов с доступом на запись к контейнеру BLOB-объектов. Используется для вывода состояния задания и результатов. Примечание. При использовании проверки подлинности на основе удостоверений URI https:// без маркера SAS по-прежнему требуется. Входные данные для этого аргумента могут быть встроенными или из пути к файлу.

--osa --output-storage-account

Имя учетной записи Azure Storage, содержащей выходной контейнер BLOB-объектов. Параметр игнорируется при предоставлении output_blob_container_uri. Требуется доступ на запись.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Глобальные параметры

--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство	Значение
Default value:	False

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство	Значение
Default value:	False

--output -o

Формат вывода.

Свойство	Значение
Default value:	json
Допустимые значения:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство	Значение
Default value:	False

az iot hub device-identity list

Вывод списка устройств в IoT Hub.

Эта команда является псевдонимом для az iot hub device-twin listэтой команды. В будущем эта az iot hub device-identity list команда может быть изменена или устарела.

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

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--auth-type

Указывает, должна ли операция автоматически наследовать ключ политики или использовать текущий сеанс Azure AD. Если тип проверки подлинности является именем входа, а имя узла ресурса указано, поиск ресурсов будет пропущен, если это не требуется. Можно настроить значение по умолчанию с помощью az configure --defaults iothub-data-auth-type={auth-type-value}.

Свойство	Значение
Группа параметров:	Access Control Arguments
Default value:	key
Допустимые значения:	key, login

--edge-enabled --ee

Флаг, указывающий включение ребра.

Свойство	Значение
Default value:	False
Допустимые значения:	false, true

--hub-name -n

IoT Hub имя или имя узла. Требуется, если --login не указан.

Свойство	Значение
Группа параметров:	IoT Hub Identifier Arguments

--login -l

Эта команда поддерживает сущность connection string с правами на выполнение действия. Используйте для предотвращения входа сеанса с помощью az login. Если connection string сущности и имя указаны, connection string имеет приоритет. Требуется, если имя --hub-name не указано.

Свойство	Значение
Группа параметров:	IoT Hub Identifier Arguments

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--top

Максимальное количество возвращаемых элементов. Используйте -1 для неограниченного количества.

Свойство	Значение
Default value:	1000

Глобальные параметры

--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство	Значение
Default value:	False

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство	Значение
Default value:	False

--output -o

Формат вывода.

Свойство	Значение
Default value:	json
Допустимые значения:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство	Значение
Default value:	False

az iot hub device-identity renew-key

Продление целевых ключей устройств IoT Hub с проверкой подлинности SAS.

В настоящее время etag и тип swap ключа не поддерживаются для повторного создания ключей массового доступа. Повторное создание массовых ключей будет отличаться от формата выходных данных одного устройства.

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]

Примеры

Обновите первичный ключ.

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

Переключите первичные и вторичные ключи.

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

Обновите вторичный ключ для двух устройств и их модулей.

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

Обновите оба ключа для всех устройств в концентраторе.

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

Обязательные параметры

--device-id -d

Список идентификаторов целевого устройства с разделителями пространства. Используйте * для всех устройств.

--hub-name -n

IoT Hub имя или имя узла. Требуется, если --login не указан.

Свойство	Значение
Группа параметров:	IoT Hub Identifier Arguments

--key-type --kt

Целевой тип ключа для повторного создания.

Свойство	Значение
Допустимые значения:	both, primary, secondary, swap

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Azure Policy для этой операции ресурса.

Свойство	Значение
Группа параметров:	Global Policy Arguments

--auth-type

Указывает, должна ли операция автоматически наследовать ключ политики или использовать текущий сеанс Azure AD. Если тип проверки подлинности является именем входа, а имя узла ресурса указано, поиск ресурсов будет пропущен, если это не требуется. Можно настроить значение по умолчанию с помощью az configure --defaults iothub-data-auth-type={auth-type-value}.

Свойство	Значение
Группа параметров:	Access Control Arguments
Default value:	key
Допустимые значения:	key, login

--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство	Значение
Группа параметров:	Global Policy Arguments

--etag -e

Тег Etag или сущности, соответствующий последнему состоянию ресурса. Если etag не указан, используется значение "*". Этот аргумент применяется только к swap.

--im --include-modules

Пометка для включения модулей устройств во время повторного создания ключей.

Свойство	Значение
Default value:	False
Допустимые значения:	false, true

--login -l

Эта команда поддерживает сущность connection string с правами на выполнение действия. Используйте для предотвращения входа сеанса с помощью az login. Если connection string сущности и имя указаны, connection string имеет приоритет. Требуется, если имя --hub-name не указано.

Свойство	Значение
Группа параметров:	IoT Hub Identifier Arguments

--no-progress

Скрытие индикатора выполнения для восстановления массового ключа.

Свойство	Значение
Default value:	False
Допустимые значения:	false, true

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Глобальные параметры

--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство	Значение
Default value:	False

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство	Значение
Default value:	False

--output -o

Формат вывода.

Свойство	Значение
Default value:	json
Допустимые значения:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство	Значение
Default value:	False

az iot hub device-identity show

Получение сведений об устройстве IoT Hub.

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

Обязательные параметры

--device-id -d

Идентификатор целевого устройства.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--auth-type

Указывает, должна ли операция автоматически наследовать ключ политики или использовать текущий сеанс Azure AD. Если тип проверки подлинности является именем входа, а имя узла ресурса указано, поиск ресурсов будет пропущен, если это не требуется. Можно настроить значение по умолчанию с помощью az configure --defaults iothub-data-auth-type={auth-type-value}.

Свойство	Значение
Группа параметров:	Access Control Arguments
Default value:	key
Допустимые значения:	key, login

--hub-name -n

IoT Hub имя или имя узла. Требуется, если --login не указан.

Свойство	Значение
Группа параметров:	IoT Hub Identifier Arguments

--login -l

Эта команда поддерживает сущность connection string с правами на выполнение действия. Используйте для предотвращения входа сеанса с помощью az login. Если connection string сущности и имя указаны, connection string имеет приоритет. Требуется, если имя --hub-name не указано.

Свойство	Значение
Группа параметров:	IoT Hub Identifier Arguments

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Глобальные параметры

--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство	Значение
Default value:	False

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство	Значение
Default value:	False

--output -o

Формат вывода.

Свойство	Значение
Default value:	json
Допустимые значения:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство	Значение
Default value:	False

az iot hub device-identity update

Обновите устройство IoT Hub.

Используйте --set, за которым следует назначения свойств для обновления устройства. Использование параметров, возвращаемых из "шоу удостоверений устройства центра iot".

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]

Примеры

Включение возможностей пограничных вычислений для устройства

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

Включите возможности пограничных вычислений для устройства с помощью удобного аргумента.

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

Отключение состояния устройства

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

Отключите состояние устройства с помощью удобного аргумента.

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

Одна команда

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

Обязательные параметры

--device-id -d

Идентификатор целевого устройства.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Azure Policy для этой операции ресурса.

Свойство	Значение
Группа параметров:	Global Policy Arguments

--add

Добавьте объект в список объектов, указав пары пути и значения ключа. Пример: --add property.listProperty <key=value, string or JSON string>.

Свойство	Значение
Группа параметров:	Generic Update Arguments
Default value:	[]

--am --auth-method

Метод авторизации, с которым необходимо создать сущность.

Свойство	Значение
Допустимые значения:	shared_private_key, x509_ca, x509_thumbprint

--auth-type

Указывает, должна ли операция автоматически наследовать ключ политики или использовать текущий сеанс Azure AD. Если тип проверки подлинности является именем входа, а имя узла ресурса указано, поиск ресурсов будет пропущен, если это не требуется. Можно настроить значение по умолчанию с помощью az configure --defaults iothub-data-auth-type={auth-type-value}.

Свойство	Значение
Группа параметров:	Access Control Arguments
Default value:	key
Допустимые значения:	key, login

--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство	Значение
Группа параметров:	Global Policy Arguments

--edge-enabled --ee

Флаг, указывающий включение ребра.

Свойство	Значение
Допустимые значения:	false, true

--etag -e

Тег Etag или сущности, соответствующий последнему состоянию ресурса. Если etag не указан, используется значение "*".

--force-string

При использовании "set" или "add" сохраняйте строковые литералы вместо попытки преобразовать в JSON.

Свойство	Значение
Группа параметров:	Generic Update Arguments
Default value:	False

--hub-name -n

IoT Hub имя или имя узла. Требуется, если --login не указан.

Свойство	Значение
Группа параметров:	IoT Hub Identifier Arguments

--login -l

Эта команда поддерживает сущность connection string с правами на выполнение действия. Используйте для предотвращения входа сеанса с помощью az login. Если connection string сущности и имя указаны, connection string имеет приоритет. Требуется, если имя --hub-name не указано.

Свойство	Значение
Группа параметров:	IoT Hub Identifier Arguments

--pk --primary-key

Первичный симметричный общий ключ доступа, хранящийся в формате Base64.

Свойство	Значение
Группа параметров:	Symmetric Key Arguments

--primary-thumbprint --ptp

Самозаверяющий отпечаток сертификата, используемый для первичного отпечатка.

Свойство	Значение
Группа параметров:	X.509 Arguments

--remove

Удалите свойство или элемент из списка. Пример: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Свойство	Значение
Группа параметров:	Generic Update Arguments
Default value:	[]

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--secondary-key --sk

Вторичный симметричный общий ключ доступа, хранящийся в формате Base64.

Свойство	Значение
Группа параметров:	Symmetric Key Arguments

--secondary-thumbprint --stp

Самозаверяющий отпечаток сертификата, используемый для вторичного отпечатка.

Свойство	Значение
Группа параметров:	X.509 Arguments

--set

Обновите объект, указав путь к свойству и значение для задания. Пример: --set property1.property2=<value>.

Свойство	Значение
Группа параметров:	Generic Update Arguments
Default value:	[]

--sta --status

Задайте состояние устройства при создании.

Свойство	Значение
Допустимые значения:	disabled, enabled

--star --status-reason

Описание состояния устройства.

Глобальные параметры

--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство	Значение
Default value:	False

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство	Значение
Default value:	False

--output -o

Формат вывода.

Свойство	Значение
Default value:	json
Допустимые значения:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство	Значение
Default value:	False