IoTHubConfigurationManager Classe
Uma classe para fornecer APIs de conveniência para operações de Configuration Manager do IoTHub, com base nas APIs REST do IotHub geradas automaticamente
Inicializador para um cliente do Serviço Configuration Manager.
Após uma criação bem-sucedida, a classe foi autenticada com o IoTHub e está pronta para chamar as APIs membro para se comunicar com o IoTHub.
- Herança
-
builtins.objectIoTHubConfigurationManager
Construtor
IoTHubConfigurationManager(connection_string=None, host=None, auth=None)Parâmetros
| Nome | Description |
|---|---|
|
connection_string
|
A cadeia de conexão do IoTHub usada para autenticar a conexão com o IoTHub se estivermos usando connection_str autenticação. Valor padrão: nenhum valor padrão: None
|
|
host
|
A URL do serviço do Azure se estivermos usando a autenticação de credencial de token. Valor padrão: nenhum valor padrão: None
|
|
auth
|
O objeto de autenticação do Azure se estivermos usando a autenticação de credencial de token. Valor padrão: nenhum valor padrão: None
|
Métodos
| apply_configuration_on_edge_device |
Aplica o conteúdo de configuração fornecido ao dispositivo de borda especificado. O conteúdo dos módulos é obrigatório. |
| create_configuration |
Cria uma configuração para dispositivos ou módulos de um IoTHub. |
| delete_configuration |
Exclui uma configuração de um IoTHub. |
| from_connection_string |
Inicializador classmethod para um cliente do Serviço IoTHubConfigurationManager. Cria a classe IoTHubConfigurationManager da cadeia de conexão. Após uma criação bem-sucedida, a classe foi autenticada com o IoTHub e está pronta para chamar as APIs membro para se comunicar com o IoTHub. |
| from_token_credential |
Inicializador classmethod para um cliente do Serviço IoTHubConfigurationManager. Cria a classe IoTHubConfigurationManager com base na URL do nome do host e na credencial do token do Azure. Após uma criação bem-sucedida, a classe foi autenticada com o IoTHub e está pronta para chamar as APIs membro para se comunicar com o IoTHub. |
| get_configuration |
Recupera a configuração do IoTHub para um dispositivo específico. |
| get_configurations |
Recupera várias configurações para dispositivos e módulos de um IoTHub. Retorna o número especificado de configurações. Não há suporte para paginação. |
| test_configuration_queries |
Valida a consulta de condição de destino e as consultas de métrica personalizadas para uma configuração. |
| update_configuration |
Atualizações uma configuração para dispositivos ou módulos de um IoTHub. Observação: essa ID de configuração e o Conteúdo não podem ser atualizados pelo usuário. |
apply_configuration_on_edge_device
Aplica o conteúdo de configuração fornecido ao dispositivo de borda especificado. O conteúdo dos módulos é obrigatório.
apply_configuration_on_edge_device(device_id, configuration_content)Parâmetros
| Nome | Description |
|---|---|
|
configuration_content
Obrigatório
|
O nome (Id) do dispositivo de borda. |
|
device_id
Obrigatório
|
|
Retornos
| Tipo | Description |
|---|---|
|
Um objeto. |
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
create_configuration
Cria uma configuração para dispositivos ou módulos de um IoTHub.
create_configuration(configuration)Parâmetros
| Nome | Description |
|---|---|
|
configuration_id
Obrigatório
|
A ID da configuração. |
|
configuration
Obrigatório
|
A configuração a ser criada. |
Retornos
| Tipo | Description |
|---|---|
|
Objeto de configuração que contém a configuração criada. |
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
delete_configuration
Exclui uma configuração de um IoTHub.
delete_configuration(configuration_id, etag=None)Parâmetros
| Nome | Description |
|---|---|
|
configuration_id
Obrigatório
|
A ID da configuração. |
|
configuration
Obrigatório
|
A configuração a ser criada. |
|
etag
|
O valor de etag (if_match) a ser usado para a operação de exclusão. valor padrão: None
|
Retornos
| Tipo | Description |
|---|---|
|
Objeto de configuração que contém a configuração atualizada. |
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
from_connection_string
Inicializador classmethod para um cliente do Serviço IoTHubConfigurationManager. Cria a classe IoTHubConfigurationManager da cadeia de conexão.
Após uma criação bem-sucedida, a classe foi autenticada com o IoTHub e está pronta para chamar as APIs membro para se comunicar com o IoTHub.
from_connection_string(connection_string)Parâmetros
| Nome | Description |
|---|---|
|
connection_string
Obrigatório
|
A cadeia de conexão do IoTHub usada para autenticar a conexão com o IoTHub. |
Retornos
| Tipo | Description |
|---|---|
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
from_token_credential
Inicializador classmethod para um cliente do Serviço IoTHubConfigurationManager. Cria a classe IoTHubConfigurationManager com base na URL do nome do host e na credencial do token do Azure.
Após uma criação bem-sucedida, a classe foi autenticada com o IoTHub e está pronta para chamar as APIs membro para se comunicar com o IoTHub.
from_token_credential(url, token_credential)Parâmetros
| Nome | Description |
|---|---|
|
url
Obrigatório
|
A URL do serviço do Azure (nome do host). |
|
token_credential
Obrigatório
|
<xref:azure.core.TokenCredential>
O objeto de credencial de token do Azure |
Retornos
| Tipo | Description |
|---|---|
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
get_configuration
Recupera a configuração do IoTHub para um dispositivo específico.
get_configuration(configuration_id)Parâmetros
| Nome | Description |
|---|---|
|
configuration_id
Obrigatório
|
A ID da configuração. |
Retornos
| Tipo | Description |
|---|---|
|
O objeto Configuration. |
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
get_configurations
Recupera várias configurações para dispositivos e módulos de um IoTHub. Retorna o número especificado de configurações. Não há suporte para paginação.
get_configurations(max_count=None)Parâmetros
| Nome | Description |
|---|---|
|
max_count
|
O número máximo de configurações solicitadas. valor padrão: None
|
Retornos
| Tipo | Description |
|---|---|
|
O objeto list[Configuration]. |
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
test_configuration_queries
Valida a consulta de condição de destino e as consultas de métrica personalizadas para uma configuração.
test_configuration_queries(configuration_queries_test_input)Parâmetros
| Nome | Description |
|---|---|
|
configuration_queries_test_input
Obrigatório
|
A entrada de teste de consultas. |
Retornos
| Tipo | Description |
|---|---|
|
O objeto ConfigurationQueriesTestResponse. |
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
update_configuration
Atualizações uma configuração para dispositivos ou módulos de um IoTHub. Observação: essa ID de configuração e o Conteúdo não podem ser atualizados pelo usuário.
update_configuration(configuration, etag)Parâmetros
| Nome | Description |
|---|---|
|
configuration_id
Obrigatório
|
A ID da configuração. |
|
configuration
Obrigatório
|
A configuração contém a configuração atualizada. |
|
etag
Obrigatório
|
O valor de etag (if_match) a ser usado para a operação de atualização. |
Retornos
| Tipo | Description |
|---|---|
|
Objeto de configuração que contém a configuração atualizada. |
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
Azure SDK for Python
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de