Skip to main content

easyfabric.fabric.rest_api

REST API utilities for interacting with Microsoft Fabric APIs.

requests​

MSG_REST_ACCESS_TOKEN_MISSING​

MSG_REST_CONFIG_AUTOHINT_FAIL​

MSG_REST_KV_SECRET_FAIL​

MSG_REST_NOTEBOOK_TOKEN_FAIL​

MSG_REST_PRINCIPAL_TOKEN_FAIL​

MSG_REST_SQL_ENDPOINT_NOT_FOUND​

MSG_REST_SQL_REFRESH_SKIP​

MSG_REST_SQL_REFRESH_TRIGGERED​

MSG_REST_WORKSPACE_ID_MISSING​

ConfigManager​

initialize_config​

refresh_sql_endpoint_metadata​

def refresh_sql_endpoint_metadata(lakehouse_name: str,
                                  workspace_id: str = None,
                                  access_token: str = None,
                                  config_manager: ConfigManager = None,
                                  timeout_minutes: int = 15,
                                  interactive_only: bool = False) -> dict

Refreshes the SQL Endpoint metadata for a given lakehouse.

Arguments:

  • lakehouse_name str - Name of the lakehouse (display name).
  • workspace_id str, optional - Workspace ID. If not provided, it will be retrieved from spark.conf or notebook context.
  • access_token str, optional - Bearer token. If not provided, it will be retrieved using notebookutils or Service Principal from config_manager.
  • config_manager ConfigManager, optional - Configuration manager used to retrieve app credentials if access_token is not provided.
  • timeout_minutes int, optional - Timeout for the refresh in minutes. Defaults to 15.
  • interactive_only bool, optional - If True, only runs the refresh if the notebook is running in interactive mode. Defaults to False.

Returns:

  • dict - The API response from the refresh request, or a skip message.

Raises:

  • ValueError - If workspace_id, access_token or credentials cannot be determined.
  • requests.exceptions.HTTPError - If the API request fails.