Items - Update Apache Airflow Job

Service:

ApacheAirflowJob

API Version:

v1

Updates the properties of the specified Apache Airflow job.

Permissions

The caller must have read and write permissions for the apache airflow job.

Required Delegated Scopes

ApacheAirflowJob.ReadWrite.All or Item.ReadWrite.All

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity	Support
User	Yes
Service principal and Managed identities	Yes

Interface

PATCH https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/ApacheAirflowJobs/{ApacheAirflowJobId}

URI Parameters

Name	In	Required	Type	Description
ApacheAirflowJobId	path	True	string (uuid)	The Apache Airflow job ID.
workspaceId	path	True	string (uuid)	The workspace ID.

Request Body

Name	Type	Description
description	string	The Apache Airflow job description. Maximum length is 256 characters.
displayName	string	The Apache Airflow job display name. The display name must follow naming rules according to item type.

Responses

Name	Type	Description
200 OK	ApacheAirflowJob	Request completed successfully.
Other Status Codes	ErrorResponse	Common error codes: ItemNotFound - The requested item was not found. InvalidRequest - Invalid update request.

Examples

Update an Apache Airflow job example

Sample request

HTTP

PATCH https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/ApacheAirflowJobs/5b218778-e7a5-4d73-8187-f10824047715

{
  "description": "Apache Airflow job's New description"
}

Sample response

Status code:

200

{
  "description": "Apache Airflow job's New description",
  "displayName": "ApacheAirflowJob1",
  "type": "ApacheAirflowJob",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Definitions

Name	Description
ApacheAirflowJob	An Apache Airflow job object.
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.
ItemTag	Represents a tag applied on an item.
ItemType	The type of the item. Additional item types may be added over time.
UpdateApacheAirflowJobRequest	Update Apache Airflow job request.

ApacheAirflowJob

Object

An Apache Airflow job object.

Name	Type	Description
description	string	The item description.
displayName	string	The item display name.
folderId	string (uuid)	The folder ID.
id	string (uuid)	The item ID.
tags	ItemTag[]	List of applied tags.
type	ItemType	The item type.
workspaceId	string (uuid)	The workspace ID.

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.

ItemTag

Object

Represents a tag applied on an item.

Name	Type	Description
displayName	string	The name of the tag.
id	string (uuid)	The tag ID.

ItemType

Enumeration

The type of the item. Additional item types may be added over time.

Value	Description
Dashboard	PowerBI dashboard.
Report	PowerBI report.
SemanticModel	PowerBI semantic model.
PaginatedReport	PowerBI paginated report.
Datamart	PowerBI datamart.
Lakehouse	A lakehouse.
Eventhouse	An eventhouse.
Environment	An environment.
KQLDatabase	A KQL database.
KQLQueryset	A KQL queryset.
KQLDashboard	A KQL dashboard.
DataPipeline	A data pipeline.
Notebook	A notebook.
SparkJobDefinition	A spark job definition.
MLExperiment	A machine learning experiment.
MLModel	A machine learning model.
Warehouse	A warehouse.
Eventstream	An eventstream.
SQLEndpoint	An SQL endpoint.
MirroredWarehouse	A mirrored warehouse.
MirroredDatabase	A mirrored database.
Reflex	A Reflex.
GraphQLApi	An API for GraphQL item.
MountedDataFactory	A MountedDataFactory.
SQLDatabase	A SQLDatabase.
CopyJob	A Copy job.
VariableLibrary	A VariableLibrary.
Dataflow	A Dataflow.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	A Warehouse snapshot.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	A Digital Twin Builder Flow.
MirroredAzureDatabricksCatalog	A mirrored azure databricks catalog.

UpdateApacheAirflowJobRequest

Object

Update Apache Airflow job request.

Name	Type	Description
description	string	The Apache Airflow job description. Maximum length is 256 characters.
displayName	string	The Apache Airflow job display name. The display name must follow naming rules according to item type.