Skip to content

Prints every azr option and invisibly returns a data.frame of the same information. The resolution order is: a value set for the session -> options(azr.*) -> the option's environment variable -> a built-in default.

NameR optionEnv variableDefaultDescription
"chain_verbose"azr.chain_verboseAZR_CHAIN_VERBOSEFALSEVerbose credential-chain discovery
"api_verbose"azr.api_verboseAZR_API_VERBOSEFALSEVerbose api_client request/response
"cli_auto_login"azr.cli_auto_loginAZR_CLI_AUTO_LOGINFALSEAuto Azure CLI login
"dataset_tier"azr.dataset_tierAZR_DATASET_TIER"prod"Default tier for azr_dataset_uri()

Usage

azr_options(mask = TRUE)

Arguments

mask

Logical. When TRUE (default), sensitive option values are shown as "<hidden>" when set.

Value

Invisibly, a data.frame with columns option, value, source, env_var, env_value, and default.

Examples

azr_options()
#> 
#> ── azr options ────────────────────────────────────────────────────────
#> api_verbose = "FALSE" (default)
#>   `AZR_API_VERBOSE`: (not set)
#> chain_verbose = "FALSE" (default)
#>   `AZR_CHAIN_VERBOSE`: (not set)
#> cli_auto_login = "FALSE" (default)
#>   `AZR_CLI_AUTO_LOGIN`: (not set)
#> dataset_tier = "prod" (default)
#>   `AZR_DATASET_TIER`: (not set)

# Set for the session
options(azr.chain_verbose = TRUE)

# Or via environment variable (before starting R)
# AZR_CHAIN_VERBOSE=true