Items - Update Apache Airflow Job Definition

Service:

ApacheAirflowJob

API Version:

v1

Overrides the definition for the specified Apache Airflow job.
This API supports long running operations (LRO).

Updating the 's definition, does not affect its sensitivity label.

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

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

With optional parameters:

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/ApacheAirflowJobs/{ApacheAirflowJobId}/updateDefinition?updateMetadata={updateMetadata}

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.
updateMetadata	query		boolean	When set to true and the .platform file is provided as part of the definition, the item's metadata is updated using the metadata in the .platform file

Request Body

Name	Required	Type	Description
definition	True	ApacheAirflowJobDefinition	Apache Airflow job public definition object.

Responses

Name	Type	Description
200 OK		Request completed successfully.
202 Accepted		Request accepted. Update definition is in progress. Headers Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Common error codes: OperationNotSupportedForItem - Operation not supported for requested item. CorruptedPayload - The provided payload is corrupted.

Examples

Update an Apache Airflow job public definition example

Sample request

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/ApacheAirflowJobs/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True

{
  "definition": {
    "parts": [
      {
        "path": "ApacheAirflowJobV1.json",
        "payload": "ewogICJwcm9wZXJ0aWVzIjogewogICAgInR5cGUiOiAiQXBhY2hlQWlyZmxvd0pvYiIsCiAgICAidHlwZVByb3BlcnRpZXMiOiB7CiAgICAgICJhaXJmbG93UHJvcGVydGllcyI6IHsKICAgICAgICAiYWlyZmxvd1ZlcnNpb24iOiAiMi42LjMiLAogICAgICAgICJweXRob25WZXJzaW9uIjogIjMuOCIsCiAgICAgICAgImVudmlyb25tZW50VmFyaWFibGVzIjoge30sCiAgICAgICAgImFpcmZsb3dDb25maWd1cmF0aW9uT3ZlcnJpZGVzIjoge30sCiAgICAgICAgImFpcmZsb3dSZXF1aXJlbWVudHMiOiBbCiAgICAgICAgICAiZmxhc2stYmNyeXB0PT0wLjcuMSIKICAgICAgICBdLAogICAgICAgICJwYWNrYWdlUHJvdmlkZXJQYXRoIjogInBsdWdpbnMiLAogICAgICAgICJlbmFibGVBQURJbnRlZ3JhdGlvbiI6IHRydWUsCiAgICAgICAgImVuYWJsZVRyaWdnZXJlcnMiOiBmYWxzZSwKICAgICAgICAic2VjcmV0cyI6IFtdCiAgICAgIH0sCiAgICAgICJjb21wdXRlUHJvcGVydGllcyI6IHsKICAgICAgICAiY29tcHV0ZVBvb2wiOiAiU3RhcnRlclBvb2wiLAogICAgICAgICJsb2NhdGlvbiI6ICJDZW50cmFsIFVTIiwKICAgICAgICAiY29tcHV0ZVNpemUiOiAiU21hbGwiLAogICAgICAgICJleHRyYU5vZGVzIjogMCwKICAgICAgICAiZW5hYmxlQXZhaWxhYmlsaXR5Wm9uZXMiOiBmYWxzZSwKICAgICAgICAiZW5hYmxlQXV0b3NjYWxlIjogZmFsc2UKICAgICAgfQogICAgfQogIH0KfQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Sample response

Status code:

200

Status code:

202

Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
Retry-After: 30

Definitions

Name	Description
ApacheAirflowJobDefinition	Apache Airflow job public definition object.
ApacheAirflowJobDefinitionPart	Apache Airflow job public definition part object.
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.
PayloadType	The type of the definition part payload. Additional payload types may be added over time.
UpdateApacheAirflowJobDefinitionRequest	Update public definition request payload.

ApacheAirflowJobDefinition

Object

Apache Airflow job public definition object.

Name	Type	Description
parts	ApacheAirflowJobDefinitionPart[]	A list of definition parts.

ApacheAirflowJobDefinitionPart

Object

Apache Airflow job public definition part object.

Name	Type	Description
path	string	The public definition part path.
payload	string	The public definition part payload.
payloadType	PayloadType	The payload type.

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.

PayloadType

Enumeration

The type of the definition part payload. Additional payload types may be added over time.

Value	Description
InlineBase64	Inline Base 64.

UpdateApacheAirflowJobDefinitionRequest

Object

Update public definition request payload.

Name	Type	Description
definition	ApacheAirflowJobDefinition	Apache Airflow job public definition object.