DigitalTwinsClient 클래스

Digital Twins 클라이언트의 인스턴스를 만듭니다.

상속

builtins.object

DigitalTwinsClient

생성자

DigitalTwinsClient(endpoint: str, credential: TokenCredential, **kwargs: Any)

매개 변수

endpoint

str

필수

Azure Search 서비스의 URL 엔드포인트

credential

TokenCredential

필수

서비스에 대한 요청을 인증하는 자격 증명

메서드

create_models	하나 이상의 모델을 만듭니다. 오류가 발생하면 모델이 업로드되지 않습니다.
decommission_model	모델을 서비스 해제합니다.
delete_digital_twin	디지털 트윈을 삭제합니다.
delete_event_route	이벤트 경로를 삭제합니다.
delete_model	모델을 삭제합니다.
delete_relationship	디지털 트윈에서 관계를 삭제합니다.
get_component	디지털 트윈의 구성 요소를 가져옵니다.
get_digital_twin	디지털 트윈을 가져옵니다.
get_event_route	이벤트 경로를 가져옵니다.
get_model	모델 메타데이터 및 모델 정의를 포함하여 모델을 가져옵니다.
get_relationship	디지털 트윈에서 관계를 가져옵니다.
list_event_routes	모든 이벤트 경로를 검색합니다.
list_incoming_relationships	디지털 트윈에 대해 들어오는 모든 관계를 검색합니다.
list_models	모델 목록을 가져옵니다.
list_relationships	디지털 트윈에 대한 관계를 검색합니다.
publish_component_telemetry	디지털 트윈의 구성 요소에서 원격 분석을 게시한 다음, 아래에 정의된 하나 이상의 대상 엔드포인트(구독자)에서 사용됩니다.
publish_telemetry	디지털 트윈에서 원격 분석을 게시한 다음, 아래에 정의된 하나 이상의 대상 엔드포인트(구독자)가 사용합니다.
query_twins	디지털 트윈 쿼리. 참고: 인스턴스의 변경 내용이 쿼리에 반영되기 전에 사이에 지연이 있을 수 있습니다. 쿼리 제한 사항에 대한 자세한 내용은 https://docs.microsoft.com/azure/digital-twins/how-to-query-graph#query-limitations
update_component	JSON 패치를 사용하여 디지털 트윈의 구성 요소 속성을 업데이트합니다.
update_digital_twin	JSON 패치를 사용하여 디지털 트윈을 업데이트합니다.
update_relationship	JSON 패치를 사용하여 디지털 트윈에서 관계의 속성을 업데이트.
upsert_digital_twin	디지털 트윈을 만들거나 업데이트합니다.
upsert_event_route	이벤트 경로를 만들거나 업데이트합니다.
upsert_relationship	디지털 트윈에서 관계를 만들거나 업데이트합니다.

create_models

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

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

매개 변수

model_list

List[Dict[str,object]]

필수

만들 모델 집합입니다. 각 받아쓰기 는 정확히 하나의 모델에 해당합니다.

반환

만든 모델 목록입니다.

반환 형식

List[DigitalTwinsModelData]

예외

HttpResponseError

ResourceExistsError

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

decommission_model

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

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

매개 변수

model_id

str

필수

모델의 ID입니다. ID는 전역적으로 고유하며 대/소문자를 구분합니다.

반환

None

반환 형식

None

예외

HttpResponseError

ResourceNotFoundError

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

delete_digital_twin

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

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

매개 변수

digital_twin_id

str

필수

디지털 트윈의 ID입니다.

match_condition

MatchConditions

작업을 수행할 조건입니다.

etag

str

엔터티의 etag가 match_condition 따라 제공된 값과 일치하는 경우에만 작업을 수행합니다.

반환

None

반환 형식

None

예외

HttpResponseError

ResourceNotFoundError

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

delete_event_route

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

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

매개 변수

event_route_id

str

필수

삭제할 이벤트 경로의 ID입니다.

반환

None

반환 형식

None

예외

HttpResponseError

ResourceNotFoundError

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

delete_model

모델을 삭제합니다.

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

매개 변수

model_id

str

필수

삭제할 모델의 ID입니다.

반환

None

반환 형식

None

예외

HttpResponseError

ResourceNotFoundError

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

ResourceExistsError

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

delete_relationship

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

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

매개 변수

digital_twin_id

str

필수

디지털 트윈의 ID입니다.

relationship_id

str

필수

삭제할 관계의 ID입니다.

match_condition

MatchConditions

작업을 수행할 조건입니다.

etag

str

엔터티의 etag가 match_condition 따라 제공된 값과 일치하는 경우에만 작업을 수행합니다.

반환

None

반환 형식

None

예외

HttpResponseError

ResourceNotFoundError

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

get_component

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

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

매개 변수

digital_twin_id

str

필수

디지털 트윈의 ID입니다.

component_name

str

필수

검색되는 구성 요소입니다.

반환

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

반환 형식

Dict[str, object]

예외

HttpResponseError

ResourceNotFoundError

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

get_digital_twin

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

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

매개 변수

digital_twin_id

str

필수

디지털 트윈의 ID입니다.

반환

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

반환 형식

Dict[str, object]

예외

HttpResponseError

ResourceNotFoundError

디지털 트윈이 없는 경우.

get_event_route

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

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

매개 변수

event_route_id

str

필수

이벤트 경로의 ID입니다.

반환

이벤트 경로 개체입니다.

반환 형식

DigitalTwinsEventRoute

예외

HttpResponseError

ResourceNotFoundError

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

get_model

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

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

매개 변수

model_id

str

필수

모델의 ID입니다.

include_model_definition

bool

모델의 정의를 결과의 일부로 포함합니다. 기본값은 False입니다.

반환

모델 데이터입니다.

반환 형식

DigitalTwinsModelData

예외

HttpResponseError

ResourceNotFoundError

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

get_relationship

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

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

매개 변수

digital_twin_id

str

필수

디지털 트윈의 ID입니다.

relationship_id

str

필수

검색할 관계의 ID입니다.

반환

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

반환 형식

Dict[str, object]

예외

HttpResponseError

ResourceNotFoundError

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

list_event_routes

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

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

매개 변수

results_per_page

int

요청당 검색할 최대 항목 수입니다. 서버는 요청된 최대값보다 작게 반환하도록 선택할 수 있습니다.

반환

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

반환 형식

ItemPaged[DigitalTwinsEventRoute]

예외

HttpResponseError

list_incoming_relationships

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

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

매개 변수

digital_twin_id

str

필수

디지털 트윈의 ID입니다.

반환

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

반환 형식

ItemPaged[IncomingRelationship]

예외

HttpResponseError

ResourceNotFoundError

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

list_models

모델 목록을 가져옵니다.

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

매개 변수

dependencies_for

List[str]

필수

종속성을 검색할 모델 ID입니다. 생략하면 모든 모델이 검색됩니다.

include_model_definition

bool

결과의 일부로 모델 정의를 포함합니다. 기본값은 False입니다.

results_per_page

int

요청당 검색할 최대 항목 수입니다. 서버는 요청된 최대값보다 작게 반환하도록 선택할 수 있습니다.

반환

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

반환 형식

ItemPaged[DigitalTwinsModelData]

예외

HttpResponseError

list_relationships

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

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

매개 변수

digital_twin_id

str

필수

디지털 트윈의 ID입니다.

relationship_id

str

필수

가져올 관계의 ID입니다(모든 관계가 검색되지 않는 경우).

반환

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

반환 형식

ItemPaged[Dict[str,object]]

예외

HttpResponseError

ResourceNotFoundError

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

publish_component_telemetry

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

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

매개 변수

digital_twin_id

str

필수

디지털 트윈의 ID입니다.

component_name

str

필수

DTDL 구성 요소의 이름입니다.

telemetry

object

필수

보낼 원격 분석 데이터입니다.

message_id

str

메시지 ID입니다. 지정하지 않으면 UUID가 생성됩니다.

반환

None

반환 형식

None

예외

HttpResponseError

ResourceNotFoundError

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

publish_telemetry

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

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

매개 변수

digital_twin_id

str

필수

디지털 트윈의 ID

telemetry

object

필수

전송할 원격 분석 데이터

message_id

str

메시지 ID입니다. 지정하지 않으면 UUID가 생성됩니다.

반환

None

반환 형식

None

예외

HttpResponseError

ResourceNotFoundError

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

query_twins

디지털 트윈 쿼리.

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

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

매개 변수

query_expression

str

필수

실행할 쿼리 식입니다.

반환

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

반환 형식

ItemPaged[Dict[str, object]]

예외

HttpResponseError

update_component

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

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

매개 변수

digital_twin_id

str

필수

디지털 트윈의 ID입니다.

component_name

str

필수

업데이트되는 구성 요소입니다.

json_patch

List[Dict[str,object]]

필수

JSON 패치에서 설명하는 업데이트 사양입니다.

match_condition

MatchConditions

작업을 수행할 조건입니다.

etag

str

엔터티의 etag가 match_condition 따라 제공된 값과 일치하는 경우에만 작업을 수행합니다.

반환

None

반환 형식

None

예외

HttpResponseError

ResourceNotFoundError

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

update_digital_twin

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

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

매개 변수

digital_twin_id

str

필수

디지털 트윈의 ID입니다.

json_patch

List[Dict[str,object]]

필수

JSON 패치에서 설명하는 업데이트 사양입니다. 속성 값 및 $model 요소에 대한 업데이트 동일한 요청에서 발생할 수 있습니다. 작업은 추가, 바꾸기 및 제거로 제한됩니다.

match_condition

MatchConditions

작업을 수행할 조건입니다.

etag

str

엔터티의 etag가 match_condition 따라 제공된 값과 일치하는 경우에만 작업을 수행합니다.

반환

None

반환 형식

None

예외

HttpResponseError

ResourceNotFoundError

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

update_relationship

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

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

매개 변수

digital_twin_id

str

필수

디지털 트윈의 ID입니다.

relationship_id

str

필수

검색할 관계의 ID입니다.

json_patch

List[Dict[str,object]]

필수

관계 속성 업데이트에 대한 JSON 패치 설명입니다.

match_condition

MatchConditions

작업을 수행할 조건입니다.

etag

str

엔터티의 etag가 match_condition 따라 제공된 값과 일치하는 경우에만 작업을 수행합니다.

반환

None

반환 형식

None

예외

HttpResponseError

ResourceNotFoundError

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

upsert_digital_twin

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

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

매개 변수

digital_twin_id

str

필수

디지털 트윈의 ID입니다.

digital_twin

Dict[str,object]

필수

만들거나 업데이트할 트윈이 포함된 사전입니다.

match_condition

MatchConditions

작업을 수행할 조건입니다.

etag

str

엔터티의 etag가 match_condition 따라 제공된 값과 일치하는 경우에만 작업을 수행합니다.

반환

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

반환 형식

Dict[str, object]

예외

HttpResponseError

ResourceExistsError

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

upsert_event_route

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

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

매개 변수

event_route_id

str

필수

만들거나 업데이트할 이벤트 경로의 ID입니다.

event_route

DigitalTwinsEventRoute

필수

이벤트 경로 데이터입니다.

반환

None

반환 형식

None

예외

HttpResponseError

upsert_relationship

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

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

매개 변수

digital_twin_id

str

필수

디지털 트윈의 ID입니다.

relationship_id

str

필수

검색할 관계의 ID입니다.

relationship

Dict[str,object]

필수

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

match_condition

MatchConditions

작업을 수행할 조건입니다.

etag

str

엔터티의 etag가 match_condition 따라 제공된 값과 일치하는 경우에만 작업을 수행합니다.

반환

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

반환 형식

Dict[str, object]

예외

HttpResponseError

ResourceNotFoundError

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