DigitalTwinsClient 클래스

하나 이상의 모델을 만듭니다. 오류가 발생하면 모델이 업로드되지 않습니다.

create_models(dtdl_models: List[Dict[str, object]], **kwargs: Any) -> List[DigitalTwinsModelData]

매개 변수

반환

만든 모델 목록입니다.

반환 형식

예외

제공된 모델 중 하나 이상이 이미 있습니다.

모델을 서비스 해제합니다.

decommission_model(model_id: str, **kwargs: Any) -> None

매개 변수

반환

None

반환 형식

예외

제공된 ID를 가진 모델이 없습니다.

디지털 트윈을 삭제합니다.

delete_digital_twin(digital_twin_id: str, **kwargs: Any) -> None

매개 변수

반환

None

반환 형식

예외

제공된 ID가 있는 디지털 트윈이 없는 경우

이벤트 경로를 삭제합니다.

delete_event_route(event_route_id: str, **kwargs: Any) -> None

매개 변수

반환

None

반환 형식

예외

제공된 ID를 가진 이벤트 경로가 없습니다.

모델을 삭제합니다.

delete_model(model_id: str, **kwargs: Any) -> None

매개 변수

반환

None

반환 형식

예외

제공된 ID를 가진 모델이 없습니다.

모델이 삭제되지 않도록 하는 종속성이 있습니다.

디지털 트윈에서 관계를 삭제합니다.

delete_relationship(digital_twin_id: str, relationship_id: str, **kwargs: Any) -> None

매개 변수

반환

None

반환 형식

예외

디지털 트윈이 없거나 제공된 ID와의 관계가 없는 경우

디지털 트윈의 구성 요소를 가져옵니다.

get_component(digital_twin_id: str, component_name: str, **kwargs: Any) -> Dict[str, object]

매개 변수

반환

구성 요소를 포함하는 사전입니다.

반환 형식

예외

제공된 ID가 있는 디지털 트윈이 없거나 구성 요소 이름이 잘못된 경우

디지털 트윈을 가져옵니다.

get_digital_twin(digital_twin_id: str, **kwargs: Any) -> Dict[str, object]

매개 변수

반환

쌍을 포함하는 사전입니다.

반환 형식

예외

디지털 트윈이 없는 경우.

이벤트 경로를 가져옵니다.

get_event_route(event_route_id: str, **kwargs: Any) -> DigitalTwinsEventRoute

매개 변수

반환

이벤트 경로 개체입니다.

반환 형식

예외

제공된 ID를 가진 이벤트 경로가 없습니다.

모델 메타데이터 및 모델 정의를 포함하여 모델을 가져옵니다.

get_model(model_id: str, **kwargs: Any) -> DigitalTwinsModelData

매개 변수

반환

모델 데이터입니다.

반환 형식

예외

제공된 ID를 가진 모델이 없으면 입니다.

디지털 트윈에서 관계를 가져옵니다.

get_relationship(digital_twin_id: str, relationship_id: str, **kwargs: Any) -> Dict[str, object]

매개 변수

반환

관계를 포함하는 사전입니다.

반환 형식

예외

디지털 트윈이 없거나 제공된 ID와의 관계가 없는 경우

모든 이벤트 경로를 검색합니다.

list_event_routes(**kwargs: Any) -> ItemPaged[DigitalTwinsEventRoute]

매개 변수

반환

이벤트 경로의 반복기 인스턴스입니다.

반환 형식

예외

디지털 트윈에 대해 들어오는 모든 관계를 검색합니다.

list_incoming_relationships(digital_twin_id: str, **kwargs: Any) -> ItemPaged[IncomingRelationship]

매개 변수

반환

두 관계의 인스턴스와 같은 반복기입니다.

반환 형식

예외

제공된 ID가 있는 디지털 트윈이 없는 경우

모델 목록을 가져옵니다.

list_models(dependencies_for: List[str] | None = None, **kwargs: Any) -> ItemPaged[DigitalTwinsModelData]

매개 변수

반환

모델 데이터 목록의 반복기 인스턴스입니다.

반환 형식

예외

디지털 트윈에 대한 관계를 검색합니다.

list_relationships(digital_twin_id: str, relationship_id: str | None = None, **kwargs: Any) -> ItemPaged[Dict[str, object]]

매개 변수

반환

관계 목록의 반복기 인스턴스

반환 형식

예외

제공된 ID가 있는 디지털 트윈이 없는 경우

디지털 트윈의 구성 요소에서 원격 분석을 게시한 다음, 아래에 정의된 하나 이상의 대상 엔드포인트(구독자)에서 사용됩니다.

publish_component_telemetry(digital_twin_id: str, component_name: str, telemetry: object, **kwargs: Any) -> None

매개 변수

반환

None

반환 형식

예외

제공된 ID가 있는 디지털 트윈이 없거나 구성 요소 이름이 잘못된 경우

디지털 트윈에서 원격 분석을 게시한 다음, 아래에 정의된 하나 이상의 대상 엔드포인트(구독자)가 사용합니다.

publish_telemetry(digital_twin_id: str, telemetry: object, **kwargs: Any) -> None

매개 변수

반환

None

반환 형식

예외

제공된 ID가 있는 디지털 트윈이 없는 경우

디지털 트윈 쿼리.

참고: 인스턴스의 변경 내용이 쿼리에 반영되기 전에 사이에 지연이 있을 수 있습니다. 쿼리 제한 사항에 대한 자세한 내용은 https://docs.microsoft.com/azure/digital-twins/how-to-query-graph#query-limitations

query_twins(query_expression: str, **kwargs: Any) -> ItemPaged[Dict[str, object]]

매개 변수

반환

쿼리 결과의 반복 가능한 입니다.

반환 형식

예외

JSON 패치를 사용하여 디지털 트윈의 구성 요소 속성을 업데이트합니다.

update_component(digital_twin_id: str, component_name: str, json_patch: List[Dict[str, object]], **kwargs: Any) -> None

매개 변수

반환

None

반환 형식

예외

제공된 ID가 있는 디지털 트윈이 없거나 구성 요소 이름이 잘못된 경우

JSON 패치를 사용하여 디지털 트윈을 업데이트합니다.

update_digital_twin(digital_twin_id: str, json_patch: List[Dict[str, object]], **kwargs: Any) -> None

매개 변수

반환

None

반환 형식

예외

제공된 ID가 있는 디지털 트윈이 없는 경우

JSON 패치를 사용하여 디지털 트윈에서 관계의 속성을 업데이트.

update_relationship(digital_twin_id: str, relationship_id: str, json_patch: List[Dict[str, object]], **kwargs: Any) -> None

매개 변수

반환

None

반환 형식

예외

디지털 트윈이 없거나 제공된 ID와의 관계가 없는 경우

디지털 트윈을 만들거나 업데이트합니다.

upsert_digital_twin(digital_twin_id: str, digital_twin: Dict[str, object], **kwargs: Any) -> Dict[str, object]

매개 변수

반환

생성되거나 업데이트된 트윈을 포함하는 사전입니다.

반환 형식

예외

디지털 트윈이 이미 있는 경우

이벤트 경로를 만들거나 업데이트합니다.

upsert_event_route(event_route_id: str, event_route: DigitalTwinsEventRoute, **kwargs: Any) -> None

매개 변수

반환

None

반환 형식

예외

디지털 트윈에서 관계를 만들거나 업데이트합니다.

upsert_relationship(digital_twin_id: str, relationship_id: str, relationship: Dict[str, object], **kwargs: Any) -> Dict[str, object]

매개 변수

반환

생성되거나 업데이트된 관계입니다.

반환 형식

예외

디지털 트윈이 없는 경우 디지털 트윈을 대상으로 하거나 제공된 ID와의 관계를 대상으로 합니다.