DigitalTwinsClient.GetRelationshipsAsync<T> Método

Referência

Definição

Namespace:: Azure.DigitalTwins.Core

Assembly:: Azure.DigitalTwins.Core.dll

Pacote:: Azure.DigitalTwins.Core v1.4.0

Origem:: DigitalTwinsClient.cs

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Obtém todas as relações em um gêmeo digital iterando por meio de uma coleção de forma assíncrona.

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)

Parâmetros de tipo

T

O tipo com o qual desserializar a relação.

Parâmetros

digitalTwinId: String

A ID do gêmeo digital de origem.

relationshipName: String

O nome de uma relação para a qual filtrar. Se for nulo, todas as relações para o gêmeo digital serão retornadas.

cancellationToken: CancellationToken

O token de cancelamento.

Retornos

AsyncPageable<T>

A lista AsyncPageable<T> paginável de relações de aplicativo/json pertencentes ao gêmeo digital especificado e à resposta HTTP.

Exceções

RequestFailedException

A exceção que captura os erros do serviço. Verifique as ErrorCode propriedades e Status para obter mais detalhes.

ArgumentNullException

A exceção é gerada quando digitalTwinId é null.

Exemplos

Este exemplo demonstra a iteração sobre relações de saída e desserialização de cadeias de caracteres de relação em objetos 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"]}");
}

Comentários

As relações retornadas como parte da lista paginável sempre podem ser desserializadas em uma instância do BasicRelationship. Você também pode desserializar a relação em um tipo personalizado que estenda o BasicRelationship.

Para obter mais exemplos, confira nossos exemplos de repositório.

Aplica-se a

Confira também

GetRelationships<T>(String, String, CancellationToken)

Compartilhar via