Skip to contents

Discover Microsoft Fabric workspaces

Source: R/fabric_discovery.R
fabric_workspaces.Rd

Returns the Fabric workspaces available to the signed-in user or application Use the result to choose a workspace for fabric_items() or one of the typed discovery helpers

Usage

fabric_workspaces(
  roles = NULL,
  prefer_workspace_endpoints = FALSE,
  tenant_id = Sys.getenv("FABRICQUERYR_TENANT_ID"),
  client_id = Sys.getenv("FABRICQUERYR_CLIENT_ID", unset =
    "04b07795-8ddb-461a-bbee-02f9e1bf7b46"),
  token = NULL,
  auth_args = list(),
  api_base = .fabric_api_base,
  output = c("r6", "list")
)

Arguments

roles

Optional workspace roles to include, such as "Viewer", "Contributor", "Member", or "Admin". Leave NULL to return every visible workspace

prefer_workspace_endpoints

Whether to request workspace-specific API and OneLake endpoints. When TRUE, each listed workspace is hydrated with Get Workspace because List Workspaces returns only the API endpoint. Keep FALSE unless your organization uses workspace-level private links

tenant_id

Microsoft Entra tenant ID. Defaults to FABRICQUERYR_TENANT_ID

client_id

Microsoft Entra application/client ID. Defaults to FABRICQUERYR_CLIENT_ID, then the Azure CLI application ID

token

Optional access token or token-provider function. Leave NULL to let 'fabricQueryR' use its normal sign-in flow

auth_args

Additional sign-in options passed to AzureAuth::get_azure_token()

api_base

Fabric REST API base URL. Leave unchanged unless using a different Fabric cloud or a test service

output

Discovery record representation. The default "r6" returns R6 objects with type-specific methods. Use "list" when a plain record is specifically required

Value

A list with one workspace object per visible workspace. With output = "r6", each object is a FabricWorkspace. With output = "list", each object is a fabric_workspace list. Both representations preserve all fields returned by Fabric

Details

The caller needs permission to read Fabric workspaces. Discovery uses the Fabric API and requires Workspace.Read.All or Workspace.ReadWrite.All

References

List workspaces REST API

Get workspace REST API

Workspace roles

Examples

if (FALSE) { # \dontrun{
# Sign in and list every Fabric workspace you can access
workspaces <- fabric_workspaces()

# Inspect a field before choosing a workspace
vapply(workspaces, `[[`, character(1), "displayName")
workspace <- workspaces[[1L]]
workspace$displayName

# Object methods call the corresponding exported functions
# workspace$items() -> fabric_items(workspace)
items <- workspace$items()
# workspace$lakehouses() -> fabric_lakehouses(workspace)
lakehouse <- workspace$lakehouses()[[1L]]
# lakehouse$tables() -> fabric_lakehouse_tables(lakehouse)
lakehouse$tables()
} # }