storage_queue {AzureQstor}

Message queues

Description

Get, list, create, or delete queues.

Usage

storage_queue(endpoint, ...)

## S3 method for class 'character'
storage_queue(
  endpoint,
  key = NULL,
  token = NULL,
  sas = NULL,
  api_version = getOption("azure_storage_api_version"),
  ...
)

## S3 method for class 'queue_endpoint'
storage_queue(endpoint, name, ...)

list_storage_queues(endpoint, ...)

## S3 method for class 'character'
list_storage_queues(
  endpoint,
  key = NULL,
  token = NULL,
  sas = NULL,
  api_version = getOption("azure_storage_api_version"),
  ...
)

## S3 method for class 'queue_endpoint'
list_storage_queues(endpoint, ...)

## S3 method for class 'queue_endpoint'
list_storage_containers(endpoint, ...)

create_storage_queue(endpoint, ...)

## S3 method for class 'character'
create_storage_queue(
  endpoint,
  key = NULL,
  token = NULL,
  sas = NULL,
  api_version = getOption("azure_storage_api_version"),
  ...
)

## S3 method for class 'queue_endpoint'
create_storage_queue(endpoint, name, ...)

## S3 method for class 'StorageQueue'
create_storage_queue(endpoint, ...)

delete_storage_queue(endpoint, ...)

## S3 method for class 'character'
delete_storage_queue(
  endpoint,
  key = NULL,
  token = NULL,
  sas = NULL,
  api_version = getOption("azure_storage_api_version"),
  ...
)

## S3 method for class 'queue_endpoint'
delete_storage_queue(endpoint, name, ...)

## S3 method for class 'StorageQueue'
delete_storage_queue(endpoint, confirm = TRUE, ...)

Arguments

endpoint

Either a queue endpoint object as created by storage_endpoint, or a character string giving the URL of the endpoint.

...

Further arguments passed to lower-level functions.

key, token, sas

If an endpoint object is not supplied, authentication credentials: either an access key, an Azure Active Directory (AAD) token, or a SAS, in that order of priority.

api_version

If an endpoint object is not supplied, the storage API version to use when interacting with the host. Currently defaults to "2019-07-07".

name

The name of the queue to get, create, or delete.

confirm

For deleting a queue, whether to ask for confirmation.

Details

You can call these functions in a couple of ways: by passing the full URL of the storage queue, or by passing the endpoint object and the name of the share as a string.

Value

For storage_queue and create_storage_queue, an object of class StorageQueue. For list_storage_queues, a list of such objects.

See Also

StorageQueue, queue_endpoint

Examples

## Not run: 

endp <- storage_endpoint("https://mystorage.queue.core.windows.net", key="key")

# to talk to an existing queue
queue <- storage_queue(endp, "queue1")

# to create a new queue
queue2 <- create_storage_queue(endp, "queue2")

# various ways to delete a queue (will ask for confirmation first)
queue2$delete()
delete_storage_queue(queue2)
delete_storage_queue(endp, "queue2")

## End(Not run)