microsoft
/
AzureSMR
зеркало из
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность

Add Azure Batch functions to package documentation; fix some typos

This commit is contained in:
Andrie de Vries 2017-06-14 19:23:16 +01:00
Родитель bb981715b0
Коммит ea1ef50c0c
7 изменённых файлов: 29 добавлений и 27 удалений
Показать статистику Скачать Patch файл Скачать Diff файл Показать все файлы Свернуть все файлы

16
R/AzureBatch.R
Просмотреть файл

@ -9,12 +9,9 @@
azureListBatchAccounts <- function(azureActiveContext, resourceGroup, subscriptionID,
verbose = FALSE) {
assert_that(is.azureActiveContext(azureActiveContext))
azureCheckToken(azureActiveContext)
azToken <- azureActiveContext$Token
if (missing(subscriptionID)) subscriptionID <- azureActiveContext$subscriptionID
assert_that(is_subscription_id(subscriptionID))
verbosity <- set_verbosity(verbose)
type_batch <- "Microsoft.Batch/batchAccounts"
@ -28,7 +25,8 @@ azureListBatchAccounts <- function(azureActiveContext, resourceGroup, subscripti
z
}
#' Create an Azure Batch Account.
#' Create an azure batch account.
#'
#' @inheritParams setAzureContext
#' @inheritParams azureAuthenticate
@ -42,8 +40,6 @@ azureCreateBatchAccount <- function(azureActiveContext, batchAccount,
resourceGroup, subscriptionID,
asynchronous = FALSE, verbose = FALSE) {
assert_that(is.azureActiveContext(azureActiveContext))
azureCheckToken(azureActiveContext)
azToken <- azureActiveContext$Token
if (missing(subscriptionID)) subscriptionID <- azureActiveContext$subscriptionID
if (missing(resourceGroup)) resourceGroup <- azureActiveContext$resourceGroup
@ -86,7 +82,8 @@ azureCreateBatchAccount <- function(azureActiveContext, batchAccount,
TRUE
}
#' Delete an Azure Batch Account.
#' Delete an azure batch account.
#'
#' @inheritParams setAzureContext
#' @inheritParams azureAuthenticate
@ -97,8 +94,6 @@ azureCreateBatchAccount <- function(azureActiveContext, batchAccount,
azureDeleteBatchAccount <- function(azureActiveContext, batchAccount,
resourceGroup, subscriptionID, verbose = FALSE) {
assert_that(is.azureActiveContext(azureActiveContext))
azureCheckToken(azureActiveContext)
azToken <- azureActiveContext$Token
if (missing(resourceGroup)) resourceGroup <- azureActiveContext$resourceGroup
if (missing(subscriptionID)) subscriptionID <- azureActiveContext$subscriptionID
@ -125,6 +120,7 @@ azureDeleteBatchAccount <- function(azureActiveContext, batchAccount,
TRUE
}
#' Get the Batch Keys for Specified Batch Account.
#'
#' @inheritParams setAzureContext
@ -135,8 +131,6 @@ azureDeleteBatchAccount <- function(azureActiveContext, batchAccount,
azureBatchGetKey <- function(azureActiveContext, batchAccount,
resourceGroup, subscriptionID, verbose = FALSE) {
assert_that(is.azureActiveContext(azureActiveContext))
azureCheckToken(azureActiveContext)
azToken <- azureActiveContext$Token
if (missing(resourceGroup)) resourceGroup <- azureActiveContext$resourceGroup
if (missing(subscriptionID)) subscriptionID <- azureActiveContext$subscriptionID

5
R/AzureSMR-package.R
Просмотреть файл

@ -28,6 +28,11 @@
#' - [azureDeleteHDI()]
#' - [azureRunScriptAction()]
#' - [azureScriptActionHistory()]
#' * Azure batch:
#' - [azureListBatchAccounts()]
#' - [azureCreateBatchAccount()]
#' - [azureDeleteBatchAccount()]
#' - [azureBatchGetKey()]
#'
#'
#' @name AzureSMR

7
man/AzureSMR.Rd
Просмотреть файл

@ -46,6 +46,13 @@ This enables you to use and change many Azure resources. The following is an inc
\item \code{\link[=azureRunScriptAction]{azureRunScriptAction()}}
\item \code{\link[=azureScriptActionHistory]{azureScriptActionHistory()}}
}
\item Azure batch:
\itemize{
\item \code{\link[=azureListBatchAccounts]{azureListBatchAccounts()}}
\item \code{\link[=azureCreateBatchAccount]{azureCreateBatchAccount()}}
\item \code{\link[=azureDeleteBatchAccount]{azureDeleteBatchAccount()}}
\item \code{\link[=azureBatchGetKey]{azureBatchGetKey()}}
}
}
}
\keyword{package}

5
man/azureBatchGetKey.Rd
Просмотреть файл

@ -8,11 +8,11 @@ azureBatchGetKey(azureActiveContext, batchAccount, resourceGroup,
subscriptionID, verbose = FALSE)
}
\arguments{
\item{azureActiveContext}{A container used for caching variables used by `AzureSMR`}
\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
\item{resourceGroup}{Name of the resource group}
\item{subscriptionID}{Subscription ID. This is obtained automatically by [azureAuthenticate()] when only a single subscriptionID is available via Active Directory}
\item{subscriptionID}{Subscription ID. This is obtained automatically by \code{\link[=azureAuthenticate]{azureAuthenticate()}} when only a single subscriptionID is available via Active Directory}
\item{verbose}{Print Tracing information (Default False)}
}
@ -24,4 +24,3 @@ Other Batch account functions: \code{\link{azureCreateBatchAccount}},
\code{\link{azureDeleteBatchAccount}},
\code{\link{azureListBatchAccounts}}
}

9
man/azureCreateBatchAccount.Rd
Просмотреть файл

@ -2,31 +2,30 @@
% Please edit documentation in R/AzureBatch.R
\name{azureCreateBatchAccount}
\alias{azureCreateBatchAccount}
\title{Create an Azure Batch Account.}
\title{Create an azure batch account.}
\usage{
azureCreateBatchAccount(azureActiveContext, batchAccount,
location = "northeurope", resourceGroup, subscriptionID,
asynchronous = FALSE, verbose = FALSE)
}
\arguments{
\item{azureActiveContext}{A container used for caching variables used by `AzureSMR`}
\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
\item{location}{A string for the location to create batch account}
\item{resourceGroup}{Name of the resource group}
\item{subscriptionID}{Subscription ID. This is obtained automatically by [azureAuthenticate()] when only a single subscriptionID is available via Active Directory}
\item{subscriptionID}{Subscription ID. This is obtained automatically by \code{\link[=azureAuthenticate]{azureAuthenticate()}} when only a single subscriptionID is available via Active Directory}
\item{asynchronous}{If TRUE, submits asynchronous request to Azure. Otherwise waits until batch account is created.}
\item{verbose}{Print Tracing information (Default False)}
}
\description{
Create an Azure Batch Account.
Create an azure batch account.
}
\seealso{
Other Batch account functions: \code{\link{azureBatchGetKey}},
\code{\link{azureDeleteBatchAccount}},
\code{\link{azureListBatchAccounts}}
}

9
man/azureDeleteBatchAccount.Rd
Просмотреть файл

@ -2,26 +2,25 @@
% Please edit documentation in R/AzureBatch.R
\name{azureDeleteBatchAccount}
\alias{azureDeleteBatchAccount}
\title{Delete an Azure Batch Account.}
\title{Delete an azure batch account.}
\usage{
azureDeleteBatchAccount(azureActiveContext, batchAccount, resourceGroup,
subscriptionID, verbose = FALSE)
}
\arguments{
\item{azureActiveContext}{A container used for caching variables used by `AzureSMR`}
\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
\item{resourceGroup}{Name of the resource group}
\item{subscriptionID}{Subscription ID. This is obtained automatically by [azureAuthenticate()] when only a single subscriptionID is available via Active Directory}
\item{subscriptionID}{Subscription ID. This is obtained automatically by \code{\link[=azureAuthenticate]{azureAuthenticate()}} when only a single subscriptionID is available via Active Directory}
\item{verbose}{Print Tracing information (Default False)}
}
\description{
Delete an Azure Batch Account.
Delete an azure batch account.
}
\seealso{
Other Batch account functions: \code{\link{azureBatchGetKey}},
\code{\link{azureCreateBatchAccount}},
\code{\link{azureListBatchAccounts}}
}

5
man/azureListBatchAccounts.Rd
Просмотреть файл

@ -8,11 +8,11 @@ azureListBatchAccounts(azureActiveContext, resourceGroup, subscriptionID,
verbose = FALSE)
}
\arguments{
\item{azureActiveContext}{A container used for caching variables used by `AzureSMR`}
\item{azureActiveContext}{A container used for caching variables used by \code{AzureSMR}}
\item{resourceGroup}{Name of the resource group}
\item{subscriptionID}{Subscription ID. This is obtained automatically by [azureAuthenticate()] when only a single subscriptionID is available via Active Directory}
\item{subscriptionID}{Subscription ID. This is obtained automatically by \code{\link[=azureAuthenticate]{azureAuthenticate()}} when only a single subscriptionID is available via Active Directory}
\item{verbose}{Print Tracing information (Default False)}
}
@ -24,4 +24,3 @@ Other Batch account functions: \code{\link{azureBatchGetKey}},
\code{\link{azureCreateBatchAccount}},
\code{\link{azureDeleteBatchAccount}}
}