ConfigurationsClient.GetAsync Método

Definição

Namespace:

Microsoft.Azure.Devices

Assembly:

Microsoft.Azure.Devices.dll

Pacote:

Microsoft.Azure.Devices v2.0.0-preview002

Sobrecargas

GetAsync(Int32, CancellationToken)	Recupera o número especificado de configuração de cada partição do Hub IoT. Os resultados não são ordenados.
GetAsync(String, CancellationToken)	Recupera o objeto de configuração especificado.

GetAsync(Int32, CancellationToken)

Recupera o número especificado de configuração de cada partição do Hub IoT. Os resultados não são ordenados.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.Azure.Devices.Configuration>> GetAsync (int maxCount, System.Threading.CancellationToken cancellationToken = default);

abstract member GetAsync : int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<seq<Microsoft.Azure.Devices.Configuration>>
override this.GetAsync : int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<seq<Microsoft.Azure.Devices.Configuration>>

Public Overridable Function GetAsync (maxCount As Integer, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IEnumerable(Of Configuration))

Parâmetros

maxCount

Int32

cancellationToken

CancellationToken

Retornos

Task<IEnumerable<Configuration>>

A lista de configuração.

Exceções

ArgumentException

Gerado se o maxCount valor for menor que zero.

IotHubServiceException

Gerado se o Hub IoT respondeu à solicitação com um código de status não bem-sucedido. Por exemplo, se a solicitação fornecida foi limitada, IotHubServiceException com ThrottlingException é lançada. Para obter uma lista completa de possíveis casos de erro, consulte IotHubServiceErrorCode.

HttpRequestException

Se a solicitação HTTP falhar devido a um problema subjacente, como conectividade de rede, falha de DNS ou validação de certificado do servidor.

OperationCanceledException

Se o fornecido cancellationToken tiver solicitado o cancelamento.

GetAsync(String, CancellationToken)

Recupera o objeto de configuração especificado.

public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.Configuration> GetAsync (string configurationId, System.Threading.CancellationToken cancellationToken = default);

abstract member GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.Configuration>
override this.GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.Configuration>

Public Overridable Function GetAsync (configurationId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Configuration)

Parâmetros

configurationId

String

A ID da configuração que está sendo recuperada.

cancellationToken

CancellationToken

O token que permite que a operação seja cancelada.

Retornos

Task<Configuration>

O objeto de configuração.

Exceções

ArgumentNullException

Gerado quando o fornecido configurationId é nulo.

ArgumentException

Gerado se o configurationId estiver vazio ou espaço em branco.

IotHubServiceException

Gerado se o Hub IoT respondeu à solicitação com um código de status não bem-sucedido. Por exemplo, se a solicitação fornecida foi limitada, IotHubServiceException com ThrottlingException é lançada. Para obter uma lista completa de possíveis casos de erro, consulte IotHubServiceErrorCode.

HttpRequestException

Se a solicitação HTTP falhar devido a um problema subjacente, como conectividade de rede, falha de DNS ou validação de certificado do servidor.

OperationCanceledException

Se o fornecido cancellationToken tiver solicitado o cancelamento.