This commit is contained in:
Hong Ooi 2019-04-23 21:34:03 +10:00
Родитель fccea87ff1
Коммит 08b53d8bfa
7 изменённых файлов: 16 добавлений и 40 удалений

Просмотреть файл

@ -1,6 +1,6 @@
Package: AzureKeyVault
Title: Key and Secret Management in 'Azure'
Version: 0.0.1
Version: 1.0.0
Authors@R: c(
person("Hong", "Ooi", , "hongooi@microsoft.com", role = c("aut", "cre")),
person("Microsoft", role="cph")

Просмотреть файл

@ -17,7 +17,7 @@
#' - `location`: The location/region in which to create the account. Defaults to the resource group location.
#' - `initial_access`: The user or service principals that will have access to the vault. This should be a list of objects of type `[vault_access_policy]`, created by the function of the same name. The default is to grant access to the logged-in user or service principal of the current Resource Manager client.
#' - `sku`: The sku for the vault. Set this to "Premium" to enable the use of hardware security modules (HSMs).
#' - `...`: Other named arguments to pass to the [az_storage] initialization function.
#' - `...`: Other named arguments to pass to the [az_key_vault] initialization function.
#' - `wait`: Whether to wait for the resource creation to complete before returning.
#'
#' @section Details:
@ -142,7 +142,7 @@ add_methods <- function()
AzureRMR::az_resource_group$set("public", "create_key_vault", overwrite=TRUE,
function(name, location=self$location, initial_access=default_access(), sku="Standard", ..., wait=TRUE)
{
creds <- decode_jwt(self$token$credentials$access_token)
creds <- AzureAuth::decode_jwt(self$token$credentials$access_token)
tenant <- creds$payload$tid
default_access=function()

Просмотреть файл

@ -47,7 +47,7 @@
#' For `backup`, a string representing the backup blob for a certificate. If the certificate has multiple versions, the blob will contain all versions.
#'
#' @seealso
#' [certificiate], [cert_key_properties], [cert_x509_properties], [cert_issuer_properties], [vault_object_attrs]
#' [certificate], [cert_key_properties], [cert_x509_properties], [cert_issuer_properties], [vault_object_attrs]
#'
#' [Azure Key Vault documentation](https://docs.microsoft.com/en-us/azure/key-vault/),
#' [Azure Key Vault API reference](https://docs.microsoft.com/en-us/rest/api/keyvault)

Просмотреть файл

@ -4,10 +4,10 @@
#'
#' @docType class
#' @section Fields:
#' - `keys`: A sub-object for working with encryption keys stored in the vault. See `Keys` below.
#' - `secrets`: A sub-object for working with secrets stored in the vault. See `Secrets` below.
#' - `certificates`: A sub-object for working with certificates stored in the vault. See `Certificates` below.
#' - `storage`: A sub-object for working with storage accounts managed by the vault. See `Storage accounts` below.
#' - `keys`: A sub-object for working with encryption keys stored in the vault. See [keys].
#' - `secrets`: A sub-object for working with secrets stored in the vault. See [secrets].
#' - `certificates`: A sub-object for working with certificates stored in the vault. See [certificates].
#' - `storage`: A sub-object for working with storage accounts managed by the vault. See [storage].
#'
#' @section Methods:
#' This class provides one method, for initialization:
@ -23,16 +23,8 @@
#'
#' To work with objects stored in the key vault, use the methods provided by one of the sub-objects listed in 'Fields'.
#'
#' @section Keys:
#'
#' @section Secrets:
#'
#' @section Certificates:
#'
#' @section Storage accounts:
#'
#' @seealso
#' [az_vault], [keys], [secrets], [certificates], [storage]
#' [az_key_vault], [keys], [secrets], [certificates], [storage]
#'
#' [Azure Key Vault documentation](https://docs.microsoft.com/en-us/azure/key-vault/),
#' [Azure Key Vault API reference](https://docs.microsoft.com/en-us/rest/api/keyvault)

Просмотреть файл

@ -87,7 +87,7 @@ vault$certificates$get_contacts()
}
}
\seealso{
\link{certificiate}, \link{cert_key_properties}, \link{cert_x509_properties}, \link{cert_issuer_properties}, \link{vault_object_attrs}
\link{certificate}, \link{cert_key_properties}, \link{cert_x509_properties}, \link{cert_issuer_properties}, \link{vault_object_attrs}
\href{https://docs.microsoft.com/en-us/azure/key-vault/}{Azure Key Vault documentation},
\href{https://docs.microsoft.com/en-us/rest/api/keyvault}{Azure Key Vault API reference}

Просмотреть файл

@ -19,7 +19,7 @@ Method for the \link[AzureRMR:az_resource_group]{AzureRMR::az_resource_group} cl
\item \code{location}: The location/region in which to create the account. Defaults to the resource group location.
\item \code{initial_access}: The user or service principals that will have access to the vault. This should be a list of objects of type \code{[vault_access_policy]}, created by the function of the same name. The default is to grant access to the logged-in user or service principal of the current Resource Manager client.
\item \code{sku}: The sku for the vault. Set this to "Premium" to enable the use of hardware security modules (HSMs).
\item \code{...}: Other named arguments to pass to the \link{az_storage} initialization function.
\item \code{...}: Other named arguments to pass to the \link{az_key_vault} initialization function.
\item \code{wait}: Whether to wait for the resource creation to complete before returning.
}
}

Просмотреть файл

@ -14,10 +14,10 @@ Class representing the client endpoint for a key vault, exposing methods for wor
\section{Fields}{
\itemize{
\item \code{keys}: A sub-object for working with encryption keys stored in the vault. See \code{Keys} below.
\item \code{secrets}: A sub-object for working with secrets stored in the vault. See \code{Secrets} below.
\item \code{certificates}: A sub-object for working with certificates stored in the vault. See \code{Certificates} below.
\item \code{storage}: A sub-object for working with storage accounts managed by the vault. See \code{Storage accounts} below.
\item \code{keys}: A sub-object for working with encryption keys stored in the vault. See \link{keys}.
\item \code{secrets}: A sub-object for working with secrets stored in the vault. See \link{secrets}.
\item \code{certificates}: A sub-object for working with certificates stored in the vault. See \link{certificates}.
\item \code{storage}: A sub-object for working with storage accounts managed by the vault. See \link{storage}.
}
}
@ -38,22 +38,6 @@ The arguments are as follows:
To work with objects stored in the key vault, use the methods provided by one of the sub-objects listed in 'Fields'.
}
\section{Keys}{
}
\section{Secrets}{
}
\section{Certificates}{
}
\section{Storage accounts}{
}
\examples{
\dontrun{
@ -71,7 +55,7 @@ key_vault$new("mykeyvault", token=token)
}
}
\seealso{
\link{az_vault}, \link{keys}, \link{secrets}, \link{certificates}, \link{storage}
\link{az_key_vault}, \link{keys}, \link{secrets}, \link{certificates}, \link{storage}
\href{https://docs.microsoft.com/en-us/azure/key-vault/}{Azure Key Vault documentation},
\href{https://docs.microsoft.com/en-us/rest/api/keyvault}{Azure Key Vault API reference}