IoTHubRegistryManager Classe
Uma classe para fornecer APIs de conveniência para operações do IoTHub Registry Manager, com base nas APIs REST do IotHub geradas automaticamente
Inicializador para um cliente do Serviço do Gestor de Registos.
Os utilizadores não devem chamar isto diretamente. Em vez disso, devem ser 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 membros para comunicar com o IoTHub.
- Herança
-
builtins.objectIoTHubRegistryManager
Construtor
IoTHubRegistryManager(connection_string=None, host=None, token_credential=None)Parâmetros
| Name | Description |
|---|---|
|
connection_string
|
A cadeia de ligação do IoTHub utilizada para autenticar a ligação com o IoTHub se estivermos a utilizar connection_str autenticação. Valor predefinido: Nenhum valor predefinido: None
|
|
host
|
O URL do serviço do Azure se estivermos a utilizar a autenticação de credenciais de token. Valor predefinido: Nenhum valor predefinido: None
|
|
auth
Necessário
|
O objeto de autenticação do Azure se estivermos a utilizar a autenticação de credenciais de token. Valor predefinido: Nenhum |
|
token_credential
|
valor predefinido: None
|
Métodos
| bulk_create_or_update_devices |
Crie, atualize ou elimine as identidades de vários dispositivos do registo de identidade do IoTHub. Crie, atualize ou elimine as identidades de vários dispositivos do registo de identidade do IoTHub. Uma identidade de dispositivo só pode ser especificada uma vez na lista. São permitidas diferentes operações (criar, atualizar, eliminar) em diferentes dispositivos. Pode especificar um máximo de 100 dispositivos por invocação. Para operações de grande escala, considere utilizar a funcionalidade de importação com 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 com a autoridade de certificação. |
| create_device_with_sas |
Cria uma identidade de dispositivo no IoTHub com a autenticação SAS. |
| create_device_with_x509 |
Cria uma identidade de dispositivo no IoTHub com a autenticação X509. |
| create_module_with_certificate_authority |
Cria uma identidade de módulo para um dispositivo no IoTHub com a autoridade de certificação. |
| create_module_with_sas |
Cria uma identidade de módulo para um dispositivo no IoTHub com a autenticação SAS. |
| create_module_with_x509 |
Cria uma identidade de módulo para um dispositivo no IoTHub com a autenticação X509. |
| delete_device |
Elimina uma identidade de dispositivo do IoTHub. |
| delete_module |
Elimina uma identidade de módulo para um dispositivo do IoTHub. |
| from_connection_string |
Inicializador classmethod para um cliente do Serviço do Gestor de Registo. Cria a classe Gestor de Registo a partir da cadeia de ligação. Após uma criação bem-sucedida, a classe foi autenticada com o IoTHub e está pronta para chamar as APIs membros para comunicar com o IoTHub. |
| from_token_credential |
Inicializador classmethod para um cliente do Serviço do Gestor de Registo. Cria a classe Gestor de Registo a partir do URL do nome do anfitrião e da 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 membros para comunicar com o IoTHub. |
| get_device |
Obtém uma identidade de dispositivo do IoTHub. |
| get_device_registry_statistics |
Obtém as estatísticas do registo de dispositivos do IoTHub. |
| get_devices |
Obtenha as identidades de vários dispositivos a partir do registo de identidade do IoTHub. Não recomendada. Utilize a linguagem de consulta do IoTHub para obter as informações de identidade do dispositivo duplo 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 |
Obtém uma identidade de módulo para um dispositivo a partir do IoTHub. |
| get_module_twin |
Obtém um módulo duplo. |
| get_modules |
Obtém todas as identidades do módulo num dispositivo. |
| get_service_statistics |
Obtém as estatísticas do serviço IoTHub. |
| get_twin |
Obtém um dispositivo duplo. |
| invoke_device_method |
Invocar um método direto num dispositivo. |
| invoke_device_module_method |
Invocar um método direto num dispositivo. |
| query_iot_hub |
Consulte um IoTHub para obter informações sobre dispositivos duplos com uma linguagem semelhante a SQL. Consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language para obter mais informações. A paginação de resultados é suportada. Esta ação devolve informações apenas sobre dispositivos duplos. |
| replace_module_twin |
Substitui as etiquetas e as propriedades pretendidas de um módulo duplo. |
| replace_twin |
Substitui as etiquetas e as propriedades pretendidas de um dispositivo duplo. |
| send_c2d_message |
Enviar uma mensagem C2D para um Dispositivo IoTHub. |
| update_device_with_certificate_authority |
Atualizações uma identidade de dispositivo no IoTHub com a autoridade de certificação. |
| update_device_with_sas |
Atualizações uma identidade de dispositivo no IoTHub com a autenticação SAS. |
| update_device_with_x509 |
Atualizações uma identidade de dispositivo no IoTHub com a autenticação X509. |
| update_module_twin |
Atualizações etiquetas e propriedades pretendidas de um módulo duplo. |
| update_module_with_certificate_authority |
Atualizações uma identidade de módulo para um dispositivo no IoTHub com a autoridade de certificação. |
| update_module_with_sas |
Atualizações uma identidade de módulo para um dispositivo no IoTHub com a autenticação SAS. |
| update_module_with_x509 |
Atualizações uma identidade de módulo para um dispositivo no IoTHub com a autenticação X509. |
| update_twin |
Atualizações etiquetas e propriedades pretendidas de um dispositivo duplo. |
bulk_create_or_update_devices
Crie, atualize ou elimine as identidades de vários dispositivos do registo de identidade do IoTHub.
Crie, atualize ou elimine as identidades de vários dispositivos do registo de identidade do IoTHub. Uma identidade de dispositivo só pode ser especificada uma vez na lista. São permitidas diferentes operações (criar, atualizar, eliminar) em diferentes dispositivos. Pode especificar um máximo de 100 dispositivos por invocação. Para operações de grande escala, considere utilizar a funcionalidade de importação com 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
| Name | Description |
|---|---|
|
devices
Necessário
|
A lista de objetos de dispositivo a operar. |
Devoluções
| 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 com 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
| Name | Description |
|---|---|
|
device_id
Necessário
|
O nome (ID) do dispositivo. |
|
status
Necessário
|
Estado inicial do dispositivo criado. (Valores possíveis: "ativado" ou "desativado"). |
|
iot_edge
|
Se o dispositivo criado é ou não um dispositivo IoT Edge. Valor predefinido: Falso valor predefinido: False
|
|
status_reason
|
O motivo do estado da identidade do dispositivo. Valor predefinido: Nenhum valor predefinido: None
|
|
device_scope
|
O âmbito do dispositivo. Valor predefinido: Nenhum é gerado automaticamente e imutável para dispositivos edge e modificável em dispositivos de folha para criar uma relação subordinada/principal. Para dispositivos de folha, o valor para definir um dispositivo edge principal pode ser obtido a partir da propriedade device_scope do dispositivo edge principal. valor predefinido: None
|
|
parent_scopes
|
Os âmbitos dos dispositivos edge de nível superior, se aplicável. Valor predefinido: Nenhum para dispositivos edge, o valor para definir um dispositivo edge principal pode ser obtido a partir da propriedade device_scope do dispositivo edge principal. Para dispositivos de folha, pode ser definido para o mesmo valor que device_scope ou restante para o serviço copiar. valor predefinido: None
|
Devoluções
| Tipo | Description |
|---|---|
|
Objeto do 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 com 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
| Name | Description |
|---|---|
|
device_id
Necessário
|
O nome (ID) do dispositivo. |
|
primary_key
Necessário
|
Chave de autenticação primária. |
|
secondary_key
Necessário
|
Chave de autenticação secundária. |
|
status
Necessário
|
Estado inicial do dispositivo criado. (Valores possíveis: "ativado" ou "desativado") |
|
iot_edge
|
Se o dispositivo criado é ou não um dispositivo IoT Edge. Valor predefinido: Falso valor predefinido: False
|
|
status_reason
|
O motivo do estado da identidade do dispositivo. Valor predefinido: Nenhum valor predefinido: None
|
|
device_scope
|
O âmbito do dispositivo. Valor predefinido: Nenhum é gerado automaticamente e imutável para dispositivos edge e modificável em dispositivos de folha para criar uma relação subordinada/principal. Para dispositivos de folha, o valor para definir um dispositivo edge principal pode ser obtido a partir da propriedade device_scope do dispositivo edge principal. valor predefinido: None
|
|
parent_scopes
|
Os âmbitos dos dispositivos edge de nível superior, se aplicável. Valor predefinido: Nenhum para dispositivos edge, o valor para definir um dispositivo edge principal pode ser obtido a partir da propriedade device_scope do dispositivo edge principal. Para dispositivos de folha, pode ser definido para o mesmo valor que device_scope ou restante para o serviço copiar. valor predefinido: None
|
Devoluções
| Tipo | Description |
|---|---|
|
Objeto do 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 com 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
| Name | Description |
|---|---|
|
device_id
Necessário
|
O nome (ID) do dispositivo. |
|
primary_thumbprint
Necessário
|
Thumbprint X509 primário. |
|
secondary_thumbprint
Necessário
|
Thumbprint X509 secundário. |
|
status
Necessário
|
Estado inicial do dispositivo criado. (Valores possíveis: "ativado" ou "desativado") |
|
iot_edge
|
Se o dispositivo criado é ou não um dispositivo IoT Edge. Valor predefinido: Falso valor predefinido: False
|
|
status_reason
|
O motivo do estado da identidade do dispositivo. Valor predefinido: Nenhum valor predefinido: None
|
|
device_scope
|
O âmbito do dispositivo. Valor predefinido: Nenhum é gerado automaticamente e imutável para dispositivos edge e modificável em dispositivos de folha para criar uma relação subordinada/principal. Para dispositivos de folha, o valor para definir um dispositivo edge principal pode ser obtido a partir da propriedade device_scope do dispositivo edge principal. valor predefinido: None
|
|
parent_scopes
|
Os âmbitos dos dispositivos edge de nível superior, se aplicável. Valor predefinido: Nenhum para dispositivos edge, o valor para definir um dispositivo edge principal pode ser obtido a partir da propriedade device_scope do dispositivo edge principal. Para dispositivos de folha, pode ser definido para o mesmo valor que device_scope ou restante para o serviço copiar. valor predefinido: None
|
Devoluções
| Tipo | Description |
|---|---|
|
Objeto do 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 com a autoridade de certificação.
create_module_with_certificate_authority(device_id, module_id, managed_by)Parâmetros
| Name | Description |
|---|---|
|
device_id
Necessário
|
O nome (ID) do dispositivo. |
|
module_id
Necessário
|
O nome (ID) do módulo. |
|
managed_by
Necessário
|
O nome do dispositivo de gestor (edge). |
Devoluções
| Tipo | Description |
|---|---|
|
Objeto de módulo 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 com a autenticação SAS.
create_module_with_sas(device_id, module_id, managed_by, primary_key, secondary_key)Parâmetros
| Name | Description |
|---|---|
|
device_id
Necessário
|
O nome (ID) do dispositivo. |
|
module_id
Necessário
|
O nome (ID) do módulo. |
|
managed_by
Necessário
|
O nome do dispositivo de gestor (edge). |
|
primary_key
Necessário
|
Chave de autenticação primária. |
|
secondary_key
Necessário
|
Chave de autenticação secundária. |
Devoluções
| Tipo | Description |
|---|---|
|
Objeto de módulo 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 com a autenticação X509.
create_module_with_x509(device_id, module_id, managed_by, primary_thumbprint, secondary_thumbprint)Parâmetros
| Name | Description |
|---|---|
|
device_id
Necessário
|
O nome (ID) do dispositivo. |
|
module_id
Necessário
|
O nome (ID) do módulo. |
|
managed_by
Necessário
|
O nome do dispositivo de gestor (edge). |
|
primary_thumbprint
Necessário
|
Thumbprint X509 primário. |
|
secondary_thumbprint
Necessário
|
Thumbprint X509 secundário. |
Devoluções
| Tipo | Description |
|---|---|
|
Objeto de módulo 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
Elimina uma identidade de dispositivo do IoTHub.
delete_device(device_id, etag=None)Parâmetros
| Name | Description |
|---|---|
|
device_id
Necessário
|
O nome (ID) do dispositivo. |
|
etag
|
O valor etag (if_match) a utilizar para a operação de eliminação. valor predefinido: None
|
Devoluções
| Tipo | Description |
|---|---|
|
Nenhum. |
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
delete_module
Elimina uma identidade de módulo para um dispositivo do IoTHub.
delete_module(device_id, module_id, etag=None)Parâmetros
| Name | Description |
|---|---|
|
device_id
Necessário
|
O nome (ID) do dispositivo. |
|
module_id
Necessário
|
O nome (ID) do módulo. |
|
etag
|
O valor etag (if_match) a utilizar para a operação de eliminação. valor predefinido: None
|
Devoluções
| 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 Gestor de Registo. Cria a classe Gestor de Registo a partir da cadeia de ligação.
Após uma criação bem-sucedida, a classe foi autenticada com o IoTHub e está pronta para chamar as APIs membros para comunicar com o IoTHub.
from_connection_string(connection_string)Parâmetros
| Name | Description |
|---|---|
|
connection_string
Necessário
|
A cadeia de ligação do IoTHub utilizada para autenticar a ligação com o IoTHub. |
Devoluções
| 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 Gestor de Registo. Cria a classe Gestor de Registo a partir do URL do nome do anfitrião e da 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 membros para comunicar com o IoTHub.
from_token_credential(url, token_credential)Parâmetros
| Name | Description |
|---|---|
|
url
Necessário
|
O URL do serviço do Azure (nome do anfitrião). |
|
token_credential
Necessário
|
<xref:azure.core.TokenCredential>
O objeto de credencial do token do Azure |
Devoluções
| Tipo | Description |
|---|---|
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
get_device
Obtém uma identidade de dispositivo do IoTHub.
get_device(device_id)Parâmetros
| Name | Description |
|---|---|
|
device_id
Necessário
|
O nome (ID) do dispositivo. |
Devoluções
| Tipo | Description |
|---|---|
|
O objeto Dispositivo que contém o dispositivo pedido. |
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
get_device_registry_statistics
Obtém as estatísticas do registo de dispositivos do IoTHub.
get_device_registry_statistics()Devoluções
| 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 a partir do registo de identidade do IoTHub. Não recomendada. Utilize a linguagem de consulta do IoTHub para obter as informações de identidade do dispositivo duplo 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
| Name | Description |
|---|---|
|
max_number_of_devices
|
Este parâmetro, quando especificado, define o número máximo de identidades de dispositivo que são devolvidas. Qualquer valor fora do intervalo de 1-1000 é considerado 1000 valor predefinido: None
|
Devoluções
| 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
Obtém uma identidade de módulo para um dispositivo a partir do IoTHub.
get_module(device_id, module_id)Parâmetros
| Name | Description |
|---|---|
|
device_id
Necessário
|
O nome (ID) do dispositivo. |
|
module_id
Necessário
|
O nome (ID) do módulo. |
Devoluções
| Tipo | Description |
|---|---|
|
O objeto Módulo que contém o módulo pedido. |
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
get_module_twin
Obtém um módulo duplo.
get_module_twin(device_id, module_id)Parâmetros
| Name | Description |
|---|---|
|
device_id
Necessário
|
O nome (ID) do dispositivo. |
|
module_id
Necessário
|
O nome (ID) do módulo. |
Devoluções
| Tipo | Description |
|---|---|
|
O objeto Duplo. |
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
get_modules
Obtém todas as identidades do módulo num dispositivo.
get_modules(device_id)Parâmetros
| Name | Description |
|---|---|
|
device_id
Necessário
|
O nome (ID) do dispositivo. |
Devoluções
| 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
Obtém as estatísticas do serviço IoTHub.
get_service_statistics()Devoluções
| 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 duplo.
get_twin(device_id)Parâmetros
| Name | Description |
|---|---|
|
device_id
Necessário
|
O nome (ID) do dispositivo. |
Devoluções
| Tipo | Description |
|---|---|
|
O objeto Duplo. |
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
invoke_device_method
Invocar um método direto num dispositivo.
invoke_device_method(device_id, direct_method_request)Parâmetros
| Name | Description |
|---|---|
|
device_id
Necessário
|
O nome (ID) do dispositivo. |
|
direct_method_request
Necessário
|
O pedido de método. |
Devoluções
| 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 num dispositivo.
invoke_device_module_method(device_id, module_id, direct_method_request)Parâmetros
| Name | Description |
|---|---|
|
device_id
Necessário
|
O nome (ID) do dispositivo. |
|
module_id
Necessário
|
O nome (ID) do módulo. |
|
direct_method_request
Necessário
|
O pedido de método. |
Devoluções
| 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 obter informações sobre dispositivos duplos com uma linguagem semelhante a SQL. Consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language para obter mais informações. A paginação de resultados é suportada. Esta ação devolve informações apenas sobre dispositivos duplos.
query_iot_hub(query_specification, continuation_token=None, max_item_count=None)Parâmetros
| Name | Description |
|---|---|
|
query
Necessário
|
A especificação da consulta. |
|
continuation_token
|
Token de continuação para paginação valor predefinido: None
|
|
max_item_count
|
Número máximo de dispositivos duplos pedidos valor predefinido: None
|
|
query_specification
Necessário
|
|
Devoluções
| 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 as etiquetas e as propriedades pretendidas de um módulo duplo.
replace_module_twin(device_id, module_id, module_twin, etag=None)Parâmetros
| Name | Description |
|---|---|
|
device_id
Necessário
|
O nome (ID) do dispositivo. |
|
module_id
Necessário
|
O nome (ID) do módulo. |
|
module_twin
Necessário
|
As informações dos duplos do módulo. |
|
etag
|
O valor etag (if_match) a utilizar para a operação de substituição. valor predefinido: None
|
Devoluções
| Tipo | Description |
|---|---|
|
O objeto Duplo. |
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
replace_twin
Substitui as etiquetas e as propriedades pretendidas de um dispositivo duplo.
replace_twin(device_id, device_twin, etag=None)Parâmetros
| Name | Description |
|---|---|
|
device_id
Necessário
|
O nome (ID) do dispositivo. |
|
device_twin
Necessário
|
As informações de duplos do dispositivo. |
|
etag
|
O valor etag (if_match) a utilizar para a operação de substituição. valor predefinido: None
|
Devoluções
| Tipo | Description |
|---|---|
|
O objeto Duplo. |
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
send_c2d_message
Enviar uma mensagem C2D para um Dispositivo IoTHub.
send_c2d_message(device_id, message, properties={})Parâmetros
| Name | Description |
|---|---|
|
device_id
Necessário
|
O nome (ID) do dispositivo. |
|
message
Necessário
|
A mensagem que será entregue no dispositivo. |
|
properties
|
As propriedades a enviar com a mensagem. Pode conter propriedades da aplicação e propriedades do sistema valor predefinido: {}
|
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 com 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
| Name | Description |
|---|---|
|
device_id
Necessário
|
O nome (ID) do dispositivo. |
|
etag
Necessário
|
O valor etag (if_match) a utilizar para a operação de atualização. |
|
status
Necessário
|
Estado inicial do dispositivo criado. (Valores possíveis: "ativado" ou "desativado"). |
|
iot_edge
|
Se o dispositivo criado é ou não um dispositivo IoT Edge. Valor predefinido: Falso valor predefinido: False
|
|
status_reason
|
O motivo do estado da identidade do dispositivo. Valor predefinido: Nenhum valor predefinido: None
|
|
device_scope
|
O âmbito do dispositivo. Valor predefinido: Nenhum é gerado automaticamente e imutável para dispositivos edge e modificável em dispositivos de folha para criar uma relação subordinada/principal. Para dispositivos de folha, o valor para definir um dispositivo edge principal pode ser obtido a partir da propriedade device_scope do dispositivo edge principal. valor predefinido: None
|
|
parent_scopes
|
Os âmbitos dos dispositivos edge de nível superior, se aplicável. Valor predefinido: Nenhum para dispositivos edge, o valor para definir um dispositivo edge principal pode ser obtido a partir da propriedade device_scope do dispositivo edge principal. Para dispositivos de folha, pode ser definido para o mesmo valor que device_scope ou restante para o serviço copiar. valor predefinido: None
|
Devoluções
| Tipo | Description |
|---|---|
|
O objeto Dispositivo 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 com 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
| Name | Description |
|---|---|
|
device_id
Necessário
|
O nome (ID) do dispositivo. |
|
etag
Necessário
|
O valor etag (if_match) a utilizar para a operação de atualização. |
|
primary_key
Necessário
|
Chave de autenticação primária. |
|
secondary_key
Necessário
|
Chave de autenticação secundária. |
|
status
Necessário
|
Estado inicial do dispositivo criado. (Valores possíveis: "ativado" ou "desativado"). |
|
iot_edge
|
Se o dispositivo criado é ou não um dispositivo IoT Edge. Valor predefinido: Falso valor predefinido: False
|
|
status_reason
|
O motivo do estado da identidade do dispositivo. Valor predefinido: Nenhum valor predefinido: None
|
|
device_scope
|
O âmbito do dispositivo. Valor predefinido: Nenhum é gerado automaticamente e imutável para dispositivos edge e modificável em dispositivos de folha para criar uma relação subordinada/principal. Para dispositivos de folha, o valor para definir um dispositivo edge principal pode ser obtido a partir da propriedade device_scope do dispositivo edge principal. valor predefinido: None
|
|
parent_scopes
|
Os âmbitos dos dispositivos edge de nível superior, se aplicável. Valor predefinido: Nenhum para dispositivos edge, o valor para definir um dispositivo edge principal pode ser obtido a partir da propriedade device_scope do dispositivo edge principal. Para dispositivos de folha, este valor pode ser definido para o mesmo valor que device_scope ou deixado para o serviço copiar. valor predefinido: None
|
Devoluções
| Tipo | Description |
|---|---|
|
O objeto dispositivo 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 com 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
| Name | Description |
|---|---|
|
device_id
Necessário
|
O nome (ID) do dispositivo. |
|
etag
Necessário
|
O valor de etag (if_match) a utilizar para a operação de atualização. |
|
primary_thumbprint
Necessário
|
Thumbprint X509 primário. |
|
secondary_thumbprint
Necessário
|
Thumbprint X509 secundário. |
|
status
Necessário
|
Estado inicial do dispositivo criado. (Valores possíveis: "ativado" ou "desativado"). |
|
iot_edge
|
Se o dispositivo criado é ou não um dispositivo IoT Edge. Valor predefinido: Falso valor predefinido: False
|
|
status_reason
|
O motivo do estado da identidade do dispositivo. Valor predefinido: Nenhum valor predefinido: None
|
|
device_scope
|
O âmbito do dispositivo. Valor predefinido: Nenhum auto gerado e imutável para dispositivos edge e modificável em dispositivos de folha para criar uma relação subordinada/principal. Para dispositivos de folha, o valor para definir um dispositivo edge principal pode ser obtido a partir da propriedade device_scope do dispositivo edge principal. valor predefinido: None
|
|
parent_scopes
|
Os âmbitos dos dispositivos edge de nível superior, se aplicável. Valor predefinido: Nenhum para dispositivos edge, o valor para definir um dispositivo edge principal pode ser obtido a partir da propriedade device_scope do dispositivo edge principal. Para dispositivos de folha, este valor pode ser definido para o mesmo valor que device_scope ou deixado para o serviço copiar. valor predefinido: None
|
Devoluções
| Tipo | Description |
|---|---|
|
O objeto dispositivo 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 etiquetas e propriedades pretendidas de um módulo duplo.
update_module_twin(device_id, module_id, module_twin, etag=None)Parâmetros
| Name | Description |
|---|---|
|
device_id
Necessário
|
O nome (ID) do dispositivo. |
|
module_id
Necessário
|
O nome (ID) do módulo. |
|
module_twin
Necessário
|
As informações de duplos do módulo. |
|
etag
|
O valor de etag (if_match) a utilizar para a operação de atualização. valor predefinido: None
|
Devoluções
| Tipo | Description |
|---|---|
|
O objeto Duplo. |
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 com a autoridade de certificação.
update_module_with_certificate_authority(device_id, module_id, managed_by, etag)Parâmetros
| Name | Description |
|---|---|
|
device_id
Necessário
|
O nome (ID) do dispositivo. |
|
module_id
Necessário
|
O nome (ID) do módulo. |
|
managed_by
Necessário
|
O nome do dispositivo do gestor (edge). |
|
etag
Necessário
|
O valor de etag (if_match) a utilizar para a operação de atualização. |
Devoluções
| Tipo | Description |
|---|---|
|
O objeto módulo 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 com a autenticação SAS.
update_module_with_sas(device_id, module_id, managed_by, etag, primary_key, secondary_key)Parâmetros
| Name | Description |
|---|---|
|
device_id
Necessário
|
O nome (ID) do dispositivo. |
|
module_id
Necessário
|
O nome (ID) do módulo. |
|
managed_by
Necessário
|
O nome do dispositivo do gestor (edge). |
|
etag
Necessário
|
O valor de etag (if_match) a utilizar para a operação de atualização. |
|
primary_key
Necessário
|
Chave de autenticação primária. |
|
secondary_key
Necessário
|
Chave de autenticação secundária. |
Devoluções
| Tipo | Description |
|---|---|
|
O objeto módulo 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 com a autenticação X509.
update_module_with_x509(device_id, module_id, managed_by, etag, primary_thumbprint, secondary_thumbprint)Parâmetros
| Name | Description |
|---|---|
|
device_id
Necessário
|
O nome (ID) do dispositivo. |
|
module_id
Necessário
|
O nome (ID) do módulo. |
|
managed_by
Necessário
|
O nome do dispositivo do gestor (edge). |
|
etag
Necessário
|
O valor de etag (if_match) a utilizar para a operação de atualização. |
|
primary_thumbprint
Necessário
|
Thumbprint X509 primário. |
|
secondary_thumbprint
Necessário
|
Thumbprint X509 secundário. |
Devoluções
| Tipo | Description |
|---|---|
|
O objeto módulo 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 etiquetas e propriedades pretendidas de um dispositivo duplo.
update_twin(device_id, device_twin, etag=None)Parâmetros
| Name | Description |
|---|---|
|
device_id
Necessário
|
O nome (ID) do dispositivo. |
|
device_twin
Necessário
|
As informações do dispositivo duplo. |
|
etag
|
O valor de etag (if_match) a utilizar para a operação de atualização. valor predefinido: None
|
Devoluções
| Tipo | Description |
|---|---|
|
O objeto Duplo. |
Exceções
| Tipo | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
Azure SDK for Python
Comentários
Brevemente: Ao longo de 2024, vamos descontinuar progressivamente o GitHub Issues como mecanismo de feedback para conteúdos e substituí-lo por um novo sistema de feedback. Para obter mais informações, veja: https://aka.ms/ContentUserFeedback.
Submeter e ver comentários