az iot hub module-identity

Примечание

Эта ссылка является частью расширения Azure-IOT для Azure CLI и требует версии 2.17.1 или более поздней. Расширение будет автоматически установлено при первом запуске команды AZ IOT центр — удостоверение . Подробнее о расширениях.

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

Команды

az iot hub module-identity connection-string

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

az iot hub module-identity connection-string show

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

az iot hub module-identity create

Создание модуля на целевом устройстве IoT в центре Интернета вещей.

az iot hub module-identity delete

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

az iot hub module-identity list

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

az iot hub module-identity renew-key

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

az iot hub module-identity show

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

az iot hub module-identity update

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

az iot hub module-identity create

Создание модуля на целевом устройстве IoT в центре Интернета вещей.

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]
                                  [--primary-thumbprint]
                                  [--resource-group]
                                  [--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 -l

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

--od --output-dir

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

--primary-thumbprint --ptp

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

--resource-group -g

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

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

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

--resource-group -g

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

az iot hub module-identity list

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

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

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

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

Имя центра Интернета вещей.

--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. Если заданы строка подключения и имя сущности, то строка соединения имеет приоритет.

--resource-group -g

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

az iot hub module-identity show

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

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

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

--resource-group -g

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

az iot hub module-identity update

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

Используйте параметр--SET, а затем назначений свойств для обновления модуля. Используйте свойства, возвращенные из "модуль центра Интернета вещей — отображение удостоверений".

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

Добавьте объект в список объектов, указав путь и пары "ключ-значение". Пример:--добавить свойство. Листпроперти <ключ = значение, строка или строка JSON>.

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

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

--remove

Удаление свойства или элемента из списка. Пример:--Remove Property. List или--Remove пропертиторемове.

--resource-group -g

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

--set

Обновите объект, указав путь к свойству и значение, которое необходимо задать. Пример:--Set свойство1. свойство2 =.