Document how to use blob store functions without authentication #76

R/AzureBlob.R

@@ -4,6 +4,7 @@
 #' @inheritParams setAzureContext
 #' @inheritParams azureAuthenticate
 #' @inheritParams azureSAGetKey
+#' @param 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`.
 #'
 #' @param 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).
 #' @param prefix Optional. Filters the results to return only blobs whose names begin with the specified prefix.
@@ -11,6 +12,9 @@
 #' @param 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.
 #'
 #' @return 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.
+#'
+#' @template blob_no_authentication
+#' @references https://docs.microsoft.com/en-us/rest/api/storageservices/list-blobs
 #' @family Blob store functions
 #' @export
 azureListStorageBlobs <- function(azureActiveContext, storageAccount, storageKey,
@@ -92,13 +96,15 @@ azureListStorageBlobs <- function(azureActiveContext, storageAccount, storageKey
 
 #' List blob blobs in a storage account directory.
 #'
+#' @inheritParams azureListStorageBlobs
 #' @inheritParams setAzureContext
 #' @inheritParams azureAuthenticate
 #' @inheritParams azureSAGetKey
-
+#'
 #' @param directory Blob store directory to list for content
 #' @param recursive If TRUE, list blob store directories recursively
 #'
+#' @template blob_no_authentication
 #' @family Blob store functions
 #' @export
 azureBlobLS <- function(azureActiveContext, directory, recursive = FALSE,
@@ -181,13 +187,15 @@ azureBlobLS <- function(azureActiveContext, directory, recursive = FALSE,
 
 #' Get contents from a specifed storage blob.
 #'
+#' @inheritParams azureListStorageBlobs
 #' @inheritParams setAzureContext
 #' @inheritParams azureAuthenticate
 #' @inheritParams azureSAGetKey
 #' @inheritParams azureBlobLS
-
+#'
 #' @param type String, either "text" or "raw". Passed to [httr::content()]
 #'
+#' @template blob_no_authentication
 #' @family Blob store functions
 #' @export
 
@@ -257,6 +265,7 @@ azureGetBlob <- function(azureActiveContext, blob, directory, type = "text",
 
 #' Write contents to a specifed storage blob.
 #'
+#' @inheritParams azureListStorageBlobs
 #' @inheritParams setAzureContext
 #' @inheritParams azureAuthenticate
 #' @inheritParams azureSAGetKey
@@ -265,6 +274,7 @@ azureGetBlob <- function(azureActiveContext, blob, directory, type = "text",
 #' @param contents - Object or value to store
 #' @param file - Local filename to store in Azure blob
 #'
+#' @template blob_no_authentication
 #' @family Blob store functions
 #' @export
 azurePutBlob <- function(azureActiveContext, blob, contents = "", file = "",
@@ -337,11 +347,13 @@ azurePutBlob <- function(azureActiveContext, blob, contents = "", file = "",
 
 #' Find file in a storage account directory.
 #'
+#' @inheritParams azureListStorageBlobs
 #' @inheritParams setAzureContext
 #' @inheritParams azureAuthenticate
 #' @inheritParams azureSAGetKey
 #' @inheritParams azurePutBlob
 #'
+#' @template blob_no_authentication
 #' @family Blob store functions
 #' @export
 azureBlobFind <- function(azureActiveContext, file, storageAccount, storageKey,
@@ -383,12 +395,14 @@ azureBlobFind <- function(azureActiveContext, file, storageAccount, storageKey,
 
 #' Azure blob change current directory.
 #'
+#' @inheritParams azureListStorageBlobs
 #' @inheritParams setAzureContext
 #' @inheritParams azureAuthenticate
 #' @inheritParams azureSAGetKey
 #' @inheritParams azureBlobLS
 #' @inheritParams azurePutBlob
 #'
+#' @template blob_no_authentication
 #' @family Blob store functions
 #' @export
 azureBlobCD <- function(azureActiveContext, directory, container, file,
@@ -430,7 +444,7 @@ azureBlobCD <- function(azureActiveContext, directory, container, file,
   assert_that(is_storage_key(storageKey))
 
   if (directory == "../" || directory == "..") {
-    # Basic attempt azToken relative paths
+    # Basic attempt at relative paths
     directory <- gsub("/[a-zA-Z0-9]*$", "", azureActiveContext$directory)
   }
 
@@ -458,11 +472,13 @@ azureBlobCD <- function(azureActiveContext, directory, container, file,
 
 #' Delete a specifed storage blob.
 #'
+#' @inheritParams azureListStorageBlobs
 #' @inheritParams setAzureContext
 #' @inheritParams azureAuthenticate
 #' @inheritParams azureSAGetKey
 #' @inheritParams azureBlobLS
 #'
+#' @template blob_no_authentication
 #' @family Blob store functions
 #' @export
 

R/AzureContextObject.R

@@ -38,10 +38,10 @@ createAzureContext <- function(tenantID, clientID, authKey, configFile){
 #'
 #' Updates the value of an `azureActiveContext` object, created by [createAzureContext()]
 #'
-#' @param azureActiveContext A container used for caching variables used by `AzureSMR`
-#' @param tenantID The Tenant ID provided during creation of the Active Directory application / service principal
-#' @param clientID The Client ID provided during creation of the Active Directory application / service principal
-#' @param authKey The Authentication Key provided during creation of the Active Directory application / service principal
+#' @param azureActiveContext A container used for caching variables used by `AzureSMR`, created by [createAzureContext()]
+#' @param tenantID The tenant ID provided during creation of the Active Directory application / service principal
+#' @param clientID The client ID provided during creation of the Active Directory application / service principal
+#' @param authKey The authentication key provided during creation of the Active Directory application / service principal
 #' @param subscriptionID Subscription ID.  This is obtained automatically by [azureAuthenticate()] when only a single subscriptionID is available via Active Directory
 #' @param resourceGroup Name of the resource group
 #' @param vmName Name of the virtual machine

R/AzureCost.R

@@ -10,9 +10,7 @@
 #' 
 #' @inheritParams setAzureContext
 #' 
-#' @param instance Instance name that one would like to check expe
-#' nse. It is by default empty, which returns data consumption for 
-#' all instances under subscription.
+#' @param instance Instance name that one would like to check expense. It is by default empty, which returns data consumption for all instances under subscription.
 #' 
 #' @param timeStart Start time.
 #' @param timeEnd End time.
@@ -228,6 +226,8 @@ azureDataConsumption <- function(azureActiveContext,
 
 #' Get pricing details of resources under a subscription.
 #' 
+#' The pricing rates function wraps API calls to Azure RateCard and currently the API supports only the Pay-As-You-Go offer scheme. 
+#'
 #' @inheritParams setAzureContext
 #' 
 #' @param currency Currency in which price rating is measured.
@@ -236,8 +236,6 @@ azureDataConsumption <- function(azureActiveContext,
 #' 
 #' @param region region information about the subscription.
 #' 
-#' @note The pricing rates function wraps API calls to Azure RateCard and currently the API supports only the Pay-As-You-Go offer scheme. 
-#' 
 #' @family Cost functions
 #' @export
 azurePricingRates <- function(azureActiveContext,
@@ -313,8 +311,7 @@ azurePricingRates <- function(azureActiveContext,
 #' @inheritParams azureDataConsumption
 #' @inheritParams azurePricingRates
 #' 
-#' @return Total cost measured in the given currency of the specified Azure 
-#' instance in the period.
+#' @return Total cost measured in the given currency of the specified Azure instance in the period.
 #' 
 #' @family Cost functions
 #' @export

man-roxygen/blob_no_authentication.R

@@ -0,0 +1,2 @@
+#' @section 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` .

man/azureAuthenticate.Rd

@@ -8,13 +8,13 @@ azureAuthenticate(azureActiveContext, tenantID, clientID, authKey,
   verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
-\item{tenantID}{The Tenant ID provided during creation of the Active Directory application / service principal}
+\item{tenantID}{The tenant ID provided during creation of the Active Directory application / service principal}
 
-\item{clientID}{The Client ID provided during creation of the Active Directory application / service principal}
+\item{clientID}{The client ID provided during creation of the Active Directory application / service principal}
 
-\item{authKey}{The Authentication Key provided during creation of the Active Directory application / service principal}
+\item{authKey}{The authentication key provided during creation of the Active Directory application / service principal}
 
 \item{verbose}{Print Tracing information (Default False)}
 }

man/azureBatchGetKey.Rd

@@ -8,7 +8,7 @@ azureBatchGetKey(azureActiveContext, batchAccount, resourceGroup,
   subscriptionID, verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{resourceGroup}{Name of the resource group}
 

man/azureBlobCD.Rd

@@ -8,7 +8,7 @@ azureBlobCD(azureActiveContext, directory, container, file, storageAccount,
   storageKey, resourceGroup, verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{Either an \code{azureActiveContext} object or \code{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 \code{NULL}, you must provide the \code{storageKey}.}
 
 \item{directory}{Blob store directory to list for content}
 
@@ -29,6 +29,11 @@ azureBlobCD(azureActiveContext, directory, container, file, storageAccount,
 \description{
 Azure blob change current directory.
 }
+\section{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` .
+}
+
 \seealso{
 Other Blob store functions: \code{\link{azureBlobFind}},
   \code{\link{azureBlobLS}}, \code{\link{azureDeleteBlob}},

man/azureBlobFind.Rd

@@ -8,7 +8,7 @@ azureBlobFind(azureActiveContext, file, storageAccount, storageKey, container,
   resourceGroup, verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{Either an \code{azureActiveContext} object or \code{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 \code{NULL}, you must provide the \code{storageKey}.}
 
 \item{file}{\itemize{
 \item Local filename to store in Azure blob
@@ -27,6 +27,11 @@ azureBlobFind(azureActiveContext, file, storageAccount, storageKey, container,
 \description{
 Find file in a storage account directory.
 }
+\section{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` .
+}
+
 \seealso{
 Other Blob store functions: \code{\link{azureBlobCD}},
   \code{\link{azureBlobLS}}, \code{\link{azureDeleteBlob}},

man/azureBlobLS.Rd

@@ -8,7 +8,7 @@ azureBlobLS(azureActiveContext, directory, recursive = FALSE, storageAccount,
   storageKey, container, resourceGroup, verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{Either an \code{azureActiveContext} object or \code{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 \code{NULL}, you must provide the \code{storageKey}.}
 
 \item{directory}{Blob store directory to list for content}
 
@@ -27,6 +27,11 @@ azureBlobLS(azureActiveContext, directory, recursive = FALSE, storageAccount,
 \description{
 List blob blobs in a storage account directory.
 }
+\section{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` .
+}
+
 \seealso{
 Other Blob store functions: \code{\link{azureBlobCD}},
   \code{\link{azureBlobFind}},

man/azureCancelDeploy.Rd

@@ -8,7 +8,7 @@ azureCancelDeploy(azureActiveContext, deplname, resourceGroup, subscriptionID,
   verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{deplname}{Deployment name}
 

man/azureCheckToken.Rd

@@ -7,7 +7,7 @@
 azureCheckToken(azureActiveContext)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 }
 \description{
 Check the timestamp of a token and renew if needed.

man/azureCreateBatchAccount.Rd

@@ -9,7 +9,7 @@ azureCreateBatchAccount(azureActiveContext, batchAccount,
   asynchronous = FALSE, verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{location}{A string for the location to create batch account}
 

man/azureCreateHDI.Rd

@@ -12,7 +12,7 @@ azureCreateHDI(azureActiveContext, resourceGroup, location, clustername,
   verbose = FALSE, debug = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{resourceGroup}{Name of the resource group}
 

man/azureCreateResourceGroup.Rd

@@ -8,7 +8,7 @@ azureCreateResourceGroup(azureActiveContext, resourceGroup, location,
   subscriptionID, verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{resourceGroup}{Name of the resource group}
 

man/azureCreateStorageAccount.Rd

@@ -9,7 +9,7 @@ azureCreateStorageAccount(azureActiveContext, storageAccount,
   asynchronous = FALSE, verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{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.}
 

man/azureCreateStorageContainer.Rd

@@ -8,7 +8,7 @@ azureCreateStorageContainer(azureActiveContext, container, storageAccount,
   storageKey, resourceGroup, subscriptionID, verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{container}{Storage container name. See \code{\link[=azureListStorageContainers]{azureListStorageContainers()}}}
 

man/azureDataConsumption.Rd

@@ -9,11 +9,9 @@ azureDataConsumption(azureActiveContext, instance = "", timeStart, timeEnd,
   granularity = "Hourly", verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
-\item{instance}{Instance name that one would like to check expe
-nse. It is by default empty, which returns data consumption for
-all instances under subscription.}
+\item{instance}{Instance name that one would like to check expense. It is by default empty, which returns data consumption for all instances under subscription.}
 
 \item{timeStart}{Start time.}
 

man/azureDeleteBatchAccount.Rd

@@ -8,7 +8,7 @@ azureDeleteBatchAccount(azureActiveContext, batchAccount, resourceGroup,
   subscriptionID, verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{resourceGroup}{Name of the resource group}
 

man/azureDeleteBlob.Rd

@@ -8,7 +8,7 @@ azureDeleteBlob(azureActiveContext, blob, directory, storageAccount, storageKey,
   container, resourceGroup, verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{Either an \code{azureActiveContext} object or \code{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 \code{NULL}, you must provide the \code{storageKey}.}
 
 \item{blob}{Blob name}
 
@@ -27,6 +27,11 @@ azureDeleteBlob(azureActiveContext, blob, directory, storageAccount, storageKey,
 \description{
 Delete a specifed storage blob.
 }
+\section{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` .
+}
+
 \seealso{
 Other Blob store functions: \code{\link{azureBlobCD}},
   \code{\link{azureBlobFind}}, \code{\link{azureBlobLS}},

man/azureDeleteDeploy.Rd

@@ -8,7 +8,7 @@ azureDeleteDeploy(azureActiveContext, deplname, resourceGroup, subscriptionID,
   verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{deplname}{Deployment name}
 

man/azureDeleteHDI.Rd

@@ -8,7 +8,7 @@ azureDeleteHDI(azureActiveContext, clustername, subscriptionID, resourceGroup,
   verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{clustername}{Cluster name, used for HDI and Spark clusters. See \code{\link[=azureCreateHDI]{azureCreateHDI()}}}
 

man/azureDeleteResourceGroup.Rd

@@ -8,7 +8,7 @@ azureDeleteResourceGroup(azureActiveContext, resourceGroup, subscriptionID,
   type, verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{resourceGroup}{Name of the resource group}
 

man/azureDeleteStorageContainer.Rd

@@ -8,7 +8,7 @@ azureDeleteStorageContainer(azureActiveContext, container, storageAccount,
   storageKey, resourceGroup, subscriptionID, verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{container}{Storage container name. See \code{\link[=azureListStorageContainers]{azureListStorageContainers()}}}
 

man/azureDeleteVM.Rd

@@ -8,7 +8,7 @@ azureDeleteVM(azureActiveContext, resourceGroup, vmName, subscriptionID,
   mode = "Sync", verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{resourceGroup}{Name of the resource group}
 

man/azureDeletestorageAccount.Rd

@@ -8,7 +8,7 @@ azureDeletestorageAccount(azureActiveContext, storageAccount, resourceGroup,
   subscriptionID, verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{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.}
 

man/azureDeployStatus.Rd

@@ -8,7 +8,7 @@ azureDeployStatus(azureActiveContext, deplname, resourceGroup, subscriptionID,
   verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{deplname}{Deployment name}
 

man/azureDeployTemplate.Rd

@@ -9,7 +9,7 @@ azureDeployTemplate(azureActiveContext, deplname, templateURL, paramURL,
   subscriptionID, verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{deplname}{Deployment name}
 

man/azureExpenseCalculator.Rd

@@ -8,11 +8,9 @@ azureExpenseCalculator(azureActiveContext, instance = "", timeStart, timeEnd,
   granularity, currency, locale, offerId, region, verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
-\item{instance}{Instance name that one would like to check expe
-nse. It is by default empty, which returns data consumption for
-all instances under subscription.}
+\item{instance}{Instance name that one would like to check expense. It is by default empty, which returns data consumption for all instances under subscription.}
 
 \item{timeStart}{Start time.}
 
@@ -29,8 +27,7 @@ all instances under subscription.}
 \item{region}{region information about the subscription.}
 }
 \value{
-Total cost measured in the given currency of the specified Azure
-instance in the period.
+Total cost measured in the given currency of the specified Azure instance in the period.
 }
 \description{
 Note if difference between \code{timeStart} and \code{timeEnd} is less than the finest granularity, e.g., "Hourly" (we notice this is a usual case when one needs to be aware of the charges of a job that takes less than an hour), the expense will be estimated based solely on computation hour. That is, the total expense is the multiplication of computation hour and pricing rate of the requested instance.

man/azureGetAllVMstatus.Rd

@@ -7,7 +7,7 @@
 azureGetAllVMstatus(azureActiveContext)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 }
 \description{
 First queries the azure active context for all visible resources, then sequentially queries the status of all virtuam machines.

man/azureGetBlob.Rd

@@ -8,7 +8,7 @@ azureGetBlob(azureActiveContext, blob, directory, type = "text",
   storageAccount, storageKey, container, resourceGroup, verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{Either an \code{azureActiveContext} object or \code{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 \code{NULL}, you must provide the \code{storageKey}.}
 
 \item{blob}{Blob name}
 
@@ -29,6 +29,11 @@ azureGetBlob(azureActiveContext, blob, directory, type = "text",
 \description{
 Get contents from a specifed storage blob.
 }
+\section{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` .
+}
+
 \seealso{
 Other Blob store functions: \code{\link{azureBlobCD}},
   \code{\link{azureBlobFind}}, \code{\link{azureBlobLS}},

man/azureHDIConf.Rd

@@ -8,7 +8,7 @@ azureHDIConf(azureActiveContext, clustername, resourceGroup, subscriptionID,
   name, type, location, verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{clustername}{Cluster name, used for HDI and Spark clusters. See \code{\link[=azureCreateHDI]{azureCreateHDI()}}}
 

man/azureHiveSQL.Rd

@@ -8,7 +8,7 @@ azureHiveSQL(azureActiveContext, CMD, clustername, hdiAdmin, hdiPassword,
   path = "wasb:///tmp/", verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{CMD}{SQl COmmand String}
 

man/azureHiveStatus.Rd

@@ -8,7 +8,7 @@ azureHiveStatus(azureActiveContext, clustername, hdiAdmin, hdiPassword,
   verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{clustername}{Cluster name, used for HDI and Spark clusters. See \code{\link[=azureCreateHDI]{azureCreateHDI()}}}
 

man/azureListBatchAccounts.Rd

@@ -8,7 +8,7 @@ azureListBatchAccounts(azureActiveContext, resourceGroup, subscriptionID,
   verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{resourceGroup}{Name of the resource group}
 

man/azureListHDI.Rd

@@ -8,7 +8,7 @@ azureListHDI(azureActiveContext, resourceGroup, clustername = "*",
   subscriptionID, name, type, location, verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{resourceGroup}{Name of the resource group}
 

man/azureListRG.Rd

@@ -7,7 +7,7 @@
 azureListRG(azureActiveContext, subscriptionID, verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{subscriptionID}{Subscription ID.  This is obtained automatically by \code{\link[=azureAuthenticate]{azureAuthenticate()}} when only a single subscriptionID is available via Active Directory}
 

man/azureListSA.Rd

@@ -8,7 +8,7 @@ azureListSA(azureActiveContext, resourceGroup, subscriptionID,
   verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{resourceGroup}{Name of the resource group}
 

man/azureListScaleSetNetwork.Rd

@@ -8,7 +8,7 @@ azureListScaleSetNetwork(azureActiveContext, resourceGroup, location,
   subscriptionID, verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{resourceGroup}{Name of the resource group}
 

man/azureListScaleSetVM.Rd

@@ -8,7 +8,7 @@ azureListScaleSetVM(azureActiveContext, scaleSet, resourceGroup, location,
   subscriptionID, verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{scaleSet}{Character vector with name of the scaleset (see also \code{\link[=azureListScaleSets]{azureListScaleSets()}})}
 

man/azureListScaleSets.Rd

@@ -8,7 +8,7 @@ azureListScaleSets(azureActiveContext, resourceGroup, location, subscriptionID,
   verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{resourceGroup}{Name of the resource group}
 

man/azureListStorageBlobs.Rd

@@ -8,7 +8,7 @@ azureListStorageBlobs(azureActiveContext, storageAccount, storageKey, container,
   maxresults, prefix, delimiter, marker, verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{Either an \code{azureActiveContext} object or \code{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 \code{NULL}, you must provide the \code{storageKey}.}
 
 \item{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.}
 
@@ -32,6 +32,14 @@ Returns a data frame. This data frame has an attribute called \code{marker} that
 \description{
 List storage blobs for specified storage account.
 }
+\section{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
+}
 \seealso{
 Other Blob store functions: \code{\link{azureBlobCD}},
   \code{\link{azureBlobFind}}, \code{\link{azureBlobLS}},

man/azureListStorageContainers.Rd

@@ -8,7 +8,7 @@ azureListStorageContainers(azureActiveContext, storageAccount, storageKey,
   resourceGroup, subscriptionID, verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{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.}
 

man/azureListSubscriptions.Rd

@@ -7,7 +7,7 @@
 azureListSubscriptions(azureActiveContext, verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{verbose}{Print Tracing information (Default False)}
 }

man/azureListVM.Rd

@@ -8,7 +8,7 @@ azureListVM(azureActiveContext, resourceGroup, location, subscriptionID,
   verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{resourceGroup}{Name of the resource group}
 

man/azurePricingRates.Rd

@@ -8,7 +8,7 @@ azurePricingRates(azureActiveContext, currency, locale, offerId, region,
   verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{currency}{Currency in which price rating is measured.}
 
@@ -19,9 +19,6 @@ azurePricingRates(azureActiveContext, currency, locale, offerId, region,
 \item{region}{region information about the subscription.}
 }
 \description{
-Get pricing details of resources under a subscription.
-}
-\note{
 The pricing rates function wraps API calls to Azure RateCard and currently the API supports only the Pay-As-You-Go offer scheme.
 }
 \seealso{

man/azurePutBlob.Rd

@@ -8,7 +8,7 @@ azurePutBlob(azureActiveContext, blob, contents = "", file = "", directory,
   storageAccount, storageKey, container, resourceGroup, verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{Either an \code{azureActiveContext} object or \code{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 \code{NULL}, you must provide the \code{storageKey}.}
 
 \item{blob}{Blob name}
 
@@ -35,6 +35,11 @@ azurePutBlob(azureActiveContext, blob, contents = "", file = "", directory,
 \description{
 Write contents to a specifed storage blob.
 }
+\section{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` .
+}
+
 \seealso{
 Other Blob store functions: \code{\link{azureBlobCD}},
   \code{\link{azureBlobFind}}, \code{\link{azureBlobLS}},

man/azureResizeHDI.Rd

@@ -4,12 +4,12 @@
 \alias{azureResizeHDI}
 \title{Resize a HDInsight cluster role.}
 \usage{
-azureResizeHDI(azureActiveContext, clustername, role = c("worker", "head",
-  "edge"), size = 2, mode = c("Sync", "Async"), subscriptionID,
-  resourceGroup, verbose = FALSE)
+azureResizeHDI(azureActiveContext, clustername, role = c("workernode",
+  "headnode", "edgenode"), size = 2, mode = c("Sync", "Async"),
+  subscriptionID, resourceGroup, verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{clustername}{Cluster name, used for HDI and Spark clusters. See \code{\link[=azureCreateHDI]{azureCreateHDI()}}}
 

man/azureRunScriptAction.Rd

@@ -10,7 +10,7 @@ azureRunScriptAction(azureActiveContext, scriptname, scriptURL,
   verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{scriptname}{Identifier for Custom action script operation}
 

man/azureSAGetKey.Rd

@@ -8,7 +8,7 @@ azureSAGetKey(azureActiveContext, storageAccount, resourceGroup, subscriptionID,
   verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{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.}
 

man/azureScriptActionHistory.Rd

@@ -11,7 +11,7 @@ azureScriptActionHistory(azureActiveContext, resourceGroup, clustername = "*",
 \method{summary}{azureScriptActionHistory}(object, ...)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{resourceGroup}{Name of the resource group}
 

man/azureSparkCMD.Rd

@@ -8,7 +8,7 @@ azureSparkCMD(azureActiveContext, CMD, clustername, hdiAdmin, hdiPassword,
   sessionID, verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{CMD}{CMD}
 

man/azureSparkJob.Rd

@@ -8,7 +8,7 @@ azureSparkJob(azureActiveContext, FILE, clustername, hdiAdmin, hdiPassword,
   log = "URL", verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{FILE}{file}
 

man/azureSparkListJobs.Rd

@@ -8,7 +8,7 @@ azureSparkListJobs(azureActiveContext, clustername, hdiAdmin, hdiPassword,
   verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{clustername}{Cluster name, used for HDI and Spark clusters. See \code{\link[=azureCreateHDI]{azureCreateHDI()}}}
 

man/azureSparkListSessions.Rd

@@ -8,7 +8,7 @@ azureSparkListSessions(azureActiveContext, clustername, hdiAdmin, hdiPassword,
   verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{clustername}{Cluster name, used for HDI and Spark clusters. See \code{\link[=azureCreateHDI]{azureCreateHDI()}}}
 

man/azureSparkNewSession.Rd

@@ -8,7 +8,7 @@ azureSparkNewSession(azureActiveContext, clustername, hdiAdmin, hdiPassword,
   kind = "spark", verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{clustername}{Cluster name, used for HDI and Spark clusters. See \code{\link[=azureCreateHDI]{azureCreateHDI()}}}
 

man/azureSparkShowURL.Rd

@@ -7,7 +7,7 @@
 azureSparkShowURL(azureActiveContext, URL)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{URL}{URL}
 }

man/azureSparkStopSession.Rd

@@ -8,7 +8,7 @@ azureSparkStopSession(azureActiveContext, clustername, hdiAdmin, hdiPassword,
   sessionID, verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{clustername}{Cluster name, used for HDI and Spark clusters. See \code{\link[=azureCreateHDI]{azureCreateHDI()}}}
 

man/azureStartVM.Rd

@@ -8,7 +8,7 @@ azureStartVM(azureActiveContext, resourceGroup, vmName, mode = "Sync",
   subscriptionID, verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{resourceGroup}{Name of the resource group}
 

man/azureStopVM.Rd

@@ -8,7 +8,7 @@ azureStopVM(azureActiveContext, resourceGroup, vmName, mode = "Sync",
   subscriptionID, verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{resourceGroup}{Name of the resource group}
 

man/azureVMStatus.Rd

@@ -8,7 +8,7 @@ azureVMStatus(azureActiveContext, resourceGroup, vmName, subscriptionID,
   ignore = "N", verbose = FALSE)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{resourceGroup}{Name of the resource group}
 

man/createAzureContext.Rd

@@ -7,11 +7,11 @@
 createAzureContext(tenantID, clientID, authKey, configFile)
 }
 \arguments{
-\item{tenantID}{The Tenant ID provided during creation of the Active Directory application / service principal}
+\item{tenantID}{The tenant ID provided during creation of the Active Directory application / service principal}
 
-\item{clientID}{The Client ID provided during creation of the Active Directory application / service principal}
+\item{clientID}{The client ID provided during creation of the Active Directory application / service principal}
 
-\item{authKey}{The Authentication Key provided during creation of the Active Directory application / service principal}
+\item{authKey}{The authentication key provided during creation of the Active Directory application / service principal}
 }
 \value{
 An \code{azureActiveContext} object

man/pkg-deprecated.Rd

@@ -10,7 +10,7 @@ dumpAzureContext(azureActiveContext)
 AzureListRG(...)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
 \item{...}{passed to \code{\link[=azureListRG]{azureListRG()}}}
 }

man/setAzureContext.Rd

@@ -9,13 +9,13 @@ setAzureContext(azureActiveContext, tenantID, clientID, authKey, subscriptionID,
   hdiPassword, clustername, kind, sessionID)
 }
 \arguments{
-\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
+\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}, created by \code{\link[=createAzureContext]{createAzureContext()}}}
 
-\item{tenantID}{The Tenant ID provided during creation of the Active Directory application / service principal}
+\item{tenantID}{The tenant ID provided during creation of the Active Directory application / service principal}
 
-\item{clientID}{The Client ID provided during creation of the Active Directory application / service principal}
+\item{clientID}{The client ID provided during creation of the Active Directory application / service principal}
 
-\item{authKey}{The Authentication Key provided during creation of the Active Directory application / service principal}
+\item{authKey}{The authentication key provided during creation of the Active Directory application / service principal}
 
 \item{subscriptionID}{Subscription ID.  This is obtained automatically by \code{\link[=azureAuthenticate]{azureAuthenticate()}} when only a single subscriptionID is available via Active Directory}