Skip to content

Commit 101eb92

Browse files
authored
Doc fixes (#33)
* more doc fixes * fixes * rm dead link * rm dead link 2
1 parent 7053ead commit 101eb92

21 files changed

Lines changed: 47 additions & 34 deletions

.Rbuildignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,4 @@ CONTRIBUTING.md
99
drat.sh
1010
^LICENSE\.md$
1111
^\.github$
12+
^SECURITY\.md$

.github/workflows/check-standard.yaml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,19 @@ jobs:
1717
config:
1818
- {os: windows-latest, r: 'release'}
1919
- {os: macOS-latest, r: 'release'}
20-
- {os: ubuntu-20.04, r: 'release', rspm: "https://packagemanager.rstudio.com/cran/__linux__/focal/latest"}
20+
- {os: ubuntu-24.04, r: 'release', rspm: "https://packagemanager.rstudio.com/cran/__linux__/focal/latest"}
2121

2222
env:
2323
R_REMOTES_NO_ERRORS_FROM_WARNINGS: true
2424
RSPM: ${{ matrix.config.rspm }}
2525

2626
steps:
27-
- uses: actions/checkout@v2
27+
- uses: actions/checkout@v4
2828
with:
2929
fetch-depth: 0 # required for mirroring, see https://stackoverflow.com/a/64272409/474349
3030

3131
- name: Copy to Cloudyr
32-
if: runner.os == 'Linux' && github.ref == 'refs/heads/master' && github.repository_owner == 'Azure'
32+
if: github.repository_owner == 'Azure' && runner.os == 'Linux' && github.ref == 'refs/heads/master'
3333
env:
3434
token: "${{ secrets.ghPat }}"
3535
# git config hack required, see https://stackoverflow.com/q/64270867/474349
@@ -54,11 +54,11 @@ jobs:
5454

5555
- name: Cache R packages
5656
if: runner.os != 'Windows'
57-
uses: actions/cache@v2
57+
uses: actions/cache@v3
5858
with:
5959
path: ${{ env.R_LIBS_USER }}
6060
key: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-${{ hashFiles('.github/depends.Rds') }}
61-
restore-keys: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-
61+
# restore-keys: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-5-
6262

6363
- name: Install system dependencies
6464
if: runner.os == 'Linux'
@@ -85,13 +85,13 @@ jobs:
8585

8686
- name: Upload check results
8787
if: failure()
88-
uses: actions/upload-artifact@main
88+
uses: actions/upload-artifact@v4
8989
with:
9090
name: ${{ runner.os }}-r${{ matrix.config.r }}-results
9191
path: check
9292

9393
- name: Update Cloudyr drat
94-
if: success() && runner.os == 'Linux' && github.ref == 'refs/heads/master' && github.repository_owner == 'Azure'
94+
if: success() && github.repository_owner == 'Azure' && runner.os == 'Linux' && github.ref == 'refs/heads/master'
9595
env:
9696
token: "${{ secrets.ghPat }}"
9797
run: |

DESCRIPTION

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Package: AzureRMR
22
Title: Interface to 'Azure Resource Manager'
3-
Version: 2.4.4
3+
Version: 2.4.5
44
Authors@R: c(
55
person("Hong", "Ooi", , "hongooi73@gmail.com", role = c("aut", "cre")),
66
person("Microsoft", role="cph")
@@ -28,4 +28,4 @@ Suggests:
2828
httpuv,
2929
AzureStor
3030
Roxygen: list(markdown=TRUE, r6=FALSE, old_usage=TRUE)
31-
RoxygenNote: 7.2.1
31+
RoxygenNote: 7.3.1

NAMESPACE

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,4 +50,16 @@ export(pool_sapply)
5050
export(pool_size)
5151
import(AzureAuth)
5252
import(AzureGraph)
53+
importFrom(AzureAuth,AzureR_dir)
54+
importFrom(AzureAuth,clean_token_directory)
55+
importFrom(AzureAuth,delete_azure_token)
56+
importFrom(AzureAuth,get_azure_token)
57+
importFrom(AzureAuth,is_azure_token)
58+
importFrom(AzureAuth,is_azure_v1_token)
59+
importFrom(AzureAuth,is_guid)
60+
importFrom(AzureAuth,list_azure_tokens)
61+
importFrom(AzureGraph,format_public_fields)
62+
importFrom(AzureGraph,format_public_methods)
63+
importFrom(AzureGraph,is_empty)
64+
importFrom(AzureGraph,named_list)
5365
importFrom(utils,modifyList)

NEWS.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
# AzureRMR 2.4.5
2+
3+
- Update documentation links for CRAN
4+
15
# AzureRMR 2.4.4
26

37
- Fix broken `list_azure_logins` function. Thanks to Pedro Z (@pedrobtz).

R/az_login.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
#' @param version The Azure Active Directory version to use for authenticating.
1212
#' @param scopes The Azure Service Management scopes (permissions) to obtain for this login. Only for `version=2`.
1313
#' @param config_file Optionally, a JSON file containing any of the arguments listed above. Arguments supplied in this file take priority over those supplied on the command line. You can also use the output from the Azure CLI `az ad sp create-for-rbac` command.
14-
#' @param token Optionally, an OAuth 2.0 token, of class [AzureToken]. This allows you to reuse the authentication details for an existing session. If supplied, the other arguments above to `create_azure_login` will be ignored.
14+
#' @param token Optionally, an OAuth 2.0 token, of class [AzureAuth::AzureToken]. This allows you to reuse the authentication details for an existing session. If supplied, the other arguments above to `create_azure_login` will be ignored.
1515
#' @param graph_host The Microsoft Graph endpoint. See 'Microsoft Graph integration' below.
1616
#' @param refresh For `get_azure_login`, whether to refresh the authentication token on loading the client.
1717
#' @param selection For `get_azure_login`, if you have multiple logins for a given tenant, which one to use. This can be a number, or the input MD5 hash of the token used for the login. If not supplied, `get_azure_login` will print a menu and ask you to choose a login.
@@ -31,7 +31,7 @@
3131
#' If the AzureGraph package is installed and the `graph_host` argument is not `NULL`, `create_azure_login` will also create a login client for Microsoft Graph with the same credentials. This is to facilitate working with registered apps and service principals, eg when managing roles and permissions. Some Azure services also require creating service principals as part of creating a resource (eg Azure Kubernetes Service), and keeping the Graph credentials consistent with ARM helps ensure nothing breaks.
3232
#'
3333
#' @section Linux DSVM note:
34-
#' If you are using a Linux [Data Science Virtual Machine](https://azure.microsoft.com/en-us/services/virtual-machines/data-science-virtual-machines/) in Azure, you may have problems running `create_azure_login()` (ie, without any arguments). In this case, try `create_azure_login(auth_type="device_code")`.
34+
#' If you are using a Linux [Data Science Virtual Machine](https://azure.microsoft.com/en-us/products/virtual-machines/data-science-virtual-machines/) in Azure, you may have problems running `create_azure_login()` (ie, without any arguments). In this case, try `create_azure_login(auth_type="device_code")`.
3535
#'
3636
#' @return
3737
#' For `get_azure_login` and `create_azure_login`, an object of class `az_rm`, representing the ARM login client. For `list_azure_logins`, a (possibly nested) list of such objects.

R/az_resgroup.R

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
#' @section Initialization:
3434
#' Initializing a new object of this class can either retrieve an existing resource group, or create a new resource group on the host. Generally, the easiest way to create a resource group object is via the `get_resource_group`, `create_resource_group` or `list_resource_groups` methods of the [az_subscription] class, which handle this automatically.
3535
#'
36-
#' To create a resource group object in isolation, supply (at least) an Oauth 2.0 token of class [AzureToken], the subscription ID, and the resource group name. If this object refers to a _new_ resource group, supply the location as well (use the `list_locations` method of the `az_subscription class` for possible locations). You can also pass any optional parameters for the resource group as named arguments to `new()`.
36+
#' To create a resource group object in isolation, supply (at least) an Oauth 2.0 token of class [AzureAuth::AzureToken], the subscription ID, and the resource group name. If this object refers to a _new_ resource group, supply the location as well (use the `list_locations` method of the `az_subscription class` for possible locations). You can also pass any optional parameters for the resource group as named arguments to `new()`.
3737
#'
3838
#' @section Templates:
3939
#' To deploy a new template, pass the following arguments to `deploy_template()`:
@@ -75,8 +75,7 @@
7575
#' @seealso
7676
#' [az_subscription], [az_template], [az_resource],
7777
#' [Azure resource group overview](https://learn.microsoft.com/en-us/azure/azure-resource-manager/resource-group-overview#resource-groups),
78-
#' [Resources API reference](https://learn.microsoft.com/en-us/rest/api/resources/resources),
79-
#' [Template API reference](https://learn.microsoft.com/en-us/rest/api/resources/deployments)
78+
#' [Resources API reference](https://learn.microsoft.com/en-us/rest/api/resources/resources)
8079
#'
8180
#' For role-based access control methods, see [rbac]
8281
#'

R/az_rm.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
#' - `aad_host`: Azure Active Directory host for authentication. Defaults to `https://login.microsoftonline.com/`. Change this if you are using a government or private cloud.
2828
#' - `...`: Further arguments to pass to `get_azure_token`.
2929
#' - `scopes`: The Azure Service Management scopes (permissions) to obtain for this login. Only for `version=2`.
30-
#' - `token`: Optionally, an OAuth 2.0 token, of class [AzureToken]. This allows you to reuse the authentication details for an existing session. If supplied, all other arguments will be ignored.
30+
#' - `token`: Optionally, an OAuth 2.0 token, of class [AzureAuth::AzureToken]. This allows you to reuse the authentication details for an existing session. If supplied, all other arguments will be ignored.
3131
#'
3232
#' @section Operations:
3333
#' The `do_operation()` method allows you to carry out arbitrary operations on the Resource Manager endpoint. It takes the following arguments:

R/az_subscription.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
#' - `get_tags()` Get the tags on this subscription.
3030
#'
3131
#' @section Details:
32-
#' Generally, the easiest way to create a subscription object is via the `get_subscription` or `list_subscriptions` methods of the [az_rm] class. To create a subscription object in isolation, call the `new()` method and supply an Oauth 2.0 token of class [AzureToken], along with the ID of the subscription.
32+
#' Generally, the easiest way to create a subscription object is via the `get_subscription` or `list_subscriptions` methods of the [az_rm] class. To create a subscription object in isolation, call the `new()` method and supply an Oauth 2.0 token of class [AzureAuth::AzureToken], along with the ID of the subscription.
3333
#'
3434
#' @section Operations:
3535
#' The `do_operation()` method allows you to carry out arbitrary operations on the subscription. It takes the following arguments:
@@ -158,7 +158,7 @@ public=list(
158158
else sapply(apis, select_version)
159159
}
160160
},
161-
161+
162162
get_tags=function()
163163
{
164164
if(is.null(self$tags))

R/az_template.R

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,7 @@
3333
#'
3434
#' @seealso
3535
#' [az_resource_group], [az_resource], [build_template_definition], [build_template_parameters]
36-
#' [Template overview](https://learn.microsoft.com/en-us/azure/templates/),
37-
#' [Template API reference](https://learn.microsoft.com/en-us/rest/api/resources/deployments)
36+
#' [Template overview](https://learn.microsoft.com/en-us/azure/templates/)
3837
#'
3938
#' @examples
4039
#' \dontrun{

0 commit comments

Comments
 (0)