DigitalTwinsClient Classe
Crea un'istanza del client Gemelli digitali.
- Ereditarietà
-
builtins.objectDigitalTwinsClient
Costruttore
DigitalTwinsClient(endpoint: str, credential: TokenCredential, **kwargs: Any)Parametri
Metodi
| create_models |
Creare uno o più modelli. Quando si verifica un errore, non vengono caricati modelli. |
| decommission_model |
Rimuove un modello. |
| delete_digital_twin |
Eliminare un gemello digitale. |
| delete_event_route |
Eliminare una route evento. |
| delete_model |
Eliminare un modello. |
| delete_relationship |
Eliminare una relazione su un gemello digitale. |
| get_component |
Ottenere un componente su un gemello digitale. |
| get_digital_twin |
Ottenere un gemello digitale. |
| get_event_route |
Ottenere una route di eventi. |
| get_model |
Ottenere un modello, inclusi i metadati del modello e la definizione del modello. |
| get_relationship |
Ottenere una relazione su un gemello digitale. |
| list_event_routes |
Recupera tutte le route degli eventi. |
| list_incoming_relationships |
Recuperare tutte le relazioni in ingresso per un gemello digitale. |
| list_models |
Ottenere l'elenco dei modelli. |
| list_relationships |
Recuperare le relazioni per un gemello digitale. |
| publish_component_telemetry |
Pubblicare i dati di telemetria dal componente di un gemello digitale, che viene quindi utilizzato da uno o più endpoint di destinazione (sottoscrittori) definiti in . |
| publish_telemetry |
Pubblicare i dati di telemetria da un gemello digitale, che viene quindi utilizzato da uno o più endpoint di destinazione (sottoscrittori) definiti in . |
| query_twins |
Eseguire una query per gemelli digitali. Nota: potrebbe verificarsi un ritardo tra le modifiche apportate all'istanza nelle query. Per altre informazioni sulle limitazioni delle query, vedere https://docs.microsoft.com/azure/digital-twins/how-to-query-graph#query-limitations |
| update_component |
Aggiornare le proprietà di un componente in un gemello digitale usando una patch JSON. |
| update_digital_twin |
Aggiornare un gemello digitale usando una patch JSON. |
| update_relationship |
Aggiornamenti le proprietà di una relazione su un gemello digitale usando una patch JSON. |
| upsert_digital_twin |
Creare o aggiornare un gemello digitale. |
| upsert_event_route |
Creare o aggiornare una route di eventi. |
| upsert_relationship |
Creare o aggiornare una relazione su un gemello digitale. |
create_models
Creare uno o più modelli. Quando si verifica un errore, non vengono caricati modelli.
create_models(dtdl_models: List[Dict[str, object]], **kwargs: Any) -> List[DigitalTwinsModelData]Parametri
Set di modelli da creare. Ogni dict corrisponde esattamente a un modello.
Restituisce
Elenco dei modelli creati.
Tipo restituito
Eccezioni
Esiste già uno o più modelli forniti.
decommission_model
Rimuove un modello.
decommission_model(model_id: str, **kwargs: Any) -> NoneParametri
- model_id
- str
ID per il modello. L'ID è univoco a livello globale e distinzione tra maiuscole e minuscole.
Restituisce
Nessuno
Tipo restituito
Eccezioni
Non esiste alcun modello con l'ID specificato.
delete_digital_twin
Eliminare un gemello digitale.
delete_digital_twin(digital_twin_id: str, **kwargs: Any) -> NoneParametri
- match_condition
- MatchConditions
Condizione in base alla quale eseguire l'operazione.
- etag
- str
Eseguire l'operazione solo se l'etag dell'entità corrisponde al valore specificato in base al match_condition.
Restituisce
Nessuno
Tipo restituito
Eccezioni
Se non è presente alcun gemello digitale con l'ID specificato.
delete_event_route
Eliminare una route evento.
delete_event_route(event_route_id: str, **kwargs: Any) -> NoneParametri
Restituisce
Nessuno
Tipo restituito
Eccezioni
Non esiste alcuna route evento con l'ID specificato.
delete_model
Eliminare un modello.
delete_model(model_id: str, **kwargs: Any) -> NoneParametri
Restituisce
Nessuno
Tipo restituito
Eccezioni
Non esiste alcun modello con l'ID specificato.
Esistono dipendenze sul modello che impediscono l'eliminazione.
delete_relationship
Eliminare una relazione su un gemello digitale.
delete_relationship(digital_twin_id: str, relationship_id: str, **kwargs: Any) -> NoneParametri
- match_condition
- MatchConditions
Condizione in base alla quale eseguire l'operazione.
- etag
- str
Eseguire l'operazione solo se l'etag dell'entità corrisponde al valore specificato in base al match_condition.
Restituisce
Nessuno
Tipo restituito
Eccezioni
Se non esiste alcuna relazione o gemello digitale con l'ID specificato.
get_component
Ottenere un componente su un gemello digitale.
get_component(digital_twin_id: str, component_name: str, **kwargs: Any) -> Dict[str, object]Parametri
Restituisce
Dizionario contenente il componente.
Tipo restituito
Eccezioni
Se non è presente alcun gemello digitale con l'ID specificato o il nome del componente non è valido.
get_digital_twin
Ottenere un gemello digitale.
get_digital_twin(digital_twin_id: str, **kwargs: Any) -> Dict[str, object]Parametri
Restituisce
Dizionario contenente il gemello.
Tipo restituito
Eccezioni
Se il gemello digitale non esiste.
get_event_route
Ottenere una route di eventi.
get_event_route(event_route_id: str, **kwargs: Any) -> DigitalTwinsEventRouteParametri
Restituisce
Oggetto route dell'evento.
Tipo restituito
Eccezioni
Non esiste alcuna route evento con l'ID specificato.
get_model
Ottenere un modello, inclusi i metadati del modello e la definizione del modello.
get_model(model_id: str, **kwargs: Any) -> DigitalTwinsModelDataParametri
- include_model_definition
- bool
Includere la definizione del modello come parte del risultato. Il valore predefinito è False.
Restituisce
Dati del modello.
Tipo restituito
Eccezioni
Se non è presente alcun modello con l'ID specificato.
get_relationship
Ottenere una relazione su un gemello digitale.
get_relationship(digital_twin_id: str, relationship_id: str, **kwargs: Any) -> Dict[str, object]Parametri
Restituisce
Dizionario contenente la relazione.
Tipo restituito
Eccezioni
Se non esiste alcuna relazione o gemello digitale con l'ID specificato.
list_event_routes
Recupera tutte le route degli eventi.
list_event_routes(**kwargs: Any) -> ItemPaged[DigitalTwinsEventRoute]Parametri
- results_per_page
- int
Numero massimo di elementi da recuperare per richiesta. Il server può scegliere di restituire meno del massimo richiesto.
Restituisce
Istanza iteratore delle route eventi.
Tipo restituito
Eccezioni
list_incoming_relationships
Recuperare tutte le relazioni in ingresso per un gemello digitale.
list_incoming_relationships(digital_twin_id: str, **kwargs: Any) -> ItemPaged[IncomingRelationship]Parametri
Restituisce
Iteratore come istanza di una relazione.
Tipo restituito
Eccezioni
Se non è presente alcun gemello digitale con l'ID specificato.
list_models
Ottenere l'elenco dei modelli.
list_models(dependencies_for: List[str] | None = None, **kwargs: Any) -> ItemPaged[DigitalTwinsModelData]Parametri
ID modello in cui sono recuperate le dipendenze. Se omesso, tutti i modelli vengono recuperati.
- include_model_definition
- bool
Includere la definizione del modello come parte dei risultati. Il valore predefinito è False.
- results_per_page
- int
Numero massimo di elementi da recuperare per richiesta. Il server può scegliere di restituire meno del massimo richiesto.
Restituisce
Istanza iteratore dell'elenco di dati del modello.
Tipo restituito
Eccezioni
list_relationships
Recuperare le relazioni per un gemello digitale.
list_relationships(digital_twin_id: str, relationship_id: str | None = None, **kwargs: Any) -> ItemPaged[Dict[str, object]]Parametri
- relationship_id
- str
ID della relazione da ottenere (se None tutte le relazioni verranno recuperate).
Restituisce
Istanza iteratore dell'elenco di relazioni
Tipo restituito
Eccezioni
Se non è presente alcun gemello digitale con l'ID specificato.
publish_component_telemetry
Pubblicare i dati di telemetria dal componente di un gemello digitale, che viene quindi utilizzato da uno o più endpoint di destinazione (sottoscrittori) definiti in .
publish_component_telemetry(digital_twin_id: str, component_name: str, telemetry: object, **kwargs: Any) -> NoneParametri
- message_id
- str
ID del messaggio. Se non specificato, verrà generato un UUID.
Restituisce
Nessuno
Tipo restituito
Eccezioni
Se non è presente alcun gemello digitale con l'ID specificato o il nome del componente non è valido.
publish_telemetry
Pubblicare i dati di telemetria da un gemello digitale, che viene quindi utilizzato da uno o più endpoint di destinazione (sottoscrittori) definiti in .
publish_telemetry(digital_twin_id: str, telemetry: object, **kwargs: Any) -> NoneParametri
- message_id
- str
ID del messaggio. Se non specificato, verrà generato un UUID.
Restituisce
Nessuno
Tipo restituito
Eccezioni
Se non è presente alcun gemello digitale con l'ID specificato.
query_twins
Eseguire una query per gemelli digitali.
Nota: potrebbe verificarsi un ritardo tra le modifiche apportate all'istanza nelle query. Per altre informazioni sulle limitazioni delle query, vedere https://docs.microsoft.com/azure/digital-twins/how-to-query-graph#query-limitations
query_twins(query_expression: str, **kwargs: Any) -> ItemPaged[Dict[str, object]]Parametri
Restituisce
Iterabile dei risultati delle query.
Tipo restituito
Eccezioni
update_component
Aggiornare le proprietà di un componente in un gemello digitale usando una patch JSON.
update_component(digital_twin_id: str, component_name: str, json_patch: List[Dict[str, object]], **kwargs: Any) -> NoneParametri
- match_condition
- MatchConditions
Condizione in base alla quale eseguire l'operazione.
- etag
- str
Eseguire l'operazione solo se l'etag dell'entità corrisponde al valore specificato in base al match_condition.
Restituisce
Nessuno
Tipo restituito
Eccezioni
Se non è presente alcun gemello digitale con l'ID specificato o il nome del componente non è valido.
update_digital_twin
Aggiornare un gemello digitale usando una patch JSON.
update_digital_twin(digital_twin_id: str, json_patch: List[Dict[str, object]], **kwargs: Any) -> NoneParametri
Specifica di aggiornamento descritta da JSON Patch. Aggiornamenti ai valori delle proprietà e agli elementi $model possono verificarsi nella stessa richiesta. Le operazioni sono limitate a aggiungere, sostituire e rimuovere.
- match_condition
- MatchConditions
Condizione in base alla quale eseguire l'operazione.
- etag
- str
Eseguire l'operazione solo se l'etag dell'entità corrisponde al valore specificato in base al match_condition.
Restituisce
Nessuno
Tipo restituito
Eccezioni
Se non è presente alcun gemello digitale con l'ID specificato.
update_relationship
Aggiornamenti le proprietà di una relazione su un gemello digitale usando una patch JSON.
update_relationship(digital_twin_id: str, relationship_id: str, json_patch: List[Dict[str, object]], **kwargs: Any) -> NoneParametri
Descrizione della patch JSON dell'aggiornamento alle proprietà della relazione.
- match_condition
- MatchConditions
Condizione in base alla quale eseguire l'operazione.
- etag
- str
Eseguire l'operazione solo se l'etag dell'entità corrisponde al valore specificato in base al match_condition.
Restituisce
Nessuno
Tipo restituito
Eccezioni
Se non esiste alcuna relazione o gemello digitale con l'ID specificato.
upsert_digital_twin
Creare o aggiornare un gemello digitale.
upsert_digital_twin(digital_twin_id: str, digital_twin: Dict[str, object], **kwargs: Any) -> Dict[str, object]Parametri
- match_condition
- MatchConditions
Condizione in base alla quale eseguire l'operazione.
- etag
- str
Eseguire l'operazione solo se l'etag dell'entità corrisponde al valore specificato in base al match_condition.
Restituisce
Dizionario contenente il gemello creato o aggiornato.
Tipo restituito
Eccezioni
Se il gemello digitale esiste già.
upsert_event_route
Creare o aggiornare una route di eventi.
upsert_event_route(event_route_id: str, event_route: DigitalTwinsEventRoute, **kwargs: Any) -> NoneParametri
Restituisce
Nessuno
Tipo restituito
Eccezioni
upsert_relationship
Creare o aggiornare una relazione su un gemello digitale.
upsert_relationship(digital_twin_id: str, relationship_id: str, relationship: Dict[str, object], **kwargs: Any) -> Dict[str, object]Parametri
- match_condition
- MatchConditions
Condizione in base alla quale eseguire l'operazione.
- etag
- str
Eseguire l'operazione solo se l'etag dell'entità corrisponde al valore specificato in base al match_condition.
Restituisce
Relazione creata o aggiornata.
Tipo restituito
Eccezioni
Se non sono presenti gemelli digitali, gemelli digitali di destinazione o relazione con l'ID specificato.
Azure SDK for Python