Edit

Share via

Background Jobs - Run On Demand Refresh Materialized Lake Views

Service:
Lakehouse
API Version:
v1

Run on-demand Refresh MaterializedLakeViews job instance.

Note

This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.

Required Delegated Scopes

Lakehouse.Execute.All or Item.Execute.All

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity Support
User Yes
Service principal and Managed identities No

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/lakehouses/{lakehouseId}/jobs/instances?jobType={jobType}

URI Parameters

Name In Required Type Description
lakehouseId
 path True

string (uuid)

The lakehouse ID.
workspaceId
 path True

string (uuid)

The workspace ID.
jobType
 query True

string

RefreshMaterializedLakeViews job type.

Responses

Name Type Description
202 Accepted

Request accepted, job execution is in progress.

Headers

  • Location: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Common error codes:

  • MissingMinimalPermisisons - The caller does not have sufficient permissions to run job instance. n

  • InvalidJobType - The requested job type is invalid.

  • TooManyRequestsForJobs - The caller is making to many run on-demand job requests.

  • ItemNotFound - Requested item id not found.

Examples

Run RefreshMaterializedLakeViews with no request body.

Sample request

POST https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/lakehouses/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/jobs/instances?jobType=RefreshMaterializedLakeViews

Sample response

Status code:
202 
Location: https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/jobs/instances/f2d65699-dd22-4889-980c-15226deb0e1b
Retry-After: 60

Definitions

Name Description
ErrorRelatedResource

The error related resource details object.
ErrorResponse

The error response.
ErrorResponseDetails

The error response details.

ErrorRelatedResource

Object

The error related resource details object.

Name Type Description
resourceId

string

The resource ID that's involved in the error.
resourceType

string

The type of the resource that's involved in the error.

ErrorResponse

Object

The error response.

Name Type Description
errorCode

string

A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message

string

A human readable representation of the error.
moreDetails

ErrorResponseDetails[]

List of additional error details.
relatedResource

ErrorRelatedResource

The error related resource details.
requestId

string

ID of the request associated with the error.

ErrorResponseDetails

Object

The error response details.

Name Type Description
errorCode

string

A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message

string

A human readable representation of the error.
relatedResource

ErrorRelatedResource

The error related resource details.