utils: Miscellaneous utility functions

Description Usage Arguments Details Value

Description

Miscellaneous utility functions

Usage

1
2
3
4
5
6
7
named_list(lst = NULL, name_fields = "name")

is_url(x, https_only = FALSE)

is_empty(x)

get_paged_list(lst, token, next_link_name = "nextLink", value_name = "value")

Arguments

lst

A named list of objects.

name_fields

The components of the objects in lst, to be used as names.

x

For is_url and is_empty, An R object.

https_only

For is_url, whether to allow only HTTPS URLs.

token

For get_paged_list, an Azure OAuth token, of class AzureToken.

next_link_name, value_name

For get_paged_list, the names of the next link and value components in the lst argument. The default values are correct for Resource Manager.

Details

named_list extracts from each object in lst, the components named by name_fields. It then constructs names for lst from these components, separated by a "/".

get_paged_list reconstructs a complete list of objects from a paged response. Many Resource Manager list operations will return paged output, that is, the response contains a subset of all items, along with a URL to query to retrieve the next subset. get_paged_list retrieves each subset and returns all items in a single list.

Value

For named_list, the list that was passed in but with names. An empty input results in a named list output: a list of length 0, with a names attribute.

For get_paged_list, a list.

For is_url, whether the object appears to be a URL (is character of length 1, and starts with the string "http"). Optionally, restricts the check to HTTPS URLs only. For is_empty, whether the length of the object is zero (this includes the special case of NULL).


Hong-Revo/AzureSMRbase documentation built on Aug. 1, 2020, 7:32 p.m.