IoTHubRegistryManager Classe
Uma classe para fornecer APIs de conveniência para operações do Gerenciador de Registros do IoTHub, com base nas APIs REST do IotHub geradas automaticamente
Inicializador para um cliente do Serviço do Gerenciador de Registro.
Os usuários não devem chamar isso diretamente. Em vez disso, eles devem os métodos de fábrica from_connection_string() ou from_token_credential().
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.objectIoTHubRegistryManager
Construtor
IoTHubRegistryManager(connection_string=None, host=None, token_credential=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
Obrigatório
|
O objeto de autenticação do Azure se estivermos usando a autenticação de credencial de token. Valor padrão: nenhum |
|
token_credential
|
valor padrão: None
|
Métodos
| bulk_create_or_update_devices |
Crie, atualize ou exclua as identidades de vários dispositivos do registro de identidade do IoTHub. Crie, atualize ou exclua as identidades de vários dispositivos do registro de identidade do IoTHub. Uma identidade de dispositivo pode ser especificada apenas uma vez na lista. Operações diferentes (criar, atualizar, excluir) em diferentes dispositivos são permitidas. Um máximo de 100 dispositivos pode ser especificado por invocação. Para operações em grande escala, considere usar o recurso de importação usando o armazenamento de blobs(https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities). |
| create_device_with_certificate_authority |
Cria uma identidade de dispositivo no IoTHub usando a autoridade de certificação. |
| create_device_with_sas |
Cria uma identidade de dispositivo no IoTHub usando a autenticação SAS. |
| create_device_with_x509 |
Cria uma identidade de dispositivo no IoTHub usando a autenticação X509. |
| create_module_with_certificate_authority |
Cria uma identidade de módulo para um dispositivo no IoTHub usando a autoridade de certificação. |
| create_module_with_sas |
Cria uma identidade de módulo para um dispositivo no IoTHub usando a autenticação SAS. |
| create_module_with_x509 |
Cria uma identidade de módulo para um dispositivo no IoTHub usando a autenticação X509. |
| delete_device |
Exclui uma identidade do dispositivo do IoTHub. |
| delete_module |
Exclui uma identidade de módulo para um dispositivo do IoTHub. |
| from_connection_string |
Inicializador classmethod para um cliente do Serviço do Gerenciador de Registro. Cria a classe gerenciador do Registro 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 do Gerenciador de Registro. Cria a classe do Gerenciador de Registro com base na URL do nome do host e na credencial de 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_device |
Recupera uma identidade de dispositivo do IoTHub. |
| get_device_registry_statistics |
Recupera as estatísticas do registro de dispositivo do IoTHub. |
| get_devices |
Obtenha as identidades de vários dispositivos do registro de identidade do IoTHub. Não recomendado. Use a linguagem de consulta do IoTHub para recuperar informações de identidade do dispositivo gêmeo e do dispositivo. Consulte https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub e https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language para obter mais informações. |
| get_module |
Recupera uma identidade de módulo para um dispositivo do IoTHub. |
| get_module_twin |
Obtém um módulo gêmeo. |
| get_modules |
Recupera todas as identidades de módulo em um dispositivo. |
| get_service_statistics |
Recupera as estatísticas do serviço IoTHub. |
| get_twin |
Obtém um dispositivo gêmeo. |
| invoke_device_method |
Invocar um método direto em um dispositivo. |
| invoke_device_module_method |
Invocar um método direto em um dispositivo. |
| query_iot_hub |
Consulte um IoTHub para recuperar informações sobre dispositivos gêmeos usando uma linguagem semelhante a SQL. Consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language para obter mais informações. Há suporte para paginação de resultados. Isso retorna informações apenas sobre dispositivos gêmeos. |
| replace_module_twin |
Substitui marcas e propriedades desejadas de um módulo gêmeo. |
| replace_twin |
Substitui marcas e propriedades desejadas de um dispositivo gêmeo. |
| send_c2d_message |
Envie uma mensagem C2D para um dispositivo IoTHub. |
| update_device_with_certificate_authority |
Atualizações uma identidade de dispositivo no IoTHub usando a autoridade de certificação. |
| update_device_with_sas |
Atualizações uma identidade de dispositivo no IoTHub usando a autenticação SAS. |
| update_device_with_x509 |
Atualizações uma identidade de dispositivo no IoTHub usando a autenticação X509. |
| update_module_twin |
Atualizações marcas e propriedades desejadas de um módulo gêmeo. |
| update_module_with_certificate_authority |
Atualizações uma identidade de módulo para um dispositivo no IoTHub usando a autoridade de certificação. |
| update_module_with_sas |
Atualizações uma identidade de módulo para um dispositivo no IoTHub usando a autenticação SAS. |
| update_module_with_x509 |
Atualizações uma identidade de módulo para um dispositivo no IoTHub usando a autenticação X509. |
| update_twin |
Atualizações marcas e propriedades desejadas de um dispositivo gêmeo. |
bulk_create_or_update_devices
Crie, atualize ou exclua as identidades de vários dispositivos do registro de identidade do IoTHub.
Crie, atualize ou exclua as identidades de vários dispositivos do registro de identidade do IoTHub. Uma identidade de dispositivo pode ser especificada apenas uma vez na lista. Operações diferentes (criar, atualizar, excluir) em diferentes dispositivos são permitidas. Um máximo de 100 dispositivos pode ser especificado por invocação. Para operações em grande escala, considere usar o recurso de importação usando o armazenamento de blobs(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
| Nome | Description |
|---|---|
|
devices
Obrigatório
|
A lista de objetos de dispositivo nos quais operar. |
Retornos
| Tipo | Description |
|---|---|
|
O objeto BulkRegistryOperationResult. |
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
create_device_with_certificate_authority
Cria uma identidade de dispositivo no IoTHub usando a autoridade de certificação.
create_device_with_certificate_authority(device_id, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)Parâmetros
| Nome | Description |
|---|---|
|
device_id
Obrigatório
|
O nome (ID) do dispositivo. |
|
status
Obrigatório
|
Estado inicial do dispositivo criado. (Valores possíveis: "habilitado" ou "desabilitado"). |
|
iot_edge
|
Se o dispositivo criado é ou não um dispositivo IoT Edge. Valor padrão: False valor padrão: False
|
|
status_reason
|
O motivo do status de identidade do dispositivo. Valor padrão: nenhum valor padrão: None
|
|
device_scope
|
O escopo do dispositivo. Valor padrão: nenhum gerado automaticamente e imutável para dispositivos de borda e modificável em dispositivos folha para criar uma relação filho/pai. Para dispositivos folha, o valor para definir um dispositivo de borda pai pode ser recuperado da propriedade device_scope do dispositivo de borda pai. valor padrão: None
|
|
parent_scopes
|
Os escopos dos dispositivos de borda de nível superior, se aplicável. Valor padrão: Nenhum Para dispositivos de borda, o valor para definir um dispositivo de borda pai pode ser recuperado da propriedade device_scope do dispositivo de borda pai. Para dispositivos folha, isso pode ser definido com o mesmo valor que device_scope ou deixado para o serviço copiar. valor padrão: None
|
Retornos
| Tipo | Description |
|---|---|
|
Objeto de dispositivo que contém o dispositivo criado. |
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
create_device_with_sas
Cria uma identidade de dispositivo no IoTHub usando a autenticação 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
| Nome | Description |
|---|---|
|
device_id
Obrigatório
|
O nome (ID) do dispositivo. |
|
primary_key
Obrigatório
|
Chave de autenticação primária. |
|
secondary_key
Obrigatório
|
Chave de autenticação secundária. |
|
status
Obrigatório
|
Estado inicial do dispositivo criado. (Valores possíveis: "habilitado" ou "desabilitado") |
|
iot_edge
|
Se o dispositivo criado é ou não um dispositivo IoT Edge. Valor padrão: False valor padrão: False
|
|
status_reason
|
O motivo do status de identidade do dispositivo. Valor padrão: nenhum valor padrão: None
|
|
device_scope
|
O escopo do dispositivo. Valor padrão: nenhum gerado automaticamente e imutável para dispositivos de borda e modificável em dispositivos folha para criar uma relação filho/pai. Para dispositivos folha, o valor para definir um dispositivo de borda pai pode ser recuperado da propriedade device_scope do dispositivo de borda pai. valor padrão: None
|
|
parent_scopes
|
Os escopos dos dispositivos de borda de nível superior, se aplicável. Valor padrão: Nenhum Para dispositivos de borda, o valor para definir um dispositivo de borda pai pode ser recuperado da propriedade device_scope do dispositivo de borda pai. Para dispositivos folha, isso pode ser definido com o mesmo valor que device_scope ou deixado para o serviço copiar. valor padrão: None
|
Retornos
| Tipo | Description |
|---|---|
|
Objeto de dispositivo que contém o dispositivo criado. |
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
create_device_with_x509
Cria uma identidade de dispositivo no IoTHub usando a autenticação 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
| Nome | Description |
|---|---|
|
device_id
Obrigatório
|
O nome (ID) do dispositivo. |
|
primary_thumbprint
Obrigatório
|
Impressão digital X509 primária. |
|
secondary_thumbprint
Obrigatório
|
Impressão digital X509 secundária. |
|
status
Obrigatório
|
Estado inicial do dispositivo criado. (Valores possíveis: "habilitado" ou "desabilitado") |
|
iot_edge
|
Se o dispositivo criado é ou não um dispositivo IoT Edge. Valor padrão: False valor padrão: False
|
|
status_reason
|
O motivo do status de identidade do dispositivo. Valor padrão: nenhum valor padrão: None
|
|
device_scope
|
O escopo do dispositivo. Valor padrão: nenhum gerado automaticamente e imutável para dispositivos de borda e modificável em dispositivos folha para criar uma relação filho/pai. Para dispositivos folha, o valor para definir um dispositivo de borda pai pode ser recuperado da propriedade device_scope do dispositivo de borda pai. valor padrão: None
|
|
parent_scopes
|
Os escopos dos dispositivos de borda de nível superior, se aplicável. Valor padrão: Nenhum Para dispositivos de borda, o valor para definir um dispositivo de borda pai pode ser recuperado da propriedade device_scope do dispositivo de borda pai. Para dispositivos folha, isso pode ser definido com o mesmo valor que device_scope ou deixado para o serviço copiar. valor padrão: None
|
Retornos
| Tipo | Description |
|---|---|
|
Objeto de dispositivo que contém o dispositivo criado. |
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
create_module_with_certificate_authority
Cria uma identidade de módulo para um dispositivo no IoTHub usando a autoridade de certificação.
create_module_with_certificate_authority(device_id, module_id, managed_by)Parâmetros
| Nome | Description |
|---|---|
|
device_id
Obrigatório
|
O nome (ID) do dispositivo. |
|
module_id
Obrigatório
|
O nome (Id) do módulo. |
|
managed_by
Obrigatório
|
O nome do dispositivo gerenciador (borda). |
Retornos
| Tipo | Description |
|---|---|
|
Objeto module que contém o módulo criado. |
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
create_module_with_sas
Cria uma identidade de módulo para um dispositivo no IoTHub usando a autenticação SAS.
create_module_with_sas(device_id, module_id, managed_by, primary_key, secondary_key)Parâmetros
| Nome | Description |
|---|---|
|
device_id
Obrigatório
|
O nome (ID) do dispositivo. |
|
module_id
Obrigatório
|
O nome (Id) do módulo. |
|
managed_by
Obrigatório
|
O nome do dispositivo gerenciador (borda). |
|
primary_key
Obrigatório
|
Chave de autenticação primária. |
|
secondary_key
Obrigatório
|
Chave de autenticação secundária. |
Retornos
| Tipo | Description |
|---|---|
|
Objeto module que contém o módulo criado. |
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
create_module_with_x509
Cria uma identidade de módulo para um dispositivo no IoTHub usando a autenticação X509.
create_module_with_x509(device_id, module_id, managed_by, primary_thumbprint, secondary_thumbprint)Parâmetros
| Nome | Description |
|---|---|
|
device_id
Obrigatório
|
O nome (ID) do dispositivo. |
|
module_id
Obrigatório
|
O nome (Id) do módulo. |
|
managed_by
Obrigatório
|
O nome do dispositivo gerenciador (borda). |
|
primary_thumbprint
Obrigatório
|
Impressão digital X509 primária. |
|
secondary_thumbprint
Obrigatório
|
Impressão digital X509 secundária. |
Retornos
| Tipo | Description |
|---|---|
|
Objeto module que contém o módulo criado. |
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
delete_device
Exclui uma identidade do dispositivo do IoTHub.
delete_device(device_id, etag=None)Parâmetros
| Nome | Description |
|---|---|
|
device_id
Obrigatório
|
O nome (ID) do dispositivo. |
|
etag
|
O valor de etag (if_match) a ser usado para a operação de exclusão. valor padrão: None
|
Retornos
| Tipo | Description |
|---|---|
|
Nenhum. |
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
delete_module
Exclui uma identidade de módulo para um dispositivo do IoTHub.
delete_module(device_id, module_id, etag=None)Parâmetros
| Nome | Description |
|---|---|
|
device_id
Obrigatório
|
O nome (ID) do dispositivo. |
|
module_id
Obrigatório
|
O nome (Id) do módulo. |
|
etag
|
O valor de etag (if_match) a ser usado para a operação de exclusão. valor padrão: None
|
Retornos
| Tipo | Description |
|---|---|
|
Nenhum. |
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 do Gerenciador de Registro. Cria a classe gerenciador do Registro 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 do Gerenciador de Registro. Cria a classe do Gerenciador de Registro com base na URL do nome do host e na credencial de 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_device
Recupera uma identidade de dispositivo do IoTHub.
get_device(device_id)Parâmetros
| Nome | Description |
|---|---|
|
device_id
Obrigatório
|
O nome (ID) do dispositivo. |
Retornos
| Tipo | Description |
|---|---|
|
O objeto Device que contém o dispositivo solicitado. |
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
get_device_registry_statistics
Recupera as estatísticas do registro de dispositivo do IoTHub.
get_device_registry_statistics()Retornos
| Tipo | Description |
|---|---|
|
O objeto RegistryStatistics. |
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
get_devices
Obtenha as identidades de vários dispositivos do registro de identidade do IoTHub. Não recomendado. Use a linguagem de consulta do IoTHub para recuperar informações de identidade do dispositivo gêmeo e do dispositivo. Consulte https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub e https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language para obter mais informações.
get_devices(max_number_of_devices=None)Parâmetros
| Nome | Description |
|---|---|
|
max_number_of_devices
|
Esse parâmetro, quando especificado, define o número máximo de identidades de dispositivo retornadas. Qualquer valor fora do intervalo de 1 a 1000 é considerado 1000 valor padrão: None
|
Retornos
| Tipo | Description |
|---|---|
|
Lista de informações do dispositivo. |
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
get_module
Recupera uma identidade de módulo para um dispositivo do IoTHub.
get_module(device_id, module_id)Parâmetros
| Nome | Description |
|---|---|
|
device_id
Obrigatório
|
O nome (ID) do dispositivo. |
|
module_id
Obrigatório
|
O nome (Id) do módulo. |
Retornos
| Tipo | Description |
|---|---|
|
O objeto Module que contém o módulo solicitado. |
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
get_module_twin
Obtém um módulo gêmeo.
get_module_twin(device_id, module_id)Parâmetros
| Nome | Description |
|---|---|
|
device_id
Obrigatório
|
O nome (ID) do dispositivo. |
|
module_id
Obrigatório
|
O nome (Id) do módulo. |
Retornos
| Tipo | Description |
|---|---|
|
O objeto Twin. |
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
get_modules
Recupera todas as identidades de módulo em um dispositivo.
get_modules(device_id)Parâmetros
| Nome | Description |
|---|---|
|
device_id
Obrigatório
|
O nome (ID) do dispositivo. |
Retornos
| Tipo | Description |
|---|---|
|
A lista[Módulo] que contém todos os módulos no dispositivo. |
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
get_service_statistics
Recupera as estatísticas do serviço IoTHub.
get_service_statistics()Retornos
| Tipo | Description |
|---|---|
|
O objeto ServiceStatistics. |
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
get_twin
Obtém um dispositivo gêmeo.
get_twin(device_id)Parâmetros
| Nome | Description |
|---|---|
|
device_id
Obrigatório
|
O nome (ID) do dispositivo. |
Retornos
| Tipo | Description |
|---|---|
|
O objeto Twin. |
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
invoke_device_method
Invocar um método direto em um dispositivo.
invoke_device_method(device_id, direct_method_request)Parâmetros
| Nome | Description |
|---|---|
|
device_id
Obrigatório
|
O nome (ID) do dispositivo. |
|
direct_method_request
Obrigatório
|
A solicitação de método. |
Retornos
| Tipo | Description |
|---|---|
|
O objeto CloudToDeviceMethodResult. |
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
invoke_device_module_method
Invocar um método direto em um dispositivo.
invoke_device_module_method(device_id, module_id, direct_method_request)Parâmetros
| Nome | Description |
|---|---|
|
device_id
Obrigatório
|
O nome (ID) do dispositivo. |
|
module_id
Obrigatório
|
O nome (Id) do módulo. |
|
direct_method_request
Obrigatório
|
A solicitação de método. |
Retornos
| Tipo | Description |
|---|---|
|
O objeto CloudToDeviceMethodResult. |
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
query_iot_hub
Consulte um IoTHub para recuperar informações sobre dispositivos gêmeos usando uma linguagem semelhante a SQL. Consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language para obter mais informações. Há suporte para paginação de resultados. Isso retorna informações apenas sobre dispositivos gêmeos.
query_iot_hub(query_specification, continuation_token=None, max_item_count=None)Parâmetros
| Nome | Description |
|---|---|
|
query
Obrigatório
|
A especificação de consulta. |
|
continuation_token
|
Token de continuação para paginação valor padrão: None
|
|
max_item_count
|
Número máximo de dispositivos gêmeos solicitados valor padrão: None
|
|
query_specification
Obrigatório
|
|
Retornos
| Tipo | Description |
|---|---|
|
O objeto QueryResult. |
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
replace_module_twin
Substitui marcas e propriedades desejadas de um módulo gêmeo.
replace_module_twin(device_id, module_id, module_twin, etag=None)Parâmetros
| Nome | Description |
|---|---|
|
device_id
Obrigatório
|
O nome (ID) do dispositivo. |
|
module_id
Obrigatório
|
O nome (Id) do módulo. |
|
module_twin
Obrigatório
|
As informações do gêmeo do módulo. |
|
etag
|
O valor de etag (if_match) a ser usado para a operação de substituição. valor padrão: None
|
Retornos
| Tipo | Description |
|---|---|
|
O objeto Twin. |
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
replace_twin
Substitui marcas e propriedades desejadas de um dispositivo gêmeo.
replace_twin(device_id, device_twin, etag=None)Parâmetros
| Nome | Description |
|---|---|
|
device_id
Obrigatório
|
O nome (ID) do dispositivo. |
|
device_twin
Obrigatório
|
As informações do gêmeo do dispositivo. |
|
etag
|
O valor de etag (if_match) a ser usado para a operação de substituição. valor padrão: None
|
Retornos
| Tipo | Description |
|---|---|
|
O objeto Twin. |
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
send_c2d_message
Envie uma mensagem C2D para um dispositivo IoTHub.
send_c2d_message(device_id, message, properties={})Parâmetros
| Nome | Description |
|---|---|
|
device_id
Obrigatório
|
O nome (ID) do dispositivo. |
|
message
Obrigatório
|
A mensagem que deve ser entregue ao dispositivo. |
|
properties
|
As propriedades a serem enviadas com a mensagem. Pode conter propriedades do aplicativo e propriedades do sistema valor padrão: {}
|
Exceções
| Tipo | Description |
|---|---|
|
Exception if the Send command is not able to send the message
|
update_device_with_certificate_authority
Atualizações uma identidade de dispositivo no IoTHub usando a autoridade de certificação.
update_device_with_certificate_authority(device_id, etag, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)Parâmetros
| Nome | Description |
|---|---|
|
device_id
Obrigatório
|
O nome (ID) do dispositivo. |
|
etag
Obrigatório
|
O valor de etag (if_match) a ser usado para a operação de atualização. |
|
status
Obrigatório
|
Estado inicial do dispositivo criado. (Valores possíveis: "habilitado" ou "desabilitado"). |
|
iot_edge
|
Se o dispositivo criado é ou não um dispositivo IoT Edge. Valor padrão: False valor padrão: False
|
|
status_reason
|
O motivo do status de identidade do dispositivo. Valor padrão: nenhum valor padrão: None
|
|
device_scope
|
O escopo do dispositivo. Valor padrão: nenhum gerado automaticamente e imutável para dispositivos de borda e modificável em dispositivos folha para criar uma relação filho/pai. Para dispositivos folha, o valor para definir um dispositivo de borda pai pode ser recuperado da propriedade device_scope do dispositivo de borda pai. valor padrão: None
|
|
parent_scopes
|
Os escopos dos dispositivos de borda de nível superior, se aplicável. Valor padrão: Nenhum para dispositivos de borda, o valor para definir um dispositivo de borda pai pode ser recuperado da propriedade device_scope do dispositivo de borda pai. Para dispositivos folha, isso pode ser definido com o mesmo valor que device_scope ou deixado para o serviço copiar. valor padrão: None
|
Retornos
| Tipo | Description |
|---|---|
|
O objeto Device atualizado que contém o dispositivo criado. |
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
update_device_with_sas
Atualizações uma identidade de dispositivo no IoTHub usando a autenticação 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
| Nome | Description |
|---|---|
|
device_id
Obrigatório
|
O nome (ID) do dispositivo. |
|
etag
Obrigatório
|
O valor de etag (if_match) a ser usado para a operação de atualização. |
|
primary_key
Obrigatório
|
Chave de autenticação primária. |
|
secondary_key
Obrigatório
|
Chave de autenticação secundária. |
|
status
Obrigatório
|
Estado inicial do dispositivo criado. (Valores possíveis: "habilitado" ou "desabilitado"). |
|
iot_edge
|
Se o dispositivo criado é ou não um dispositivo IoT Edge. Valor padrão: False valor padrão: False
|
|
status_reason
|
O motivo do status de identidade do dispositivo. Valor padrão: nenhum valor padrão: None
|
|
device_scope
|
O escopo do dispositivo. Valor padrão: nenhum gerado automaticamente e imutável para dispositivos de borda e modificável em dispositivos folha para criar uma relação filho/pai. Para dispositivos folha, o valor para definir um dispositivo de borda pai pode ser recuperado da propriedade device_scope do dispositivo de borda pai. valor padrão: None
|
|
parent_scopes
|
Os escopos dos dispositivos de borda de nível superior, se aplicável. Valor padrão: Nenhum para dispositivos de borda, o valor para definir um dispositivo de borda pai pode ser recuperado da propriedade device_scope do dispositivo de borda pai. Para dispositivos folha, isso pode ser definido com o mesmo valor que device_scope ou deixado para o serviço copiar. valor padrão: None
|
Retornos
| Tipo | Description |
|---|---|
|
O objeto Device atualizado que contém o dispositivo criado. |
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
update_device_with_x509
Atualizações uma identidade de dispositivo no IoTHub usando a autenticação 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
| Nome | Description |
|---|---|
|
device_id
Obrigatório
|
O nome (ID) do dispositivo. |
|
etag
Obrigatório
|
O valor de etag (if_match) a ser usado para a operação de atualização. |
|
primary_thumbprint
Obrigatório
|
Impressão digital X509 primária. |
|
secondary_thumbprint
Obrigatório
|
Impressão digital X509 secundária. |
|
status
Obrigatório
|
Estado inicial do dispositivo criado. (Valores possíveis: "habilitado" ou "desabilitado"). |
|
iot_edge
|
Se o dispositivo criado é ou não um dispositivo IoT Edge. Valor padrão: False valor padrão: False
|
|
status_reason
|
O motivo do status de identidade do dispositivo. Valor padrão: nenhum valor padrão: None
|
|
device_scope
|
O escopo do dispositivo. Valor padrão: nenhum gerado automaticamente e imutável para dispositivos de borda e modificável em dispositivos folha para criar uma relação filho/pai. Para dispositivos folha, o valor para definir um dispositivo de borda pai pode ser recuperado da propriedade device_scope do dispositivo de borda pai. valor padrão: None
|
|
parent_scopes
|
Os escopos dos dispositivos de borda de nível superior, se aplicável. Valor padrão: Nenhum para dispositivos de borda, o valor para definir um dispositivo de borda pai pode ser recuperado da propriedade device_scope do dispositivo de borda pai. Para dispositivos folha, isso pode ser definido com o mesmo valor que device_scope ou deixado para o serviço copiar. valor padrão: None
|
Retornos
| Tipo | Description |
|---|---|
|
O objeto Device atualizado que contém o dispositivo criado. |
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
update_module_twin
Atualizações marcas e propriedades desejadas de um módulo gêmeo.
update_module_twin(device_id, module_id, module_twin, etag=None)Parâmetros
| Nome | Description |
|---|---|
|
device_id
Obrigatório
|
O nome (ID) do dispositivo. |
|
module_id
Obrigatório
|
O nome (Id) do módulo. |
|
module_twin
Obrigatório
|
As informações do gêmeo do módulo. |
|
etag
|
O valor de etag (if_match) a ser usado para a operação de atualização. valor padrão: None
|
Retornos
| Tipo | Description |
|---|---|
|
O objeto Twin. |
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
update_module_with_certificate_authority
Atualizações uma identidade de módulo para um dispositivo no IoTHub usando a autoridade de certificação.
update_module_with_certificate_authority(device_id, module_id, managed_by, etag)Parâmetros
| Nome | Description |
|---|---|
|
device_id
Obrigatório
|
O nome (ID) do dispositivo. |
|
module_id
Obrigatório
|
O nome (Id) do módulo. |
|
managed_by
Obrigatório
|
O nome do dispositivo gerenciador (borda). |
|
etag
Obrigatório
|
O valor de etag (if_match) a ser usado para a operação de atualização. |
Retornos
| Tipo | Description |
|---|---|
|
O objeto Module atualizado que contém o módulo criado. |
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
update_module_with_sas
Atualizações uma identidade de módulo para um dispositivo no IoTHub usando a autenticação SAS.
update_module_with_sas(device_id, module_id, managed_by, etag, primary_key, secondary_key)Parâmetros
| Nome | Description |
|---|---|
|
device_id
Obrigatório
|
O nome (ID) do dispositivo. |
|
module_id
Obrigatório
|
O nome (Id) do módulo. |
|
managed_by
Obrigatório
|
O nome do dispositivo gerenciador (borda). |
|
etag
Obrigatório
|
O valor de etag (if_match) a ser usado para a operação de atualização. |
|
primary_key
Obrigatório
|
Chave de autenticação primária. |
|
secondary_key
Obrigatório
|
Chave de autenticação secundária. |
Retornos
| Tipo | Description |
|---|---|
|
O objeto Module atualizado que contém o módulo criado. |
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
update_module_with_x509
Atualizações uma identidade de módulo para um dispositivo no IoTHub usando a autenticação X509.
update_module_with_x509(device_id, module_id, managed_by, etag, primary_thumbprint, secondary_thumbprint)Parâmetros
| Nome | Description |
|---|---|
|
device_id
Obrigatório
|
O nome (ID) do dispositivo. |
|
module_id
Obrigatório
|
O nome (Id) do módulo. |
|
managed_by
Obrigatório
|
O nome do dispositivo gerenciador (borda). |
|
etag
Obrigatório
|
O valor de etag (if_match) a ser usado para a operação de atualização. |
|
primary_thumbprint
Obrigatório
|
Impressão digital X509 primária. |
|
secondary_thumbprint
Obrigatório
|
Impressão digital X509 secundária. |
Retornos
| Tipo | Description |
|---|---|
|
O objeto Module atualizado que contém o módulo criado. |
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
update_twin
Atualizações marcas e propriedades desejadas de um dispositivo gêmeo.
update_twin(device_id, device_twin, etag=None)Parâmetros
| Nome | Description |
|---|---|
|
device_id
Obrigatório
|
O nome (ID) do dispositivo. |
|
device_twin
Obrigatório
|
As informações do gêmeo do dispositivo. |
|
etag
|
O valor de etag (if_match) a ser usado para a operação de atualização. valor padrão: None
|
Retornos
| Tipo | Description |
|---|---|
|
O objeto Twin. |
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