Azure Databricks · Example Payload

Microsoft Azure Databricks Createjob Example

AnalyticsApache SparkBig DataData EngineeringMachine Learning

Microsoft Azure Databricks Createjob Example is an example object payload from Azure Databricks, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "createJob",
  "method": "POST",
  "path": "/2.1/jobs/create",
  "summary": "Azure Databricks Create a New Job",
  "requestExamples": [
    {
      "contentType": "application/json",
      "name": "CreatejobRequestExample",
      "example": {
        "name": "Example Title",
        "tags": "example_value",
        "tasks": [
          {
            "task_key": "example_value",
            "description": "A sample description.",
            "depends_on": {},
            "existing_cluster_id": "500123",
            "job_cluster_key": "example_value",
            "notebook_task": {},
            "spark_jar_task": {},
            "spark_python_task": {},
            "spark_submit_task": {},
            "pipeline_task": {},
            "python_wheel_task": {},
            "sql_task": {},
            "dbt_task": {},
            "run_if": "ALL_SUCCESS",
            "timeout_seconds": 10,
            "max_retries": 10,
            "min_retry_interval_millis": 10,
            "retry_on_timeout": true,
            "libraries": {}
          }
        ],
        "job_clusters": [
          {
            "job_cluster_key": "example_value"
          }
        ],
        "email_notifications": {
          "on_start": [
            {}
          ],
          "on_success": [
            {}
          ],
          "on_failure": [
            {}
          ],
          "on_duration_warning_threshold_exceeded": [
            {}
          ],
          "no_alert_for_skipped_runs": true
        },
        "webhook_notifications": {
          "on_start": [
            {}
          ],
          "on_success": [
            {}
          ],
          "on_failure": [
            {}
          ],
          "on_duration_warning_threshold_exceeded": [
            {}
          ]
        },
        "notification_settings": {
          "no_alert_for_skipped_runs": true,
          "no_alert_for_canceled_runs": true
        },
        "timeout_seconds": 10,
        "max_concurrent_runs": 10,
        "schedule": {
          "quartz_cron_expression": "example_value",
          "timezone_id": "500123",
          "pause_status": "PAUSED"
        },
        "trigger": {
          "file_arrival": {
            "url": "https://www.example.com",
            "min_time_between_triggers_seconds": 10,
            "wait_after_last_change_seconds": 10
          }
        },
        "continuous": {
          "pause_status": "PAUSED"
        },
        "git_source": {
          "git_url": "https://www.example.com",
          "git_provider": "gitHub",
          "git_branch": "example_value",
          "git_tag": "example_value",
          "git_commit": "example_value"
        },
        "format": "SINGLE_TASK",
        "queue": {
          "enabled": true
        },
        "parameters": [
          {
            "name": "Example Title",
            "default": "example_value"
          }
        ],
        "run_as": {
          "user_name": "example_value",
          "service_principal_name": "example_value"
        }
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "name": "Createjob200Example",
      "example": {
        "job_id": "500123"
      }
    }
  ]
}