diff --git a/NAMESPACE b/NAMESPACE index 52ef64c..4ec0b90 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -76,6 +76,7 @@ importFrom(httr,http_status) importFrom(httr,status_code) importFrom(jsonlite,fromJSON) importFrom(plyr,rbind.fill) +importFrom(utils,URLencode) importFrom(utils,browseURL) importFrom(utils,ls.str) importFrom(utils,str) diff --git a/man/AzureSMR-package.Rd b/man/AzureSMR-package.Rd index d9df671..533b5c7 100644 --- a/man/AzureSMR-package.Rd +++ b/man/AzureSMR-package.Rd @@ -1,5 +1,5 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/AzureSM-package.R +% Please edit documentation in R/AzureSMR-package.R \docType{package} \name{AzureSMR-package} \alias{AzureSMR-package} @@ -10,7 +10,6 @@ The AzureSMR package connects R to the Azure Service Manager API. } \details{ This enables you to use and change many Azure resources, including: - \itemize{ \item Storage blobs \item HDInsight (Nodes, Hive, Spark) diff --git a/man/Internal.Rd b/man/Internal.Rd index 9d924ac..6a05f15 100644 --- a/man/Internal.Rd +++ b/man/Internal.Rd @@ -26,5 +26,5 @@ is.azureActiveContext(x) Functions for creating and displaying information about azureActiveContext objects. } \seealso{ -\code{\link{createAzureContext}} +\code{createAzureContext} } diff --git a/man/azureAuthenticate.Rd b/man/azureAuthenticate.Rd index f238ddf..98314d8 100644 --- a/man/azureAuthenticate.Rd +++ b/man/azureAuthenticate.Rd @@ -25,7 +25,7 @@ Retunrs Azure Tokem and sets AzureContext Token Authenticates against Azure Active directory application. } \note{ -See \url{https://azure.microsoft.com/en-us/documentation/articles/resource-group-create-service-principal-portal/} to learn how to set up an Active directory application +See \url{https://azure.microsoft.com/en-us/documentation/articles/resource-group-create-service-principal-portal/} for instructions to set up an Active Directory application } \references{ \url{https://azure.microsoft.com/en-us/documentation/articles/resource-group-create-service-principal-portal/} diff --git a/man/azureBlobCD.Rd b/man/azureBlobCD.Rd index 21a01be..7e6cc4d 100644 --- a/man/azureBlobCD.Rd +++ b/man/azureBlobCD.Rd @@ -12,9 +12,11 @@ azureBlobCD(azureActiveContext, directory, container, file, storageAccount, \item{directory}{Blob store directory to list for content} -\item{container}{Storage container name. See \code{\link{azureListStorageContainers}}} +\item{container}{Storage container name. See \code{azureListStorageContainers}} -\item{file}{- Local filename to store in Azure blob} +\item{file}{\itemize{ +\item Local filename to store in Azure blob +}} \item{storageAccount}{Name of the azure storage account} diff --git a/man/azureBlobFind.Rd b/man/azureBlobFind.Rd index ab5c1a5..bb27caf 100644 --- a/man/azureBlobFind.Rd +++ b/man/azureBlobFind.Rd @@ -10,13 +10,15 @@ azureBlobFind(azureActiveContext, file, storageAccount, storageKey, container, \arguments{ \item{azureActiveContext}{A container used for caching variables used by AzureSMR} -\item{file}{- Local filename to store in Azure blob} +\item{file}{\itemize{ +\item Local filename to store in Azure blob +}} \item{storageAccount}{Name of the azure storage account} \item{storageKey}{Storage key associated with storage account} -\item{container}{Storage container name. See \code{\link{azureListStorageContainers}}} +\item{container}{Storage container name. See \code{azureListStorageContainers}} \item{resourceGroup}{Name of the resource group} diff --git a/man/azureBlobLS.Rd b/man/azureBlobLS.Rd index 2797a7d..befce6e 100644 --- a/man/azureBlobLS.Rd +++ b/man/azureBlobLS.Rd @@ -18,7 +18,7 @@ azureBlobLS(azureActiveContext, directory, recursive = FALSE, storageAccount, \item{storageKey}{Storage key associated with storage account} -\item{container}{Storage container name. See \code{\link{azureListStorageContainers}}} +\item{container}{Storage container name. See \code{azureListStorageContainers}} \item{resourceGroup}{Name of the resource group} diff --git a/man/azureCancelDeploy.Rd b/man/azureCancelDeploy.Rd index c5678b0..93bca0c 100644 --- a/man/azureCancelDeploy.Rd +++ b/man/azureCancelDeploy.Rd @@ -14,9 +14,9 @@ azureCancelDeploy(azureActiveContext, deplname, resourceGroup, subscriptionID, \item{resourceGroup}{Name of the resource group} -\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{\link{azureAuthenticate}} when only a single subscriptionID is available via Active Directory} +\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{azureAuthenticate} when only a single subscriptionID is available via Active Directory} -\item{azToken}{Azure authentication token, obtained by \code{\link{azureAuthenticate}}} +\item{azToken}{Azure authentication token, obtained by \code{azureAuthenticate}} \item{verbose}{Print Tracing information (Default False)} } diff --git a/man/azureCreateHDI.Rd b/man/azureCreateHDI.Rd index 83b26b5..909bd3c 100644 --- a/man/azureCreateHDI.Rd +++ b/man/azureCreateHDI.Rd @@ -13,7 +13,7 @@ azureCreateHDI(azureActiveContext, clustername, location, kind = "spark", \arguments{ \item{azureActiveContext}{A container used for caching variables used by AzureSMR} -\item{clustername}{Cluster name, used for HDI and Spark clusters. See \code{\link{azureCreateHDI}}} +\item{clustername}{Cluster name, used for HDI and Spark clusters. See \code{azureCreateHDI}} \item{location}{Azure region, e.g. 'westeurope' or 'southcentralus'} @@ -49,9 +49,9 @@ azureCreateHDI(azureActiveContext, clustername, location, kind = "spark", \item{vmSize}{Size of nodes: "Large", "Small", "Standard_D14_V2", etc.} -\item{azToken}{Azure authentication token, obtained by \code{\link{azureAuthenticate}}} +\item{azToken}{Azure authentication token, obtained by \code{azureAuthenticate}} -\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{\link{azureAuthenticate}} when only a single subscriptionID is available via Active Directory} +\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{azureAuthenticate} when only a single subscriptionID is available via Active Directory} \item{mode}{Provisioning mode, "Sync" or "Async". Use "Async" to immediately return to R session after submission of request} diff --git a/man/azureCreateResourceGroup.Rd b/man/azureCreateResourceGroup.Rd index cd96a6d..9b4d115 100644 --- a/man/azureCreateResourceGroup.Rd +++ b/man/azureCreateResourceGroup.Rd @@ -14,9 +14,9 @@ azureCreateResourceGroup(azureActiveContext, resourceGroup, location, \item{location}{Azure region, e.g. 'westeurope' or 'southcentralus'} -\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{\link{azureAuthenticate}} when only a single subscriptionID is available via Active Directory} +\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{azureAuthenticate} when only a single subscriptionID is available via Active Directory} -\item{azToken}{Azure authentication token, obtained by \code{\link{azureAuthenticate}}} +\item{azToken}{Azure authentication token, obtained by \code{azureAuthenticate}} \item{verbose}{Print Tracing information (Default False)} } diff --git a/man/azureCreateStorageAccount.Rd b/man/azureCreateStorageAccount.Rd index e9ef810..fe836da 100644 --- a/man/azureCreateStorageAccount.Rd +++ b/man/azureCreateStorageAccount.Rd @@ -16,7 +16,7 @@ azureCreateStorageAccount(azureActiveContext, storageAccount, \item{resourceGroup}{Name of the resource group} -\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{\link{azureAuthenticate}} when only a single subscriptionID is available via Active Directory} +\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{azureAuthenticate} when only a single subscriptionID is available via Active Directory} \item{verbose}{Print Tracing information (Default False)} } diff --git a/man/azureCreateStorageContainer.Rd b/man/azureCreateStorageContainer.Rd index 287737a..9edef27 100644 --- a/man/azureCreateStorageContainer.Rd +++ b/man/azureCreateStorageContainer.Rd @@ -10,7 +10,7 @@ azureCreateStorageContainer(azureActiveContext, container, storageAccount, \arguments{ \item{azureActiveContext}{A container used for caching variables used by AzureSMR} -\item{container}{Storage container name. See \code{\link{azureListStorageContainers}}} +\item{container}{Storage container name. See \code{azureListStorageContainers}} \item{storageAccount}{Name of the azure storage account} @@ -18,9 +18,9 @@ azureCreateStorageContainer(azureActiveContext, container, storageAccount, \item{resourceGroup}{Name of the resource group} -\item{azToken}{Azure authentication token, obtained by \code{\link{azureAuthenticate}}} +\item{azToken}{Azure authentication token, obtained by \code{azureAuthenticate}} -\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{\link{azureAuthenticate}} when only a single subscriptionID is available via Active Directory} +\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{azureAuthenticate} when only a single subscriptionID is available via Active Directory} \item{verbose}{Print Tracing information (Default False)} } diff --git a/man/azureDeleteBlob.Rd b/man/azureDeleteBlob.Rd index 11485af..85cef36 100644 --- a/man/azureDeleteBlob.Rd +++ b/man/azureDeleteBlob.Rd @@ -18,7 +18,7 @@ azureDeleteBlob(azureActiveContext, blob, directory, storageAccount, storageKey, \item{storageKey}{Storage key associated with storage account} -\item{container}{Storage container name. See \code{\link{azureListStorageContainers}}} +\item{container}{Storage container name. See \code{azureListStorageContainers}} \item{resourceGroup}{Name of the resource group} diff --git a/man/azureDeleteDeploy.Rd b/man/azureDeleteDeploy.Rd index 0e7e960..fc077ca 100644 --- a/man/azureDeleteDeploy.Rd +++ b/man/azureDeleteDeploy.Rd @@ -14,9 +14,9 @@ azureDeleteDeploy(azureActiveContext, deplname, resourceGroup, subscriptionID, \item{resourceGroup}{Name of the resource group} -\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{\link{azureAuthenticate}} when only a single subscriptionID is available via Active Directory} +\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{azureAuthenticate} when only a single subscriptionID is available via Active Directory} -\item{azToken}{Azure authentication token, obtained by \code{\link{azureAuthenticate}}} +\item{azToken}{Azure authentication token, obtained by \code{azureAuthenticate}} \item{verbose}{Print Tracing information (Default False)} } diff --git a/man/azureDeleteHDI.Rd b/man/azureDeleteHDI.Rd index c8b4403..d262d2e 100644 --- a/man/azureDeleteHDI.Rd +++ b/man/azureDeleteHDI.Rd @@ -10,11 +10,11 @@ azureDeleteHDI(azureActiveContext, clustername, azToken, subscriptionID, \arguments{ \item{azureActiveContext}{A container used for caching variables used by AzureSMR} -\item{clustername}{Cluster name, used for HDI and Spark clusters. See \code{\link{azureCreateHDI}}} +\item{clustername}{Cluster name, used for HDI and Spark clusters. See \code{azureCreateHDI}} -\item{azToken}{Azure authentication token, obtained by \code{\link{azureAuthenticate}}} +\item{azToken}{Azure authentication token, obtained by \code{azureAuthenticate}} -\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{\link{azureAuthenticate}} when only a single subscriptionID is available via Active Directory} +\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{azureAuthenticate} when only a single subscriptionID is available via Active Directory} \item{resourceGroup}{Name of the resource group} diff --git a/man/azureDeleteResourceGroup.Rd b/man/azureDeleteResourceGroup.Rd index 9128441..15504c2 100644 --- a/man/azureDeleteResourceGroup.Rd +++ b/man/azureDeleteResourceGroup.Rd @@ -12,9 +12,9 @@ azureDeleteResourceGroup(azureActiveContext, resourceGroup, subscriptionID, \item{resourceGroup}{Name of the resource group} -\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{\link{azureAuthenticate}} when only a single subscriptionID is available via Active Directory} +\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{azureAuthenticate} when only a single subscriptionID is available via Active Directory} -\item{azToken}{Azure authentication token, obtained by \code{\link{azureAuthenticate}}} +\item{azToken}{Azure authentication token, obtained by \code{azureAuthenticate}} \item{type}{filter by resource type} diff --git a/man/azureDeleteStorageContainer.Rd b/man/azureDeleteStorageContainer.Rd index 44ee610..ef8aa03 100644 --- a/man/azureDeleteStorageContainer.Rd +++ b/man/azureDeleteStorageContainer.Rd @@ -10,7 +10,7 @@ azureDeleteStorageContainer(azureActiveContext, container, storageAccount, \arguments{ \item{azureActiveContext}{A container used for caching variables used by AzureSMR} -\item{container}{Storage container name. See \code{\link{azureListStorageContainers}}} +\item{container}{Storage container name. See \code{azureListStorageContainers}} \item{storageAccount}{Name of the azure storage account} @@ -18,9 +18,9 @@ azureDeleteStorageContainer(azureActiveContext, container, storageAccount, \item{resourceGroup}{Name of the resource group} -\item{azToken}{Azure authentication token, obtained by \code{\link{azureAuthenticate}}} +\item{azToken}{Azure authentication token, obtained by \code{azureAuthenticate}} -\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{\link{azureAuthenticate}} when only a single subscriptionID is available via Active Directory} +\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{azureAuthenticate} when only a single subscriptionID is available via Active Directory} \item{verbose}{Print Tracing information (Default False)} } diff --git a/man/azureDeleteVM.Rd b/man/azureDeleteVM.Rd index 6e1e908..27682ec 100644 --- a/man/azureDeleteVM.Rd +++ b/man/azureDeleteVM.Rd @@ -14,9 +14,9 @@ azureDeleteVM(azureActiveContext, resourceGroup, vmName, subscriptionID, \item{vmName}{Virtual Machine name} -\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{\link{azureAuthenticate}} when only a single subscriptionID is available via Active Directory} +\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{azureAuthenticate} when only a single subscriptionID is available via Active Directory} -\item{azToken}{Azure authentication token, obtained by \code{\link{azureAuthenticate}}} +\item{azToken}{Azure authentication token, obtained by \code{azureAuthenticate}} \item{mode}{Wait for operation to complete 'Sync' (Default)} diff --git a/man/azureDeletestorageAccount.Rd b/man/azureDeletestorageAccount.Rd index 5328323..e1effe7 100644 --- a/man/azureDeletestorageAccount.Rd +++ b/man/azureDeletestorageAccount.Rd @@ -14,7 +14,7 @@ azureDeletestorageAccount(azureActiveContext, storageAccount, resourceGroup, \item{resourceGroup}{Name of the resource group} -\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{\link{azureAuthenticate}} when only a single subscriptionID is available via Active Directory} +\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{azureAuthenticate} when only a single subscriptionID is available via Active Directory} \item{verbose}{Print Tracing information (Default False)} } diff --git a/man/azureDeployStatus.Rd b/man/azureDeployStatus.Rd index 46121f8..3a67188 100644 --- a/man/azureDeployStatus.Rd +++ b/man/azureDeployStatus.Rd @@ -14,9 +14,9 @@ azureDeployStatus(azureActiveContext, deplname, resourceGroup, subscriptionID, \item{resourceGroup}{Name of the resource group} -\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{\link{azureAuthenticate}} when only a single subscriptionID is available via Active Directory} +\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{azureAuthenticate} when only a single subscriptionID is available via Active Directory} -\item{azToken}{Azure authentication token, obtained by \code{\link{azureAuthenticate}}} +\item{azToken}{Azure authentication token, obtained by \code{azureAuthenticate}} \item{verbose}{Print Tracing information (Default False)} } diff --git a/man/azureDeployTemplate.Rd b/man/azureDeployTemplate.Rd index 1aac49b..c908850 100644 --- a/man/azureDeployTemplate.Rd +++ b/man/azureDeployTemplate.Rd @@ -25,9 +25,9 @@ azureDeployTemplate(azureActiveContext, deplname, templateURL, paramURL, \item{resourceGroup}{Name of the resource group} -\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{\link{azureAuthenticate}} when only a single subscriptionID is available via Active Directory} +\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{azureAuthenticate} when only a single subscriptionID is available via Active Directory} -\item{azToken}{Azure authentication token, obtained by \code{\link{azureAuthenticate}}} +\item{azToken}{Azure authentication token, obtained by \code{azureAuthenticate}} \item{verbose}{Print Tracing information (Default False)} } diff --git a/man/azureGetBlob.Rd b/man/azureGetBlob.Rd index 603200a..e8798e4 100644 --- a/man/azureGetBlob.Rd +++ b/man/azureGetBlob.Rd @@ -14,13 +14,13 @@ azureGetBlob(azureActiveContext, blob, directory, type = "text", \item{directory}{Blob store directory to list for content} -\item{type}{String, either "text" or "raw". Passed to \code{\link[httr]{content}}} +\item{type}{String, either "text" or "raw". Passed to \code{httr::content}} \item{storageAccount}{Name of the azure storage account} \item{storageKey}{Storage key associated with storage account} -\item{container}{Storage container name. See \code{\link{azureListStorageContainers}}} +\item{container}{Storage container name. See \code{azureListStorageContainers}} \item{resourceGroup}{Name of the resource group} diff --git a/man/azureHDIConf.Rd b/man/azureHDIConf.Rd index 1e86bd1..5419d60 100644 --- a/man/azureHDIConf.Rd +++ b/man/azureHDIConf.Rd @@ -10,13 +10,13 @@ azureHDIConf(azureActiveContext, clustername, resourceGroup, subscriptionID, \arguments{ \item{azureActiveContext}{A container used for caching variables used by AzureSMR} -\item{clustername}{Cluster name, used for HDI and Spark clusters. See \code{\link{azureCreateHDI}}} +\item{clustername}{Cluster name, used for HDI and Spark clusters. See \code{azureCreateHDI}} \item{resourceGroup}{Name of the resource group} -\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{\link{azureAuthenticate}} when only a single subscriptionID is available via Active Directory} +\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{azureAuthenticate} when only a single subscriptionID is available via Active Directory} -\item{azToken}{Azure authentication token, obtained by \code{\link{azureAuthenticate}}} +\item{azToken}{Azure authentication token, obtained by \code{azureAuthenticate}} \item{name}{filter by resource name} diff --git a/man/azureHiveSQL.Rd b/man/azureHiveSQL.Rd index bd5a81f..28e69fb 100644 --- a/man/azureHiveSQL.Rd +++ b/man/azureHiveSQL.Rd @@ -12,7 +12,7 @@ azureHiveSQL(azureActiveContext, CMD, clustername, hdiAdmin, hdiPassword, \item{CMD}{SQl COmmand String} -\item{clustername}{Cluster name, used for HDI and Spark clusters. See \code{\link{azureCreateHDI}}} +\item{clustername}{Cluster name, used for HDI and Spark clusters. See \code{azureCreateHDI}} \item{hdiAdmin}{HDInsight admin username} diff --git a/man/azureHiveStatus.Rd b/man/azureHiveStatus.Rd index 842a874..838e849 100644 --- a/man/azureHiveStatus.Rd +++ b/man/azureHiveStatus.Rd @@ -10,7 +10,7 @@ azureHiveStatus(azureActiveContext, clustername, hdiAdmin, hdiPassword, \arguments{ \item{azureActiveContext}{A container used for caching variables used by AzureSMR} -\item{clustername}{Cluster name, used for HDI and Spark clusters. See \code{\link{azureCreateHDI}}} +\item{clustername}{Cluster name, used for HDI and Spark clusters. See \code{azureCreateHDI}} \item{hdiAdmin}{HDInsight admin username} diff --git a/man/azureListAllResources.Rd b/man/azureListAllResources.Rd index 4df16b8..d50ce49 100644 --- a/man/azureListAllResources.Rd +++ b/man/azureListAllResources.Rd @@ -14,7 +14,7 @@ azureListAllResources(azureActiveContext, resourceGroup, subscriptionID, \item{subscriptionID}{subscriptionID Object (or use azureActiveContext)} -\item{azToken}{Azure authentication token, obtained by \code{\link{azureAuthenticate}}} +\item{azToken}{Azure authentication token, obtained by \code{azureAuthenticate}} \item{name}{filter by resource name} diff --git a/man/azureListHDI.Rd b/man/azureListHDI.Rd index c0fedea..fa7a7fa 100644 --- a/man/azureListHDI.Rd +++ b/man/azureListHDI.Rd @@ -12,11 +12,11 @@ azureListHDI(azureActiveContext, resourceGroup, clustername = "*", \item{resourceGroup}{Name of the resource group} -\item{clustername}{Cluster name, used for HDI and Spark clusters. See \code{\link{azureCreateHDI}}} +\item{clustername}{Cluster name, used for HDI and Spark clusters. See \code{azureCreateHDI}} -\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{\link{azureAuthenticate}} when only a single subscriptionID is available via Active Directory} +\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{azureAuthenticate} when only a single subscriptionID is available via Active Directory} -\item{azToken}{Azure authentication token, obtained by \code{\link{azureAuthenticate}}} +\item{azToken}{Azure authentication token, obtained by \code{azureAuthenticate}} \item{name}{filter by resource name} diff --git a/man/azureListRG.Rd b/man/azureListRG.Rd index 0ee597b..20affb0 100644 --- a/man/azureListRG.Rd +++ b/man/azureListRG.Rd @@ -12,9 +12,9 @@ AzureListRG(azureActiveContext, subscriptionID, azToken, verbose = FALSE) \arguments{ \item{azureActiveContext}{A container used for caching variables used by AzureSMR} -\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{\link{azureAuthenticate}} when only a single subscriptionID is available via Active Directory} +\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{azureAuthenticate} when only a single subscriptionID is available via Active Directory} -\item{azToken}{Azure authentication token, obtained by \code{\link{azureAuthenticate}}} +\item{azToken}{Azure authentication token, obtained by \code{azureAuthenticate}} \item{verbose}{Print Tracing information (Default False)} } diff --git a/man/azureListSA.Rd b/man/azureListSA.Rd index 6f42f66..c362dbf 100644 --- a/man/azureListSA.Rd +++ b/man/azureListSA.Rd @@ -12,7 +12,7 @@ azureListSA(azureActiveContext, resourceGroup, subscriptionID, \item{resourceGroup}{Name of the resource group} -\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{\link{azureAuthenticate}} when only a single subscriptionID is available via Active Directory} +\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{azureAuthenticate} when only a single subscriptionID is available via Active Directory} \item{verbose}{Print Tracing information (Default False)} } diff --git a/man/azureListScaleSetNetwork.Rd b/man/azureListScaleSetNetwork.Rd index c5cec73..7cbad92 100644 --- a/man/azureListScaleSetNetwork.Rd +++ b/man/azureListScaleSetNetwork.Rd @@ -14,9 +14,9 @@ azureListScaleSetNetwork(azureActiveContext, resourceGroup, location, \item{location}{Azure region, e.g. 'westeurope' or 'southcentralus'} -\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{\link{azureAuthenticate}} when only a single subscriptionID is available via Active Directory} +\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{azureAuthenticate} when only a single subscriptionID is available via Active Directory} -\item{azToken}{Azure authentication token, obtained by \code{\link{azureAuthenticate}}} +\item{azToken}{Azure authentication token, obtained by \code{azureAuthenticate}} \item{verbose}{Print Tracing information (Default False)} } diff --git a/man/azureListScaleSetVM.Rd b/man/azureListScaleSetVM.Rd index 3c8ea75..4512c48 100644 --- a/man/azureListScaleSetVM.Rd +++ b/man/azureListScaleSetVM.Rd @@ -16,9 +16,9 @@ azureListScaleSetVM(azureActiveContext, scaleSet, resourceGroup, location, \item{location}{Azure region, e.g. 'westeurope' or 'southcentralus'} -\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{\link{azureAuthenticate}} when only a single subscriptionID is available via Active Directory} +\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{azureAuthenticate} when only a single subscriptionID is available via Active Directory} -\item{azToken}{Azure authentication token, obtained by \code{\link{azureAuthenticate}}} +\item{azToken}{Azure authentication token, obtained by \code{azureAuthenticate}} \item{verbose}{Print Tracing information (Default False)} } diff --git a/man/azureListScaleSets.Rd b/man/azureListScaleSets.Rd index 864aedd..38f9fd4 100644 --- a/man/azureListScaleSets.Rd +++ b/man/azureListScaleSets.Rd @@ -14,9 +14,9 @@ azureListScaleSets(azureActiveContext, resourceGroup, location, subscriptionID, \item{location}{Azure region, e.g. 'westeurope' or 'southcentralus'} -\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{\link{azureAuthenticate}} when only a single subscriptionID is available via Active Directory} +\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{azureAuthenticate} when only a single subscriptionID is available via Active Directory} -\item{azToken}{Azure authentication token, obtained by \code{\link{azureAuthenticate}}} +\item{azToken}{Azure authentication token, obtained by \code{azureAuthenticate}} \item{verbose}{Print Tracing information (Default False)} } diff --git a/man/azureListStorageBlobs.Rd b/man/azureListStorageBlobs.Rd index 09f40d8..64b7e6b 100644 --- a/man/azureListStorageBlobs.Rd +++ b/man/azureListStorageBlobs.Rd @@ -14,19 +14,19 @@ azureListStorageBlobs(azureActiveContext, storageAccount, storageKey, container, \item{storageKey}{Storage key associated with storage account} -\item{container}{Storage container name. See \code{\link{azureListStorageContainers}}} +\item{container}{Storage container name. See \code{azureListStorageContainers}} \item{resourceGroup}{Name of the resource group} -\item{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) .} +\item{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).} \item{prefix}{Optional. Filters the results to return only blobs whose names begin with the specified prefix.} \item{delimiter}{Optional. When the request includes this parameter, the operation returns a BlobPrefix element in the response body that acts as a placeholder for all blobs whose names begin with the same substring up to the appearance of the delimiter character. The delimiter may be a single character or a string.} -\item{verbose}{Print Tracing information (Default False)} +\item{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.} -\item{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.} +\item{verbose}{Print Tracing information (Default False)} } \value{ Returns a data frame. This data frame has an attribute called "marker" that can be used with the "marker" argument to return the next set of values. diff --git a/man/azureListStorageContainers.Rd b/man/azureListStorageContainers.Rd index 4200a15..d630e63 100644 --- a/man/azureListStorageContainers.Rd +++ b/man/azureListStorageContainers.Rd @@ -16,9 +16,9 @@ azureListStorageContainers(azureActiveContext, storageAccount, storageKey, \item{resourceGroup}{Name of the resource group} -\item{azToken}{Azure authentication token, obtained by \code{\link{azureAuthenticate}}} +\item{azToken}{Azure authentication token, obtained by \code{azureAuthenticate}} -\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{\link{azureAuthenticate}} when only a single subscriptionID is available via Active Directory} +\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{azureAuthenticate} when only a single subscriptionID is available via Active Directory} \item{verbose}{Print Tracing information (Default False)} } diff --git a/man/azureListSubscriptions.Rd b/man/azureListSubscriptions.Rd index 59f5f58..f08bf19 100644 --- a/man/azureListSubscriptions.Rd +++ b/man/azureListSubscriptions.Rd @@ -9,7 +9,7 @@ azureListSubscriptions(azureActiveContext, azToken, verbose = FALSE) \arguments{ \item{azureActiveContext}{A container used for caching variables used by AzureSMR} -\item{azToken}{Azure authentication token, obtained by \code{\link{azureAuthenticate}}} +\item{azToken}{Azure authentication token, obtained by \code{azureAuthenticate}} \item{verbose}{Print Tracing information (Default False)} } diff --git a/man/azureListVM.Rd b/man/azureListVM.Rd index 1f8646b..14eb30e 100644 --- a/man/azureListVM.Rd +++ b/man/azureListVM.Rd @@ -14,9 +14,9 @@ azureListVM(azureActiveContext, resourceGroup, location, subscriptionID, \item{location}{Azure region, e.g. 'westeurope' or 'southcentralus'} -\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{\link{azureAuthenticate}} when only a single subscriptionID is available via Active Directory} +\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{azureAuthenticate} when only a single subscriptionID is available via Active Directory} -\item{azToken}{Azure authentication token, obtained by \code{\link{azureAuthenticate}}} +\item{azToken}{Azure authentication token, obtained by \code{azureAuthenticate}} \item{verbose}{Print Tracing information (Default False)} } diff --git a/man/azurePutBlob.Rd b/man/azurePutBlob.Rd index 5d0a33b..023d93d 100644 --- a/man/azurePutBlob.Rd +++ b/man/azurePutBlob.Rd @@ -12,9 +12,13 @@ azurePutBlob(azureActiveContext, blob, contents = "", file = "", directory, \item{blob}{Blob name} -\item{contents}{- Object or value to store} +\item{contents}{\itemize{ +\item Object or value to store +}} -\item{file}{- Local filename to store in Azure blob} +\item{file}{\itemize{ +\item Local filename to store in Azure blob +}} \item{directory}{Blob store directory to list for content} @@ -22,7 +26,7 @@ azurePutBlob(azureActiveContext, blob, contents = "", file = "", directory, \item{storageKey}{Storage key associated with storage account} -\item{container}{Storage container name. See \code{\link{azureListStorageContainers}}} +\item{container}{Storage container name. See \code{azureListStorageContainers}} \item{resourceGroup}{Name of the resource group} diff --git a/man/azureResizeHDI.Rd b/man/azureResizeHDI.Rd index 51dc40a..9044d90 100644 --- a/man/azureResizeHDI.Rd +++ b/man/azureResizeHDI.Rd @@ -10,7 +10,7 @@ azureResizeHDI(azureActiveContext, clustername, role = "worker", size = 2, \arguments{ \item{azureActiveContext}{A container used for caching variables used by AzureSMR} -\item{clustername}{Cluster name, used for HDI and Spark clusters. See \code{\link{azureCreateHDI}}} +\item{clustername}{Cluster name, used for HDI and Spark clusters. See \code{azureCreateHDI}} \item{role}{role type: 'worker', 'head' or 'Edge'} @@ -18,9 +18,9 @@ azureResizeHDI(azureActiveContext, clustername, role = "worker", size = 2, \item{mode}{Provisioning mode, "Sync" or "Async". Use "Async" to immediately return to R session after submission of request} -\item{azToken}{Azure authentication token, obtained by \code{\link{azureAuthenticate}}} +\item{azToken}{Azure authentication token, obtained by \code{azureAuthenticate}} -\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{\link{azureAuthenticate}} when only a single subscriptionID is available via Active Directory} +\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{azureAuthenticate} when only a single subscriptionID is available via Active Directory} \item{resourceGroup}{Name of the resource group} diff --git a/man/azureRunScriptAction.Rd b/man/azureRunScriptAction.Rd index 1ae4c07..bde1090 100644 --- a/man/azureRunScriptAction.Rd +++ b/man/azureRunScriptAction.Rd @@ -21,15 +21,15 @@ azureRunScriptAction(azureActiveContext, scriptname = "script1", scriptURL, \item{edgeNode}{install on worker nodes (default FALSE)} -\item{clustername}{Cluster name, used for HDI and Spark clusters. See \code{\link{azureCreateHDI}}} +\item{clustername}{Cluster name, used for HDI and Spark clusters. See \code{azureCreateHDI}} \item{resourceGroup}{Name of the resource group} \item{parameters}{parameters} -\item{azToken}{Azure authentication token, obtained by \code{\link{azureAuthenticate}}} +\item{azToken}{Azure authentication token, obtained by \code{azureAuthenticate}} -\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{\link{azureAuthenticate}} when only a single subscriptionID is available via Active Directory} +\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{azureAuthenticate} when only a single subscriptionID is available via Active Directory} \item{verbose}{Print Tracing information (Default False)} } diff --git a/man/azureSAGetKey.Rd b/man/azureSAGetKey.Rd index 81e2a91..7dd54d0 100644 --- a/man/azureSAGetKey.Rd +++ b/man/azureSAGetKey.Rd @@ -14,7 +14,7 @@ azureSAGetKey(azureActiveContext, storageAccount, resourceGroup, subscriptionID, \item{resourceGroup}{Name of the resource group} -\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{\link{azureAuthenticate}} when only a single subscriptionID is available via Active Directory} +\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{azureAuthenticate} when only a single subscriptionID is available via Active Directory} \item{verbose}{Print Tracing information (Default False)} } diff --git a/man/azureScriptActionHistory.Rd b/man/azureScriptActionHistory.Rd index b6df4f5..e2a585b 100644 --- a/man/azureScriptActionHistory.Rd +++ b/man/azureScriptActionHistory.Rd @@ -12,11 +12,11 @@ azureScriptActionHistory(azureActiveContext, resourceGroup, clustername = "*", \item{resourceGroup}{Name of the resource group} -\item{clustername}{Cluster name, used for HDI and Spark clusters. See \code{\link{azureCreateHDI}}} +\item{clustername}{Cluster name, used for HDI and Spark clusters. See \code{azureCreateHDI}} -\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{\link{azureAuthenticate}} when only a single subscriptionID is available via Active Directory} +\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{azureAuthenticate} when only a single subscriptionID is available via Active Directory} -\item{azToken}{Azure authentication token, obtained by \code{\link{azureAuthenticate}}} +\item{azToken}{Azure authentication token, obtained by \code{azureAuthenticate}} \item{name}{filter by resource name} diff --git a/man/azureSparkCMD.Rd b/man/azureSparkCMD.Rd index 3b7fb5e..55bed95 100644 --- a/man/azureSparkCMD.Rd +++ b/man/azureSparkCMD.Rd @@ -12,13 +12,13 @@ azureSparkCMD(azureActiveContext, CMD, clustername, hdiAdmin, hdiPassword, \item{CMD}{CMD} -\item{clustername}{Cluster name, used for HDI and Spark clusters. See \code{\link{azureCreateHDI}}} +\item{clustername}{Cluster name, used for HDI and Spark clusters. See \code{azureCreateHDI}} \item{hdiAdmin}{HDInsight admin username} \item{hdiPassword}{HDInsight admin password} -\item{sessionID}{Spark sessionID. See \code{\link{azureSparkCMD}}} +\item{sessionID}{Spark sessionID. See \code{azureSparkCMD}} \item{verbose}{Print Tracing information (Default False)} } diff --git a/man/azureSparkJob.Rd b/man/azureSparkJob.Rd index de205c9..d41a6f0 100644 --- a/man/azureSparkJob.Rd +++ b/man/azureSparkJob.Rd @@ -12,7 +12,7 @@ azureSparkJob(azureActiveContext, FILE, clustername, hdiAdmin, hdiPassword, \item{FILE}{file} -\item{clustername}{Cluster name, used for HDI and Spark clusters. See \code{\link{azureCreateHDI}}} +\item{clustername}{Cluster name, used for HDI and Spark clusters. See \code{azureCreateHDI}} \item{hdiAdmin}{HDInsight admin username} diff --git a/man/azureSparkListJobs.Rd b/man/azureSparkListJobs.Rd index 4de5820..e13f988 100644 --- a/man/azureSparkListJobs.Rd +++ b/man/azureSparkListJobs.Rd @@ -10,7 +10,7 @@ azureSparkListJobs(azureActiveContext, clustername, hdiAdmin, hdiPassword, \arguments{ \item{azureActiveContext}{A container used for caching variables used by AzureSMR} -\item{clustername}{Cluster name, used for HDI and Spark clusters. See \code{\link{azureCreateHDI}}} +\item{clustername}{Cluster name, used for HDI and Spark clusters. See \code{azureCreateHDI}} \item{hdiAdmin}{HDInsight admin username} diff --git a/man/azureSparkListSessions.Rd b/man/azureSparkListSessions.Rd index 23cdfaa..ce02c5c 100644 --- a/man/azureSparkListSessions.Rd +++ b/man/azureSparkListSessions.Rd @@ -10,7 +10,7 @@ azureSparkListSessions(azureActiveContext, clustername, hdiAdmin, hdiPassword, \arguments{ \item{azureActiveContext}{A container used for caching variables used by AzureSMR} -\item{clustername}{Cluster name, used for HDI and Spark clusters. See \code{\link{azureCreateHDI}}} +\item{clustername}{Cluster name, used for HDI and Spark clusters. See \code{azureCreateHDI}} \item{hdiAdmin}{HDInsight admin username} diff --git a/man/azureSparkNewSession.Rd b/man/azureSparkNewSession.Rd index b97595e..dede974 100644 --- a/man/azureSparkNewSession.Rd +++ b/man/azureSparkNewSession.Rd @@ -10,7 +10,7 @@ azureSparkNewSession(azureActiveContext, clustername, hdiAdmin, hdiPassword, \arguments{ \item{azureActiveContext}{A container used for caching variables used by AzureSMR} -\item{clustername}{Cluster name, used for HDI and Spark clusters. See \code{\link{azureCreateHDI}}} +\item{clustername}{Cluster name, used for HDI and Spark clusters. See \code{azureCreateHDI}} \item{hdiAdmin}{HDInsight admin username} diff --git a/man/azureSparkStopSession.Rd b/man/azureSparkStopSession.Rd index 3d82b96..44187e1 100644 --- a/man/azureSparkStopSession.Rd +++ b/man/azureSparkStopSession.Rd @@ -10,13 +10,13 @@ azureSparkStopSession(azureActiveContext, clustername, hdiAdmin, hdiPassword, \arguments{ \item{azureActiveContext}{A container used for caching variables used by AzureSMR} -\item{clustername}{Cluster name, used for HDI and Spark clusters. See \code{\link{azureCreateHDI}}} +\item{clustername}{Cluster name, used for HDI and Spark clusters. See \code{azureCreateHDI}} \item{hdiAdmin}{HDInsight admin username} \item{hdiPassword}{HDInsight admin password} -\item{sessionID}{Spark sessionID. See \code{\link{azureSparkCMD}}} +\item{sessionID}{Spark sessionID. See \code{azureSparkCMD}} \item{verbose}{Print Tracing information (Default False)} } diff --git a/man/azureStartVM.Rd b/man/azureStartVM.Rd index e8621d0..19869a1 100644 --- a/man/azureStartVM.Rd +++ b/man/azureStartVM.Rd @@ -16,9 +16,9 @@ azureStartVM(azureActiveContext, resourceGroup, vmName, mode = "Sync", \item{mode}{Wait for operation to complete 'Sync' (Default)} -\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{\link{azureAuthenticate}} when only a single subscriptionID is available via Active Directory} +\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{azureAuthenticate} when only a single subscriptionID is available via Active Directory} -\item{azToken}{Azure authentication token, obtained by \code{\link{azureAuthenticate}}} +\item{azToken}{Azure authentication token, obtained by \code{azureAuthenticate}} \item{verbose}{Print Tracing information (Default False)} } diff --git a/man/azureStopVM.Rd b/man/azureStopVM.Rd index 373e1b2..21f7860 100644 --- a/man/azureStopVM.Rd +++ b/man/azureStopVM.Rd @@ -16,9 +16,9 @@ azureStopVM(azureActiveContext, resourceGroup, vmName, mode = "Sync", \item{mode}{Wait for operation to complete 'Sync' (Default)} -\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{\link{azureAuthenticate}} when only a single subscriptionID is available via Active Directory} +\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{azureAuthenticate} when only a single subscriptionID is available via Active Directory} -\item{azToken}{Azure authentication token, obtained by \code{\link{azureAuthenticate}}} +\item{azToken}{Azure authentication token, obtained by \code{azureAuthenticate}} \item{verbose}{Print Tracing information (Default False)} } diff --git a/man/azureVMStatus.Rd b/man/azureVMStatus.Rd index 306d4ba..d006207 100644 --- a/man/azureVMStatus.Rd +++ b/man/azureVMStatus.Rd @@ -14,9 +14,9 @@ azureVMStatus(azureActiveContext, resourceGroup, vmName, subscriptionID, \item{vmName}{Name of the virtual Machine} -\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{\link{azureAuthenticate}} when only a single subscriptionID is available via Active Directory} +\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{azureAuthenticate} when only a single subscriptionID is available via Active Directory} -\item{azToken}{Azure authentication token, obtained by \code{\link{azureAuthenticate}}} +\item{azToken}{Azure authentication token, obtained by \code{azureAuthenticate}} \item{ignore}{ignore} diff --git a/man/createAzureContext.Rd b/man/createAzureContext.Rd index 187d401..e33f545 100644 --- a/man/createAzureContext.Rd +++ b/man/createAzureContext.Rd @@ -20,7 +20,7 @@ Create a container (azureContextObject) for holding variables used by the AzureS See the Azure documentation (\url{https://azure.microsoft.com/en-us/documentation/articles/resource-group-create-service-principal-portal/}) for information to configure an Active Directory application. } \seealso{ -\code{\link{setAzureContext}} +\code{setAzureContext} Other azureActiveContext functions: \code{\link{setAzureContext}} } diff --git a/man/setAzureContext.Rd b/man/setAzureContext.Rd index c25aa3c..e9b0b5e 100644 --- a/man/setAzureContext.Rd +++ b/man/setAzureContext.Rd @@ -17,9 +17,9 @@ setAzureContext(azureActiveContext, tenantID, clientID, authKey, azToken, \item{authKey}{The Authentication Key provided during creation of the Active Directory application / service principal} -\item{azToken}{Azure authentication token, obtained by \code{\link{azureAuthenticate}}} +\item{azToken}{Azure authentication token, obtained by \code{azureAuthenticate}} -\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{\link{azureAuthenticate}} when only a single subscriptionID is available via Active Directory} +\item{subscriptionID}{Set the subscriptionID. This is obtained automatically by \code{azureAuthenticate} when only a single subscriptionID is available via Active Directory} \item{resourceGroup}{Name of the resource group} @@ -27,7 +27,7 @@ setAzureContext(azureActiveContext, tenantID, clientID, authKey, azToken, \item{storageAccount}{Name of the azure storage account} -\item{container}{Storage container name. See \code{\link{azureListStorageContainers}}} +\item{container}{Storage container name. See \code{azureListStorageContainers}} \item{blob}{Blob name} @@ -37,14 +37,14 @@ setAzureContext(azureActiveContext, tenantID, clientID, authKey, azToken, \item{hdiPassword}{HDInsight admin password} -\item{clustername}{Cluster name, used for HDI and Spark clusters. See \code{\link{azureCreateHDI}}} +\item{clustername}{Cluster name, used for HDI and Spark clusters. See \code{azureCreateHDI}} \item{kind}{HDinsight kind: "hadoop","spark" or "pyspark"} -\item{sessionID}{Spark sessionID. See \code{\link{azureSparkCMD}}} +\item{sessionID}{Spark sessionID. See \code{azureSparkCMD}} } \description{ -Updates the value of an azureActiveContext object, created by \code{\link{createAzureContext}} +Updates the value of an azureActiveContext object, created by \code{createAzureContext} } \seealso{ Other azureActiveContext functions: \code{\link{createAzureContext}}