CloudQueueClient.GetQueueReference Method

Storage Client Library NET API

[This topic is part of the Microsoft Azure Storage Client Library 1.7, which has been deprecated. See Storage Client Library for the latest version.]

Gets a reference to the queue at the specified address.

Namespace: Microsoft.WindowsAzure.StorageClient
Assembly: Microsoft.WindowsAzure.StorageClient (in Microsoft.WindowsAzure.StorageClient.dll)

Usage

Visual Basic
Dim instance As CloudQueueClient
Dim queueAddress As String
Dim returnValue As CloudQueue

returnValue = instance.GetQueueReference(queueAddress)

Syntax

Visual Basic
Public Function GetQueueReference ( _
	queueAddress As String _
) As CloudQueue
C#
public CloudQueue GetQueueReference (
	string queueAddress
)
C++
public:
CloudQueue^ GetQueueReference (
	String^ queueAddress
)
J#
JScript

Parameters

queueAddress

Type: System.String

Either the name of the queue, or the absolute URI to the queue.

Return Value

Type: Microsoft.WindowsAzure.StorageClient.CloudQueue

A reference to the queue.

Example

The following code example gets a reference to a queue and creates it if it does not exist.

 Copy Code
static void CreateQueue(Uri queueEndpoint, string accountName, string accountKey)
{
    //Create service client for credentialed access to the Queue service.
    CloudQueueClient queueClient = new CloudQueueClient(queueEndpoint, new StorageCredentialsAccountAndKey(accountName, accountKey));

    //Get a reference to a queue in this storage account.
    CloudQueue queue = queueClient.GetQueueReference("myqueue");

    //Check whether the queue exists, and create it if it does not.
    if (!queue.Exists())
    {
        queue.Create();
    }
}

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows Vista, Windows 7, Windows Server 2008, Windows 8.1, Windows Server 2012 R2, Windows 8 and Windows Server 2012

Change History

See Also