diff --git a/R/AzureBlob.R b/R/AzureBlob.R index 4fd0bdf..adee442 100644 --- a/R/AzureBlob.R +++ b/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 diff --git a/R/AzureContextObject.R b/R/AzureContextObject.R index 7ebb732..94537eb 100644 --- a/R/AzureContextObject.R +++ b/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 diff --git a/R/AzureCost.R b/R/AzureCost.R index 33e4d0e..68a4f47 100644 --- a/R/AzureCost.R +++ b/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 diff --git a/man-roxygen/blob_no_authentication.R b/man-roxygen/blob_no_authentication.R new file mode 100644 index 0000000..6e2e10e --- /dev/null +++ b/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` . diff --git a/man/azureAuthenticate.Rd b/man/azureAuthenticate.Rd index 97fc9ce..c56fafc 100644 --- a/man/azureAuthenticate.Rd +++ b/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)} } diff --git a/man/azureBatchGetKey.Rd b/man/azureBatchGetKey.Rd index e8fc7d5..f747860 100644 --- a/man/azureBatchGetKey.Rd +++ b/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} diff --git a/man/azureBlobCD.Rd b/man/azureBlobCD.Rd index a049310..80e9dac 100644 --- a/man/azureBlobCD.Rd +++ b/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}}, diff --git a/man/azureBlobFind.Rd b/man/azureBlobFind.Rd index 58a6766..754cf10 100644 --- a/man/azureBlobFind.Rd +++ b/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}}, diff --git a/man/azureBlobLS.Rd b/man/azureBlobLS.Rd index 1f63bf3..debda91 100644 --- a/man/azureBlobLS.Rd +++ b/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}}, diff --git a/man/azureCancelDeploy.Rd b/man/azureCancelDeploy.Rd index f2010e4..885ca51 100644 --- a/man/azureCancelDeploy.Rd +++ b/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} diff --git a/man/azureCheckToken.Rd b/man/azureCheckToken.Rd index fc7c308..d5f8ffe 100644 --- a/man/azureCheckToken.Rd +++ b/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. diff --git a/man/azureCreateBatchAccount.Rd b/man/azureCreateBatchAccount.Rd index c027f3d..701d2e6 100644 --- a/man/azureCreateBatchAccount.Rd +++ b/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} diff --git a/man/azureCreateHDI.Rd b/man/azureCreateHDI.Rd index dde1fd1..dff204a 100644 --- a/man/azureCreateHDI.Rd +++ b/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} diff --git a/man/azureCreateResourceGroup.Rd b/man/azureCreateResourceGroup.Rd index ae729b8..2576703 100644 --- a/man/azureCreateResourceGroup.Rd +++ b/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} diff --git a/man/azureCreateStorageAccount.Rd b/man/azureCreateStorageAccount.Rd index 7a59191..d85694d 100644 --- a/man/azureCreateStorageAccount.Rd +++ b/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.} diff --git a/man/azureCreateStorageContainer.Rd b/man/azureCreateStorageContainer.Rd index c92cfe7..9819447 100644 --- a/man/azureCreateStorageContainer.Rd +++ b/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()}}} diff --git a/man/azureDataConsumption.Rd b/man/azureDataConsumption.Rd index 9a5afb2..cedcfd7 100644 --- a/man/azureDataConsumption.Rd +++ b/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.} diff --git a/man/azureDeleteBatchAccount.Rd b/man/azureDeleteBatchAccount.Rd index 5ebcb17..3bd3ce5 100644 --- a/man/azureDeleteBatchAccount.Rd +++ b/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} diff --git a/man/azureDeleteBlob.Rd b/man/azureDeleteBlob.Rd index dde2dde..6801ab0 100644 --- a/man/azureDeleteBlob.Rd +++ b/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}}, diff --git a/man/azureDeleteDeploy.Rd b/man/azureDeleteDeploy.Rd index 1819283..9517d72 100644 --- a/man/azureDeleteDeploy.Rd +++ b/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} diff --git a/man/azureDeleteHDI.Rd b/man/azureDeleteHDI.Rd index 0130994..b7f8cdf 100644 --- a/man/azureDeleteHDI.Rd +++ b/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()}}} diff --git a/man/azureDeleteResourceGroup.Rd b/man/azureDeleteResourceGroup.Rd index f08b27c..12973c3 100644 --- a/man/azureDeleteResourceGroup.Rd +++ b/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} diff --git a/man/azureDeleteStorageContainer.Rd b/man/azureDeleteStorageContainer.Rd index b546b70..ba500eb 100644 --- a/man/azureDeleteStorageContainer.Rd +++ b/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()}}} diff --git a/man/azureDeleteVM.Rd b/man/azureDeleteVM.Rd index 58985a8..9158d69 100644 --- a/man/azureDeleteVM.Rd +++ b/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} diff --git a/man/azureDeletestorageAccount.Rd b/man/azureDeletestorageAccount.Rd index 6fd43ee..fce8d68 100644 --- a/man/azureDeletestorageAccount.Rd +++ b/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.} diff --git a/man/azureDeployStatus.Rd b/man/azureDeployStatus.Rd index 0bcba39..d309734 100644 --- a/man/azureDeployStatus.Rd +++ b/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} diff --git a/man/azureDeployTemplate.Rd b/man/azureDeployTemplate.Rd index 9b4a5ee..e4ff4dc 100644 --- a/man/azureDeployTemplate.Rd +++ b/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} diff --git a/man/azureExpenseCalculator.Rd b/man/azureExpenseCalculator.Rd index 432e1e4..f43e82a 100644 --- a/man/azureExpenseCalculator.Rd +++ b/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. diff --git a/man/azureGetAllVMstatus.Rd b/man/azureGetAllVMstatus.Rd index 6527fb6..b0069d9 100644 --- a/man/azureGetAllVMstatus.Rd +++ b/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. diff --git a/man/azureGetBlob.Rd b/man/azureGetBlob.Rd index e1bf690..2f6a416 100644 --- a/man/azureGetBlob.Rd +++ b/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}}, diff --git a/man/azureHDIConf.Rd b/man/azureHDIConf.Rd index e20a2d2..3eeffa7 100644 --- a/man/azureHDIConf.Rd +++ b/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()}}} diff --git a/man/azureHiveSQL.Rd b/man/azureHiveSQL.Rd index 37760cd..59b0bf8 100644 --- a/man/azureHiveSQL.Rd +++ b/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} diff --git a/man/azureHiveStatus.Rd b/man/azureHiveStatus.Rd index 3ef46b6..9592fa3 100644 --- a/man/azureHiveStatus.Rd +++ b/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()}}} diff --git a/man/azureListBatchAccounts.Rd b/man/azureListBatchAccounts.Rd index 181f31f..f49598f 100644 --- a/man/azureListBatchAccounts.Rd +++ b/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} diff --git a/man/azureListHDI.Rd b/man/azureListHDI.Rd index 5ed9b4b..3e7497f 100644 --- a/man/azureListHDI.Rd +++ b/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} diff --git a/man/azureListRG.Rd b/man/azureListRG.Rd index 30d129a..7d4a366 100644 --- a/man/azureListRG.Rd +++ b/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} diff --git a/man/azureListSA.Rd b/man/azureListSA.Rd index 356e2e0..117967c 100644 --- a/man/azureListSA.Rd +++ b/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} diff --git a/man/azureListScaleSetNetwork.Rd b/man/azureListScaleSetNetwork.Rd index 8791fde..9c707a9 100644 --- a/man/azureListScaleSetNetwork.Rd +++ b/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} diff --git a/man/azureListScaleSetVM.Rd b/man/azureListScaleSetVM.Rd index 6f4f757..4c32fae 100644 --- a/man/azureListScaleSetVM.Rd +++ b/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()}})} diff --git a/man/azureListScaleSets.Rd b/man/azureListScaleSets.Rd index 08021e0..8c11ae9 100644 --- a/man/azureListScaleSets.Rd +++ b/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} diff --git a/man/azureListStorageBlobs.Rd b/man/azureListStorageBlobs.Rd index 7bbb82b..8cfea3c 100644 --- a/man/azureListStorageBlobs.Rd +++ b/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}}, diff --git a/man/azureListStorageContainers.Rd b/man/azureListStorageContainers.Rd index 6d7bfc6..f146748 100644 --- a/man/azureListStorageContainers.Rd +++ b/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.} diff --git a/man/azureListSubscriptions.Rd b/man/azureListSubscriptions.Rd index 9a1c587..da120c9 100644 --- a/man/azureListSubscriptions.Rd +++ b/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)} } diff --git a/man/azureListVM.Rd b/man/azureListVM.Rd index 692534a..05ca228 100644 --- a/man/azureListVM.Rd +++ b/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} diff --git a/man/azurePricingRates.Rd b/man/azurePricingRates.Rd index 383fcab..59aeaf0 100644 --- a/man/azurePricingRates.Rd +++ b/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{ diff --git a/man/azurePutBlob.Rd b/man/azurePutBlob.Rd index 91d61d3..9b826d1 100644 --- a/man/azurePutBlob.Rd +++ b/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}}, diff --git a/man/azureResizeHDI.Rd b/man/azureResizeHDI.Rd index bbff30d..bd3da02 100644 --- a/man/azureResizeHDI.Rd +++ b/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()}}} diff --git a/man/azureRunScriptAction.Rd b/man/azureRunScriptAction.Rd index 8d62722..ccd99c4 100644 --- a/man/azureRunScriptAction.Rd +++ b/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} diff --git a/man/azureSAGetKey.Rd b/man/azureSAGetKey.Rd index fca79e0..64a06bb 100644 --- a/man/azureSAGetKey.Rd +++ b/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.} diff --git a/man/azureScriptActionHistory.Rd b/man/azureScriptActionHistory.Rd index 50eb15e..f7ec168 100644 --- a/man/azureScriptActionHistory.Rd +++ b/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} diff --git a/man/azureSparkCMD.Rd b/man/azureSparkCMD.Rd index e22f754..2553bf0 100644 --- a/man/azureSparkCMD.Rd +++ b/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} diff --git a/man/azureSparkJob.Rd b/man/azureSparkJob.Rd index 1da35c2..55eb05b 100644 --- a/man/azureSparkJob.Rd +++ b/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} diff --git a/man/azureSparkListJobs.Rd b/man/azureSparkListJobs.Rd index 7af149a..94d6145 100644 --- a/man/azureSparkListJobs.Rd +++ b/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()}}} diff --git a/man/azureSparkListSessions.Rd b/man/azureSparkListSessions.Rd index 3089519..76a9e9e 100644 --- a/man/azureSparkListSessions.Rd +++ b/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()}}} diff --git a/man/azureSparkNewSession.Rd b/man/azureSparkNewSession.Rd index 4ff5096..627ba74 100644 --- a/man/azureSparkNewSession.Rd +++ b/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()}}} diff --git a/man/azureSparkShowURL.Rd b/man/azureSparkShowURL.Rd index 3a415a8..dbc14b7 100644 --- a/man/azureSparkShowURL.Rd +++ b/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} } diff --git a/man/azureSparkStopSession.Rd b/man/azureSparkStopSession.Rd index 2496ed6..600d061 100644 --- a/man/azureSparkStopSession.Rd +++ b/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()}}} diff --git a/man/azureStartVM.Rd b/man/azureStartVM.Rd index 19a72b8..7826bc6 100644 --- a/man/azureStartVM.Rd +++ b/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} diff --git a/man/azureStopVM.Rd b/man/azureStopVM.Rd index 78885ce..507af4a 100644 --- a/man/azureStopVM.Rd +++ b/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} diff --git a/man/azureVMStatus.Rd b/man/azureVMStatus.Rd index aa55c7a..1102bc3 100644 --- a/man/azureVMStatus.Rd +++ b/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} diff --git a/man/createAzureContext.Rd b/man/createAzureContext.Rd index c124465..43f6b1b 100644 --- a/man/createAzureContext.Rd +++ b/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 diff --git a/man/pkg-deprecated.Rd b/man/pkg-deprecated.Rd index 19f6de9..a42f06d 100644 --- a/man/pkg-deprecated.Rd +++ b/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()}}} } diff --git a/man/setAzureContext.Rd b/man/setAzureContext.Rd index dbf933f..5a7f663 100644 --- a/man/setAzureContext.Rd +++ b/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}