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

IoTHubRegistryManager Класс

  • Ссылка

Класс для предоставления удобных API-интерфейсов для операций диспетчера реестра IoTHub на основе автоматически созданных интерфейсов REST API IotHub.

Инициализатор для клиента службы Диспетчера реестра.

Пользователи не должны вызывать этот объект напрямую. Вместо этого следует использовать фабричные методы from_connection_string() или from_token_credential().

После успешного создания класс прошел проверку подлинности с помощью Центра Интернета вещей и готов вызывать API-интерфейсы-члены для взаимодействия с IoTHub.

Наследование
builtins.object
IoTHubRegistryManager

Конструктор

IoTHubRegistryManager(connection_string=None, host=None, token_credential=None)

Параметры

Имя Описание
connection_string
str

Строка подключения IoTHub, используемая для проверки подлинности подключения к IoTHub, если мы используем connection_str проверку подлинности. Значение по умолчанию: нет

значение по умолчанию: None
host
str

URL-адрес службы Azure, если используется проверка подлинности с использованием учетных данных маркера. Значение по умолчанию: нет

значение по умолчанию: None
auth
Обязательно
str

Объект проверки подлинности Azure, если мы используем проверку подлинности с использованием учетных данных маркера. Значение по умолчанию: нет
token_credential
значение по умолчанию: None

Методы

bulk_create_or_update_devices

Создание, обновление или удаление удостоверений нескольких устройств из реестра удостоверений IoTHub.

Создание, обновление или удаление удостоверений нескольких устройств из реестра удостоверений IoTHub. Удостоверение устройства можно указать только один раз в списке. Разрешены различные операции (создание, обновление, удаление) на разных устройствах. Для каждого вызова можно указать не более 100 устройств. Для крупномасштабных операций рекомендуется использовать функцию импорта с использованием хранилища BLOB-объектов(https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities).
create_device_with_certificate_authority

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

Создает удостоверение устройства на Сайте Интернета вещей с помощью проверки подлинности SAS.
create_device_with_x509

Создает удостоверение устройства на Сайте Интернета вещей с помощью проверки подлинности X509.
create_module_with_certificate_authority

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

Создает удостоверение модуля для устройства на Сайте Интернета вещей с помощью проверки подлинности SAS.
create_module_with_x509

Создает удостоверение модуля для устройства на Сайте Интернета вещей с помощью проверки подлинности X509.
delete_device

Удаляет удостоверение устройства из IoTHub.
delete_module

Удаляет удостоверение модуля для устройства из IoTHub.
from_connection_string

Инициализатор classmethod для клиента службы Диспетчера реестра. Создает класс Registry Manager из строки подключения.

После успешного создания класс прошел проверку подлинности в IoTHub и готов вызывать API-интерфейсы-члены для взаимодействия с IoTHub.
from_token_credential

Инициализатор classmethod для клиента службы Диспетчера реестра. Создает класс Registry Manager на основе URL-адреса имени узла и учетных данных маркера Azure.

После успешного создания класс прошел проверку подлинности в IoTHub и готов вызывать API-интерфейсы-члены для взаимодействия с IoTHub.
get_device

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

Извлекает статистику реестра устройств IoTHub.
get_devices

Получение удостоверений нескольких устройств из реестра удостоверений IoTHub. Не рекомендуется. Используйте язык запросов IoTHub для получения сведений о двойниках устройств и удостоверениях устройства. Дополнительные сведения см. в разделах https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub и https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language.
get_module

Извлекает удостоверение модуля для устройства из IoTHub.
get_module_twin

Возвращает двойник модуля.
get_modules

Извлекает все удостоверения модулей на устройстве.
get_service_statistics

Извлекает статистику службы IoTHub.
get_twin

Возвращает двойник устройства.
invoke_device_method

Вызов прямого метода на устройстве.
invoke_device_module_method

Вызов прямого метода на устройстве.
query_iot_hub

Запрос к Центру Интернета вещей для получения сведений о двойниках устройств с помощью языка, похожего на SQL. Подробнее см. в разделе https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language. Поддерживается разбиение результатов на страницы. При этом возвращаются сведения только о двойниках устройств.
replace_module_twin

Заменяет теги и требуемые свойства двойника модуля.
replace_twin

Заменяет теги и требуемые свойства двойника устройства.
send_c2d_message

Отправка сообщения C2D на устройство IoTHub.
update_device_with_certificate_authority

Обновления удостоверение устройства на Сайте Интернета вещей с помощью центра сертификации.
update_device_with_sas

Обновления удостоверение устройства в Центре Интернета вещей с помощью проверки подлинности SAS.
update_device_with_x509

Обновления удостоверение устройства в Центре Интернета вещей с помощью проверки подлинности X509.
update_module_twin

Обновления теги и требуемые свойства двойника модуля.
update_module_with_certificate_authority

Обновления удостоверение модуля для устройства в IoTHub с помощью центра сертификации.
update_module_with_sas

Обновления удостоверение модуля для устройства в Центре Интернета вещей с помощью проверки подлинности SAS.
update_module_with_x509

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

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

bulk_create_or_update_devices

Создание, обновление или удаление удостоверений нескольких устройств из реестра удостоверений IoTHub.

Создание, обновление или удаление удостоверений нескольких устройств из реестра удостоверений IoTHub. Удостоверение устройства можно указать только один раз в списке. Разрешены различные операции (создание, обновление, удаление) на разных устройствах. Для каждого вызова можно указать не более 100 устройств. Для крупномасштабных операций рекомендуется использовать функцию импорта с использованием хранилища BLOB-объектов(https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities).

bulk_create_or_update_devices(devices)

Параметры

Имя Описание
devices
Обязательно
list[ExportImportDevice]

Список объектов устройств для работы.

Возвращаемое значение

Тип Описание

Объект BulkRegistryOperationResult.

Исключения

Тип Описание
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

create_device_with_certificate_authority

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

create_device_with_certificate_authority(device_id, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)

Параметры

Имя Описание
device_id
Обязательно
str

Имя (идентификатор) устройства.
status
Обязательно
str

Начальное состояние созданного устройства. (Возможные значения: "enabled" или "disabled").
iot_edge
bool

Указывает, является ли созданное устройство IoT Edge устройством. Значение по умолчанию: False

значение по умолчанию: False
status_reason
str

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

значение по умолчанию: None
device_scope
str

Область действия устройства. Значение по умолчанию: none Auto generated and immutable for edge devices and modifiable in leaf devices to create child/parent relationship. Для конечных устройств значение для задания родительского пограничного устройства можно получить из свойства device_scope родительского пограничного устройства.

значение по умолчанию: None
parent_scopes
Union[list[str], str]

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

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

Возвращаемое значение

Тип Описание

Объект device, содержащий созданное устройство.

Исключения

Тип Описание
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

create_device_with_sas

Создает удостоверение устройства на Сайте Интернета вещей с помощью проверки подлинности SAS.

create_device_with_sas(device_id, primary_key, secondary_key, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)

Параметры

Имя Описание
device_id
Обязательно
str

Имя (идентификатор) устройства.
primary_key
Обязательно
str

Первичный ключ проверки подлинности.
secondary_key
Обязательно
str

Вторичный ключ проверки подлинности.
status
Обязательно
str

Начальное состояние созданного устройства. (Возможные значения: "enabled" или "disabled")
iot_edge
bool

Указывает, является ли созданное устройство IoT Edge устройством. Значение по умолчанию: False

значение по умолчанию: False
status_reason
str

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

значение по умолчанию: None
device_scope
str

Область действия устройства. Значение по умолчанию: none Auto generated and immutable for edge devices and modifiable in leaf devices to create child/parent relationship. Для конечных устройств значение для задания родительского пограничного устройства можно получить из свойства device_scope родительского пограничного устройства.

значение по умолчанию: None
parent_scopes
Union[list[str], str]

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

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

Возвращаемое значение

Тип Описание

Объект device, содержащий созданное устройство.

Исключения

Тип Описание
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

create_device_with_x509

Создает удостоверение устройства на Сайте Интернета вещей с помощью проверки подлинности X509.

create_device_with_x509(device_id, primary_thumbprint, secondary_thumbprint, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)

Параметры

Имя Описание
device_id
Обязательно
str

Имя (идентификатор) устройства.
primary_thumbprint
Обязательно
str

Основной отпечаток X509.
secondary_thumbprint
Обязательно
str

Дополнительный отпечаток X509.
status
Обязательно
str

Начальное состояние созданного устройства. (Возможные значения: "enabled" или "disabled")
iot_edge
bool

Указывает, является ли созданное устройство IoT Edge устройством. Значение по умолчанию: False

значение по умолчанию: False
status_reason
str

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

значение по умолчанию: None
device_scope
str

Область действия устройства. Значение по умолчанию: none Auto generated and immutable for edge devices and modifiable in leaf devices to create child/parent relationship. Для конечных устройств значение для задания родительского пограничного устройства можно получить из свойства device_scope родительского пограничного устройства.

значение по умолчанию: None
parent_scopes
Union[list[str], str]

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

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

Возвращаемое значение

Тип Описание

Объект device, содержащий созданное устройство.

Исключения

Тип Описание
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

create_module_with_certificate_authority

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

create_module_with_certificate_authority(device_id, module_id, managed_by)

Параметры

Имя Описание
device_id
Обязательно
str

Имя (идентификатор) устройства.
module_id
Обязательно
str

Имя (id) модуля.
managed_by
Обязательно
str

Имя устройства диспетчера (edge).

Возвращаемое значение

Тип Описание

Объект Module, содержащий созданный модуль.

Исключения

Тип Описание
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

create_module_with_sas

Создает удостоверение модуля для устройства на Сайте Интернета вещей с помощью проверки подлинности SAS.

create_module_with_sas(device_id, module_id, managed_by, primary_key, secondary_key)

Параметры

Имя Описание
device_id
Обязательно
str

Имя (идентификатор) устройства.
module_id
Обязательно
str

Имя (id) модуля.
managed_by
Обязательно
str

Имя устройства диспетчера (edge).
primary_key
Обязательно
str

Первичный ключ проверки подлинности.
secondary_key
Обязательно
str

Вторичный ключ проверки подлинности.

Возвращаемое значение

Тип Описание

Объект Module, содержащий созданный модуль.

Исключения

Тип Описание
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

create_module_with_x509

Создает удостоверение модуля для устройства на Сайте Интернета вещей с помощью проверки подлинности X509.

create_module_with_x509(device_id, module_id, managed_by, primary_thumbprint, secondary_thumbprint)

Параметры

Имя Описание
device_id
Обязательно
str

Имя (идентификатор) устройства.
module_id
Обязательно
str

Имя (id) модуля.
managed_by
Обязательно
str

Имя устройства диспетчера (edge).
primary_thumbprint
Обязательно
str

Основной отпечаток X509.
secondary_thumbprint
Обязательно
str

Дополнительный отпечаток X509.

Возвращаемое значение

Тип Описание

Объект Module, содержащий созданный модуль.

Исключения

Тип Описание
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

delete_device

Удаляет удостоверение устройства из IoTHub.

delete_device(device_id, etag=None)

Параметры

Имя Описание
device_id
Обязательно
str

Имя (идентификатор) устройства.
etag
str

Значение etag (if_match), используемое для операции удаления.

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

Возвращаемое значение

Тип Описание

Нет.

Исключения

Тип Описание
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

delete_module

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

delete_module(device_id, module_id, etag=None)

Параметры

Имя Описание
device_id
Обязательно
str

Имя (идентификатор) устройства.
module_id
Обязательно
str

Имя (id) модуля.
etag
str

Значение etag (if_match), используемое для операции удаления.

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

Возвращаемое значение

Тип Описание

Нет.

Исключения

Тип Описание
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

from_connection_string

Инициализатор classmethod для клиента службы Диспетчера реестра. Создает класс Registry Manager из строки подключения.

После успешного создания класс прошел проверку подлинности в IoTHub и готов вызывать API-интерфейсы-члены для взаимодействия с IoTHub.

from_connection_string(connection_string)

Параметры

Имя Описание
connection_string
Обязательно
str

Строка подключения IoTHub, используемая для проверки подлинности подключения к IoTHub.

Возвращаемое значение

Тип Описание
IoTHubRegistryManager

Исключения

Тип Описание
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

from_token_credential

Инициализатор classmethod для клиента службы Диспетчера реестра. Создает класс Registry Manager на основе URL-адреса имени узла и учетных данных маркера Azure.

После успешного создания класс прошел проверку подлинности в IoTHub и готов вызывать API-интерфейсы-члены для взаимодействия с IoTHub.

from_token_credential(url, token_credential)

Параметры

Имя Описание
url
Обязательно
str

URL-адрес службы Azure (имя узла).
token_credential
Обязательно
<xref:azure.core.TokenCredential>

Объект учетных данных маркера Azure

Возвращаемое значение

Тип Описание
IoTHubRegistryManager

Исключения

Тип Описание
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

get_device

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

get_device(device_id)

Параметры

Имя Описание
device_id
Обязательно
str

Имя (идентификатор) устройства.

Возвращаемое значение

Тип Описание

Объект Device, содержащий запрошенное устройство.

Исключения

Тип Описание
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

get_device_registry_statistics

Извлекает статистику реестра устройств IoTHub.

get_device_registry_statistics()

Возвращаемое значение

Тип Описание

Объект RegistryStatistics.

Исключения

Тип Описание
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

get_devices

Получение удостоверений нескольких устройств из реестра удостоверений IoTHub. Не рекомендуется. Используйте язык запросов IoTHub для получения сведений о двойниках устройств и удостоверениях устройства. Дополнительные сведения см. в разделах https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub и https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language.

get_devices(max_number_of_devices=None)

Параметры

Имя Описание
max_number_of_devices
int

Этот параметр определяет максимальное число возвращаемых удостоверений устройств. Любое значение за пределами диапазона от 1 до 1000 считается 1000.

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

Возвращаемое значение

Тип Описание

Список сведений об устройстве.

Исключения

Тип Описание
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

get_module

Извлекает удостоверение модуля для устройства из IoTHub.

get_module(device_id, module_id)

Параметры

Имя Описание
device_id
Обязательно
str

Имя (идентификатор) устройства.
module_id
Обязательно
str

Имя (id) модуля.

Возвращаемое значение

Тип Описание

Объект Module, содержащий запрошенный модуль.

Исключения

Тип Описание
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

get_module_twin

Возвращает двойник модуля.

get_module_twin(device_id, module_id)

Параметры

Имя Описание
device_id
Обязательно
str

Имя (идентификатор) устройства.
module_id
Обязательно
str

Имя (id) модуля.

Возвращаемое значение

Тип Описание

Объект Twin.

Исключения

Тип Описание
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

get_modules

Извлекает все удостоверения модулей на устройстве.

get_modules(device_id)

Параметры

Имя Описание
device_id
Обязательно
str

Имя (идентификатор) устройства.

Возвращаемое значение

Тип Описание

Список [Модуль], содержащий все модули на устройстве.

Исключения

Тип Описание
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

get_service_statistics

Извлекает статистику службы IoTHub.

get_service_statistics()

Возвращаемое значение

Тип Описание

Объект ServiceStatistics.

Исключения

Тип Описание
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

get_twin

Возвращает двойник устройства.

get_twin(device_id)

Параметры

Имя Описание
device_id
Обязательно
str

Имя (идентификатор) устройства.

Возвращаемое значение

Тип Описание

Объект Twin.

Исключения

Тип Описание
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

invoke_device_method

Вызов прямого метода на устройстве.

invoke_device_method(device_id, direct_method_request)

Параметры

Имя Описание
device_id
Обязательно
str

Имя (идентификатор) устройства.
direct_method_request
Обязательно
CloudToDeviceMethod

Запрос метода.

Возвращаемое значение

Тип Описание

Объект CloudToDeviceMethodResult.

Исключения

Тип Описание
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

invoke_device_module_method

Вызов прямого метода на устройстве.

invoke_device_module_method(device_id, module_id, direct_method_request)

Параметры

Имя Описание
device_id
Обязательно
str

Имя (идентификатор) устройства.
module_id
Обязательно
str

Имя (id) модуля.
direct_method_request
Обязательно
CloudToDeviceMethod

Запрос метода.

Возвращаемое значение

Тип Описание

Объект CloudToDeviceMethodResult.

Исключения

Тип Описание
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

query_iot_hub

Запрос к Центру Интернета вещей для получения сведений о двойниках устройств с помощью языка, похожего на SQL. Подробнее см. в разделе https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language. Поддерживается разбиение результатов на страницы. При этом возвращаются сведения только о двойниках устройств.

query_iot_hub(query_specification, continuation_token=None, max_item_count=None)

Параметры

Имя Описание
query
Обязательно
QuerySpecification

Спецификация запроса.
continuation_token
str

Маркер продолжения для разбиения по страницам

значение по умолчанию: None
max_item_count
str

Максимальное число запрошенных двойников устройств

значение по умолчанию: None
query_specification
Обязательно

Возвращаемое значение

Тип Описание

Объект QueryResult.

Исключения

Тип Описание
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

replace_module_twin

Заменяет теги и требуемые свойства двойника модуля.

replace_module_twin(device_id, module_id, module_twin, etag=None)

Параметры

Имя Описание
device_id
Обязательно
str

Имя (идентификатор) устройства.
module_id
Обязательно
str

Имя (id) модуля.
module_twin
Обязательно
Twin

Сведения о двойнику модуля.
etag
str

Значение etag (if_match), используемое для операции замены.

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

Возвращаемое значение

Тип Описание

Объект Twin.

Исключения

Тип Описание
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

replace_twin

Заменяет теги и требуемые свойства двойника устройства.

replace_twin(device_id, device_twin, etag=None)

Параметры

Имя Описание
device_id
Обязательно
str

Имя (идентификатор) устройства.
device_twin
Обязательно
Twin

Сведения о двойнику устройства.
etag
str

Значение etag (if_match), используемое для операции замены.

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

Возвращаемое значение

Тип Описание

Объект Twin.

Исключения

Тип Описание
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

send_c2d_message

Отправка сообщения C2D на устройство IoTHub.

send_c2d_message(device_id, message, properties={})

Параметры

Имя Описание
device_id
Обязательно
str

Имя (идентификатор) устройства.
message
Обязательно
str

Сообщение, которое должно быть доставлено на устройство.
properties
dict

Свойства, отправляемые вместе с сообщением. Может содержать свойства приложения и системные свойства

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

Исключения

Тип Описание
Exception if the Send command is not able to send the message

update_device_with_certificate_authority

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

update_device_with_certificate_authority(device_id, etag, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)

Параметры

Имя Описание
device_id
Обязательно
str

Имя (идентификатор) устройства.
etag
Обязательно
str

Значение etag (if_match), используемое для операции обновления.
status
Обязательно
str

Начальное состояние созданного устройства. (Возможные значения: "enabled" или "disabled").
iot_edge
bool

Указывает, является ли созданное устройство IoT Edge устройством. Значение по умолчанию: False

значение по умолчанию: False
status_reason
str

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

значение по умолчанию: None
device_scope
str

Область действия устройства. Значение по умолчанию: none Auto generated and immutable for edge devices and modifiable in leaf devices to create child/parent relationship. Для конечных устройств значение для задания родительского пограничного устройства можно получить из свойства device_scope родительского пограничного устройства.

значение по умолчанию: None
parent_scopes
Union[list[str], str]

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

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

Возвращаемое значение

Тип Описание

Обновленный объект Device, содержащий созданное устройство.

Исключения

Тип Описание
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

update_device_with_sas

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

update_device_with_sas(device_id, etag, primary_key, secondary_key, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)

Параметры

Имя Описание
device_id
Обязательно
str

Имя (идентификатор) устройства.
etag
Обязательно
str

Значение etag (if_match), используемое для операции обновления.
primary_key
Обязательно
str

Первичный ключ проверки подлинности.
secondary_key
Обязательно
str

Вторичный ключ проверки подлинности.
status
Обязательно
str

Начальное состояние созданного устройства. (Возможные значения: "enabled" или "disabled").
iot_edge
bool

Указывает, является ли созданное устройство IoT Edge устройством. Значение по умолчанию: False

значение по умолчанию: False
status_reason
str

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

значение по умолчанию: None
device_scope
str

Область действия устройства. Значение по умолчанию: None Автоматически создается и неизменяемо для пограничных устройств и может изменяться на конечных устройствах для создания связи между дочерними и родительскими элементами. Для конечных устройств значение для установки родительского пограничного устройства можно получить из свойства device_scope родительского пограничного устройства.

значение по умолчанию: None
parent_scopes
Union[list[str], str]

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

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

Возвращаемое значение

Тип Описание

Обновленный объект Device, содержащий созданное устройство.

Исключения

Тип Описание
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

update_device_with_x509

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

update_device_with_x509(device_id, etag, primary_thumbprint, secondary_thumbprint, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)

Параметры

Имя Описание
device_id
Обязательно
str

Имя (идентификатор) устройства.
etag
Обязательно
str

Значение etag (if_match), используемое для операции обновления.
primary_thumbprint
Обязательно
str

Основной отпечаток X509.
secondary_thumbprint
Обязательно
str

Вторичный отпечаток X509.
status
Обязательно
str

Начальное состояние созданного устройства. (Возможные значения: "enabled" или "disabled").
iot_edge
bool

Является ли созданное устройство IoT Edge устройством. Значение по умолчанию: False

значение по умолчанию: False
status_reason
str

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

значение по умолчанию: None
device_scope
str

Область действия устройства. Значение по умолчанию: None Автоматически создается и неизменяемо для пограничных устройств и может изменяться на конечных устройствах для создания связи между дочерними и родительскими элементами. Для конечных устройств значение для установки родительского пограничного устройства можно получить из свойства device_scope родительского пограничного устройства.

значение по умолчанию: None
parent_scopes
Union[list[str], str]

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

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

Возвращаемое значение

Тип Описание

Обновленный объект Device, содержащий созданное устройство.

Исключения

Тип Описание
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

update_module_twin

Обновления теги и требуемые свойства двойника модуля.

update_module_twin(device_id, module_id, module_twin, etag=None)

Параметры

Имя Описание
device_id
Обязательно
str

Имя (идентификатор) устройства.
module_id
Обязательно
str

Имя (id) модуля.
module_twin
Обязательно
Twin

Сведения о двойником модуле.
etag
str

Значение etag (if_match), используемое для операции обновления.

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

Возвращаемое значение

Тип Описание

Объект Двойник.

Исключения

Тип Описание
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

update_module_with_certificate_authority

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

update_module_with_certificate_authority(device_id, module_id, managed_by, etag)

Параметры

Имя Описание
device_id
Обязательно
str

Имя (идентификатор) устройства.
module_id
Обязательно
str

Имя (id) модуля.
managed_by
Обязательно
str

Имя устройства диспетчера (edge).
etag
Обязательно
str

Значение etag (if_match), используемое для операции обновления.

Возвращаемое значение

Тип Описание

Обновленный объект Module, содержащий созданный модуль.

Исключения

Тип Описание
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

update_module_with_sas

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

update_module_with_sas(device_id, module_id, managed_by, etag, primary_key, secondary_key)

Параметры

Имя Описание
device_id
Обязательно
str

Имя (идентификатор) устройства.
module_id
Обязательно
str

Имя (id) модуля.
managed_by
Обязательно
str

Имя устройства диспетчера (edge).
etag
Обязательно
str

Значение etag (if_match), используемое для операции обновления.
primary_key
Обязательно
str

Первичный ключ проверки подлинности.
secondary_key
Обязательно
str

Вторичный ключ проверки подлинности.

Возвращаемое значение

Тип Описание

Обновленный объект Module, содержащий созданный модуль.

Исключения

Тип Описание
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

update_module_with_x509

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

update_module_with_x509(device_id, module_id, managed_by, etag, primary_thumbprint, secondary_thumbprint)

Параметры

Имя Описание
device_id
Обязательно
str

Имя (идентификатор) устройства.
module_id
Обязательно
str

Имя (id) модуля.
managed_by
Обязательно
str

Имя устройства диспетчера (edge).
etag
Обязательно
str

Значение etag (if_match), используемое для операции обновления.
primary_thumbprint
Обязательно
str

Основной отпечаток X509.
secondary_thumbprint
Обязательно
str

Вторичный отпечаток X509.

Возвращаемое значение

Тип Описание

Обновленный объект Module, содержащий созданный модуль.

Исключения

Тип Описание
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

update_twin

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

update_twin(device_id, device_twin, etag=None)

Параметры

Имя Описание
device_id
Обязательно
str

Имя (идентификатор) устройства.
device_twin
Обязательно
Twin

Сведения о двойнику устройства.
etag
str

Значение etag (if_match), используемое для операции обновления.

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

Возвращаемое значение

Тип Описание

Объект Двойник.

Исключения

Тип Описание
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>