azureListStorageBlobs: List storage blobs for specified storage account.

Description Usage Arguments Value Using blob store functions without authentication References See Also

View source: R/AzureBlob.R

Description

List storage blobs for specified storage account.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
azureListStorageBlobs(
  azureActiveContext,
  storageAccount,
  storageKey,
  container,
  maxresults,
  prefix,
  delimiter,
  marker,
  verbose = FALSE
)

Arguments

azureActiveContext

Either an 'azureActiveContext' object or 'NULL'. The blob store functions support two modes of connecting to the Azure API: authenticate using Active Directory or providing your own storage key. If this value is 'NULL', you must provide the 'storageKey'.

storageAccount

Name of the azure storage account. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

storageKey

Storage key associated with storage account

container

Storage container name. See [azureListStorageContainers()]

maxresults

Optional. Specifies the maximum number of blobs to return, including all BlobPrefix elements. If the request does not specify maxresults or specifies a value greater than 5,000, the server will return up to 5,000 items. Setting 'maxresults' to a value less than or equal to zero results in error response code 400 (Bad Request).

prefix

Optional. Filters the results to return only blobs whose names begin with the specified prefix.

delimiter

Optional. When the request includes this parameter, the operation returns a BlobPrefix element in the response body that acts as a placeholder for all blobs whose names begin with the same substring up to the appearance of the delimiter character. The delimiter may be a single character or a string.

marker

Optional. A string value that identifies the portion of the list to be returned with the next list operation. The operation returns a marker value within the response body if the list returned was not complete. The marker value may then be used in a subsequent call to request the next set of list items. The marker value is opaque to the client.

verbose

If TRUE, prints verbose messages

Value

Returns a data frame. This data frame has an attribute called 'marker' that can be used with the 'marker' argument to return the next set of values.

Using blob store functions without authentication

The blob store functions support two modes of connecting to the Azure API:authenticate using Active Directory or providing your own storage key. If this value is 'NULL', you must provide the 'storageKey' .

References

https://docs.microsoft.com/en-us/rest/api/storageservices/list-blobs

See Also

Other Blob store functions: azureBlobCD(), azureBlobFind(), azureBlobLS(), azureDeleteBlob(), azureGetBlob(), azurePutBlob()


CharlesCara/AzureSMRLite documentation built on March 10, 2020, 11:52 p.m.