Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/digital-twins-core

Package version

Index

Classes

Interfaces

Type aliases

Variables

Object literals

Type aliases

DigitalTwinModelsAddResponse

DigitalTwinModelsAddResponse: DigitalTwinsModelData[] & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: DigitalTwinsModelData[] } }

Contains response data for the add operation.

DigitalTwinModelsGetByIdResponse

DigitalTwinModelsGetByIdResponse: DigitalTwinsModelData & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: DigitalTwinsModelData } }

Contains response data for the getById operation.

DigitalTwinModelsListNextResponse

DigitalTwinModelsListNextResponse: PagedDigitalTwinsModelDataCollection & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PagedDigitalTwinsModelDataCollection } }

Contains response data for the listNext operation.

DigitalTwinModelsListResponse

DigitalTwinModelsListResponse: PagedDigitalTwinsModelDataCollection & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PagedDigitalTwinsModelDataCollection } }

Contains response data for the list operation.

DigitalTwinsAddRelationshipResponse

DigitalTwinsAddRelationshipResponse: DigitalTwinsAddRelationshipHeaders & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: any; parsedHeaders: DigitalTwinsAddRelationshipHeaders }; body: any }

Contains response data for the addRelationship operation.

DigitalTwinsAddResponse

DigitalTwinsAddResponse: DigitalTwinsAddHeaders & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: any; parsedHeaders: DigitalTwinsAddHeaders }; body: any }

Contains response data for the add operation.

DigitalTwinsGetByIdResponse

DigitalTwinsGetByIdResponse: DigitalTwinsGetByIdHeaders & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: any; parsedHeaders: DigitalTwinsGetByIdHeaders }; body: any }

Contains response data for the getById operation.

DigitalTwinsGetComponentResponse

DigitalTwinsGetComponentResponse: DigitalTwinsGetComponentHeaders & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: any; parsedHeaders: DigitalTwinsGetComponentHeaders }; body: any }

Contains response data for the getComponent operation.

DigitalTwinsGetRelationshipByIdResponse

DigitalTwinsGetRelationshipByIdResponse: DigitalTwinsGetRelationshipByIdHeaders & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: any; parsedHeaders: DigitalTwinsGetRelationshipByIdHeaders }; body: any }

Contains response data for the getRelationshipById operation.

DigitalTwinsListIncomingRelationshipsNextResponse

DigitalTwinsListIncomingRelationshipsNextResponse: IncomingRelationshipCollection & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: IncomingRelationshipCollection } }

Contains response data for the listIncomingRelationshipsNext operation.

DigitalTwinsListIncomingRelationshipsResponse

DigitalTwinsListIncomingRelationshipsResponse: IncomingRelationshipCollection & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: IncomingRelationshipCollection } }

Contains response data for the listIncomingRelationships operation.

DigitalTwinsListRelationshipsNextResponse

DigitalTwinsListRelationshipsNextResponse: RelationshipCollection & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: RelationshipCollection } }

Contains response data for the listRelationshipsNext operation.

DigitalTwinsListRelationshipsResponse

DigitalTwinsListRelationshipsResponse: RelationshipCollection & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: RelationshipCollection } }

Contains response data for the listRelationships operation.

DigitalTwinsUpdateComponentResponse

DigitalTwinsUpdateComponentResponse: DigitalTwinsUpdateComponentHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: DigitalTwinsUpdateComponentHeaders } }

Contains response data for the updateComponent operation.

DigitalTwinsUpdateRelationshipResponse

DigitalTwinsUpdateRelationshipResponse: DigitalTwinsUpdateRelationshipHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: DigitalTwinsUpdateRelationshipHeaders } }

Contains response data for the updateRelationship operation.

DigitalTwinsUpdateResponse

DigitalTwinsUpdateResponse: DigitalTwinsUpdateHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: DigitalTwinsUpdateHeaders } }

Contains response data for the update operation.

EventRoutesGetByIdResponse

EventRoutesGetByIdResponse: EventRoute & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: EventRoute } }

Contains response data for the getById operation.

EventRoutesListNextResponse

EventRoutesListNextResponse: EventRouteCollection & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: EventRouteCollection } }

Contains response data for the listNext operation.

EventRoutesListResponse

EventRoutesListResponse: EventRouteCollection & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: EventRouteCollection } }

Contains response data for the list operation.

QueryQueryTwinsResponse

QueryQueryTwinsResponse: QueryQueryTwinsHeaders & QueryResult & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: QueryResult; parsedHeaders: QueryQueryTwinsHeaders } }

Contains response data for the queryTwins operation.

Variables

Const DEFAULT_DIGITALTWINS_SCOPE

DEFAULT_DIGITALTWINS_SCOPE: "https://digitaltwins.azure.net/.default" = "https://digitaltwins.azure.net/.default"

Const SDK_VERSION

SDK_VERSION: string = "1.1.0-beta.1"

Const logger

logger: any = createClientLogger("azure-digitaltwins-core")

The @azure/logger configuration for this package.

Const packageName

packageName: "@azure/digital-twins-core" = "@azure/digital-twins-core"

Const packageVersion

packageVersion: "1.1.0-beta.1" = "1.1.0-beta.1"

Const serializer

serializer: any = new coreHttp.Serializer(Mappers, /* isXml */ false)

Object literals

Const $host

$host: object

parameterPath

parameterPath: string = "$host"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "$host"

type

type: object

name

name: string = "String"

Const DigitalTwinsAddHeaders

DigitalTwinsAddHeaders: object

type

type: object

className

className: string = "DigitalTwinsAddHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: string = "String"

Const DigitalTwinsAddRelationshipHeaders

DigitalTwinsAddRelationshipHeaders: object

type

type: object

className

className: string = "DigitalTwinsAddRelationshipHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: string = "String"

Const DigitalTwinsGetByIdHeaders

DigitalTwinsGetByIdHeaders: object

type

type: object

className

className: string = "DigitalTwinsGetByIdHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: string = "String"

Const DigitalTwinsGetComponentHeaders

DigitalTwinsGetComponentHeaders: object

type

type: object

className

className: string = "DigitalTwinsGetComponentHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: string = "String"

Const DigitalTwinsGetRelationshipByIdHeaders

DigitalTwinsGetRelationshipByIdHeaders: object

type

type: object

className

className: string = "DigitalTwinsGetRelationshipByIdHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: string = "String"

Const DigitalTwinsModelData

DigitalTwinsModelData: object

type

type: object

className

className: string = "DigitalTwinsModelData"

name

name: string = "Composite"

modelProperties

modelProperties: object

decommissioned

decommissioned: object

serializedName

serializedName: string = "decommissioned"

type

type: object

name

name: string = "Boolean"

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "String"

displayName

displayName: object

serializedName

serializedName: string = "displayName"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "String"

id

id: object

required

required: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

model

model: object

serializedName

serializedName: string = "model"

type

type: object

name

name: string = "any"

uploadTime

uploadTime: object

serializedName

serializedName: string = "uploadTime"

type

type: object

name

name: string = "DateTime"

Const DigitalTwinsUpdateComponentHeaders

DigitalTwinsUpdateComponentHeaders: object

type

type: object

className

className: string = "DigitalTwinsUpdateComponentHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: string = "String"

Const DigitalTwinsUpdateHeaders

DigitalTwinsUpdateHeaders: object

type

type: object

className

className: string = "DigitalTwinsUpdateHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: string = "String"

Const DigitalTwinsUpdateRelationshipHeaders

DigitalTwinsUpdateRelationshipHeaders: object

type

type: object

className

className: string = "DigitalTwinsUpdateRelationshipHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: string = "String"

Const ErrorModel

ErrorModel: object

type

type: object

className

className: string = "ErrorModel"

name

name: string = "Composite"

modelProperties

modelProperties: object

code

code: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "code"

type

type: object

name

name: string = "String"

details

details: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "details"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ErrorModel"

name

name: string = "Composite"

innererror

innererror: object

serializedName

serializedName: string = "innererror"

type

type: object

className

className: string = "InnerError"

name

name: string = "Composite"

message

message: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "message"

type

type: object

name

name: string = "String"

Const ErrorResponse

ErrorResponse: object

type

type: object

className

className: string = "ErrorResponse"

name

name: string = "Composite"

modelProperties

modelProperties: object

error

error: object

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "ErrorModel"

name

name: string = "Composite"

Const EventRoute

EventRoute: object

type

type: object

className

className: string = "EventRoute"

name

name: string = "Composite"

modelProperties

modelProperties: object

endpointName

endpointName: object

required

required: boolean = true

serializedName

serializedName: string = "endpointName"

type

type: object

name

name: string = "String"

filter

filter: object

required

required: boolean = true

serializedName

serializedName: string = "filter"

type

type: object

name

name: string = "String"

id

id: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

Const EventRouteCollection

EventRouteCollection: object

type

type: object

className

className: string = "EventRouteCollection"

name

name: string = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "EventRoute"

name

name: string = "Composite"

Const IncomingRelationship

IncomingRelationship: object

type

type: object

className

className: string = "IncomingRelationship"

name

name: string = "Composite"

modelProperties

modelProperties: object

relationshipId

relationshipId: object

serializedName

serializedName: string = "$relationshipId"

type

type: object

name

name: string = "String"

relationshipLink

relationshipLink: object

serializedName

serializedName: string = "$relationshipLink"

type

type: object

name

name: string = "String"

relationshipName

relationshipName: object

serializedName

serializedName: string = "$relationshipName"

type

type: object

name

name: string = "String"

sourceId

sourceId: object

serializedName

serializedName: string = "$sourceId"

type

type: object

name

name: string = "String"

Const IncomingRelationshipCollection

IncomingRelationshipCollection: object

type

type: object

className

className: string = "IncomingRelationshipCollection"

name

name: string = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "IncomingRelationship"

name

name: string = "Composite"

Const InnerError

InnerError: object

type

type: object

className

className: string = "InnerError"

name

name: string = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: string = "String"

innererror

innererror: object

serializedName

serializedName: string = "innererror"

type

type: object

className

className: string = "InnerError"

name

name: string = "Composite"

Const PagedDigitalTwinsModelDataCollection

PagedDigitalTwinsModelDataCollection: object

type

type: object

className

className: string = "PagedDigitalTwinsModelDataCollection"

name

name: string = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DigitalTwinsModelData"

name

name: string = "Composite"

Const QueryQueryTwinsHeaders

QueryQueryTwinsHeaders: object

type

type: object

className

className: string = "QueryQueryTwinsHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

queryCharge

queryCharge: object

serializedName

serializedName: string = "query-charge"

type

type: object

name

name: string = "Number"

Const QueryResult

QueryResult: object

type

type: object

className

className: string = "QueryResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

continuationToken

continuationToken: object

serializedName

serializedName: string = "continuationToken"

type

type: object

name

name: string = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "any"

Const QuerySpecification

QuerySpecification: object

type

type: object

className

className: string = "QuerySpecification"

name

name: string = "Composite"

modelProperties

modelProperties: object

continuationToken

continuationToken: object

serializedName

serializedName: string = "continuationToken"

type

type: object

name

name: string = "String"

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: string = "String"

Const RelationshipCollection

RelationshipCollection: object

type

type: object

className

className: string = "RelationshipCollection"

name

name: string = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "any"

Const addOperationSpec

addOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.contentType,Parameters.traceparent,Parameters.tracestate]

httpMethod

httpMethod: string = "PUT"

mediaType

mediaType: string = "json"

path

path: string = "/eventroutes/{id}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.eventRoute

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host, Parameters.id]

responses

responses: object

202

202: {}

Type declaration

204

204: {}

Type declaration

200

200: object

headersMapper

headersMapper: any = Mappers.DigitalTwinsAddHeaders

bodyMapper

bodyMapper: object

type

type: object

name

name: string = "any"

201

201: object

bodyMapper

bodyMapper: object

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DigitalTwinsModelData"

name

name: string = "Composite"

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const addRelationshipOperationSpec

addRelationshipOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.contentType,Parameters.traceparent,Parameters.tracestate,Parameters.ifNoneMatch]

httpMethod

httpMethod: string = "PUT"

mediaType

mediaType: string = "json"

path

path: string = "/digitaltwins/{id}/relationships/{relationshipId}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.relationship

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host, Parameters.id, Parameters.relationshipId]

responses

responses: object

200

200: object

headersMapper

headersMapper: any = Mappers.DigitalTwinsAddRelationshipHeaders

bodyMapper

bodyMapper: object

type

type: object

name

name: string = "any"

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const apiVersion

apiVersion: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2021-06-30-preview"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: string = "String"

Const componentPath

componentPath: object

parameterPath

parameterPath: string = "componentPath"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "componentPath"

type

type: object

name

name: string = "String"

Const contentType

contentType: object

parameterPath

parameterPath: string[] = ["options", "contentType"]

mapper

mapper: object

defaultValue

defaultValue: string = "application/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Content-Type"

type

type: object

name

name: string = "String"

Const contentType1

contentType1: object

parameterPath

parameterPath: string[] = ["options", "contentType"]

mapper

mapper: object

defaultValue

defaultValue: string = "application/json-patch+json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Content-Type"

type

type: object

name

name: string = "String"

Const deleteOperationSpec

deleteOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.traceparent, Parameters.tracestate]

httpMethod

httpMethod: string = "DELETE"

path

path: string = "/eventroutes/{id}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host, Parameters.id]

responses

responses: object

204

204: {}

Type declaration

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const deleteRelationshipOperationSpec

deleteRelationshipOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.traceparent,Parameters.tracestate,Parameters.ifMatch]

httpMethod

httpMethod: string = "DELETE"

path

path: string = "/digitaltwins/{id}/relationships/{relationshipId}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host, Parameters.id, Parameters.relationshipId]

responses

responses: object

204

204: {}

Type declaration

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const dependenciesFor

dependenciesFor: object

collectionFormat

collectionFormat: any = QueryCollectionFormat.Csv

parameterPath

parameterPath: string[] = ["options", "dependenciesFor"]

mapper

mapper: object

serializedName

serializedName: string = "dependenciesFor"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const eventRoute

eventRoute: object

mapper

mapper: any = EventRouteMapper

parameterPath

parameterPath: string[] = ["options", "eventRoute"]

Const getByIdOperationSpec

getByIdOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.traceparent, Parameters.tracestate]

httpMethod

httpMethod: string = "GET"

path

path: string = "/eventroutes/{id}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host, Parameters.id]

responses

responses: object

200

200: object

headersMapper

headersMapper: any = Mappers.DigitalTwinsGetByIdHeaders

bodyMapper

bodyMapper: object = Mappers.EventRoute

type

type: object

name

name: string = "any"

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const getComponentOperationSpec

getComponentOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.traceparent, Parameters.tracestate]

httpMethod

httpMethod: string = "GET"

path

path: string = "/digitaltwins/{id}/components/{componentPath}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host, Parameters.id, Parameters.componentPath]

responses

responses: object

200

200: object

headersMapper

headersMapper: any = Mappers.DigitalTwinsGetComponentHeaders

bodyMapper

bodyMapper: object

type

type: object

name

name: string = "any"

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const getRelationshipByIdOperationSpec

getRelationshipByIdOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.traceparent, Parameters.tracestate]

httpMethod

httpMethod: string = "GET"

path

path: string = "/digitaltwins/{id}/relationships/{relationshipId}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host, Parameters.id, Parameters.relationshipId]

responses

responses: object

200

200: object

headersMapper

headersMapper: any = Mappers.DigitalTwinsGetRelationshipByIdHeaders

bodyMapper

bodyMapper: object

type

type: object

name

name: string = "any"

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const id

id: object

parameterPath

parameterPath: string = "id"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

Const ifMatch

ifMatch: object

parameterPath

parameterPath: string[] = ["options", "ifMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-Match"

type

type: object

name

name: string = "String"

Const ifNoneMatch

ifNoneMatch: object

parameterPath

parameterPath: string[] = ["options", "ifNoneMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-None-Match"

type

type: object

name

name: string = "String"

Const includeModelDefinition

includeModelDefinition: object

parameterPath

parameterPath: string[] = ["options", "includeModelDefinition"]

mapper

mapper: object

serializedName

serializedName: string = "includeModelDefinition"

type

type: object

name

name: string = "Boolean"

Const listIncomingRelationshipsNextOperationSpec

listIncomingRelationshipsNextOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.traceparent, Parameters.tracestate]

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host, Parameters.id, Parameters.nextLink]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.IncomingRelationshipCollection

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const listIncomingRelationshipsOperationSpec

listIncomingRelationshipsOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.traceparent, Parameters.tracestate]

httpMethod

httpMethod: string = "GET"

path

path: string = "/digitaltwins/{id}/incomingrelationships"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host, Parameters.id]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.IncomingRelationshipCollection

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const listNextOperationSpec

listNextOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.traceparent,Parameters.tracestate,Parameters.maxItemsPerPage]

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host, Parameters.nextLink]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.EventRouteCollection

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const listOperationSpec

listOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.traceparent,Parameters.tracestate,Parameters.maxItemsPerPage]

httpMethod

httpMethod: string = "GET"

path

path: string = "/eventroutes"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.EventRouteCollection

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const listRelationshipsNextOperationSpec

listRelationshipsNextOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.traceparent, Parameters.tracestate]

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion, Parameters.relationshipName]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host, Parameters.id, Parameters.nextLink]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.RelationshipCollection

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const listRelationshipsOperationSpec

listRelationshipsOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.traceparent, Parameters.tracestate]

httpMethod

httpMethod: string = "GET"

path

path: string = "/digitaltwins/{id}/relationships"

queryParameters

queryParameters: any[] = [Parameters.apiVersion, Parameters.relationshipName]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host, Parameters.id]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.RelationshipCollection

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const maxItemsPerPage

maxItemsPerPage: object

parameterPath

parameterPath: string[] = ["options", "maxItemsPerPage"]

mapper

mapper: object

serializedName

serializedName: string = "max-items-per-page"

type

type: object

name

name: string = "Number"

Const messageId

messageId: object

parameterPath

parameterPath: string = "messageId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "Message-Id"

type

type: object

name

name: string = "String"

Const models

models: object

parameterPath

parameterPath: string[] = ["options", "models"]

mapper

mapper: object

serializedName

serializedName: string = "models"

constraints

constraints: object

MinItems

MinItems: number = 1

UniqueItems

UniqueItems: boolean = true

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "any"

Const nextLink

nextLink: object

parameterPath

parameterPath: string = "nextLink"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

Const patchDocument

patchDocument: object

parameterPath

parameterPath: string = "patchDocument"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "patchDocument"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "any"

Const querySpecification

querySpecification: object

mapper

mapper: any = QuerySpecificationMapper

parameterPath

parameterPath: string = "querySpecification"

Const queryTwinsOperationSpec

queryTwinsOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.contentType,Parameters.traceparent,Parameters.tracestate,Parameters.maxItemsPerPage]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/query"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.querySpecification

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.QueryResult

headersMapper

headersMapper: any = Mappers.QueryQueryTwinsHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const relationship

relationship: object

parameterPath

parameterPath: string = "relationship"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "relationship"

type

type: object

name

name: string = "any"

Const relationshipId

relationshipId: object

parameterPath

parameterPath: string = "relationshipId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "relationshipId"

type

type: object

name

name: string = "String"

Const relationshipName

relationshipName: object

parameterPath

parameterPath: string[] = ["options", "relationshipName"]

mapper

mapper: object

serializedName

serializedName: string = "relationshipName"

type

type: object

name

name: string = "String"

Const sendComponentTelemetryOperationSpec

sendComponentTelemetryOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.contentType,Parameters.traceparent,Parameters.tracestate,Parameters.messageId,Parameters.telemetrySourceTime]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/digitaltwins/{id}/components/{componentPath}/telemetry"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.telemetry

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host, Parameters.id, Parameters.componentPath]

responses

responses: object

204

204: {}

Type declaration

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const sendTelemetryOperationSpec

sendTelemetryOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.contentType,Parameters.traceparent,Parameters.tracestate,Parameters.messageId,Parameters.telemetrySourceTime]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/digitaltwins/{id}/telemetry"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.telemetry

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host, Parameters.id]

responses

responses: object

204

204: {}

Type declaration

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const telemetry

telemetry: object

parameterPath

parameterPath: string = "telemetry"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "telemetry"

type

type: object

name

name: string = "any"

Const telemetrySourceTime

telemetrySourceTime: object

parameterPath

parameterPath: string[] = ["options", "telemetrySourceTime"]

mapper

mapper: object

serializedName

serializedName: string = "Telemetry-Source-Time"

type

type: object

name

name: string = "String"

Const traceparent

traceparent: object

parameterPath

parameterPath: string[] = ["options", "traceparent"]

mapper

mapper: object

serializedName

serializedName: string = "traceparent"

type

type: object

name

name: string = "String"

Const tracestate

tracestate: object

parameterPath

parameterPath: string[] = ["options", "tracestate"]

mapper

mapper: object

serializedName

serializedName: string = "tracestate"

type

type: object

name

name: string = "String"

Const twin

twin: object

parameterPath

parameterPath: string = "twin"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "twin"

type

type: object

name

name: string = "any"

Const updateComponentOperationSpec

updateComponentOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.traceparent,Parameters.tracestate,Parameters.contentType1,Parameters.ifMatch]

httpMethod

httpMethod: string = "PATCH"

mediaType

mediaType: string = "json"

path

path: string = "/digitaltwins/{id}/components/{componentPath}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.patchDocument

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host, Parameters.id, Parameters.componentPath]

responses

responses: object

202

202: {}

Type declaration

204

204: object

headersMapper

headersMapper: any = Mappers.DigitalTwinsUpdateComponentHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const updateModel

updateModel: object

parameterPath

parameterPath: string = "updateModel"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "updateModel"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "any"

Const updateOperationSpec

updateOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.traceparent,Parameters.tracestate,Parameters.contentType1,Parameters.ifMatch]

httpMethod

httpMethod: string = "PATCH"

mediaType

mediaType: string = "json"

path

path: string = "/digitaltwins/{id}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.patchDocument

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host, Parameters.id]

responses

responses: object

202

202: {}

Type declaration

204

204: object

headersMapper

headersMapper: any = Mappers.DigitalTwinsUpdateHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const updateRelationshipOperationSpec

updateRelationshipOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.traceparent,Parameters.tracestate,Parameters.contentType1,Parameters.ifMatch]

httpMethod

httpMethod: string = "PATCH"

mediaType

mediaType: string = "json"

path

path: string = "/digitaltwins/{id}/relationships/{relationshipId}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.patchDocument

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host, Parameters.id, Parameters.relationshipId]

responses

responses: object

204

204: object

headersMapper

headersMapper: any = Mappers.DigitalTwinsUpdateRelationshipHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Generated using TypeDoc