az iot hub module-identity

Примечание

Эта ссылка является частью расширения azure-iot для Azure CLI (версия 2.30.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
значение по умолчанию: shared_private_key
--auth-type

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

допустимые значения: key, login
значение по умолчанию: 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.

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
значение по умолчанию: key
--etag -e

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

--hub-name -n

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

--login -l

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

--resource-group -g

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

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
значение по умолчанию: key
--hub-name -n

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

--login -l

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

--resource-group -g

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

--top

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

значение по умолчанию: 1000

az iot hub module-identity renew-key

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

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

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

--device-id -d

Целевое устройство.

--hub-name -n

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

--key-type --kt

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

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

Целевой модуль.

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

--auth-type

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

допустимые значения: key, login
значение по умолчанию: key
--etag -e

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

--login -l

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

--resource-group -g

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

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
значение по умолчанию: key
--hub-name -n

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

--login -l

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

--resource-group -g

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

az iot hub module-identity update

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

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

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 или json string>.

--auth-type

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

допустимые значения: key, login
значение по умолчанию: key
--etag -e

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

--force-string

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

--hub-name -n

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

--login -l

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

--remove

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

--resource-group -g

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

--set

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