Поделиться через

az iot hub module-identity

  • Ссылка

Примечание.

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

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

Команды

Имя Описание Тип Состояние
az iot hub module-identity connection-string

Управление строка подключения модуля устройства Интернета вещей.

 Расширение ГА
az iot hub module-identity connection-string show

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

 Расширение ГА
az iot hub module-identity create

Создайте модуль на целевом устройстве Интернета вещей в Центре Интернета вещей.

 Расширение ГА
az iot hub module-identity delete

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

 Расширение ГА
az iot hub module-identity list

Вывод списка модулей, расположенных на устройстве Интернета вещей в Центр Интернета вещей.

 Расширение ГА
az iot hub module-identity renew-key

Продление целевых ключей модулей устройств Центр Интернета вещей с проверкой подлинности SAS.

 Расширение ГА
az iot hub module-identity show

Получение сведений о модуле устройства Интернета вещей в Центре Интернета вещей.

 Расширение ГА
az iot hub module-identity update

Обновите модуль устройства Центр Интернета вещей.

 Расширение ГА

az iot hub module-identity create

Создайте модуль на целевом устройстве Интернета вещей в Центре Интернета вещей.

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

az iot hub module-identity create --device-id
                                  --module-id
                                  [--am {shared_private_key, x509_ca, x509_thumbprint}]
                                  [--auth-type {key, login}]
                                  [--hub-name]
                                  [--login]
                                  [--od]
                                  [--pk]
                                  [--primary-thumbprint]
                                  [--resource-group]
                                  [--secondary-key]
                                  [--secondary-thumbprint]
                                  [--valid-days]

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

--device-id -d

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

--module-id -m

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

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

--am --auth-method

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

Допустимые значения: shared_private_key, x509_ca, x509_thumbprint
Default value: shared_private_key
--auth-type

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

Допустимые значения: key, login
Default value: key
--hub-name -n

Имя центра Интернета вещей или имя узла. Требуется, если --login не указан.

--login -l

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

--od --output-dir

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

--pk --primary-key

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

--primary-thumbprint --ptp

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

--resource-group -g

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

--secondary-key --sk

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

--secondary-thumbprint --stp

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

--valid-days --vd

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

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

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

--help -h

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

--only-show-errors

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

--output -o

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

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

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

--subscription

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

--verbose

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

az iot hub module-identity delete

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

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

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

--device-id -d

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

--module-id -m

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

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

--auth-type

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

Допустимые значения: key, login
Default value: key
--etag -e

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

--hub-name -n

Имя центра Интернета вещей или имя узла. Требуется, если --login не указан.

--login -l

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

--resource-group -g

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

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

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

--help -h

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

--only-show-errors

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

--output -o

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

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

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

--subscription

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

--verbose

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

az iot hub module-identity list

Вывод списка модулей, расположенных на устройстве Интернета вещей в Центр Интернета вещей.

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

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

--device-id -d

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

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

--auth-type

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

Допустимые значения: key, login
Default value: key
--hub-name -n

Имя центра Интернета вещей или имя узла. Требуется, если --login не указан.

--login -l

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

--resource-group -g

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

--top

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

Default value: 1000
Глобальные параметры
--debug

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

--help -h

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

--only-show-errors

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

--output -o

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

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

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

--subscription

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

--verbose

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

az iot hub module-identity renew-key

Продление целевых ключей модулей устройств Центр Интернета вещей с проверкой подлинности SAS.

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

az iot hub module-identity renew-key --device-id
                                     --hub-name
                                     --key-type {both, primary, secondary, swap}
                                     --module-id
                                     [--auth-type {key, login}]
                                     [--etag]
                                     [--login]
                                     [--no-progress {false, true}]
                                     [--resource-group]

Примеры

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

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

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

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

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

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

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

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

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

--device-id -d

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

--hub-name -n

Имя центра Интернета вещей или имя узла. Требуется, если --login не указан.

--key-type --kt

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

Допустимые значения: both, primary, secondary, swap
--module-id -m

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

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

--auth-type

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

Допустимые значения: key, login
Default value: key
--etag -e

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

--login -l

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

--no-progress

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

Допустимые значения: false, true
--resource-group -g

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

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

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

--help -h

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

--only-show-errors

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

--output -o

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

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

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

--subscription

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

--verbose

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

az iot hub module-identity show

Получение сведений о модуле устройства Интернета вещей в Центре Интернета вещей.

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

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

--device-id -d

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

--module-id -m

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

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

--auth-type

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

Допустимые значения: key, login
Default value: key
--hub-name -n

Имя центра Интернета вещей или имя узла. Требуется, если --login не указан.

--login -l

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

--resource-group -g

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

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

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

--help -h

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

--only-show-errors

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

--output -o

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

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

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

--subscription

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

--verbose

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

az iot hub module-identity update

Обновите модуль устройства Центр Интернета вещей.

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

az iot hub module-identity update --device-id
                                  --module-id
                                  [--add]
                                  [--auth-type {key, login}]
                                  [--etag]
                                  [--force-string]
                                  [--hub-name]
                                  [--login]
                                  [--remove]
                                  [--resource-group]
                                  [--set]

Примеры

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

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

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

--device-id -d

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

--module-id -m

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

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

--add

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

Default value: []
--auth-type

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

Допустимые значения: key, login
Default value: key
--etag -e

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

--force-string

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

Default value: False
--hub-name -n

Имя центра Интернета вещей или имя узла. Требуется, если --login не указан.

--login -l

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

--remove

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

Default value: []
--resource-group -g

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

--set

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

Default value: []
Глобальные параметры
--debug

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

--help -h

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

--only-show-errors

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

--output -o

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

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

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

--subscription

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

--verbose

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