IoTHubRegistryManager Clase

Una clase para proporcionar API útiles para las operaciones de IoTHub Registry Manager, basadas en las API REST de IotHub generadas automáticamente.

Inicializador para un cliente de servicio del Administrador de registros.

Los usuarios no deben llamar a esto directamente. En su lugar, deben los métodos de fábrica from_connection_string() o from_token_credential().

Después de crear correctamente la clase se ha autenticado con IoTHub y está listo para llamar a las API miembro para comunicarse con IoTHub.

Herencia

builtins.object

IoTHubRegistryManager

Constructor

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

Parámetros

Nombre	Description
connection_string	str La cadena de conexión de IoTHub que se usa para autenticar la conexión con IoTHub si se usa connection_str autenticación. Valor predeterminado: ninguno valor predeterminado: None
host	str La dirección URL del servicio de Azure si usamos la autenticación de credenciales de token. Valor predeterminado: ninguno valor predeterminado: None
auth Requerido	str El objeto de autenticación de Azure si usamos la autenticación de credenciales de token. Valor predeterminado: ninguno
token_credential	valor predeterminado: None

Métodos

bulk_create_or_update_devices	Cree, actualice o elimine las identidades de varios dispositivos del registro de identidades de IoTHub. Cree, actualice o elimine las identidades de varios dispositivos del registro de identidades de IoTHub. Una identidad de dispositivo solo se puede especificar una vez en la lista. Se permiten diferentes operaciones (crear, actualizar, eliminar) en distintos dispositivos. Se puede especificar un máximo de 100 dispositivos por invocación. Para las operaciones a gran escala, considere la posibilidad de usar la característica de importación mediante Blob Storage(https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities).
create_device_with_certificate_authority	Crea una identidad de dispositivo en IoTHub mediante la entidad de certificación.
create_device_with_sas	Crea una identidad de dispositivo en IoTHub mediante la autenticación de SAS.
create_device_with_x509	Crea una identidad de dispositivo en IoTHub mediante la autenticación X509.
create_module_with_certificate_authority	Crea una identidad de módulo para un dispositivo en IoTHub mediante la entidad de certificación.
create_module_with_sas	Crea una identidad de módulo para un dispositivo en IoTHub mediante la autenticación de SAS.
create_module_with_x509	Crea una identidad de módulo para un dispositivo en IoTHub mediante la autenticación X509.
delete_device	Elimina una identidad de dispositivo de IoTHub.
delete_module	Elimina una identidad de módulo para un dispositivo de IoTHub.
from_connection_string	Inicializador classmethod para un cliente del servicio Registry Manager. Crea la clase registry Manager a partir de la cadena de conexión. Después de crear correctamente la clase se ha autenticado con IoTHub y está listo para llamar a las API miembro para comunicarse con IoTHub.
from_token_credential	Inicializador classmethod para un cliente del servicio Registry Manager. Crea una clase de Registry Manager a partir de la dirección URL del nombre de host y la credencial del token de Azure. Después de crear correctamente la clase se ha autenticado con IoTHub y está listo para llamar a las API miembro para comunicarse con IoTHub.
get_device	Recupera una identidad de dispositivo de IoTHub.
get_device_registry_statistics	Recupera las estadísticas del registro de dispositivos de IoTHub.
get_devices	Obtenga las identidades de varios dispositivos del registro de identidades de IoTHub. No se recomienda. Use el lenguaje de consulta de IoTHub para recuperar la información de identidad del dispositivo gemelo y del dispositivo. Para obtener más información, vea https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub y https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language.
get_module	Recupera una identidad de módulo para un dispositivo de IoTHub.
get_module_twin	Obtiene un módulo gemelo.
get_modules	Recupera todas las identidades de módulo en un dispositivo.
get_service_statistics	Recupera las estadísticas del servicio IoTHub.
get_twin	Obtiene un dispositivo gemelo.
invoke_device_method	Invoque un método directo en un dispositivo.
invoke_device_module_method	Invoque un método directo en un dispositivo.
query_iot_hub	Consulte una instancia de IoTHub para recuperar información sobre dispositivos gemelos mediante un lenguaje similar a SQL. Consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language para obtener más información. Se admite la paginación de resultados. Esto solo devuelve información sobre los dispositivos gemelos.
replace_module_twin	Reemplaza las etiquetas y las propiedades deseadas de un módulo gemelo.
replace_twin	Reemplaza las etiquetas y las propiedades deseadas de un dispositivo gemelo.
send_c2d_message	Envíe un mensaje C2D a un dispositivo IoTHub.
update_device_with_certificate_authority	Novedades una identidad de dispositivo en IoTHub mediante la entidad de certificación.
update_device_with_sas	Novedades una identidad de dispositivo en IoTHub mediante la autenticación SAS.
update_device_with_x509	Novedades una identidad de dispositivo en IoTHub mediante la autenticación X509.
update_module_twin	Novedades etiquetas y propiedades deseadas de un módulo gemelo.
update_module_with_certificate_authority	Novedades una identidad de módulo para un dispositivo en IoTHub mediante la entidad de certificación.
update_module_with_sas	Novedades una identidad de módulo para un dispositivo en IoTHub mediante la autenticación de SAS.
update_module_with_x509	Novedades una identidad de módulo para un dispositivo en IoTHub mediante la autenticación X509.
update_twin	Novedades etiquetas y propiedades deseadas de un dispositivo gemelo.

bulk_create_or_update_devices

Cree, actualice o elimine las identidades de varios dispositivos del registro de identidades de IoTHub.

Cree, actualice o elimine las identidades de varios dispositivos del registro de identidades de IoTHub. Una identidad de dispositivo solo se puede especificar una vez en la lista. Se permiten diferentes operaciones (crear, actualizar, eliminar) en distintos dispositivos. Se puede especificar un máximo de 100 dispositivos por invocación. Para las operaciones a gran escala, considere la posibilidad de usar la característica de importación mediante Blob Storage(https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities).

bulk_create_or_update_devices(devices)

Parámetros

Nombre	Description
devices Requerido	list[ExportImportDevice] Lista de objetos de dispositivo en los que se va a operar.

Devoluciones

Tipo	Description
	Objeto BulkRegistryOperationResult.

Excepciones

Tipo	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

create_device_with_certificate_authority

Crea una identidad de dispositivo en IoTHub mediante la entidad de certificación.

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

Parámetros

Nombre	Description
device_id Requerido	str El nombre (Id) del dispositivo.
status Requerido	str Estado inicial del dispositivo creado. (Valores posibles: "habilitado" o "deshabilitado").
iot_edge	bool Si el dispositivo creado es o no un dispositivo IoT Edge. Valor predeterminado: False valor predeterminado: False
status_reason	str Motivo del estado de identidad del dispositivo. Valor predeterminado: ninguno valor predeterminado: None
device_scope	str El ámbito del dispositivo. Valor predeterminado: Ninguno generado automáticamente e inmutable para dispositivos perimetrales y modificable en dispositivos hoja para crear una relación secundaria o primaria. En el caso de los dispositivos hoja, el valor para establecer un dispositivo perimetral primario se puede recuperar de la propiedad device_scope del dispositivo perimetral primario. valor predeterminado: None
parent_scopes	Union[list[str], str] Los ámbitos de los dispositivos perimetrales de nivel superior, si procede. Valor predeterminado: Ninguno para los dispositivos perimetrales, el valor para establecer un dispositivo perimetral primario se puede recuperar de la propiedad device_scope del dispositivo perimetral primario. En el caso de los dispositivos hoja, esto podría establecerse en el mismo valor que device_scope o dejar para que el servicio se copie. valor predeterminado: None

Devoluciones

Tipo	Description
	Objeto de dispositivo que contiene el dispositivo creado.

Excepciones

Tipo	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

create_device_with_sas

Crea una identidad de dispositivo en IoTHub mediante la autenticación de SAS.

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

Parámetros

Nombre	Description
device_id Requerido	str El nombre (Id) del dispositivo.
primary_key Requerido	str Clave de autenticación principal.
secondary_key Requerido	str Clave de autenticación secundaria.
status Requerido	str Estado inicial del dispositivo creado. (Valores posibles: "habilitado" o "deshabilitado")
iot_edge	bool Si el dispositivo creado es o no un dispositivo IoT Edge. Valor predeterminado: False valor predeterminado: False
status_reason	str Motivo del estado de identidad del dispositivo. Valor predeterminado: ninguno valor predeterminado: None
device_scope	str El ámbito del dispositivo. Valor predeterminado: Ninguno generado automáticamente e inmutable para dispositivos perimetrales y modificable en dispositivos hoja para crear una relación secundaria o primaria. En el caso de los dispositivos hoja, el valor para establecer un dispositivo perimetral primario se puede recuperar de la propiedad device_scope del dispositivo perimetral primario. valor predeterminado: None
parent_scopes	Union[list[str], str] Los ámbitos de los dispositivos perimetrales de nivel superior, si procede. Valor predeterminado: Ninguno para los dispositivos perimetrales, el valor para establecer un dispositivo perimetral primario se puede recuperar de la propiedad device_scope del dispositivo perimetral primario. En el caso de los dispositivos hoja, esto podría establecerse en el mismo valor que device_scope o dejar para que el servicio se copie. valor predeterminado: None

Devoluciones

Tipo	Description
	Objeto de dispositivo que contiene el dispositivo creado.

Excepciones

Tipo	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

create_device_with_x509

Crea una identidad de dispositivo en IoTHub mediante la autenticación X509.

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

Parámetros

Nombre	Description
device_id Requerido	str El nombre (Id) del dispositivo.
primary_thumbprint Requerido	str Huella digital X509 principal.
secondary_thumbprint Requerido	str Huella digital X509 secundaria.
status Requerido	str Estado inicial del dispositivo creado. (Valores posibles: "habilitado" o "deshabilitado")
iot_edge	bool Si el dispositivo creado es o no un dispositivo IoT Edge. Valor predeterminado: False valor predeterminado: False
status_reason	str Motivo del estado de identidad del dispositivo. Valor predeterminado: ninguno valor predeterminado: None
device_scope	str El ámbito del dispositivo. Valor predeterminado: Ninguno generado automáticamente e inmutable para dispositivos perimetrales y modificable en dispositivos hoja para crear una relación secundaria o primaria. En el caso de los dispositivos hoja, el valor para establecer un dispositivo perimetral primario se puede recuperar de la propiedad device_scope del dispositivo perimetral primario. valor predeterminado: None
parent_scopes	Union[list[str], str] Los ámbitos de los dispositivos perimetrales de nivel superior, si procede. Valor predeterminado: Ninguno para los dispositivos perimetrales, el valor para establecer un dispositivo perimetral primario se puede recuperar de la propiedad device_scope del dispositivo perimetral primario. En el caso de los dispositivos hoja, esto podría establecerse en el mismo valor que device_scope o dejar para que el servicio se copie. valor predeterminado: None

Devoluciones

Tipo	Description
	Objeto de dispositivo que contiene el dispositivo creado.

Excepciones

Tipo	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

create_module_with_certificate_authority

Crea una identidad de módulo para un dispositivo en IoTHub mediante la entidad de certificación.

create_module_with_certificate_authority(device_id, module_id, managed_by)

Parámetros

Nombre	Description
device_id Requerido	str El nombre (Id) del dispositivo.
module_id Requerido	str El nombre (Id) del módulo.
managed_by Requerido	str Nombre del dispositivo de administrador (perimetral).

Devoluciones

Tipo	Description
	Objeto module que contiene el módulo creado.

Excepciones

Tipo	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

create_module_with_sas

Crea una identidad de módulo para un dispositivo en IoTHub mediante la autenticación de SAS.

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

Parámetros

Nombre	Description
device_id Requerido	str El nombre (Id) del dispositivo.
module_id Requerido	str El nombre (Id) del módulo.
managed_by Requerido	str Nombre del dispositivo de administrador (perimetral).
primary_key Requerido	str Clave de autenticación principal.
secondary_key Requerido	str Clave de autenticación secundaria.

Devoluciones

Tipo	Description
	Objeto module que contiene el módulo creado.

Excepciones

Tipo	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

create_module_with_x509

Crea una identidad de módulo para un dispositivo en IoTHub mediante la autenticación X509.

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

Parámetros

Nombre	Description
device_id Requerido	str El nombre (Id) del dispositivo.
module_id Requerido	str El nombre (Id) del módulo.
managed_by Requerido	str Nombre del dispositivo de administrador (perimetral).
primary_thumbprint Requerido	str Huella digital X509 principal.
secondary_thumbprint Requerido	str Huella digital X509 secundaria.

Devoluciones

Tipo	Description
	Objeto module que contiene el módulo creado.

Excepciones

Tipo	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

delete_device

Elimina una identidad de dispositivo de IoTHub.

delete_device(device_id, etag=None)

Parámetros

Nombre	Description
device_id Requerido	str El nombre (Id) del dispositivo.
etag	str Valor de etag (if_match) que se va a usar para la operación de eliminación. valor predeterminado: None

Devoluciones

Tipo	Description
	Ninguno.

Excepciones

Tipo	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

delete_module

Elimina una identidad de módulo para un dispositivo de IoTHub.

delete_module(device_id, module_id, etag=None)

Parámetros

Nombre	Description
device_id Requerido	str El nombre (Id) del dispositivo.
module_id Requerido	str El nombre (Id) del módulo.
etag	str Valor de etag (if_match) que se va a usar para la operación de eliminación. valor predeterminado: None

Devoluciones

Tipo	Description
	Ninguno.

Excepciones

Tipo	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

from_connection_string

Inicializador classmethod para un cliente del servicio Registry Manager. Crea la clase registry Manager a partir de la cadena de conexión.

Después de crear correctamente la clase se ha autenticado con IoTHub y está listo para llamar a las API miembro para comunicarse con IoTHub.

from_connection_string(connection_string)

Parámetros

Nombre	Description
connection_string Requerido	str Cadena de conexión de IoTHub que se usa para autenticar la conexión con IoTHub.

Devoluciones

Tipo	Description
IoTHubRegistryManager

Excepciones

Tipo	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

from_token_credential

Inicializador classmethod para un cliente del servicio Registry Manager. Crea una clase de Registry Manager a partir de la dirección URL del nombre de host y la credencial del token de Azure.

Después de crear correctamente la clase se ha autenticado con IoTHub y está listo para llamar a las API miembro para comunicarse con IoTHub.

from_token_credential(url, token_credential)

Parámetros

Nombre	Description
url Requerido	str Dirección URL del servicio de Azure (nombre de host).
token_credential Requerido	<xref:azure.core.TokenCredential> El objeto de credencial del token de Azure

Devoluciones

Tipo	Description
IoTHubRegistryManager

Excepciones

Tipo	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

get_device

Recupera una identidad de dispositivo de IoTHub.

get_device(device_id)

Parámetros

Nombre	Description
device_id Requerido	str Nombre (id.) del dispositivo.

Devoluciones

Tipo	Description
	Objeto Device que contiene el dispositivo solicitado.

Excepciones

Tipo	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

get_device_registry_statistics

Recupera las estadísticas del registro de dispositivos de IoTHub.

get_device_registry_statistics()

Devoluciones

Tipo	Description
	Objeto RegistryStatistics.

Excepciones

Tipo	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

get_devices

Obtenga las identidades de varios dispositivos del registro de identidades de IoTHub. No se recomienda. Use el lenguaje de consulta de IoTHub para recuperar la información de identidad del dispositivo gemelo y del dispositivo. Para obtener más información, vea https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub y https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language.

get_devices(max_number_of_devices=None)

Parámetros

Nombre	Description
max_number_of_devices	int Este parámetro, cuando se especifica, define el número máximo de identidades de dispositivo que se devuelven. Cualquier valor fuera del intervalo de 1 a 1000 se considera 1000 valor predeterminado: None

Devoluciones

Tipo	Description
	Lista de información del dispositivo.

Excepciones

Tipo	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

get_module

Recupera una identidad de módulo para un dispositivo de IoTHub.

get_module(device_id, module_id)

Parámetros

Nombre	Description
device_id Requerido	str Nombre (id.) del dispositivo.
module_id Requerido	str Nombre (id.) del módulo.

Devoluciones

Tipo	Description
	Objeto Module que contiene el módulo solicitado.

Excepciones

Tipo	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

get_module_twin

Obtiene un módulo gemelo.

get_module_twin(device_id, module_id)

Parámetros

Nombre	Description
device_id Requerido	str Nombre (id.) del dispositivo.
module_id Requerido	str Nombre (id.) del módulo.

Devoluciones

Tipo	Description
	El objeto Twin.

Excepciones

Tipo	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

get_modules

Recupera todas las identidades de módulo en un dispositivo.

get_modules(device_id)

Parámetros

Nombre	Description
device_id Requerido	str Nombre (id.) del dispositivo.

Devoluciones

Tipo	Description
	Lista[Módulo] que contiene todos los módulos del dispositivo.

Excepciones

Tipo	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

get_service_statistics

Recupera las estadísticas del servicio IoTHub.

get_service_statistics()

Devoluciones

Tipo	Description
	Objeto ServiceStatistics.

Excepciones

Tipo	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

get_twin

Obtiene un dispositivo gemelo.

get_twin(device_id)

Parámetros

Nombre	Description
device_id Requerido	str Nombre (id.) del dispositivo.

Devoluciones

Tipo	Description
	El objeto Twin.

Excepciones

Tipo	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

invoke_device_method

Invoque un método directo en un dispositivo.

invoke_device_method(device_id, direct_method_request)

Parámetros

Nombre	Description
device_id Requerido	str Nombre (id.) del dispositivo.
direct_method_request Requerido	CloudToDeviceMethod Solicitud de método.

Devoluciones

Tipo	Description
	Objeto CloudToDeviceMethodResult.

Excepciones

Tipo	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

invoke_device_module_method

Invoque un método directo en un dispositivo.

invoke_device_module_method(device_id, module_id, direct_method_request)

Parámetros

Nombre	Description
device_id Requerido	str Nombre (id.) del dispositivo.
module_id Requerido	str Nombre (id.) del módulo.
direct_method_request Requerido	CloudToDeviceMethod Solicitud de método.

Devoluciones

Tipo	Description
	Objeto CloudToDeviceMethodResult.

Excepciones

Tipo	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

query_iot_hub

Consulte una instancia de IoTHub para recuperar información sobre dispositivos gemelos mediante un lenguaje similar a SQL. Consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language para obtener más información. Se admite la paginación de resultados. Esto solo devuelve información sobre los dispositivos gemelos.

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

Parámetros

Nombre	Description
query Requerido	QuerySpecification Especificación de consulta.
continuation_token	str Token de continuación para la paginación valor predeterminado: None
max_item_count	str Número máximo de dispositivos gemelos solicitados valor predeterminado: None
query_specification Requerido

Devoluciones

Tipo	Description
	Objeto QueryResult.

Excepciones

Tipo	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

replace_module_twin

Reemplaza las etiquetas y las propiedades deseadas de un módulo gemelo.

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

Parámetros

Nombre	Description
device_id Requerido	str Nombre (id.) del dispositivo.
module_id Requerido	str Nombre (id.) del módulo.
module_twin Requerido	Twin Información del gemelo del módulo.
etag	str Valor etag (if_match) que se va a usar para la operación de reemplazo. valor predeterminado: None

Devoluciones

Tipo	Description
	El objeto Twin.

Excepciones

Tipo	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

replace_twin

Reemplaza las etiquetas y las propiedades deseadas de un dispositivo gemelo.

replace_twin(device_id, device_twin, etag=None)

Parámetros

Nombre	Description
device_id Requerido	str Nombre (id.) del dispositivo.
device_twin Requerido	Twin Información del gemelo del dispositivo.
etag	str Valor etag (if_match) que se va a usar para la operación de reemplazo. valor predeterminado: None

Devoluciones

Tipo	Description
	El objeto Twin.

Excepciones

Tipo	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

send_c2d_message

Envíe un mensaje C2D a un dispositivo IoTHub.

send_c2d_message(device_id, message, properties={})

Parámetros

Nombre	Description
device_id Requerido	str Nombre (id.) del dispositivo.
message Requerido	str Mensaje que se va a entregar al dispositivo.
properties	dict Las propiedades que se van a enviar con el mensaje. Puede contener propiedades de aplicación y propiedades del sistema valor predeterminado: {}

Excepciones

Tipo	Description
Exception if the Send command is not able to send the message

update_device_with_certificate_authority

Novedades una identidad de dispositivo en IoTHub mediante la entidad de certificación.

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

Parámetros

Nombre	Description
device_id Requerido	str Nombre (id.) del dispositivo.
etag Requerido	str Valor de etag (if_match) que se va a usar para la operación de actualización.
status Requerido	str Estado inicial del dispositivo creado. (Valores posibles: "habilitado" o "deshabilitado").
iot_edge	bool Si el dispositivo creado es o no un dispositivo IoT Edge. Valor predeterminado: False valor predeterminado: False
status_reason	str Motivo del estado de la identidad del dispositivo. Valor predeterminado: ninguno valor predeterminado: None
device_scope	str El ámbito del dispositivo. Valor predeterminado: Ninguno generado automáticamente e inmutable para dispositivos perimetrales y modificable en dispositivos hoja para crear una relación secundaria o primaria. En el caso de los dispositivos hoja, el valor para establecer un dispositivo perimetral primario se puede recuperar de la propiedad device_scope del dispositivo perimetral primario. valor predeterminado: None
parent_scopes	Union[list[str], str] Los ámbitos de los dispositivos perimetrales de nivel superior, si procede. Valor predeterminado: Ninguno para los dispositivos perimetrales, el valor para establecer un dispositivo perimetral primario se puede recuperar de la propiedad device_scope del dispositivo perimetral primario. En el caso de los dispositivos hoja, esto se podría establecer en el mismo valor que device_scope o dejar para que el servicio se copie. valor predeterminado: None

Devoluciones

Tipo	Description
	Objeto Device actualizado que contiene el dispositivo creado.

Excepciones

Tipo	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

update_device_with_sas

Novedades una identidad de dispositivo en IoTHub mediante la autenticación 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)

Parámetros

Nombre	Description
device_id Requerido	str Nombre (id.) del dispositivo.
etag Requerido	str Valor de etag (if_match) que se va a usar para la operación de actualización.
primary_key Requerido	str Clave de autenticación principal.
secondary_key Requerido	str Clave de autenticación secundaria.
status Requerido	str Estado inicial del dispositivo creado. (Valores posibles: "habilitado" o "deshabilitado").
iot_edge	bool Si el dispositivo creado es o no un dispositivo IoT Edge. Valor predeterminado: False valor predeterminado: False
status_reason	str Motivo del estado de la identidad del dispositivo. Valor predeterminado: ninguno valor predeterminado: None
device_scope	str El ámbito del dispositivo. Valor predeterminado: Ninguno generado automáticamente e inmutable para dispositivos perimetrales y modificable en dispositivos hoja para crear una relación secundaria o primaria. En el caso de los dispositivos hoja, el valor para establecer un dispositivo perimetral primario se puede recuperar de la propiedad device_scope del dispositivo perimetral primario. valor predeterminado: None
parent_scopes	Union[list[str], str] Los ámbitos de los dispositivos perimetrales de nivel superior, si procede. Valor predeterminado: Ninguno para los dispositivos perimetrales, el valor para establecer un dispositivo perimetral primario se puede recuperar de la propiedad device_scope del dispositivo perimetral primario. En el caso de los dispositivos hoja, esto se podría establecer en el mismo valor que device_scope o dejar para que el servicio se copie. valor predeterminado: None

Devoluciones

Tipo	Description
	Objeto Device actualizado que contiene el dispositivo creado.

Excepciones

Tipo	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

update_device_with_x509

Novedades una identidad de dispositivo en IoTHub mediante la autenticación 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)

Parámetros

Nombre	Description
device_id Requerido	str Nombre (id.) del dispositivo.
etag Requerido	str Valor de etag (if_match) que se va a usar para la operación de actualización.
primary_thumbprint Requerido	str Huella digital X509 principal.
secondary_thumbprint Requerido	str Huella digital X509 secundaria.
status Requerido	str Estado inicial del dispositivo creado. (Valores posibles: "habilitado" o "deshabilitado").
iot_edge	bool Si el dispositivo creado es o no un dispositivo IoT Edge. Valor predeterminado: False valor predeterminado: False
status_reason	str Motivo del estado de la identidad del dispositivo. Valor predeterminado: ninguno valor predeterminado: None
device_scope	str El ámbito del dispositivo. Valor predeterminado: Ninguno generado automáticamente e inmutable para dispositivos perimetrales y modificable en dispositivos hoja para crear una relación secundaria o primaria. En el caso de los dispositivos hoja, el valor para establecer un dispositivo perimetral primario se puede recuperar de la propiedad device_scope del dispositivo perimetral primario. valor predeterminado: None
parent_scopes	Union[list[str], str] Los ámbitos de los dispositivos perimetrales de nivel superior, si procede. Valor predeterminado: Ninguno para los dispositivos perimetrales, el valor para establecer un dispositivo perimetral primario se puede recuperar de la propiedad device_scope del dispositivo perimetral primario. En el caso de los dispositivos hoja, esto se podría establecer en el mismo valor que device_scope o dejar para que el servicio se copie. valor predeterminado: None

Devoluciones

Tipo	Description
	Objeto Device actualizado que contiene el dispositivo creado.

Excepciones

Tipo	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

update_module_twin

Novedades etiquetas y propiedades deseadas de un módulo gemelo.

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

Parámetros

Nombre	Description
device_id Requerido	str Nombre (id.) del dispositivo.
module_id Requerido	str Nombre (id.) del módulo.
module_twin Requerido	Twin Información del gemelo del módulo.
etag	str Valor de etag (if_match) que se va a usar para la operación de actualización. valor predeterminado: None

Devoluciones

Tipo	Description
	El objeto Twin.

Excepciones

Tipo	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

update_module_with_certificate_authority

Novedades una identidad de módulo para un dispositivo en IoTHub mediante la entidad de certificación.

update_module_with_certificate_authority(device_id, module_id, managed_by, etag)

Parámetros

Nombre	Description
device_id Requerido	str Nombre (id.) del dispositivo.
module_id Requerido	str Nombre (id.) del módulo.
managed_by Requerido	str Nombre del dispositivo administrador (edge).
etag Requerido	str Valor de etag (if_match) que se va a usar para la operación de actualización.

Devoluciones

Tipo	Description
	Objeto Module actualizado que contiene el módulo creado.

Excepciones

Tipo	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

update_module_with_sas

Novedades una identidad de módulo para un dispositivo en IoTHub mediante la autenticación de SAS.

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

Parámetros

Nombre	Description
device_id Requerido	str Nombre (id.) del dispositivo.
module_id Requerido	str Nombre (id.) del módulo.
managed_by Requerido	str Nombre del dispositivo administrador (edge).
etag Requerido	str Valor de etag (if_match) que se va a usar para la operación de actualización.
primary_key Requerido	str Clave de autenticación principal.
secondary_key Requerido	str Clave de autenticación secundaria.

Devoluciones

Tipo	Description
	Objeto Module actualizado que contiene el módulo creado.

Excepciones

Tipo	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

update_module_with_x509

Novedades una identidad de módulo para un dispositivo en IoTHub mediante la autenticación X509.

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

Parámetros

Nombre	Description
device_id Requerido	str Nombre (id.) del dispositivo.
module_id Requerido	str Nombre (id.) del módulo.
managed_by Requerido	str Nombre del dispositivo administrador (edge).
etag Requerido	str Valor de etag (if_match) que se va a usar para la operación de actualización.
primary_thumbprint Requerido	str Huella digital X509 principal.
secondary_thumbprint Requerido	str Huella digital X509 secundaria.

Devoluciones

Tipo	Description
	Objeto Module actualizado que contiene el módulo creado.

Excepciones

Tipo	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

update_twin

Novedades etiquetas y propiedades deseadas de un dispositivo gemelo.

update_twin(device_id, device_twin, etag=None)

Parámetros

Nombre	Description
device_id Requerido	str Nombre (id.) del dispositivo.
device_twin Requerido	Twin Información del gemelo del dispositivo.
etag	str Valor de etag (if_match) que se va a usar para la operación de actualización. valor predeterminado: None

Devoluciones

Tipo	Description
	El objeto Twin.

Excepciones

Tipo	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>