JobRouterAdministrationClient.GetQueue Method

Definition

Namespace:

Azure.Communication.JobRouter

Assembly:

Azure.Communication.JobRouter.dll

Package:

Azure.Communication.JobRouter v1.0.0

Overloads

GetQueue(String, RequestContext)	[Protocol Method] Retrieves an existing queue by Id. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetQueue(String, CancellationToken) convenience overload with strongly typed models first.
GetQueue(String, CancellationToken)	Retrieves an existing queue by Id.

GetQueue(String, RequestContext)

Source:

JobRouterAdministrationClient.cs

[Protocol Method] Retrieves an existing queue by Id.

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
• Please try the simpler GetQueue(String, CancellationToken) convenience overload with strongly typed models first.

public virtual Azure.Response GetQueue (string queueId, Azure.RequestContext context);

abstract member GetQueue : string * Azure.RequestContext -> Azure.Response
override this.GetQueue : string * Azure.RequestContext -> Azure.Response

Public Overridable Function GetQueue (queueId As String, context As RequestContext) As Response

Parameters

queueId

String

Id of a queue.

context

RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Response

The response returned from the service.

Exceptions

ArgumentNullException

queueId is null.

ArgumentException

queueId is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

GetQueue(String, CancellationToken)

Source:

JobRouterAdministrationClient.cs

Retrieves an existing queue by Id.

public virtual Azure.Response<Azure.Communication.JobRouter.RouterQueue> GetQueue (string queueId, System.Threading.CancellationToken cancellationToken = default);

abstract member GetQueue : string * System.Threading.CancellationToken -> Azure.Response<Azure.Communication.JobRouter.RouterQueue>
override this.GetQueue : string * System.Threading.CancellationToken -> Azure.Response<Azure.Communication.JobRouter.RouterQueue>

Public Overridable Function GetQueue (queueId As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of RouterQueue)

Parameters

queueId

String

Id of a queue.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response<RouterQueue>

Exceptions

ArgumentNullException

queueId is null.

ArgumentException

queueId is an empty string, and was expected to be non-empty.