com.azure.resourcemanager.storage.fluent

Interface QueuesClient

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
StorageQueueInner	create(String resourceGroupName, String accountName, String queueName) Creates a new queue with the specified queue name, under the specified account.
Mono<StorageQueueInner>	createAsync(String resourceGroupName, String accountName, String queueName) Creates a new queue with the specified queue name, under the specified account.
Mono<StorageQueueInner>	createAsync(String resourceGroupName, String accountName, String queueName, Map<String,String> metadata) Creates a new queue with the specified queue name, under the specified account.
com.azure.core.http.rest.Response<StorageQueueInner>	createWithResponse(String resourceGroupName, String accountName, String queueName, Map<String,String> metadata, com.azure.core.util.Context context) Creates a new queue with the specified queue name, under the specified account.
Mono<com.azure.core.http.rest.Response<StorageQueueInner>>	createWithResponseAsync(String resourceGroupName, String accountName, String queueName, Map<String,String> metadata) Creates a new queue with the specified queue name, under the specified account.
void	delete(String resourceGroupName, String accountName, String queueName) Deletes the queue with the specified queue name, under the specified account if it exists.
Mono<Void>	deleteAsync(String resourceGroupName, String accountName, String queueName) Deletes the queue with the specified queue name, under the specified account if it exists.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String accountName, String queueName, com.azure.core.util.Context context) Deletes the queue with the specified queue name, under the specified account if it exists.
Mono<com.azure.core.http.rest.Response<Void>>	deleteWithResponseAsync(String resourceGroupName, String accountName, String queueName) Deletes the queue with the specified queue name, under the specified account if it exists.
StorageQueueInner	get(String resourceGroupName, String accountName, String queueName) Gets the queue with the specified queue name, under the specified account if it exists.
Mono<StorageQueueInner>	getAsync(String resourceGroupName, String accountName, String queueName) Gets the queue with the specified queue name, under the specified account if it exists.
com.azure.core.http.rest.Response<StorageQueueInner>	getWithResponse(String resourceGroupName, String accountName, String queueName, com.azure.core.util.Context context) Gets the queue with the specified queue name, under the specified account if it exists.
Mono<com.azure.core.http.rest.Response<StorageQueueInner>>	getWithResponseAsync(String resourceGroupName, String accountName, String queueName) Gets the queue with the specified queue name, under the specified account if it exists.
com.azure.core.http.rest.PagedIterable<ListQueueInner>	list(String resourceGroupName, String accountName) Gets a list of all the queues under the specified storage account.
com.azure.core.http.rest.PagedIterable<ListQueueInner>	list(String resourceGroupName, String accountName, String maxpagesize, String filter, com.azure.core.util.Context context) Gets a list of all the queues under the specified storage account.
com.azure.core.http.rest.PagedFlux<ListQueueInner>	listAsync(String resourceGroupName, String accountName) Gets a list of all the queues under the specified storage account.
com.azure.core.http.rest.PagedFlux<ListQueueInner>	listAsync(String resourceGroupName, String accountName, String maxpagesize, String filter) Gets a list of all the queues under the specified storage account.
StorageQueueInner	update(String resourceGroupName, String accountName, String queueName) Creates a new queue with the specified queue name, under the specified account.
Mono<StorageQueueInner>	updateAsync(String resourceGroupName, String accountName, String queueName) Creates a new queue with the specified queue name, under the specified account.
Mono<StorageQueueInner>	updateAsync(String resourceGroupName, String accountName, String queueName, Map<String,String> metadata) Creates a new queue with the specified queue name, under the specified account.
com.azure.core.http.rest.Response<StorageQueueInner>	updateWithResponse(String resourceGroupName, String accountName, String queueName, Map<String,String> metadata, com.azure.core.util.Context context) Creates a new queue with the specified queue name, under the specified account.
Mono<com.azure.core.http.rest.Response<StorageQueueInner>>	updateWithResponseAsync(String resourceGroupName, String accountName, String queueName, Map<String,String> metadata) Creates a new queue with the specified queue name, under the specified account.

Method Detail

createWithResponseAsync

Mono<com.azure.core.http.rest.Response<StorageQueueInner>> createWithResponseAsync(String resourceGroupName,
                                                                                   String accountName,
                                                                                   String queueName,
                                                                                   Map<String,String> metadata)

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.

metadata - A name-value pair that represents queue metadata.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createAsync

Mono<StorageQueueInner> createAsync(String resourceGroupName,
                                    String accountName,
                                    String queueName,
                                    Map<String,String> metadata)

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.

metadata - A name-value pair that represents queue metadata.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createAsync

Mono<StorageQueueInner> createAsync(String resourceGroupName,
                                    String accountName,
                                    String queueName)

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.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

create

StorageQueueInner create(String resourceGroupName,
                         String accountName,
                         String queueName)

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.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createWithResponse

com.azure.core.http.rest.Response<StorageQueueInner> createWithResponse(String resourceGroupName,
                                                                        String accountName,
                                                                        String queueName,
                                                                        Map<String,String> metadata,
                                                                        com.azure.core.util.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.

metadata - A name-value pair that represents queue metadata.

context - The context to associate with this operation.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

updateWithResponseAsync

Mono<com.azure.core.http.rest.Response<StorageQueueInner>> updateWithResponseAsync(String resourceGroupName,
                                                                                   String accountName,
                                                                                   String queueName,
                                                                                   Map<String,String> metadata)

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.

metadata - A name-value pair that represents queue metadata.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

updateAsync

Mono<StorageQueueInner> updateAsync(String resourceGroupName,
                                    String accountName,
                                    String queueName,
                                    Map<String,String> metadata)

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.

metadata - A name-value pair that represents queue metadata.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

updateAsync

Mono<StorageQueueInner> updateAsync(String resourceGroupName,
                                    String accountName,
                                    String queueName)

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.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

update

StorageQueueInner update(String resourceGroupName,
                         String accountName,
                         String queueName)

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.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

updateWithResponse

com.azure.core.http.rest.Response<StorageQueueInner> updateWithResponse(String resourceGroupName,
                                                                        String accountName,
                                                                        String queueName,
                                                                        Map<String,String> metadata,
                                                                        com.azure.core.util.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.

metadata - A name-value pair that represents queue metadata.

context - The context to associate with this operation.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getWithResponseAsync

Mono<com.azure.core.http.rest.Response<StorageQueueInner>> 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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getAsync

Mono<StorageQueueInner> 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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

get

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getWithResponse

com.azure.core.http.rest.Response<StorageQueueInner> getWithResponse(String resourceGroupName,
                                                                     String accountName,
                                                                     String queueName,
                                                                     com.azure.core.util.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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteWithResponseAsync

Mono<com.azure.core.http.rest.Response<Void>> 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 completion.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteAsync

Mono<Void> 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:

the completion.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

delete

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteWithResponse

com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName,
                                                           String accountName,
                                                           String queueName,
                                                           com.azure.core.util.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:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listAsync

com.azure.core.http.rest.PagedFlux<ListQueueInner> 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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listAsync

com.azure.core.http.rest.PagedFlux<ListQueueInner> 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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

list

com.azure.core.http.rest.PagedIterable<ListQueueInner> 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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

list

com.azure.core.http.rest.PagedIterable<ListQueueInner> list(String resourceGroupName,
                                                            String accountName,
                                                            String maxpagesize,
                                                            String filter,
                                                            com.azure.core.util.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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.