Compartir a través de

IoTHubConfigurationManager Clase

  • Referencia

Una clase para proporcionar api útiles para las operaciones de Configuration Manager de IoTHub, en función de las API rest de IotHub generadas automáticamente.

Inicializador para un cliente de servicio de Configuration Manager.

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
IoTHubConfigurationManager

Constructor

IoTHubConfigurationManager(connection_string=None, host=None, auth=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
str

El objeto de autenticación de Azure si usamos la autenticación de credenciales de token. Valor predeterminado: ninguno

valor predeterminado: None

Métodos

apply_configuration_on_edge_device

Aplica el contenido de configuración proporcionado al dispositivo perimetral especificado. El contenido de los módulos es obligatorio.
create_configuration

Crea una configuración para dispositivos o módulos de ioTHub.
delete_configuration

Elimina una configuración de ioTHub.
from_connection_string

Inicializador classmethod para un cliente del servicio IoTHubConfigurationManager. Crea la clase IoTHubConfigurationManager 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 IoTHubConfigurationManager. Crea la clase IoTHubConfigurationManager 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_configuration

Recupera la configuración de IoTHub para un dispositivo determinado.
get_configurations

Recupera varias configuraciones para dispositivos y módulos de ioTHub. Devuelve el número especificado de configuraciones. No se admite la paginación.
test_configuration_queries

Valida la consulta de condición de destino y las consultas de métricas personalizadas para una configuración.
update_configuration

Novedades una configuración para dispositivos o módulos de IoTHub. Nota: el usuario no puede actualizar el identificador de configuración y el contenido.

apply_configuration_on_edge_device

Aplica el contenido de configuración proporcionado al dispositivo perimetral especificado. El contenido de los módulos es obligatorio.

apply_configuration_on_edge_device(device_id, configuration_content)

Parámetros

Nombre Description
configuration_content
Requerido
ConfigurationContent

El nombre (Id) del dispositivo perimetral.
device_id
Requerido

Devoluciones

Tipo Description

Objeto.

Excepciones

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

create_configuration

Crea una configuración para dispositivos o módulos de ioTHub.

create_configuration(configuration)

Parámetros

Nombre Description
configuration_id
Requerido
str

Identificador de la configuración.
configuration
Requerido
Configuration

Configuración que se va a crear.

Devoluciones

Tipo Description

Objeto de configuración que contiene la configuración creada.

Excepciones

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

delete_configuration

Elimina una configuración de ioTHub.

delete_configuration(configuration_id, etag=None)

Parámetros

Nombre Description
configuration_id
Requerido
str

Identificador de la configuración.
configuration
Requerido
Configuration

Configuración que se va a crear.
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

Objeto de configuración que contiene la configuración actualizada.

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 IoTHubConfigurationManager. Crea la clase IoTHubConfigurationManager 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
IoTHubConfigurationManager

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 IoTHubConfigurationManager. Crea la clase IoTHubConfigurationManager 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

La dirección URL del servicio de Azure (nombre de host).
token_credential
Requerido
<xref:azure.core.TokenCredential>

El objeto de credencial de token de Azure

Devoluciones

Tipo Description
IoTHubConfigurationManager

Excepciones

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

get_configuration

Recupera la configuración de IoTHub para un dispositivo determinado.

get_configuration(configuration_id)

Parámetros

Nombre Description
configuration_id
Requerido
str

Identificador de la configuración.

Devoluciones

Tipo Description

Objeto Configuration.

Excepciones

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

get_configurations

Recupera varias configuraciones para dispositivos y módulos de ioTHub. Devuelve el número especificado de configuraciones. No se admite la paginación.

get_configurations(max_count=None)

Parámetros

Nombre Description
max_count
int

Número máximo de configuraciones solicitadas.

valor predeterminado: None

Devoluciones

Tipo Description

Objeto list[Configuration].

Excepciones

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

test_configuration_queries

Valida la consulta de condición de destino y las consultas de métricas personalizadas para una configuración.

test_configuration_queries(configuration_queries_test_input)

Parámetros

Nombre Description
configuration_queries_test_input
Requerido
ConfigurationQueriesTestInput

Las consultas prueban la entrada.

Devoluciones

Tipo Description

Objeto ConfigurationQueriesTestResponse.

Excepciones

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

update_configuration

Novedades una configuración para dispositivos o módulos de IoTHub. Nota: el usuario no puede actualizar el identificador de configuración y el contenido.

update_configuration(configuration, etag)

Parámetros

Nombre Description
configuration_id
Requerido
str

Identificador de la configuración.
configuration
Requerido
Configuration

La configuración contiene la configuración actualizada.
etag
Requerido
str

Valor de etag (if_match) que se va a usar para la operación de actualización.

Devoluciones

Tipo Description

Objeto de configuración que contiene la configuración actualizada.

Excepciones

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