DigitalTwinsClient class

패키지:

@azure/digital-twins-core

Azure IoT DigitalTwins API용 클라이언트입니다.

생성자

DigitalTwinsClient(string, TokenCredential, DigitalTwinsClientOptions)

AzureDigitalTwinsAPI의 인스턴스를 만듭니다. 예제 사용법: const { DigitalTwinsClient, ServiceClientCredentials } = require("@azure/digital-twins-core"); const client = new DigitalTwinsClient( "<endpoint>", new DefaultAzureCredential(); );

메서드

createModels(any[], OperationOptions)	하나 이상의 만들기
decomissionModel(string, OperationOptions)	json 패치를 사용하여 모델 서비스 해제 모델을 서비스 해제하면 이 모델에서 새 디지털 트윈을 더 이상 정의할 수 없습니다. 그러나 기존 디지털 트윈은 이 모델을 계속 사용할 수 있습니다. 모델이 서비스 해제되면 다시 서비스 해제되지 않을 수 있습니다.
deleteDigitalTwin(string, DigitalTwinsDeleteOptionalParams)	디지털 트윈 삭제
deleteEventRoute(string, OperationOptions)	이벤트 경로를 삭제합니다.
deleteModel(string, OperationOptions)	모델을 삭제합니다.
deleteRelationship(string, string, DigitalTwinsDeleteRelationshipOptionalParams)	디지털 트윈에서 관계를 삭제합니다.
getComponent(string, string, OperationOptions)	디지털 트윈의 구성 요소를 가져옵니다.
getDigitalTwin(string, OperationOptions)	디지털 트윈 가져오기
getEventRoute(string, OperationOptions)	이벤트 경로를 가져옵니다.
getModel(string, boolean, OperationOptions)	모델 메타데이터 및 모델 정의를 포함하여 모델을 가져옵니다.
getRelationship(string, string, OperationOptions)	디지털 트윈에서 관계를 가져옵니다.
listEventRoutes(number, OperationOptions & PageSettings)	디지털 트윈 인스턴스의 이벤트 경로를 나열합니다.
listIncomingRelationships(string, OperationOptions & PageSettings)	디지털 트윈에 대해 들어오는 모든 관계를 검색합니다.
listModels(string[], boolean, number, OperationOptions & PageSettings)	모델 목록 가져오기
listRelationships(string, OperationOptions & PageSettings)	디지털 트윈에 대한 관계를 검색합니다.
publishComponentTelemetry(string, string, string, string, OperationOptions)	디지털 트윈의 구성 요소에서 원격 분석을 게시한 다음, 아래에 정의된 하나 이상의 대상 엔드포인트(구독자)에서 사용됩니다.
publishTelemetry(string, any, string, OperationOptions)	디지털 트윈에서 원격 분석을 게시한 다음, 아래에 정의된 하나 이상의 대상 엔드포인트(구독자)가 사용합니다.
queryTwins(string, number, OperationOptions & PageSettings)	디지털 트윈 쿼리.
updateComponent(string, string, any[], DigitalTwinsUpdateComponentOptionalParams)	JSON 패치를 사용하여 디지털 트윈의 구성 요소 속성을 업데이트합니다.
updateDigitalTwin(string, any, DigitalTwinsUpdateOptionalParams)	json 패치를 사용하여 디지털 트윈을 업데이트합니다.
updateRelationship(string, string, any[], DigitalTwinsUpdateRelationshipOptionalParams)	JSON 패치를 사용하여 디지털 트윈에서 관계의 속성을 업데이트.
upsertDigitalTwin(string, string, DigitalTwinsAddOptionalParams)	디지털 트윈 만들기 또는 업데이트
upsertEventRoute(string, string, string, OperationOptions)	이벤트 경로를 만들거나 업데이트합니다.
upsertRelationship(string, string, any, DigitalTwinsAddRelationshipOptionalParams)	디지털 트윈에서 관계를 만들거나 업데이트합니다.

생성자 세부 정보

DigitalTwinsClient(string, TokenCredential, DigitalTwinsClientOptions)

AzureDigitalTwinsAPI의 인스턴스를 만듭니다.

예제 사용법:

const { DigitalTwinsClient, ServiceClientCredentials } = require("@azure/digital-twins-core");

const client = new DigitalTwinsClient(
  "<endpoint>",
  new DefaultAzureCredential();
);

new DigitalTwinsClient(endpointUrl: string, credential: TokenCredential, options?: DigitalTwinsClientOptions)

매개 변수

endpointUrl

string

서비스의 엔드포인트 URL입니다.

credential

TokenCredential

서비스에 대한 요청을 인증하는 데 사용됩니다.

options

DigitalTwinsClientOptions

서비스 클라이언트를 구성하는 데 사용됩니다.

메서드 세부 정보

createModels(any[], OperationOptions)

하나 이상의 만들기

function createModels(dtdlModels: any[], options?: OperationOptions): Promise<DigitalTwinModelsAddResponse>

매개 변수

dtdlModels

any[]

options

OperationOptions

작업 옵션

반환

Promise<DigitalTwinModelsAddResponse>

생성된 애플리케이션/json 모델 및 http 응답입니다.

decomissionModel(string, OperationOptions)

json 패치를 사용하여 모델 서비스 해제 모델을 서비스 해제하면 이 모델에서 새 디지털 트윈을 더 이상 정의할 수 없습니다. 그러나 기존 디지털 트윈은 이 모델을 계속 사용할 수 있습니다. 모델이 서비스 해제되면 다시 서비스 해제되지 않을 수 있습니다.

function decomissionModel(modelId: string, options?: OperationOptions): Promise<RestResponse>

매개 변수

modelId

string

서비스 해제할 모델의 ID입니다. 속성을 바꿀 수 있습니다.

options

OperationOptions

작업 옵션

반환

Promise<RestResponse>

http 응답입니다.

deleteDigitalTwin(string, DigitalTwinsDeleteOptionalParams)

디지털 트윈 삭제

function deleteDigitalTwin(digitalTwinId: string, options?: DigitalTwinsDeleteOptionalParams): Promise<RestResponse>

매개 변수

digitalTwinId

string

삭제할 디지털 트윈의 ID입니다.

options

DigitalTwinsDeleteOptionalParams

ifMatch를 포함한 확장 작업 옵션: 엔터티의 etag가 제공된 etag 중 하나와 일치하거나 *가 제공된 경우에만 작업을 수행합니다.

반환

Promise<RestResponse>

http 응답입니다.

deleteEventRoute(string, OperationOptions)

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

function deleteEventRoute(eventRouteId: string, options?: OperationOptions): Promise<RestResponse>

매개 변수

eventRouteId

string

삭제할 eventRoute의 ID입니다.

options

OperationOptions

작업 옵션

반환

Promise<RestResponse>

http 응답입니다.

deleteModel(string, OperationOptions)

모델을 삭제합니다.

function deleteModel(modelId: string, options?: OperationOptions): Promise<RestResponse>

매개 변수

modelId

string

삭제할 모델의 ID입니다.

options

OperationOptions

작업 옵션

반환

Promise<RestResponse>

http 응답입니다.

deleteRelationship(string, string, DigitalTwinsDeleteRelationshipOptionalParams)

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

function deleteRelationship(digitalTwinId: string, relationshipId: string, options?: DigitalTwinsDeleteRelationshipOptionalParams): Promise<RestResponse>

매개 변수

digitalTwinId

string

원본 디지털 트윈의 ID입니다.

relationshipId

string

삭제할 관계의 ID입니다.

options

DigitalTwinsDeleteRelationshipOptionalParams

ifMatch 작업 옵션: 엔터티의 etag가 제공된 etag 중 하나와 일치하거나 *가 인 경우에만 작업을 수행합니다.

반환

Promise<RestResponse>

http 응답입니다.

getComponent(string, string, OperationOptions)

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

function getComponent(digitalTwinId: string, componentName: string, options?: OperationOptions): Promise<DigitalTwinsGetComponentResponse>

매개 변수

digitalTwinId

string

디지털 트윈의 ID입니다.

componentName

string

검색할 구성 요소입니다.

options

OperationOptions

작업 옵션

반환

Promise<DigitalTwinsGetComponentResponse>

제공된 componentName 및 HTTP 응답에 해당하는 구성 요소의 Json 문자열 표현입니다.

getDigitalTwin(string, OperationOptions)

디지털 트윈 가져오기

function getDigitalTwin(digitalTwinId: string, options?: OperationOptions): Promise<DigitalTwinsGetByIdResponse>

매개 변수

digitalTwinId

string

디지털 트윈의 ID입니다.

options

OperationOptions

작업 옵션

반환

Promise<DigitalTwinsGetByIdResponse>

application/json 디지털 트윈 및 http 응답입니다.

getEventRoute(string, OperationOptions)

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

function getEventRoute(eventRouteId: string, options?: OperationOptions): Promise<EventRoutesGetByIdResponse>

매개 변수

eventRouteId

string

options

OperationOptions

작업 옵션

반환

Promise<EventRoutesGetByIdResponse>

application/json 이벤트 경로 및 http 응답입니다.

getModel(string, boolean, OperationOptions)

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

function getModel(modelId: string, includeModelDefinition?: boolean, options?: OperationOptions): Promise<DigitalTwinModelsGetByIdResponse>

매개 변수

modelId

string

모델의 ID입니다.

includeModelDefinition

boolean

options

OperationOptions

includeModelDefinition을 포함한 확장 작업 옵션: true이면 모델 정의가 결과의 일부로 반환됩니다. 기본값: false

반환

Promise<DigitalTwinModelsGetByIdResponse>

application/json 모델 및 http 응답입니다.

getRelationship(string, string, OperationOptions)

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

function getRelationship(digitalTwinId: string, relationshipId: string, options?: OperationOptions): Promise<DigitalTwinsGetRelationshipByIdResponse>

매개 변수

digitalTwinId

string

원본 디지털 트윈의 ID입니다.

relationshipId

string

검색할 관계의 ID입니다.

options

OperationOptions

작업 옵션

반환

Promise<DigitalTwinsGetRelationshipByIdResponse>

지정된 디지털 트윈 및 http 응답에 속하는 애플리케이션/json 관계의 페이징 가능한 목록입니다.

listEventRoutes(number, OperationOptions & PageSettings)

디지털 트윈 인스턴스의 이벤트 경로를 나열합니다.

function listEventRoutes(resultsPerPage?: number, options?: OperationOptions & PageSettings): PagedAsyncIterableIterator<EventRoute, EventRoutesListNextResponse, PageSettings>

매개 변수

resultsPerPage

number

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

options

OperationOptions & PageSettings

반환

PagedAsyncIterableIterator<EventRoute, EventRoutesListNextResponse, PageSettings>

application/json 이벤트 경로 및 http 응답입니다.

listIncomingRelationships(string, OperationOptions & PageSettings)

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

function listIncomingRelationships(digitalTwinId: string, options?: OperationOptions & PageSettings): PagedAsyncIterableIterator<IncomingRelationship, DigitalTwinsListIncomingRelationshipsResponse, PageSettings>

매개 변수

digitalTwinId

string

디지털 트윈의 ID입니다.

options

OperationOptions & PageSettings

반환

PagedAsyncIterableIterator<IncomingRelationship, DigitalTwinsListIncomingRelationshipsResponse, PageSettings>

listModels(string[], boolean, number, OperationOptions & PageSettings)

모델 목록 가져오기

function listModels(dependeciesFor?: string[], includeModelDefinition?: boolean, resultsPerPage?: number, options?: OperationOptions & PageSettings): PagedAsyncIterableIterator<DigitalTwinsModelData, DigitalTwinModelsListResponse, PageSettings>

매개 변수

dependeciesFor

string[]

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

includeModelDefinition

boolean

결과에 모델 정의를 포함할지 여부입니다. false이면 모델 메타데이터만 반환됩니다.

resultsPerPage

number

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

options

OperationOptions & PageSettings

반환

PagedAsyncIterableIterator<DigitalTwinsModelData, DigitalTwinModelsListResponse, PageSettings>

애플리케이션/json 모델 및 http 응답의 페이징 가능한 집합입니다.

listRelationships(string, OperationOptions & PageSettings)

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

function listRelationships(digitalTwinId: string, options?: OperationOptions & PageSettings): PagedAsyncIterableIterator<any, DigitalTwinsListRelationshipsResponse, PageSettings>

매개 변수

digitalTwinId

string

디지털 트윈의 ID입니다.

options

OperationOptions & PageSettings

반환

PagedAsyncIterableIterator<any, DigitalTwinsListRelationshipsResponse, PageSettings>

publishComponentTelemetry(string, string, string, string, OperationOptions)

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

function publishComponentTelemetry(digitalTwinId: string, componentName: string, payload: string, messageId: string, options?: OperationOptions): Promise<RestResponse>

매개 변수

digitalTwinId

string

삭제할 디지털 트윈의 ID입니다.

componentName

string

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

payload

string

보낼 애플리케이션/json 원격 분석 페이로드입니다.

messageId

string

메시지 ID입니다.

options

OperationOptions

작업 옵션

반환

Promise<RestResponse>

http 응답입니다.

publishTelemetry(string, any, string, OperationOptions)

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

function publishTelemetry(digitalTwinId: string, payload: any, messageId: string, options?: OperationOptions): Promise<RestResponse>

매개 변수

digitalTwinId

string

삭제할 디지털 트윈의 ID입니다.

payload

any

보낼 애플리케이션/json 원격 분석 페이로드입니다.

messageId

string

메시지 ID입니다.

options

OperationOptions

작업 옵션

반환

Promise<RestResponse>

http 응답입니다.

queryTwins(string, number, OperationOptions & PageSettings)

디지털 트윈 쿼리.

function queryTwins(query: string, resultsPerPage?: number, options?: OperationOptions & PageSettings): PagedAsyncIterableIterator<any, QueryQueryTwinsResponse, PageSettings>

매개 변수

query

string

SQL과 유사한 구문의 쿼리 문자열입니다.

resultsPerPage

number

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

options

OperationOptions & PageSettings

반환

PagedAsyncIterableIterator<any, QueryQueryTwinsResponse, PageSettings>

쿼리 결과의 페이지가 지정 가능한 목록입니다.

updateComponent(string, string, any[], DigitalTwinsUpdateComponentOptionalParams)

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

function updateComponent(digitalTwinId: string, componentName: string, jsonPatch: any[], options?: DigitalTwinsUpdateComponentOptionalParams): Promise<DigitalTwinsUpdateComponentResponse>

매개 변수

digitalTwinId

string

디지털 트윈의 ID입니다.

componentName

string

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

jsonPatch

any[]

지정된 디지털 트윈의 구성 요소에서 수행할 application/json-patch+json 작업입니다.

options

DigitalTwinsUpdateComponentOptionalParams

ifMatch를 포함한 확장 작업 옵션: 엔터티의 etag가 제공된 etag 중 하나와 일치하거나 *가 제공된 경우에만 작업을 수행합니다.

반환

Promise<DigitalTwinsUpdateComponentResponse>

http 응답입니다.

updateDigitalTwin(string, any, DigitalTwinsUpdateOptionalParams)

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

function updateDigitalTwin(digitalTwinId: string, jsonPatch: any, options?: DigitalTwinsUpdateOptionalParams): Promise<DigitalTwinsUpdateResponse>

매개 변수

digitalTwinId

string

디지털 트윈의 ID입니다.

jsonPatch

any

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

options

DigitalTwinsUpdateOptionalParams

ifMatch를 포함한 확장 작업 옵션: 엔터티의 etag가 제공된 etag 중 하나와 일치하거나 *가 제공된 경우에만 작업을 수행합니다.

반환

Promise<DigitalTwinsUpdateResponse>

http 응답입니다.

updateRelationship(string, string, any[], DigitalTwinsUpdateRelationshipOptionalParams)

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

function updateRelationship(digitalTwinId: string, relationshipId: string, jsonPatch: any[], options?: DigitalTwinsUpdateRelationshipOptionalParams): Promise<DigitalTwinsUpdateRelationshipResponse>

매개 변수

digitalTwinId

string

삭제할 디지털 트윈의 ID입니다.

relationshipId

string

업데이트할 관계의 ID입니다.

jsonPatch

any[]

지정된 디지털 트윈의 관계에서 수행할 application/json-patch+json 작업입니다.

options

DigitalTwinsUpdateRelationshipOptionalParams

확장 작업 옵션 ifMatch: 엔터티의 etag가 제공된 etag 중 하나와 일치하거나 *가 제공된 경우에만 작업을 수행합니다.

반환

Promise<DigitalTwinsUpdateRelationshipResponse>

upsertDigitalTwin(string, string, DigitalTwinsAddOptionalParams)

디지털 트윈 만들기 또는 업데이트

function upsertDigitalTwin(digitalTwinId: string, digitalTwinJson: string, options?: DigitalTwinsAddOptionalParams): Promise<DigitalTwinsAddResponse>

매개 변수

digitalTwinId

string

만들거나 업데이트할 디지털 트윈의 ID입니다.

digitalTwinJson

string

만들 애플리케이션/json 디지털 트윈입니다.

options

DigitalTwinsAddOptionalParams

ifNoneMatch를 포함한 확장 작업 옵션: 엔터티가 아직 없는 경우에만 작업을 수행합니다.

반환

Promise<DigitalTwinsAddResponse>

생성된 애플리케이션/json 디지털 트윈 및 http 응답입니다.

upsertEventRoute(string, string, string, OperationOptions)

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

function upsertEventRoute(eventRouteId: string, endpointId: string, filter: string, options?: OperationOptions): Promise<RestResponse>

매개 변수

eventRouteId

string

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

endpointId

string

이 이벤트 경로가 바인딩된 엔드포인트의 ID입니다.

filter

string

엔드포인트로 라우팅되는 이벤트를 설명하는 식입니다.

options

OperationOptions

작업 옵션

반환

Promise<RestResponse>

http 응답입니다.

upsertRelationship(string, string, any, DigitalTwinsAddRelationshipOptionalParams)

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

function upsertRelationship(digitalTwinId: string, relationshipId: string, relationship: any, options?: DigitalTwinsAddRelationshipOptionalParams): Promise<DigitalTwinsAddRelationshipResponse>

매개 변수

digitalTwinId

string

원본 디지털 트윈의 ID입니다.

relationshipId

string

만들 관계의 ID입니다.

relationship

any

만들 애플리케이션/json 관계입니다.

options

DigitalTwinsAddRelationshipOptionalParams

ifNoneMatch를 포함한 확장 작업 옵션: 엔터티가 아직 없는 경우에만 작업을 수행합니다.

반환

Promise<DigitalTwinsAddRelationshipResponse>