AzuredigitaltwinsClient

Attributes

AddModelsInput module-attribute

AddModelsInput = List[Dict[str, Any]]

Classes

ListModelsResponse dataclass

ListModelsResponse(value: Optional[List[Dict[str, Any]]] = None, continuation_token: Optional[str] = None, next_link: Optional[str] = None)

Response for List Models

Attributes

value class-attribute instance-attribute

value: Optional[List[Dict[str, Any]]] = None

Array values.

continuation_token class-attribute instance-attribute

continuation_token: Optional[str] = field(default=None, metadata={'wire_name': 'continuationToken'})

Continuation Token the next page of Twin Relationship.

next_link class-attribute instance-attribute

next_link: Optional[str] = field(default=None, metadata={'wire_name': 'nextLink'})

URL to get the next page of Models.

GetModelByIdResponse dataclass

GetModelByIdResponse(id: Optional[str] = None, upload_time: Optional[str] = None, decommissioned: Optional[bool] = None, model: Optional[Dict[str, Any]] = None)

Response for Get Model By Id

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

The id of the model as specified in the model definition.

upload_time class-attribute instance-attribute

upload_time: Optional[str] = field(default=None, metadata={'wire_name': 'uploadTime'})

The time the model was uploaded to the service.

decommissioned class-attribute instance-attribute

decommissioned: Optional[bool] = None

Indicates if the model is decommissioned. Decommissioned models cannot be referenced by newly created digital twins.

model class-attribute instance-attribute

model: Optional[Dict[str, Any]] = None

Model reference.

UpdateModelInput dataclass

UpdateModelInput(value: Optional[str] = None)

Update Model's Property

Attributes

value class-attribute instance-attribute

value: Optional[str] = None

Request for the API.

TwinResult dataclass

TwinResult(result: Optional[str] = None)

Response for Get Twin by Id

Attributes

result class-attribute instance-attribute

result: Optional[str] = None

Results From the Twin.

AddTwinInput dataclass

AddTwinInput(value: Optional[str] = None)

Add Twin

Attributes

value class-attribute instance-attribute

value: Optional[str] = None

Request for the API.

UpdateTwinInput dataclass

UpdateTwinInput(value: Optional[str] = None)

Update Twin

Attributes

value class-attribute instance-attribute

value: Optional[str] = None

Request for the API.

GetComponentResult dataclass

GetComponentResult(result: Optional[str] = None)

Response for Get Component

Attributes

result class-attribute instance-attribute

result: Optional[str] = None

Results From the Twin.

UpdateComponentInput dataclass

UpdateComponentInput(value: Optional[str] = None)

Update Component

Attributes

value class-attribute instance-attribute

value: Optional[str] = None

Request for the API.

TwinRelationship dataclass

TwinRelationship(source_id: Optional[str] = None, relationship_id: Optional[str] = None, target_id: Optional[str] = None, relationship_name: Optional[str] = None, etag: Optional[str] = None, additional_properties: Optional[str] = None)

Response for Get Relationship by Id

Attributes

source_id class-attribute instance-attribute

source_id: Optional[str] = field(default=None, metadata={'wire_name': '$sourceId'})

Source Id.

relationship_id class-attribute instance-attribute

relationship_id: Optional[str] = field(default=None, metadata={'wire_name': '$relationshipId'})

Relationship Id.

target_id class-attribute instance-attribute

target_id: Optional[str] = field(default=None, metadata={'wire_name': '$targetId'})

Target Id.

relationship_name class-attribute instance-attribute

relationship_name: Optional[str] = field(default=None, metadata={'wire_name': '$relationshipName'})

Relationship Name.

etag class-attribute instance-attribute

etag: Optional[str] = field(default=None, metadata={'wire_name': '$etag'})

E Tag Link.

additional_properties class-attribute instance-attribute

additional_properties: Optional[str] = field(default=None, metadata={'wire_name': 'additionalProperties'})

Property Values.

AddRelationshipInput dataclass

AddRelationshipInput(value: Optional[str] = None)

Add Relationship

Attributes

value class-attribute instance-attribute

value: Optional[str] = None

Request for the API.

UpdateRelationshipInput dataclass

UpdateRelationshipInput(value: Optional[str] = None)

Update Relationship

Attributes

value class-attribute instance-attribute

value: Optional[str] = None

Request for the API.

ListIncomingRelationshipsResponse dataclass

ListIncomingRelationshipsResponse(value: Optional[List[IncomingRelationship]] = None, continuation_token: Optional[str] = None, next_link: Optional[str] = None)

Response for List Incoming Relationships

Attributes

value class-attribute instance-attribute

value: Optional[List[IncomingRelationship]] = None

The collection of Incoming relationships.

continuation_token class-attribute instance-attribute

continuation_token: Optional[str] = field(default=None, metadata={'wire_name': 'continuationToken'})

Continuation Token the next page of Twin Relationship.

next_link class-attribute instance-attribute

next_link: Optional[str] = field(default=None, metadata={'wire_name': 'nextLink'})

URL to get the next page of Incoming Relationship.

SendTelemetryInput dataclass

SendTelemetryInput(value: Optional[str] = None)

Send Telemetry

Attributes

value class-attribute instance-attribute

value: Optional[str] = None

Send Telemetry Inputs.

SendComponentTelemetryInput dataclass

SendComponentTelemetryInput(value: Optional[str] = None)

Send Component Telemetry

Attributes

value class-attribute instance-attribute

value: Optional[str] = None

Send Component Telemetry Inputs.

ListRelationshipsResponse dataclass

ListRelationshipsResponse(value: Optional[List[TwinRelationship]] = None, continuation_token: Optional[str] = None, next_link: Optional[str] = None)

Response for List Relationships

Attributes

value class-attribute instance-attribute

value: Optional[List[TwinRelationship]] = None

The collection of twin relationships.

continuation_token class-attribute instance-attribute

continuation_token: Optional[str] = field(default=None, metadata={'wire_name': 'continuationToken'})

Continuation Token the next page of Twin Relationship.

next_link class-attribute instance-attribute

next_link: Optional[str] = field(default=None, metadata={'wire_name': 'nextLink'})

URL to get the next page of Twin Relationship.

QueryTwinsInput dataclass

QueryTwinsInput(query: Optional[str] = None, continuation_token: Optional[str] = None)

Query API

Attributes

query class-attribute instance-attribute

query: Optional[str] = None

Query the Twins.

continuation_token class-attribute instance-attribute

continuation_token: Optional[str] = field(default=None, metadata={'wire_name': 'continuationToken'})

Link to get next set of items.

QueryResult dataclass

QueryResult(value: Optional[str] = None, continuation_token: Optional[str] = None)

Response for Query API

Attributes

value class-attribute instance-attribute

value: Optional[str] = None

Results From the Twin.

continuation_token class-attribute instance-attribute

continuation_token: Optional[str] = field(default=None, metadata={'wire_name': 'continuationToken'})

Link to get next set of items.

IncomingRelationship dataclass

IncomingRelationship(source_id: Optional[str] = None, relationship_id: Optional[str] = None, relationship_name: Optional[str] = None, relationship_link: Optional[str] = None)

Definition: IncomingRelationship

Attributes

source_id class-attribute instance-attribute

source_id: Optional[str] = field(default=None, metadata={'wire_name': '$sourceId'})

Source Id.

relationship_id class-attribute instance-attribute

relationship_id: Optional[str] = field(default=None, metadata={'wire_name': '$relationshipId'})

Relationship Id.

relationship_name class-attribute instance-attribute

relationship_name: Optional[str] = field(default=None, metadata={'wire_name': '$relationshipName'})

Relationship Name.

relationship_link class-attribute instance-attribute

relationship_link: Optional[str] = field(default=None, metadata={'wire_name': '$relationshipLink'})

Relationship Link.

AzuredigitaltwinsClient

AzuredigitaltwinsClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

Bases: ConnectorClientBase

Typed client for azuredigitaltwins connector.

Initialize a AzuredigitaltwinsClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
token_provider	Optional[TokenProvider]	Optional token provider. Defaults to ManagedIdentityTokenProvider.	None
options	Optional[ConnectorClientOptions]	Optional connector client options.	None

Methods:

add_models_async async

add_models_async(input: AddModelsInput) -> dict[str, Any] | None

Add Model

Uploads one or more models. When any error occurs, no models are uploaded.

list_models_async async

list_models_async(dependencies_for: Optional[str] = None, include_model_definition: Optional[str] = None, continuation_token: Optional[str] = None) -> dict[str, Any] | None

List Models

Retrieves model metadata and, optionally, model definitions.

delete_model_async async

delete_model_async(modelid: str) -> None

Delete Model

Deletes a model. A model can only be deleted if no other models reference it.

get_model_by_id_async async

get_model_by_id_async(modelid: str, include_model_definition: Optional[str] = None) -> dict[str, Any] | None

Get Model By Id

Retrieves model metadata and, optionally, the model definition.

update_model_async async

update_model_async(input: UpdateModelInput, modelid: str) -> None

Update Model's Property

Updates the metadata for a model.

get_twin_by_id_async async

get_twin_by_id_async(twinid: str) -> dict[str, Any] | None

Get Twin by Id

Retrieves a digital twin and its data.

delete_twin_async async

delete_twin_async(twinid: str) -> None

Delete Twin

Deletes a digital twin. All relationships referencing the digital twin must already be deleted.

add_twin_async async

add_twin_async(input: AddTwinInput, twinid: str) -> dict[str, Any] | None

Add Twin

Adds or replaces a digital twin.

update_twin_async async

update_twin_async(input: UpdateTwinInput, twinid: str) -> None

Update Twin

Updates properties on a twin.

get_component_async async

get_component_async(twinid: str, component_path: str) -> dict[str, Any] | None

Get Component

Retrieves a component from a digital twin.

update_component_async async

update_component_async(input: UpdateComponentInput, twinid: str, component_path: str) -> None

Update Component

Updates integer properties on a component of a twin.

get_relationship_by_id_async async

get_relationship_by_id_async(twinid: str, relationship_id: str) -> dict[str, Any] | None

Get Relationship by Id

Retrieves a relationship between two digital twins.

delete_relationship_async async

delete_relationship_async(twinid: str, relationship_id: str) -> None

Delete Relationship

Deletes a relationship between two digital twins.

add_relationship_async async

add_relationship_async(input: AddRelationshipInput, twinid: str, relationship_id: str) -> dict[str, Any] | None

Add Relationship

Adds a relationship between two digital twins.

update_relationship_async async

update_relationship_async(input: UpdateRelationshipInput, twinid: str, relationship_id: str) -> None

Update Relationship

Updates integer properties on a relationship between two digital twins.

list_incoming_relationships_async async

list_incoming_relationships_async(twinid: str, continuation_token: Optional[str] = None) -> dict[str, Any] | None

List Incoming Relationships

Retrieves all incoming relationships for a digital twin.

send_telemetry_async async

send_telemetry_async(input: SendTelemetryInput, twinid: str) -> None

Send Telemetry

Sends telemetry on behalf of a digital twin.

send_component_telemetry_async async

send_component_telemetry_async(input: SendComponentTelemetryInput, twinid: str, component_path: str) -> None

Send Component Telemetry

Sends telemetry on behalf of a component in a digital twin.

list_relationships_async async

list_relationships_async(twinid: str, continuation_token: Optional[str] = None) -> dict[str, Any] | None

List Relationships

Retrieves all outgoing relationships from a digital twin.

query_twins_async async

query_twins_async(input: QueryTwinsInput) -> dict[str, Any] | None

Query API

Executes a query that allows traversing relationships and filtering by property values.