DigitalTwinsClient Classe
Crée une instance du client Digital Twins.
- Héritage
-
builtins.objectDigitalTwinsClient
Constructeur
DigitalTwinsClient(endpoint: str, credential: TokenCredential, **kwargs: Any)
Paramètres
- credential
- TokenCredential
Informations d’identification permettant d’authentifier les demandes adressées au service
Méthodes
create_models |
Créez un ou plusieurs modèles. En cas d’erreur, aucun modèle n’est chargé. |
decommission_model |
Désactive un modèle. |
delete_digital_twin |
Supprimez un jumeau numérique. |
delete_event_route |
Supprimer un itinéraire d’événement. |
delete_model |
Supprimer un modèle. |
delete_relationship |
Supprimer une relation sur un jumeau numérique. |
get_component |
Obtenir un composant sur un jumeau numérique. |
get_digital_twin |
Obtenez un jumeau numérique. |
get_event_route |
Obtenir un itinéraire d’événement. |
get_model |
Obtenir un modèle, y compris les métadonnées du modèle et la définition du modèle. |
get_relationship |
Obtenir une relation sur un jumeau numérique. |
list_event_routes |
Récupère tous les itinéraires d’événements. |
list_incoming_relationships |
Récupérer toutes les relations entrantes pour un jumeau numérique. |
list_models |
Obtenez la liste des modèles. |
list_relationships |
Récupérer les relations d’un jumeau numérique. |
publish_component_telemetry |
Publiez les données de télémétrie à partir du composant d’un jumeau numérique, qui sont ensuite consommées par un ou plusieurs points de terminaison de destination (abonnés) définis sous. |
publish_telemetry |
Publiez les données de télémétrie à partir d’un jumeau numérique, qui sont ensuite consommées par un ou plusieurs points de terminaison de destination (abonnés) définis sous. |
query_twins |
Recherchez des jumeaux numériques. Remarque : il peut y avoir un délai entre les modifications apportées à votre instance dans les requêtes. Pour plus d’informations sur les limitations des requêtes, consultez https://docs.microsoft.com/azure/digital-twins/how-to-query-graph#query-limitations |
update_component |
Mettez à jour les propriétés d’un composant sur un jumeau numérique à l’aide d’un correctif JSON. |
update_digital_twin |
Mettez à jour un jumeau numérique à l’aide d’un correctif JSON. |
update_relationship |
Mises à jour les propriétés d’une relation sur un jumeau numérique à l’aide d’un correctif JSON. |
upsert_digital_twin |
Créer ou mettre à jour un jumeau numérique. |
upsert_event_route |
Créez ou mettez à jour un itinéraire d’événements. |
upsert_relationship |
Créer ou mettre à jour une relation sur un jumeau numérique. |
create_models
Créez un ou plusieurs modèles. En cas d’erreur, aucun modèle n’est chargé.
create_models(dtdl_models: List[Dict[str, object]], **kwargs: Any) -> List[DigitalTwinsModelData]
Paramètres
Ensemble de modèles à créer. Chaque dict correspond exactement à un modèle.
Retours
Liste des modèles créés.
Type de retour
Exceptions
Un ou plusieurs des modèles fournis existent déjà.
decommission_model
Désactive un modèle.
decommission_model(model_id: str, **kwargs: Any) -> None
Paramètres
Retours
Aucun
Type de retour
Exceptions
Il n’existe aucun modèle avec l’ID fourni.
delete_digital_twin
Supprimez un jumeau numérique.
delete_digital_twin(digital_twin_id: str, **kwargs: Any) -> None
Paramètres
- match_condition
- MatchConditions
Condition dans laquelle effectuer l’opération.
- etag
- str
N’effectuez l’opération que si l’etag de l’entité correspond à la valeur fournie en fonction de la match_condition.
Retours
Aucun
Type de retour
Exceptions
S’il n’y a pas de jumeau numérique avec l’ID fourni.
delete_event_route
Supprimer un itinéraire d’événement.
delete_event_route(event_route_id: str, **kwargs: Any) -> None
Paramètres
Retours
Aucun
Type de retour
Exceptions
Il n’existe aucun itinéraire d’événements avec l’ID fourni.
delete_model
Supprimer un modèle.
delete_model(model_id: str, **kwargs: Any) -> None
Paramètres
Retours
Aucun
Type de retour
Exceptions
Il n’existe aucun modèle avec l’ID fourni.
Il existe des dépendances sur le modèle qui l’empêchent d’être supprimé.
delete_relationship
Supprimer une relation sur un jumeau numérique.
delete_relationship(digital_twin_id: str, relationship_id: str, **kwargs: Any) -> None
Paramètres
- match_condition
- MatchConditions
Condition dans laquelle effectuer l’opération.
- etag
- str
N’effectuez l’opération que si l’etag de l’entité correspond à la valeur fournie en fonction de la match_condition.
Retours
None
Type de retour
Exceptions
S’il n’existe pas de jumeau numérique ou de relation avec l’ID fourni.
get_component
Obtenir un composant sur un jumeau numérique.
get_component(digital_twin_id: str, component_name: str, **kwargs: Any) -> Dict[str, object]
Paramètres
Retours
Dictionnaire contenant le composant.
Type de retour
Exceptions
S’il n’y a pas de jumeau numérique avec l’ID fourni ou si le nom du composant n’est pas valide.
get_digital_twin
Obtenez un jumeau numérique.
get_digital_twin(digital_twin_id: str, **kwargs: Any) -> Dict[str, object]
Paramètres
Retours
Dictionnaire contenant le jumeau.
Type de retour
Exceptions
Si le jumeau numérique n’existe pas.
get_event_route
Obtenir un itinéraire d’événement.
get_event_route(event_route_id: str, **kwargs: Any) -> DigitalTwinsEventRoute
Paramètres
Retours
Objet de routage d’événements.
Type de retour
Exceptions
Il n’existe aucun itinéraire d’événements avec l’ID fourni.
get_model
Obtenir un modèle, y compris les métadonnées du modèle et la définition du modèle.
get_model(model_id: str, **kwargs: Any) -> DigitalTwinsModelData
Paramètres
- include_model_definition
- bool
Incluez la définition du modèle dans le résultat. La valeur par défaut est False.
Retours
Données du modèle.
Type de retour
Exceptions
S’il n’existe aucun modèle avec l’ID fourni.
get_relationship
Obtenir une relation sur un jumeau numérique.
get_relationship(digital_twin_id: str, relationship_id: str, **kwargs: Any) -> Dict[str, object]
Paramètres
Retours
Dictionnaire contenant la relation.
Type de retour
Exceptions
S’il n’existe pas de jumeau numérique ou de relation avec l’ID fourni.
list_event_routes
Récupère tous les itinéraires d’événements.
list_event_routes(**kwargs: Any) -> ItemPaged[DigitalTwinsEventRoute]
Paramètres
- results_per_page
- int
Nombre maximal d’éléments à récupérer par requête. Le serveur peut choisir de retourner moins que le maximum demandé.
Retours
Instance d’itérateur d’itinéraires d’événements.
Type de retour
Exceptions
list_incoming_relationships
Récupérer toutes les relations entrantes pour un jumeau numérique.
list_incoming_relationships(digital_twin_id: str, **kwargs: Any) -> ItemPaged[IncomingRelationship]
Paramètres
Retours
Itérateur comme une instance de l’une ou l’autre relation.
Type de retour
Exceptions
S’il n’y a pas de jumeau numérique avec l’ID fourni.
list_models
Obtenez la liste des modèles.
list_models(dependencies_for: List[str] | None = None, **kwargs: Any) -> ItemPaged[DigitalTwinsModelData]
Paramètres
ID de modèle dont les dépendances sont récupérées. En cas d’omission, tous les modèles sont récupérés.
- include_model_definition
- bool
Incluez la définition du modèle dans le cadre des résultats. La valeur par défaut est False.
- results_per_page
- int
Nombre maximal d’éléments à récupérer par requête. Le serveur peut choisir de retourner moins que le maximum demandé.
Retours
Instance d’itérateur de liste de données de modèle.
Type de retour
Exceptions
list_relationships
Récupérer les relations d’un jumeau numérique.
list_relationships(digital_twin_id: str, relationship_id: str | None = None, **kwargs: Any) -> ItemPaged[Dict[str, object]]
Paramètres
Retours
Instance d’itérateur de liste de relations
Type de retour
Exceptions
S’il n’y a pas de jumeau numérique avec l’ID fourni.
publish_component_telemetry
Publiez les données de télémétrie à partir du composant d’un jumeau numérique, qui sont ensuite consommées par un ou plusieurs points de terminaison de destination (abonnés) définis sous.
publish_component_telemetry(digital_twin_id: str, component_name: str, telemetry: object, **kwargs: Any) -> None
Paramètres
- message_id
- str
ID de message. S’il n’est pas spécifié, un UUID est généré.
Retours
None
Type de retour
Exceptions
S’il n’y a pas de jumeau numérique avec l’ID fourni ou si le nom du composant n’est pas valide.
publish_telemetry
Publiez les données de télémétrie à partir d’un jumeau numérique, qui sont ensuite consommées par un ou plusieurs points de terminaison de destination (abonnés) définis sous.
publish_telemetry(digital_twin_id: str, telemetry: object, **kwargs: Any) -> None
Paramètres
- message_id
- str
ID de message. S’il n’est pas spécifié, un UUID est généré.
Retours
None
Type de retour
Exceptions
S’il n’y a pas de jumeau numérique avec l’ID fourni.
query_twins
Recherchez des jumeaux numériques.
Remarque : il peut y avoir un délai entre les modifications apportées à votre instance dans les requêtes. Pour plus d’informations sur les limitations des requêtes, consultez https://docs.microsoft.com/azure/digital-twins/how-to-query-graph#query-limitations
query_twins(query_expression: str, **kwargs: Any) -> ItemPaged[Dict[str, object]]
Paramètres
Retours
Itérable des résultats de requête.
Type de retour
Exceptions
update_component
Mettez à jour les propriétés d’un composant sur un jumeau numérique à l’aide d’un correctif JSON.
update_component(digital_twin_id: str, component_name: str, json_patch: List[Dict[str, object]], **kwargs: Any) -> None
Paramètres
- match_condition
- MatchConditions
Condition dans laquelle effectuer l’opération.
- etag
- str
N’effectuez l’opération que si l’etag de l’entité correspond à la valeur fournie en fonction de la match_condition.
Retours
Aucun
Type de retour
Exceptions
S’il n’y a pas de jumeau numérique avec l’ID fourni ou si le nom du composant n’est pas valide.
update_digital_twin
Mettez à jour un jumeau numérique à l’aide d’un correctif JSON.
update_digital_twin(digital_twin_id: str, json_patch: List[Dict[str, object]], **kwargs: Any) -> None
Paramètres
Spécification de mise à jour décrite par JSON Patch. Mises à jour aux valeurs de propriété et aux éléments $model peuvent se produire dans la même requête. Les opérations sont limitées à l’ajout, au remplacement et à la suppression.
- match_condition
- MatchConditions
Condition dans laquelle effectuer l’opération.
- etag
- str
N’effectuez l’opération que si l’etag de l’entité correspond à la valeur fournie en fonction de la match_condition.
Retours
Aucun
Type de retour
Exceptions
S’il n’y a pas de jumeau numérique avec l’ID fourni.
update_relationship
Mises à jour les propriétés d’une relation sur un jumeau numérique à l’aide d’un correctif JSON.
update_relationship(digital_twin_id: str, relationship_id: str, json_patch: List[Dict[str, object]], **kwargs: Any) -> None
Paramètres
Description du correctif JSON de la mise à jour des propriétés de relation.
- match_condition
- MatchConditions
Condition dans laquelle effectuer l’opération.
- etag
- str
N’effectuez l’opération que si l’etag de l’entité correspond à la valeur fournie en fonction de la match_condition.
Retours
Aucun
Type de retour
Exceptions
S’il n’existe pas de jumeau numérique ou de relation avec l’ID fourni.
upsert_digital_twin
Créer ou mettre à jour un jumeau numérique.
upsert_digital_twin(digital_twin_id: str, digital_twin: Dict[str, object], **kwargs: Any) -> Dict[str, object]
Paramètres
Dictionnaire contenant le jumeau à créer ou à mettre à jour.
- match_condition
- MatchConditions
Condition dans laquelle effectuer l’opération.
- etag
- str
N’effectuez l’opération que si l’etag de l’entité correspond à la valeur fournie en fonction de la match_condition.
Retours
Dictionnaire contenant le jumeau créé ou mis à jour.
Type de retour
Exceptions
Si le jumeau numérique existe déjà.
upsert_event_route
Créez ou mettez à jour un itinéraire d’événements.
upsert_event_route(event_route_id: str, event_route: DigitalTwinsEventRoute, **kwargs: Any) -> None
Paramètres
Retours
Aucun
Type de retour
Exceptions
upsert_relationship
Créer ou mettre à jour une relation sur un jumeau numérique.
upsert_relationship(digital_twin_id: str, relationship_id: str, relationship: Dict[str, object], **kwargs: Any) -> Dict[str, object]
Paramètres
- match_condition
- MatchConditions
Condition dans laquelle effectuer l’opération.
- etag
- str
N’effectuez l’opération que si l’etag de l’entité correspond à la valeur fournie en fonction de la match_condition.
Retours
Relation créée ou mise à jour.
Type de retour
Exceptions
S’il n’y a pas de jumeau numérique, ciblez le jumeau numérique ou la relation avec l’ID fourni.
Azure SDK for Python
Commentaires
https://aka.ms/ContentUserFeedback.
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultezEnvoyer et afficher des commentaires pour