DigitalTwinsClient.GetRelationshipsAsync<T> Méthode

Définition

Espace de noms:

Azure.DigitalTwins.Core

Assembly:

Azure.DigitalTwins.Core.dll

Paquet:

Azure.DigitalTwins.Core v1.4.0

Source:

DigitalTwinsClient.cs

Obtient toutes les relations sur un jumeau numérique en itérant dans une collection de manière asynchrone.

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)

Paramètres de type

T

Type auquel désérialiser la relation.

Paramètres

digitalTwinId

String

ID du jumeau numérique source.

relationshipName

String

Nom d’une relation vers laquelle filtrer. Si la valeur est null, toutes les relations pour le jumeau numérique seront retournées.

cancellationToken

CancellationToken

Jeton d'annulation.

Retours

AsyncPageable<T>

Liste paginable AsyncPageable<T> des relations application/json appartenant au jumeau numérique spécifié et à la réponse HTTP.

Exceptions

RequestFailedException

Exception qui capture les erreurs du service. Pour plus d’informations, consultez les ErrorCode propriétés et Status .

ArgumentNullException

L’exception est levée lorsque digitalTwinId est null.

Exemples

Cet exemple illustre l’itération sur les relations sortantes et la désérialisation des chaînes de relation dans des objets BasicRelationship.

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"]}");
}

Remarques

Les relations retournées dans le cadre de la liste paginable peuvent toujours être désérialisées dans un instance de BasicRelationship. Vous pouvez également désérialiser la relation en type personnalisé qui étend le BasicRelationship.

Pour plus d’exemples, consultez nos exemples de référentiels.

Voir aussi

• GetRelationships<T>(String, String, CancellationToken)