ServiceBusAdministrationClient.GetQueueAsync Método

Referência

Definição

Namespace:: Azure.Messaging.ServiceBus.Administration

Assembly:: Azure.Messaging.ServiceBus.dll

Pacote:: Azure.Messaging.ServiceBus v7.17.5

Pacote:: Azure.Messaging.ServiceBus v7.18.0-beta.1

Origem:: ServiceBusAdministrationClient.cs

Origem:: ServiceBusAdministrationClient.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.

Recupera uma fila do namespace de serviço.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Messaging.ServiceBus.Administration.QueueProperties>> GetQueueAsync (string name, System.Threading.CancellationToken cancellationToken = default);

abstract member GetQueueAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Messaging.ServiceBus.Administration.QueueProperties>>
override this.GetQueueAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Messaging.ServiceBus.Administration.QueueProperties>>

Public Overridable Function GetQueueAsync (name As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of QueueProperties))

Parâmetros

name: String

O nome da fila em relação ao namespace do barramento de serviço.

cancellationToken: CancellationToken

Uma instância opcional CancellationToken para sinalizar a solicitação para cancelar a operação.

Retornos

Task<Response<QueueProperties>>

QueueProperties que contém informações sobre a fila.

Exceções

ServiceTimeout

A operação atinge o tempo limite. O período de tempo limite é inicializado por meio da ServiceBusAdministrationClientOptions classe (consulte a propriedade Retry). Talvez seja necessário aumentar o valor do tempo limite para evitar essa exceção se o valor de tempo limite for relativamente baixo.

MessagingEntityNotFound

A fila com esse nome não existe.

ServiceBusy

O servidor está ocupado. Você deve aguardar antes de repetir a operação.

ArgumentNullException

O nome da fila é nulo ou vazio.

ArgumentOutOfRangeException

O nome da fila excede o comprimento máximo permitido.

ArgumentException

Caso contrário, o nome da fila é inválido.

UnauthorizedAccessException

Permissão insuficiente para executar essa operação. Você deve marcar para garantir que você ServiceBusAdministrationClient tenha as declarações necessárias para executar essa operação. https://docs.microsoft.com/azure/service-bus-messaging/service-bus-sas#rights-required-for-service-bus-operations

ServiceBusException

Não foi possível encontrar a entidade especificada. O Reason será definido MessagingEntityNotFound como nesse caso.
A operação atingiu o tempo limite. O Reason será definido ServiceTimeout como nesse caso.
O servidor está ocupado. Você deve aguardar antes de repetir a operação. O motivo da falha será definido ServiceBusy como nesse caso.
Ocorre um erro interno ou uma exceção inesperada. O motivo da falha será definido GeneralError como nesse caso.

Aplica-se a

Share via