Condividi tramite

IoTHubRegistryManager Classe

  • Riferimento

Classe per fornire API utili per le operazioni di Gestione registro IoTHub, in base alle API REST IotHub generate automaticamente

Inizializzatore per un client del servizio Registry Manager.

Gli utenti non devono chiamarlo direttamente. Devono invece usare i metodi factory from_connection_string() o from_token_credential().

Dopo aver creato correttamente la classe è stata autenticata con IoTHub ed è pronta per chiamare le API membro per comunicare con IoTHub.

Ereditarietà
builtins.object
IoTHubRegistryManager

Costruttore

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

Parametri

Nome Descrizione
connection_string
str

La stringa di connessione IoTHub usata per autenticare la connessione con IoTHub se si usa connection_str autenticazione. Valore predefinito: Nessuno

valore predefinito: None
host
str

Url del servizio di Azure se si usa l'autenticazione delle credenziali del token. Valore predefinito: Nessuno

valore predefinito: None
auth
Necessario
str

Oggetto di autenticazione di Azure se si usa l'autenticazione delle credenziali del token. Valore predefinito: Nessuno
token_credential
valore predefinito: None

Metodi

bulk_create_or_update_devices

Creare, aggiornare o eliminare le identità di più dispositivi dal Registro di sistema di identità IoTHub.

Creare, aggiornare o eliminare le identità di più dispositivi dal Registro di sistema di identità IoTHub. Un'identità del dispositivo può essere specificata una sola volta nell'elenco. Sono consentite operazioni diverse (creare, aggiornare, eliminare) in dispositivi diversi. È possibile specificare un massimo di 100 dispositivi per chiamata. Per le operazioni su larga scala, è consigliabile usare la funzionalità di importazione usando archiviazione BLOB(https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities).
create_device_with_certificate_authority

Crea un'identità del dispositivo in IoTHub usando l'autorità di certificazione.
create_device_with_sas

Crea un'identità del dispositivo in IoTHub usando l'autenticazione sas.
create_device_with_x509

Crea un'identità del dispositivo in IoTHub usando l'autenticazione X509.
create_module_with_certificate_authority

Crea un'identità del modulo per un dispositivo in IoTHub usando l'autorità di certificazione.
create_module_with_sas

Crea un'identità del modulo per un dispositivo in IoTHub usando l'autenticazione sas.
create_module_with_x509

Crea un'identità del modulo per un dispositivo in IoTHub usando l'autenticazione X509.
delete_device

Elimina un'identità del dispositivo da IoTHub.
delete_module

Elimina un'identità del modulo per un dispositivo da IoTHub.
from_connection_string

Inizializzatore classmethod per un client del servizio Di Gestione registro. Crea la classe Di Gestione registro dalla stringa di connessione.

Dopo aver completato la creazione, la classe è stata autenticata con IoTHub ed è pronta per chiamare le API membro per comunicare con IoTHub.
from_token_credential

Inizializzatore classmethod per un client del servizio Di Gestione registro. Crea la classe Di Gestione registro dall'URL del nome host e dalle credenziali del token di Azure.

Dopo aver completato la creazione, la classe è stata autenticata con IoTHub ed è pronta per chiamare le API membro per comunicare con IoTHub.
get_device

Recupera un'identità del dispositivo da IoTHub.
get_device_registry_statistics

Recupera le statistiche del Registro di sistema dei dispositivi IoTHub.
get_devices

Ottenere le identità di più dispositivi dal Registro di sistema di identità IoTHub. Non consigliato. Usare il linguaggio di query IoTHub per recuperare le informazioni sull'identità del dispositivo gemello e del dispositivo. Per altre informazioni, vedere 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.
get_module

Recupera un'identità del modulo per un dispositivo da IoTHub.
get_module_twin

Ottiene un modulo gemello.
get_modules

Recupera tutte le identità del modulo in un dispositivo.
get_service_statistics

Recupera le statistiche del servizio IoTHub.
get_twin

Ottiene un dispositivo gemello.
invoke_device_method

Richiamare un metodo diretto in un dispositivo.
invoke_device_module_method

Richiamare un metodo diretto in un dispositivo.
query_iot_hub

Eseguire una query su IoTHub per recuperare informazioni relative ai dispositivi gemelli usando un linguaggio simile a SQL. Per altre informazioni, vedere https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language. La paginazione dei risultati è supportata. In questo modo vengono restituite informazioni solo sui dispositivi gemelli.
replace_module_twin

Sostituisce i tag e le proprietà desiderate di un modulo gemello.
replace_twin

Sostituisce i tag e le proprietà desiderate di un dispositivo gemello.
send_c2d_message

Inviare un messaggio C2D a un dispositivo IoTHub.
update_device_with_certificate_authority

Aggiornamenti un'identità del dispositivo in IoTHub usando l'autorità di certificazione.
update_device_with_sas

Aggiornamenti un'identità del dispositivo in IoTHub usando l'autenticazione sas.
update_device_with_x509

Aggiornamenti un'identità del dispositivo in IoTHub usando l'autenticazione X509.
update_module_twin

Aggiornamenti tag e proprietà desiderate di un modulo gemello.
update_module_with_certificate_authority

Aggiornamenti un'identità del modulo per un dispositivo in IoTHub usando l'autorità di certificazione.
update_module_with_sas

Aggiornamenti un'identità del modulo per un dispositivo in IoTHub usando l'autenticazione sas.
update_module_with_x509

Aggiornamenti un'identità del modulo per un dispositivo in IoTHub usando l'autenticazione X509.
update_twin

Aggiornamenti tag e proprietà desiderate di un dispositivo gemello.

bulk_create_or_update_devices

Creare, aggiornare o eliminare le identità di più dispositivi dal Registro di sistema di identità IoTHub.

Creare, aggiornare o eliminare le identità di più dispositivi dal Registro di sistema di identità IoTHub. Un'identità del dispositivo può essere specificata una sola volta nell'elenco. Sono consentite operazioni diverse (creare, aggiornare, eliminare) in dispositivi diversi. È possibile specificare un massimo di 100 dispositivi per chiamata. Per le operazioni su larga scala, è consigliabile usare la funzionalità di importazione usando archiviazione BLOB(https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities).

bulk_create_or_update_devices(devices)

Parametri

Nome Descrizione
devices
Necessario
list[ExportImportDevice]

Elenco di oggetti dispositivo su cui operare.

Restituisce

Tipo Descrizione

Oggetto BulkRegistryOperationResult.

Eccezioni

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

create_device_with_certificate_authority

Crea un'identità del dispositivo in IoTHub usando l'autorità di certificazione.

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

Parametri

Nome Descrizione
device_id
Necessario
str

Nome (ID) del dispositivo.
status
Necessario
str

Stato iniziale del dispositivo creato. (Valori possibili: "abilitato" o "disabilitato").
iot_edge
bool

Indipendentemente dal fatto che il dispositivo creato sia un dispositivo IoT Edge. Valore predefinito: False

valore predefinito: False
status_reason
str

Motivo dello stato dell'identità del dispositivo. Valore predefinito: Nessuno

valore predefinito: None
device_scope
str

Ambito del dispositivo. Valore predefinito: nessuna auto generata e non modificabile per i dispositivi perimetrali e modificabile nei dispositivi foglia per creare una relazione figlio/padre. Per i dispositivi foglia, il valore per impostare un dispositivo perimetrale padre può essere recuperato dalla proprietà device_scope del dispositivo perimetrale padre.

valore predefinito: None
parent_scopes
Union[list[str], str]

Se applicabile, gli ambiti dei dispositivi perimetrali di livello superiore. Valore predefinito: nessuna per i dispositivi perimetrali, il valore per impostare un dispositivo perimetrale padre può essere recuperato dalla proprietà device_scope del dispositivo perimetrale padre. Per i dispositivi foglia, è possibile impostare lo stesso valore di device_scope o sinistro per il servizio da copiare.

valore predefinito: None

Restituisce

Tipo Descrizione

Oggetto Device contenente il dispositivo creato.

Eccezioni

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

create_device_with_sas

Crea un'identità del dispositivo in IoTHub usando l'autenticazione sas.

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

Parametri

Nome Descrizione
device_id
Necessario
str

Nome (ID) del dispositivo.
primary_key
Necessario
str

Chiave di autenticazione primaria.
secondary_key
Necessario
str

Chiave di autenticazione secondaria.
status
Necessario
str

Stato iniziale del dispositivo creato. (Valori possibili: "abilitato" o "disabilitato")
iot_edge
bool

Indipendentemente dal fatto che il dispositivo creato sia un dispositivo IoT Edge. Valore predefinito: False

valore predefinito: False
status_reason
str

Motivo dello stato dell'identità del dispositivo. Valore predefinito: Nessuno

valore predefinito: None
device_scope
str

Ambito del dispositivo. Valore predefinito: nessuna auto generata e non modificabile per i dispositivi perimetrali e modificabile nei dispositivi foglia per creare una relazione figlio/padre. Per i dispositivi foglia, il valore per impostare un dispositivo perimetrale padre può essere recuperato dalla proprietà device_scope del dispositivo perimetrale padre.

valore predefinito: None
parent_scopes
Union[list[str], str]

Se applicabile, gli ambiti dei dispositivi perimetrali di livello superiore. Valore predefinito: nessuna per i dispositivi perimetrali, il valore per impostare un dispositivo perimetrale padre può essere recuperato dalla proprietà device_scope del dispositivo perimetrale padre. Per i dispositivi foglia, è possibile impostare lo stesso valore di device_scope o sinistro per il servizio da copiare.

valore predefinito: None

Restituisce

Tipo Descrizione

Oggetto Device contenente il dispositivo creato.

Eccezioni

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

create_device_with_x509

Crea un'identità del dispositivo in IoTHub usando l'autenticazione X509.

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

Parametri

Nome Descrizione
device_id
Necessario
str

Nome (ID) del dispositivo.
primary_thumbprint
Necessario
str

Identificazione personale X509 primaria.
secondary_thumbprint
Necessario
str

Identificazione personale X509 secondaria.
status
Necessario
str

Stato iniziale del dispositivo creato. (Valori possibili: "abilitato" o "disabilitato")
iot_edge
bool

Indipendentemente dal fatto che il dispositivo creato sia un dispositivo IoT Edge. Valore predefinito: False

valore predefinito: False
status_reason
str

Motivo dello stato dell'identità del dispositivo. Valore predefinito: Nessuno

valore predefinito: None
device_scope
str

Ambito del dispositivo. Valore predefinito: nessuna auto generata e non modificabile per i dispositivi perimetrali e modificabile nei dispositivi foglia per creare una relazione figlio/padre. Per i dispositivi foglia, il valore per impostare un dispositivo perimetrale padre può essere recuperato dalla proprietà device_scope del dispositivo perimetrale padre.

valore predefinito: None
parent_scopes
Union[list[str], str]

Se applicabile, gli ambiti dei dispositivi perimetrali di livello superiore. Valore predefinito: nessuna per i dispositivi perimetrali, il valore per impostare un dispositivo perimetrale padre può essere recuperato dalla proprietà device_scope del dispositivo perimetrale padre. Per i dispositivi foglia, è possibile impostare lo stesso valore di device_scope o sinistro per il servizio da copiare.

valore predefinito: None

Restituisce

Tipo Descrizione

Oggetto Device contenente il dispositivo creato.

Eccezioni

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

create_module_with_certificate_authority

Crea un'identità del modulo per un dispositivo in IoTHub usando l'autorità di certificazione.

create_module_with_certificate_authority(device_id, module_id, managed_by)

Parametri

Nome Descrizione
device_id
Necessario
str

Nome (ID) del dispositivo.
module_id
Necessario
str

Nome (ID) del modulo.
managed_by
Necessario
str

Nome del dispositivo di gestione (bordo).

Restituisce

Tipo Descrizione

Oggetto module contenente il modulo creato.

Eccezioni

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

create_module_with_sas

Crea un'identità del modulo per un dispositivo in IoTHub usando l'autenticazione sas.

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

Parametri

Nome Descrizione
device_id
Necessario
str

Nome (ID) del dispositivo.
module_id
Necessario
str

Nome (ID) del modulo.
managed_by
Necessario
str

Nome del dispositivo di gestione (bordo).
primary_key
Necessario
str

Chiave di autenticazione primaria.
secondary_key
Necessario
str

Chiave di autenticazione secondaria.

Restituisce

Tipo Descrizione

Oggetto module contenente il modulo creato.

Eccezioni

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

create_module_with_x509

Crea un'identità del modulo per un dispositivo in IoTHub usando l'autenticazione X509.

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

Parametri

Nome Descrizione
device_id
Necessario
str

Nome (ID) del dispositivo.
module_id
Necessario
str

Nome (ID) del modulo.
managed_by
Necessario
str

Nome del dispositivo di gestione (bordo).
primary_thumbprint
Necessario
str

Identificazione personale X509 primaria.
secondary_thumbprint
Necessario
str

Identificazione personale X509 secondaria.

Restituisce

Tipo Descrizione

Oggetto module contenente il modulo creato.

Eccezioni

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

delete_device

Elimina un'identità del dispositivo da IoTHub.

delete_device(device_id, etag=None)

Parametri

Nome Descrizione
device_id
Necessario
str

Nome (ID) del dispositivo.
etag
str

Valore etag (if_match) da usare per l'operazione di eliminazione.

valore predefinito: None

Restituisce

Tipo Descrizione

Nessuno.

Eccezioni

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

delete_module

Elimina un'identità del modulo per un dispositivo da IoTHub.

delete_module(device_id, module_id, etag=None)

Parametri

Nome Descrizione
device_id
Necessario
str

Nome (ID) del dispositivo.
module_id
Necessario
str

Nome (ID) del modulo.
etag
str

Valore etag (if_match) da usare per l'operazione di eliminazione.

valore predefinito: None

Restituisce

Tipo Descrizione

Nessuno.

Eccezioni

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

from_connection_string

Inizializzatore classmethod per un client del servizio Di Gestione registro. Crea la classe Di Gestione registro dalla stringa di connessione.

Dopo aver completato la creazione, la classe è stata autenticata con IoTHub ed è pronta per chiamare le API membro per comunicare con IoTHub.

from_connection_string(connection_string)

Parametri

Nome Descrizione
connection_string
Necessario
str

Stringa di connessione IoTHub usata per autenticare la connessione con IoTHub.

Restituisce

Tipo Descrizione
IoTHubRegistryManager

Eccezioni

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

from_token_credential

Inizializzatore classmethod per un client del servizio Di Gestione registro. Crea la classe Di Gestione registro dall'URL del nome host e dalle credenziali del token di Azure.

Dopo aver completato la creazione, la classe è stata autenticata con IoTHub ed è pronta per chiamare le API membro per comunicare con IoTHub.

from_token_credential(url, token_credential)

Parametri

Nome Descrizione
url
Necessario
str

URL del servizio di Azure (nome host).
token_credential
Necessario
<xref:azure.core.TokenCredential>

Oggetto credenziali del token di Azure

Restituisce

Tipo Descrizione
IoTHubRegistryManager

Eccezioni

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

get_device

Recupera un'identità del dispositivo da IoTHub.

get_device(device_id)

Parametri

Nome Descrizione
device_id
Necessario
str

Nome (ID) del dispositivo.

Restituisce

Tipo Descrizione

Oggetto Device contenente il dispositivo richiesto.

Eccezioni

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

get_device_registry_statistics

Recupera le statistiche del Registro di sistema dei dispositivi IoTHub.

get_device_registry_statistics()

Restituisce

Tipo Descrizione

Oggetto RegistryStatistics.

Eccezioni

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

get_devices

Ottenere le identità di più dispositivi dal Registro di sistema di identità IoTHub. Non consigliato. Usare il linguaggio di query IoTHub per recuperare le informazioni sull'identità del dispositivo gemello e del dispositivo. Per altre informazioni, vedere 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.

get_devices(max_number_of_devices=None)

Parametri

Nome Descrizione
max_number_of_devices
int

Questo parametro quando specificato definisce il numero massimo di identità del dispositivo restituite. Qualsiasi valore esterno all'intervallo di 1-1000 viene considerato come 1000

valore predefinito: None

Restituisce

Tipo Descrizione

Elenco delle informazioni sul dispositivo.

Eccezioni

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

get_module

Recupera un'identità del modulo per un dispositivo da IoTHub.

get_module(device_id, module_id)

Parametri

Nome Descrizione
device_id
Necessario
str

Nome (ID) del dispositivo.
module_id
Necessario
str

Nome (ID) del modulo.

Restituisce

Tipo Descrizione

Oggetto Module contenente il modulo richiesto.

Eccezioni

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

get_module_twin

Ottiene un modulo gemello.

get_module_twin(device_id, module_id)

Parametri

Nome Descrizione
device_id
Necessario
str

Nome (ID) del dispositivo.
module_id
Necessario
str

Nome (ID) del modulo.

Restituisce

Tipo Descrizione

Oggetto Twin.

Eccezioni

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

get_modules

Recupera tutte le identità del modulo in un dispositivo.

get_modules(device_id)

Parametri

Nome Descrizione
device_id
Necessario
str

Nome (ID) del dispositivo.

Restituisce

Tipo Descrizione

Elenco[Modulo] contenente tutti i moduli nel dispositivo.

Eccezioni

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

get_service_statistics

Recupera le statistiche del servizio IoTHub.

get_service_statistics()

Restituisce

Tipo Descrizione

Oggetto ServiceStatistics.

Eccezioni

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

get_twin

Ottiene un dispositivo gemello.

get_twin(device_id)

Parametri

Nome Descrizione
device_id
Necessario
str

Nome (ID) del dispositivo.

Restituisce

Tipo Descrizione

Oggetto Twin.

Eccezioni

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

invoke_device_method

Richiamare un metodo diretto in un dispositivo.

invoke_device_method(device_id, direct_method_request)

Parametri

Nome Descrizione
device_id
Necessario
str

Nome (ID) del dispositivo.
direct_method_request
Necessario
CloudToDeviceMethod

Richiesta di metodo.

Restituisce

Tipo Descrizione

Oggetto CloudToDeviceMethodResult.

Eccezioni

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

invoke_device_module_method

Richiamare un metodo diretto in un dispositivo.

invoke_device_module_method(device_id, module_id, direct_method_request)

Parametri

Nome Descrizione
device_id
Necessario
str

Nome (ID) del dispositivo.
module_id
Necessario
str

Nome (ID) del modulo.
direct_method_request
Necessario
CloudToDeviceMethod

Richiesta di metodo.

Restituisce

Tipo Descrizione

Oggetto CloudToDeviceMethodResult.

Eccezioni

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

query_iot_hub

Eseguire una query su IoTHub per recuperare informazioni relative ai dispositivi gemelli usando un linguaggio simile a SQL. Per altre informazioni, vedere https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language. La paginazione dei risultati è supportata. In questo modo vengono restituite informazioni solo sui dispositivi gemelli.

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

Parametri

Nome Descrizione
query
Necessario
QuerySpecification

Specifica della query.
continuation_token
str

Token di continuazione per il paging

valore predefinito: None
max_item_count
str

Numero massimo di dispositivi gemelli richiesti

valore predefinito: None
query_specification
Necessario

Restituisce

Tipo Descrizione

Oggetto QueryResult.

Eccezioni

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

replace_module_twin

Sostituisce i tag e le proprietà desiderate di un modulo gemello.

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

Parametri

Nome Descrizione
device_id
Necessario
str

Nome (ID) del dispositivo.
module_id
Necessario
str

Nome (ID) del modulo.
module_twin
Necessario
Twin

Informazioni gemelle del modulo.
etag
str

Valore etag (if_match) da usare per l'operazione di sostituzione.

valore predefinito: None

Restituisce

Tipo Descrizione

Oggetto Twin.

Eccezioni

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

replace_twin

Sostituisce i tag e le proprietà desiderate di un dispositivo gemello.

replace_twin(device_id, device_twin, etag=None)

Parametri

Nome Descrizione
device_id
Necessario
str

Nome (ID) del dispositivo.
device_twin
Necessario
Twin

Informazioni gemelle del dispositivo.
etag
str

Valore etag (if_match) da usare per l'operazione di sostituzione.

valore predefinito: None

Restituisce

Tipo Descrizione

Oggetto Twin.

Eccezioni

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

send_c2d_message

Inviare un messaggio C2D a un dispositivo IoTHub.

send_c2d_message(device_id, message, properties={})

Parametri

Nome Descrizione
device_id
Necessario
str

Nome (ID) del dispositivo.
message
Necessario
str

Messaggio che deve essere recapitato al dispositivo.
properties
dict

Proprietà da inviare con il messaggio. Può contenere proprietà e proprietà di sistema dell'applicazione

valore predefinito: {}

Eccezioni

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

update_device_with_certificate_authority

Aggiornamenti un'identità del dispositivo in IoTHub usando l'autorità di certificazione.

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

Parametri

Nome Descrizione
device_id
Necessario
str

Nome (ID) del dispositivo.
etag
Necessario
str

Valore etag (if_match) da usare per l'operazione di aggiornamento.
status
Necessario
str

Stato iniziale del dispositivo creato. (Valori possibili: "abilitato" o "disabilitato").
iot_edge
bool

Indipendentemente dal fatto che il dispositivo creato sia un dispositivo IoT Edge. Valore predefinito: False

valore predefinito: False
status_reason
str

Motivo dello stato dell'identità del dispositivo. Valore predefinito: Nessuno

valore predefinito: None
device_scope
str

Ambito del dispositivo. Valore predefinito: nessuna auto generata e non modificabile per i dispositivi perimetrali e modificabile nei dispositivi foglia per creare una relazione figlio/padre. Per i dispositivi foglia, il valore per impostare un dispositivo perimetrale padre può essere recuperato dalla proprietà device_scope del dispositivo perimetrale padre.

valore predefinito: None
parent_scopes
Union[list[str], str]

Se applicabile, gli ambiti dei dispositivi perimetrali di livello superiore. Valore predefinito: nessuna per i dispositivi perimetrali, il valore per impostare un dispositivo perimetrale padre può essere recuperato dalla proprietà device_scope del dispositivo perimetrale padre. Per i dispositivi foglia, è possibile impostare lo stesso valore di device_scope o sinistro per il servizio da copiare.

valore predefinito: None

Restituisce

Tipo Descrizione

Oggetto Device aggiornato contenente il dispositivo creato.

Eccezioni

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

update_device_with_sas

Aggiornamenti un'identità del dispositivo in IoTHub usando l'autenticazione 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)

Parametri

Nome Descrizione
device_id
Necessario
str

Nome (ID) del dispositivo.
etag
Necessario
str

Valore etag (if_match) da usare per l'operazione di aggiornamento.
primary_key
Necessario
str

Chiave di autenticazione primaria.
secondary_key
Necessario
str

Chiave di autenticazione secondaria.
status
Necessario
str

Stato iniziale del dispositivo creato. (Valori possibili: "abilitato" o "disabilitato").
iot_edge
bool

Indipendentemente dal fatto che il dispositivo creato sia un dispositivo IoT Edge. Valore predefinito: False

valore predefinito: False
status_reason
str

Motivo dello stato dell'identità del dispositivo. Valore predefinito: Nessuno

valore predefinito: None
device_scope
str

Ambito del dispositivo. Valore predefinito: nessuno generato automaticamente e non modificabile per i dispositivi perimetrali e modificabile nei dispositivi foglia per creare una relazione figlio/padre. Per i dispositivi foglia, il valore per impostare un dispositivo perimetrale padre può essere recuperato dalla proprietà device_scope del dispositivo perimetrale padre.

valore predefinito: None
parent_scopes
Union[list[str], str]

Ambiti dei dispositivi perimetrali di livello superiore, se applicabile. Valore predefinito: nessuno Per i dispositivi perimetrali, il valore per impostare un dispositivo perimetrale padre può essere recuperato dalla proprietà device_scope del dispositivo perimetrale padre. Per i dispositivi foglia, questo valore può essere impostato sullo stesso valore di device_scope o lasciato per il servizio da copiare.For leaf devices, this could be set to the same value as device_scope or left for the service to copy over.

valore predefinito: None

Restituisce

Tipo Descrizione

Oggetto Device aggiornato contenente il dispositivo creato.

Eccezioni

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

update_device_with_x509

Aggiornamenti un'identità del dispositivo in IoTHub usando l'autenticazione 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)

Parametri

Nome Descrizione
device_id
Necessario
str

Nome (ID) del dispositivo.
etag
Necessario
str

Valore etag (if_match) da usare per l'operazione di aggiornamento.
primary_thumbprint
Necessario
str

Identificazione personale X509 primaria.
secondary_thumbprint
Necessario
str

Identificazione personale X509 secondaria.
status
Necessario
str

Stato iniziale del dispositivo creato. (Valori possibili: "enabled" o "disabled").
iot_edge
bool

Indica se il dispositivo creato è un dispositivo IoT Edge. Valore predefinito: False

valore predefinito: False
status_reason
str

Motivo dello stato dell'identità del dispositivo. Valore predefinito: Nessuno

valore predefinito: None
device_scope
str

Ambito del dispositivo. Valore predefinito: nessuno generato automaticamente e non modificabile per i dispositivi perimetrali e modificabile nei dispositivi foglia per creare una relazione figlio/padre. Per i dispositivi foglia, il valore per impostare un dispositivo perimetrale padre può essere recuperato dalla proprietà device_scope del dispositivo perimetrale padre.

valore predefinito: None
parent_scopes
Union[list[str], str]

Ambiti dei dispositivi perimetrali di livello superiore, se applicabile. Valore predefinito: nessuno Per i dispositivi perimetrali, il valore per impostare un dispositivo perimetrale padre può essere recuperato dalla proprietà device_scope del dispositivo perimetrale padre. Per i dispositivi foglia, questo valore può essere impostato sullo stesso valore di device_scope o lasciato per il servizio da copiare.For leaf devices, this could be set to the same value as device_scope or left for the service to copy over.

valore predefinito: None

Restituisce

Tipo Descrizione

Oggetto Device aggiornato contenente il dispositivo creato.

Eccezioni

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

update_module_twin

Aggiornamenti tag e proprietà desiderate di un modulo gemello.

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

Parametri

Nome Descrizione
device_id
Necessario
str

Nome (ID) del dispositivo.
module_id
Necessario
str

Nome (ID) del modulo.
module_twin
Necessario
Twin

Informazioni sul modulo gemello.
etag
str

Valore etag (if_match) da usare per l'operazione di aggiornamento.

valore predefinito: None

Restituisce

Tipo Descrizione

Oggetto Twin.

Eccezioni

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

update_module_with_certificate_authority

Aggiornamenti un'identità del modulo per un dispositivo in IoTHub usando l'autorità di certificazione.

update_module_with_certificate_authority(device_id, module_id, managed_by, etag)

Parametri

Nome Descrizione
device_id
Necessario
str

Nome (ID) del dispositivo.
module_id
Necessario
str

Nome (ID) del modulo.
managed_by
Necessario
str

Nome del dispositivo manager (edge).
etag
Necessario
str

Valore etag (if_match) da usare per l'operazione di aggiornamento.

Restituisce

Tipo Descrizione

Oggetto Module aggiornato contenente il modulo creato.

Eccezioni

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

update_module_with_sas

Aggiornamenti un'identità del modulo per un dispositivo in IoTHub usando l'autenticazione sas.

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

Parametri

Nome Descrizione
device_id
Necessario
str

Nome (ID) del dispositivo.
module_id
Necessario
str

Nome (ID) del modulo.
managed_by
Necessario
str

Nome del dispositivo manager (edge).
etag
Necessario
str

Valore etag (if_match) da usare per l'operazione di aggiornamento.
primary_key
Necessario
str

Chiave di autenticazione primaria.
secondary_key
Necessario
str

Chiave di autenticazione secondaria.

Restituisce

Tipo Descrizione

Oggetto Module aggiornato contenente il modulo creato.

Eccezioni

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

update_module_with_x509

Aggiornamenti un'identità del modulo per un dispositivo in IoTHub usando l'autenticazione X509.

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

Parametri

Nome Descrizione
device_id
Necessario
str

Nome (ID) del dispositivo.
module_id
Necessario
str

Nome (ID) del modulo.
managed_by
Necessario
str

Nome del dispositivo manager (edge).
etag
Necessario
str

Valore etag (if_match) da usare per l'operazione di aggiornamento.
primary_thumbprint
Necessario
str

Identificazione personale X509 primaria.
secondary_thumbprint
Necessario
str

Identificazione personale X509 secondaria.

Restituisce

Tipo Descrizione

Oggetto Module aggiornato contenente il modulo creato.

Eccezioni

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

update_twin

Aggiornamenti tag e proprietà desiderate di un dispositivo gemello.

update_twin(device_id, device_twin, etag=None)

Parametri

Nome Descrizione
device_id
Necessario
str

Nome (ID) del dispositivo.
device_twin
Necessario
Twin

Informazioni sul dispositivo gemello.
etag
str

Valore etag (if_match) da usare per l'operazione di aggiornamento.

valore predefinito: None

Restituisce

Tipo Descrizione

Oggetto Twin.

Eccezioni

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