AzureStor (version 2.0.1)

az_storage: Storage account resource class

Description

Class representing a storage account, exposing methods for working with it.

Usage

az_storage

Format

An object of class R6ClassGenerator of length 24.

Methods

The following methods are available, in addition to those provided by the AzureRMR::az_resource class:

• new(...): Initialize a new storage object. See 'Initialization'.

• list_keys(): Return the access keys for this account.

• get_account_sas(...): Return an account shared access signature (SAS). See 'Shared access signatures' for more details.

• get_blob_endpoint(key, sas): Return the account's blob storage endpoint, along with an access key and/or a SAS. See 'Endpoints' for more details

• get_file_endpoint(key, sas): Return the account's file storage endpoint.

• regen_key(key): Regenerates (creates a new value for) an access key. The argument key can be 1 or 2.

Initialization

Initializing a new object of this class can either retrieve an existing storage account, or create a account on the host. Generally, the best way to initialize an object is via the get_storage_account, create_storage_account or list_storage_accounts methods of the az_resource_group class, which handle the details automatically.

Shared access signatures

The simplest way for a user to access files and data in a storage account is to give them the account's access key. This gives them full control of the account, and so may be a security risk. An alternative is to provide the user with a shared access signature (SAS), which limits access to specific resources and only for a set length of time.

To create an account SAS, call the get_account_sas() method with the following arguments:

• start: The starting access date/time, as a Date or POSIXct value. Defaults to the current time.

• expiry: The ending access date/time, as a Date or POSIXct value. Defaults to 8 hours after the start time.

• services: Which services to allow access to. A string containing a combination of the letters b, f, q, t for blob, file, queue and table access. Defaults to bfqt.

• permissions: Which permissions to grant. A string containing a combination of the letters r (read), w (write), d (delete), l (list), a (add), c (create), u (update) , p (process). Defaults to r.

• resource_types: Which levels of the resource type hierarchy to allow access to. A string containing a combination of the letters s (service), c (container), o (object). Defaults to sco.

• ip: An IP address or range to grant access to.

• protocol: Which protocol to allow, either "http", "http,https" or "https". Defaults to NULL, which is the same as "http,https".

• key: the access key used to sign (authorise) the SAS.

Endpoints

The client-side interaction with a storage account is via an endpoint. A storage account can have several endpoints, one for each type of storage supported: blob, file, queue and table.

The client-side interface in AzureStor is implemented using S3 classes. This is for consistency with other data access packages in R, which mostly use S3. It also emphasises the distinction between Resource Manager (which is for interacting with the storage account itself) and the client (which is for accessing files and data stored in the account).

To create a storage endpoint independently of Resource Manager (for example if you are a user without admin or owner access to the account), use the blob_endpoint or file_endpoint functions.

If a storage endpoint is created without an access key and SAS, only public (anonymous) access is possible.

See Also

blob_endpoint, file_endpoint, create_storage_account, get_storage_account, delete_storage_account, Date, POSIXt, Azure Storage Provider API reference, Azure Storage Services API reference

Examples

# NOT RUN {
# recommended way of retrieving a resource: via a resource group object
stor <- resgroup$get_storage_account("mystorage")

# list account access keys
stor$list_keys()

# regenerate a key
stor$regen_key(1)

# generate a shared access signature for blob storage, expiring in 7 days time
today <- Sys.time()
stor$get_account_sas(expiry=today + 7*24*60*60, services="b", permissions="rw")

# storage endpoints
stor$get_blob_endpoint()
stor$get_file_endpoint()

# }