adls_filesystem {AzureStor} | R Documentation |
Operations on an Azure Data Lake Storage Gen2 endpoint
Description
Get, list, create, or delete ADLSgen2 filesystems.
Usage
adls_filesystem(endpoint, ...)
## S3 method for class 'character'
adls_filesystem(endpoint, key = NULL, token = NULL,
sas = NULL, api_version = getOption("azure_storage_api_version"), ...)
## S3 method for class 'adls_endpoint'
adls_filesystem(endpoint, name, ...)
## S3 method for class 'adls_filesystem'
print(x, ...)
list_adls_filesystems(endpoint, ...)
## S3 method for class 'character'
list_adls_filesystems(endpoint, key = NULL,
token = NULL, sas = NULL,
api_version = getOption("azure_storage_api_version"), ...)
## S3 method for class 'adls_endpoint'
list_adls_filesystems(endpoint, ...)
create_adls_filesystem(endpoint, ...)
## S3 method for class 'character'
create_adls_filesystem(endpoint, key = NULL,
token = NULL, sas = NULL,
api_version = getOption("azure_storage_api_version"), ...)
## S3 method for class 'adls_filesystem'
create_adls_filesystem(endpoint, ...)
## S3 method for class 'adls_endpoint'
create_adls_filesystem(endpoint, name, ...)
delete_adls_filesystem(endpoint, ...)
## S3 method for class 'character'
delete_adls_filesystem(endpoint, key = NULL,
token = NULL, sas = NULL,
api_version = getOption("azure_storage_api_version"), ...)
## S3 method for class 'adls_filesystem'
delete_adls_filesystem(endpoint, ...)
## S3 method for class 'adls_endpoint'
delete_adls_filesystem(endpoint, name, confirm = TRUE, ...)
Arguments
endpoint |
Either an ADLSgen2 endpoint object as created by storage_endpoint or adls_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. Currently the |
api_version |
If an endpoint object is not supplied, the storage API version to use when interacting with the host. Currently defaults to |
name |
The name of the filesystem to get, create, or delete. |
x |
For the print method, a filesystem object. |
confirm |
For deleting a filesystem, whether to ask for confirmation. |
Details
You can call these functions in a couple of ways: by passing the full URL of the filesystem, or by passing the endpoint object and the name of the filesystem as a string.
If authenticating via AAD, you can supply the token either as a string, or as an object of class AzureToken, created via AzureRMR::get_azure_token. The latter is the recommended way of doing it, as it allows for automatic refreshing of expired tokens.
Value
For adls_filesystem
and create_adls_filesystem
, an S3 object representing an existing or created filesystem respectively.
For list_adls_filesystems
, a list of such objects.
See Also
storage_endpoint, az_storage, storage_container
Examples
## Not run:
endp <- adls_endpoint("https://mystorage.dfs.core.windows.net/", key="access_key")
# list ADLSgen2 filesystems
list_adls_filesystems(endp)
# get, create, and delete a filesystem
adls_filesystem(endp, "myfs")
create_adls_filesystem(endp, "newfs")
delete_adls_filesystem(endp, "newfs")
# alternative way to do the same
adls_filesystem("https://mystorage.dfs.core.windows.net/myfs", key="access_key")
create_adls_filesystem("https://mystorage.dfs.core.windows.net/newfs", key="access_key")
delete_adls_filesystem("https://mystorage.dfs.core.windows.net/newfs", key="access_key")
## End(Not run)