apache-airflow-job
Manage Apache Airflow jobs (DAGs, environments, pools)
Authentication scope: fabric
List Apache Airflow jobs in a workspace
fabio apache-airflow-job list --workspace <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
Read-only · Returns list
Show details of an Apache Airflow job
fabio apache-airflow-job show --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Apache Airflow job ID |
Read-only · Returns object
create
Section titled “create”Create a new Apache Airflow job
fabio apache-airflow-job create --workspace <value> --name <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--name |
string |
Yes | Display name |
--description |
string |
No | Optional description |
--sensitivity-label |
string |
No | Sensitivity label ID to apply on creation |
Examples
fabio apache-airflow-job create --workspace $WS --name "DataOrchestrator"Mutates state · Returns object
update
Section titled “update”Update Apache Airflow job properties (name and/or description)
fabio apache-airflow-job update --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Apache Airflow job ID |
--name |
string |
No | New display name |
--description |
string |
No | New description |
Mutates state · Returns object
delete
Section titled “delete”Delete an Apache Airflow job
fabio apache-airflow-job delete --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Apache Airflow job ID |
--hard-delete |
bool |
No | Permanently delete (hard delete) instead of soft delete |
Mutates state · Destructive · Returns void
get-definition
Section titled “get-definition”Get the definition of an Apache Airflow job
fabio apache-airflow-job get-definition --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Apache Airflow job ID |
--decode |
bool |
No | Decode base64 payloads inline (adds decodedPayload field) |
Read-only · Long-running operation · Returns object
update-definition
Section titled “update-definition”Update the definition of an Apache Airflow job
fabio apache-airflow-job update-definition --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Apache Airflow job ID |
--file |
string |
No | Path to definition file |
--content |
string |
No | Inline definition content |
--update-metadata |
bool |
No | Also update item metadata from .platform file if present |
Mutates state · Long-running operation · Returns void
start-environment
Section titled “start-environment”Start the Airflow environment
fabio apache-airflow-job start-environment --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Apache Airflow job ID |
Examples
fabio apache-airflow-job start-environment --workspace $WS --id $AJMutates state · Returns object
stop-environment
Section titled “stop-environment”Stop the Airflow environment
fabio apache-airflow-job stop-environment --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Apache Airflow job ID |
Mutates state · Returns object
get-environment
Section titled “get-environment”Get environment status
fabio apache-airflow-job get-environment --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Apache Airflow job ID |
Examples
fabio apache-airflow-job get-environment --workspace $WS --id $AJRead-only · Returns object
list-libraries
Section titled “list-libraries”List installed libraries in the environment
fabio apache-airflow-job list-libraries --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Apache Airflow job ID |
Read-only · Returns list
deploy-requirements
Section titled “deploy-requirements”Deploy requirements.txt to the environment
fabio apache-airflow-job deploy-requirements --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Apache Airflow job ID |
--file |
string |
No | Path to requirements.txt file |
--content |
string |
No | Inline requirements content |
Examples
fabio apache-airflow-job deploy-requirements --workspace $WS --id $AJ --content "pandas>=2.0\npyarrow>=14.0"Mutates state · Returns object
get-settings
Section titled “get-settings”Get environment settings
fabio apache-airflow-job get-settings --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Apache Airflow job ID |
Read-only · Returns object
update-settings
Section titled “update-settings”Update environment settings
fabio apache-airflow-job update-settings --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Apache Airflow job ID |
--file |
string |
No | Path to settings JSON file |
--content |
string |
No | Inline settings JSON |
Mutates state · Returns void
get-compute
Section titled “get-compute”Get environment compute information
fabio apache-airflow-job get-compute --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Apache Airflow job ID |
Read-only · Returns object
update-compute
Section titled “update-compute”Update the compute configuration for the Airflow job environment (pool template)
fabio apache-airflow-job update-compute --workspace <value> --id <value> --pool-template-id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Apache Airflow job ID |
--pool-template-id |
string |
Yes | Pool template ID to assign to this environment |
Mutates state · Long-running operation · Returns void
list-files
Section titled “list-files”List files (DAGs) in the Airflow job
fabio apache-airflow-job list-files --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Apache Airflow job ID |
Read-only · Returns list
get-file
Section titled “get-file”Get (download) a file from the Airflow job
fabio apache-airflow-job get-file --workspace <value> --id <value> --path <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Apache Airflow job ID |
--path |
string |
Yes | Remote file path |
Read-only · Returns object
upload-file
Section titled “upload-file”Upload a file to the Airflow job
fabio apache-airflow-job upload-file --workspace <value> --id <value> --path <value> --file <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Apache Airflow job ID |
--path |
string |
Yes | Remote file path (destination) |
--file |
string |
Yes | Local file to upload |
Examples
fabio apache-airflow-job upload-file --workspace $WS --id $AJ --path dags/daily_etl.py --source ./dags/daily_etl.pyMutates state · Returns object
delete-file
Section titled “delete-file”Delete a file from the Airflow job
fabio apache-airflow-job delete-file --workspace <value> --id <value> --path <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Apache Airflow job ID |
--path |
string |
Yes | Remote file path |
Mutates state · Destructive · Returns void
get-workspace-settings
Section titled “get-workspace-settings”Get workspace-level Airflow settings
fabio apache-airflow-job get-workspace-settings --workspace <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
Read-only · Returns object
update-workspace-settings
Section titled “update-workspace-settings”Update workspace-level Airflow settings
fabio apache-airflow-job update-workspace-settings --workspace <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--file |
string |
No | Path to settings JSON file |
--content |
string |
No | Inline settings JSON |
Mutates state · Returns void
list-pool-templates
Section titled “list-pool-templates”List pool templates
fabio apache-airflow-job list-pool-templates --workspace <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
Read-only · Returns list
create-pool-template
Section titled “create-pool-template”Create a pool template
fabio apache-airflow-job create-pool-template --workspace <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--name |
string |
No | Pool template name |
--file |
string |
No | Path to pool template JSON file |
--content |
string |
No | Inline pool template JSON |
Mutates state · Returns object
get-pool-template
Section titled “get-pool-template”Get a pool template
fabio apache-airflow-job get-pool-template --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Pool template ID |
Read-only · Returns object
delete-pool-template
Section titled “delete-pool-template”Delete a pool template
fabio apache-airflow-job delete-pool-template --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Pool template ID |
Mutates state · Destructive · Returns void