DigitalTwinsClient.GetRelationshipsAsync<T> Methode

Referenz

Definition

Namespace:: Azure.DigitalTwins.Core

Assembly:: Azure.DigitalTwins.Core.dll

Paket:: Azure.DigitalTwins.Core v1.4.0

Quelle:: DigitalTwinsClient.cs

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Ruft alle Beziehungen zu einem digitalen Zwilling ab, indem eine Auflistung asynchron durchlaufen wird.

public virtual Azure.AsyncPageable<T> GetRelationshipsAsync<T> (string digitalTwinId, string relationshipName = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetRelationshipsAsync : string * string * System.Threading.CancellationToken -> Azure.AsyncPageable<'T>
override this.GetRelationshipsAsync : string * string * System.Threading.CancellationToken -> Azure.AsyncPageable<'T>

Public Overridable Function GetRelationshipsAsync(Of T) (digitalTwinId As String, Optional relationshipName As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of T)

Typparameter

T

Der Typ, mit dem die Beziehung deserialisiert werden soll.

Parameter

digitalTwinId: String

Die ID des digitalen Quellzwillens.

relationshipName: String

Der Name einer Beziehung, nach der gefiltert werden soll. Bei NULL werden alle Beziehungen für den digitalen Zwilling zurückgegeben.

cancellationToken: CancellationToken

Das Abbruchtoken.

Gibt zurück

AsyncPageable<T>

Die auslagerungsfähige Liste AsyncPageable<T> der Anwendungs-/JSON-Beziehungen, die zum angegebenen digitalen Zwilling gehören, und der HTTP-Antwort.

Ausnahmen

RequestFailedException

Die Ausnahme, die die Fehler des Diensts erfasst. Weitere Details finden Sie in den ErrorCode Eigenschaften und Status .

ArgumentNullException

Die Ausnahme wird ausgelöst, wenn digitalTwinId ist null.

Beispiele

Dieses Beispiel veranschaulicht das Durchlaufen ausgehender Beziehungen und das Deserialisieren von Beziehungszeichenfolgen in BasicRelationship-Objekte.

AsyncPageable<BasicRelationship> relationships = client.GetRelationshipsAsync<BasicRelationship>("buildingTwinId");
await foreach (BasicRelationship relationship in relationships)
{
    Console.WriteLine($"Retrieved relationship '{relationship.Id}' with source {relationship.SourceId}' and " +
        $"target {relationship.TargetId}.\n\t" +
        $"Prop1: {relationship.Properties["Prop1"]}\n\t" +
        $"Prop2: {relationship.Properties["Prop2"]}");
}

Hinweise

Beziehungen, die als Teil der Auslagerungsliste zurückgegeben werden, können immer in eine instance von BasicRelationshipdeserialisiert werden. Sie können die Beziehung auch in einen benutzerdefinierten Typ deserialisieren, der den BasicRelationshiperweitert.

Weitere Beispiele finden Sie in unseren Repositorybeispielen.

Gilt für:

Weitere Informationen

GetRelationships<T>(String, String, CancellationToken)

Freigeben über