Share via

QueuesClient Interface

  • Reference
Package:
com.azure.resourcemanager.storage.fluent
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-storage:2.44.0

public interface QueuesClient

An instance of this class provides access to all the operations defined in QueuesClient.

Method Summary

Modifier and Type Method and Description
abstract StorageQueueInner create(String resourceGroupName, String accountName, String queueName, StorageQueueInner queue)

Creates a new queue with the specified queue name, under the specified account.
abstract Mono<StorageQueueInner> createAsync(String resourceGroupName, String accountName, String queueName, StorageQueueInner queue)

Creates a new queue with the specified queue name, under the specified account.
abstract Response<StorageQueueInner> createWithResponse(String resourceGroupName, String accountName, String queueName, StorageQueueInner queue, Context context)

Creates a new queue with the specified queue name, under the specified account.
abstract Mono<Response<StorageQueueInner>> createWithResponseAsync(String resourceGroupName, String accountName, String queueName, StorageQueueInner queue)

Creates a new queue with the specified queue name, under the specified account.
abstract void delete(String resourceGroupName, String accountName, String queueName)

Deletes the queue with the specified queue name, under the specified account if it exists.
abstract Mono<Void> deleteAsync(String resourceGroupName, String accountName, String queueName)

Deletes the queue with the specified queue name, under the specified account if it exists.
abstract Response<Void> deleteWithResponse(String resourceGroupName, String accountName, String queueName, Context context)

Deletes the queue with the specified queue name, under the specified account if it exists.
abstract Mono<Response<Void>> deleteWithResponseAsync(String resourceGroupName, String accountName, String queueName)

Deletes the queue with the specified queue name, under the specified account if it exists.
abstract StorageQueueInner get(String resourceGroupName, String accountName, String queueName)

Gets the queue with the specified queue name, under the specified account if it exists.
abstract Mono<StorageQueueInner> getAsync(String resourceGroupName, String accountName, String queueName)

Gets the queue with the specified queue name, under the specified account if it exists.
abstract Response<StorageQueueInner> getWithResponse(String resourceGroupName, String accountName, String queueName, Context context)

Gets the queue with the specified queue name, under the specified account if it exists.
abstract Mono<Response<StorageQueueInner>> getWithResponseAsync(String resourceGroupName, String accountName, String queueName)

Gets the queue with the specified queue name, under the specified account if it exists.
abstract PagedIterable<ListQueueInner> list(String resourceGroupName, String accountName)

Gets a list of all the queues under the specified storage account.
abstract PagedIterable<ListQueueInner> list(String resourceGroupName, String accountName, String maxpagesize, String filter, Context context)

Gets a list of all the queues under the specified storage account.
abstract PagedFlux<ListQueueInner> listAsync(String resourceGroupName, String accountName)

Gets a list of all the queues under the specified storage account.
abstract PagedFlux<ListQueueInner> listAsync(String resourceGroupName, String accountName, String maxpagesize, String filter)

Gets a list of all the queues under the specified storage account.
abstract StorageQueueInner update(String resourceGroupName, String accountName, String queueName, StorageQueueInner queue)

Creates a new queue with the specified queue name, under the specified account.
abstract Mono<StorageQueueInner> updateAsync(String resourceGroupName, String accountName, String queueName, StorageQueueInner queue)

Creates a new queue with the specified queue name, under the specified account.
abstract Response<StorageQueueInner> updateWithResponse(String resourceGroupName, String accountName, String queueName, StorageQueueInner queue, Context context)

Creates a new queue with the specified queue name, under the specified account.
abstract Mono<Response<StorageQueueInner>> updateWithResponseAsync(String resourceGroupName, String accountName, String queueName, StorageQueueInner queue)

Creates a new queue with the specified queue name, under the specified account.

Method Details

create

public abstract StorageQueueInner create(String resourceGroupName, String accountName, String queueName, StorageQueueInner queue)

Creates a new queue with the specified queue name, under the specified account.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
queueName - A queue name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of lowercase alphanumeric and dash(-) characters only, it should begin and end with an alphanumeric character and it cannot have two consecutive dash(-) characters.
queue - Queue properties and metadata to be created with.

Returns:

the response.

createAsync

public abstract Mono createAsync(String resourceGroupName, String accountName, String queueName, StorageQueueInner queue)

Creates a new queue with the specified queue name, under the specified account.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
queueName - A queue name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of lowercase alphanumeric and dash(-) characters only, it should begin and end with an alphanumeric character and it cannot have two consecutive dash(-) characters.
queue - Queue properties and metadata to be created with.

Returns:

the response body on successful completion of Mono.

createWithResponse

public abstract Response createWithResponse(String resourceGroupName, String accountName, String queueName, StorageQueueInner queue, Context context)

Creates a new queue with the specified queue name, under the specified account.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
queueName - A queue name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of lowercase alphanumeric and dash(-) characters only, it should begin and end with an alphanumeric character and it cannot have two consecutive dash(-) characters.
queue - Queue properties and metadata to be created with.
context - The context to associate with this operation.

Returns:

the response body along with Response<T>.

createWithResponseAsync

public abstract Mono> createWithResponseAsync(String resourceGroupName, String accountName, String queueName, StorageQueueInner queue)

Creates a new queue with the specified queue name, under the specified account.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
queueName - A queue name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of lowercase alphanumeric and dash(-) characters only, it should begin and end with an alphanumeric character and it cannot have two consecutive dash(-) characters.
queue - Queue properties and metadata to be created with.

Returns:

the response body along with Response<T> on successful completion of Mono.

delete

public abstract void delete(String resourceGroupName, String accountName, String queueName)

Deletes the queue with the specified queue name, under the specified account if it exists.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
queueName - A queue name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of lowercase alphanumeric and dash(-) characters only, it should begin and end with an alphanumeric character and it cannot have two consecutive dash(-) characters.

deleteAsync

public abstract Mono deleteAsync(String resourceGroupName, String accountName, String queueName)

Deletes the queue with the specified queue name, under the specified account if it exists.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
queueName - A queue name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of lowercase alphanumeric and dash(-) characters only, it should begin and end with an alphanumeric character and it cannot have two consecutive dash(-) characters.

Returns:

A Mono that completes when a successful response is received.

deleteWithResponse

public abstract Response deleteWithResponse(String resourceGroupName, String accountName, String queueName, Context context)

Deletes the queue with the specified queue name, under the specified account if it exists.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
queueName - A queue name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of lowercase alphanumeric and dash(-) characters only, it should begin and end with an alphanumeric character and it cannot have two consecutive dash(-) characters.
context - The context to associate with this operation.

Returns:

deleteWithResponseAsync

public abstract Mono> deleteWithResponseAsync(String resourceGroupName, String accountName, String queueName)

Deletes the queue with the specified queue name, under the specified account if it exists.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
queueName - A queue name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of lowercase alphanumeric and dash(-) characters only, it should begin and end with an alphanumeric character and it cannot have two consecutive dash(-) characters.

Returns:

the Response<T> on successful completion of Mono.

get

public abstract StorageQueueInner get(String resourceGroupName, String accountName, String queueName)

Gets the queue with the specified queue name, under the specified account if it exists.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
queueName - A queue name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of lowercase alphanumeric and dash(-) characters only, it should begin and end with an alphanumeric character and it cannot have two consecutive dash(-) characters.

Returns:

the queue with the specified queue name, under the specified account if it exists.

getAsync

public abstract Mono getAsync(String resourceGroupName, String accountName, String queueName)

Gets the queue with the specified queue name, under the specified account if it exists.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
queueName - A queue name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of lowercase alphanumeric and dash(-) characters only, it should begin and end with an alphanumeric character and it cannot have two consecutive dash(-) characters.

Returns:

the queue with the specified queue name, under the specified account if it exists on successful completion of Mono.

getWithResponse

public abstract Response getWithResponse(String resourceGroupName, String accountName, String queueName, Context context)

Gets the queue with the specified queue name, under the specified account if it exists.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
queueName - A queue name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of lowercase alphanumeric and dash(-) characters only, it should begin and end with an alphanumeric character and it cannot have two consecutive dash(-) characters.
context - The context to associate with this operation.

Returns:

the queue with the specified queue name, under the specified account if it exists along with Response<T>.

getWithResponseAsync

public abstract Mono> getWithResponseAsync(String resourceGroupName, String accountName, String queueName)

Gets the queue with the specified queue name, under the specified account if it exists.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
queueName - A queue name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of lowercase alphanumeric and dash(-) characters only, it should begin and end with an alphanumeric character and it cannot have two consecutive dash(-) characters.

Returns:

the queue with the specified queue name, under the specified account if it exists along with Response<T> on successful completion of Mono.

list

public abstract PagedIterable list(String resourceGroupName, String accountName)

Gets a list of all the queues under the specified storage account.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

Returns:

a list of all the queues under the specified storage account as paginated response with PagedIterable<T>.

list

public abstract PagedIterable list(String resourceGroupName, String accountName, String maxpagesize, String filter, Context context)

Gets a list of all the queues under the specified storage account.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
maxpagesize - Optional, a maximum number of queues that should be included in a list queue response.
filter - Optional, When specified, only the queues with a name starting with the given filter will be listed.
context - The context to associate with this operation.

Returns:

a list of all the queues under the specified storage account as paginated response with PagedIterable<T>.

listAsync

public abstract PagedFlux listAsync(String resourceGroupName, String accountName)

Gets a list of all the queues under the specified storage account.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

Returns:

a list of all the queues under the specified storage account as paginated response with PagedFlux<T>.

listAsync

public abstract PagedFlux listAsync(String resourceGroupName, String accountName, String maxpagesize, String filter)

Gets a list of all the queues under the specified storage account.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
maxpagesize - Optional, a maximum number of queues that should be included in a list queue response.
filter - Optional, When specified, only the queues with a name starting with the given filter will be listed.

Returns:

a list of all the queues under the specified storage account as paginated response with PagedFlux<T>.

update

public abstract StorageQueueInner update(String resourceGroupName, String accountName, String queueName, StorageQueueInner queue)

Creates a new queue with the specified queue name, under the specified account.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
queueName - A queue name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of lowercase alphanumeric and dash(-) characters only, it should begin and end with an alphanumeric character and it cannot have two consecutive dash(-) characters.
queue - Queue properties and metadata to be created with.

Returns:

the response.

updateAsync

public abstract Mono updateAsync(String resourceGroupName, String accountName, String queueName, StorageQueueInner queue)

Creates a new queue with the specified queue name, under the specified account.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
queueName - A queue name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of lowercase alphanumeric and dash(-) characters only, it should begin and end with an alphanumeric character and it cannot have two consecutive dash(-) characters.
queue - Queue properties and metadata to be created with.

Returns:

the response body on successful completion of Mono.

updateWithResponse

public abstract Response updateWithResponse(String resourceGroupName, String accountName, String queueName, StorageQueueInner queue, Context context)

Creates a new queue with the specified queue name, under the specified account.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
queueName - A queue name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of lowercase alphanumeric and dash(-) characters only, it should begin and end with an alphanumeric character and it cannot have two consecutive dash(-) characters.
queue - Queue properties and metadata to be created with.
context - The context to associate with this operation.

Returns:

the response body along with Response<T>.

updateWithResponseAsync

public abstract Mono> updateWithResponseAsync(String resourceGroupName, String accountName, String queueName, StorageQueueInner queue)

Creates a new queue with the specified queue name, under the specified account.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
queueName - A queue name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of lowercase alphanumeric and dash(-) characters only, it should begin and end with an alphanumeric character and it cannot have two consecutive dash(-) characters.
queue - Queue properties and metadata to be created with.

Returns:

the response body along with Response<T> on successful completion of Mono.

Applies to