APIHub
Back to Explore

DataLakeAnalyticsJobManagementClient

Creates an Azure Data Lake Analytics job client.

Cloud
none
HTTPS
CORS: Unknown
Visit official documentation

Latency

3006ms p95

Uptime

0.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
POST

/jobs/{jobIdentity}/CancelJob

Cancels the running job specified by the job ID.

  • jobIdentity (path, required) — Job identifier. Uniquely identifies the job across all jobs submitted to the service.
  • api-version (query, required) — Client Api Version.
GET

/jobs/{jobIdentity}/GetDebugDataPath

Gets the job debug data information specified by the job ID.

  • jobIdentity (path, required) — Job identifier. Uniquely identifies the job across all jobs submitted to the service.
  • api-version (query, required) — Client Api Version.
GET

/jobs/{jobIdentity}/GetStatistics

Gets statistics of the specified job.

  • jobIdentity (path, required) — Job Information ID.
  • api-version (query, required) — Client Api Version.
POST

/jobs/{jobIdentity}/YieldJob

Pauses the specified job and places it back in the job queue, behind other jobs of equal or higher importance, based on priority. (Only for use internally with Scope job type.)

  • jobIdentity (path, required) — Job identifier. Uniquely identifies the job across all jobs submitted to the service.
  • api-version (query, required) — Client Api Version.
GET

/pipelines

Lists all pipelines.

  • startDateTime (query) — The start date for when to get the list of pipelines. The startDateTime and endDateTime can be no more than 30 days apart.
  • endDateTime (query) — The end date for when to get the list of pipelines. The startDateTime and endDateTime can be no more than 30 days apart.
  • api-version (query, required) — Client Api Version.
GET

/pipelines/{pipelineIdentity}

Gets the Pipeline information for the specified pipeline ID.

  • pipelineIdentity (path, required) — Pipeline ID.
  • startDateTime (query) — The start date for when to get the pipeline and aggregate its data. The startDateTime and endDateTime can be no more than 30 days apart.
  • endDateTime (query) — The end date for when to get the pipeline and aggregate its data. The startDateTime and endDateTime can be no more than 30 days apart.
  • api-version (query, required) — Client Api Version.
POST

/buildJob

Builds (compiles) the specified job in the specified Data Lake Analytics account for job correctness and validation.

  • api-version (query, required) — Client Api Version.
GET

/jobs

Lists the jobs, if any, associated with the specified Data Lake Analytics account. The response includes a link to the next page of results, if any.

  • $filter (query) — OData filter. Optional.
  • $top (query, limit) — The number of items to return. Optional.
  • $skip (query, offset) — The number of items to skip over before returning elements. Optional.
  • $select (query) — OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
  • $orderby (query) — OrderBy clause. One or more comma-separated expressions with an optional "asc" (the default) or "desc" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional.
  • $count (query, limit) — The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional.
  • api-version (query, required) — Client Api Version.
GET

/jobs/{jobIdentity}

Gets the job information for the specified job ID.

  • jobIdentity (path, required) — JobInfo ID.
  • api-version (query, required) — Client Api Version.
PATCH

/jobs/{jobIdentity}

Updates the job information for the specified job ID. (Only for use internally with Scope job type.)

  • jobIdentity (path, required) — Job identifier. Uniquely identifies the job across all jobs submitted to the service.
  • api-version (query, required) — Client Api Version.
PUT

/jobs/{jobIdentity}

Submits a job to the specified Data Lake Analytics account.

  • jobIdentity (path, required) — Job identifier. Uniquely identifies the job across all jobs submitted to the service.
  • api-version (query, required) — Client Api Version.
GET

/recurrences

Lists all recurrences.

  • startDateTime (query) — The start date for when to get the list of recurrences. The startDateTime and endDateTime can be no more than 30 days apart.
  • endDateTime (query) — The end date for when to get the list of recurrences. The startDateTime and endDateTime can be no more than 30 days apart.
  • api-version (query, required) — Client Api Version.
GET

/recurrences/{recurrenceIdentity}

Gets the recurrence information for the specified recurrence ID.

  • recurrenceIdentity (path, required) — Recurrence ID.
  • startDateTime (query) — The start date for when to get the recurrence and aggregate its data. The startDateTime and endDateTime can be no more than 30 days apart.
  • endDateTime (query) — The end date for when to get recurrence and aggregate its data. The startDateTime and endDateTime can be no more than 30 days apart.
  • api-version (query, required) — Client Api Version.

13 endpoints auto-detected

curl -X POST \
  "https://azure.local/jobs/{jobIdentity}/CancelJob"

azure.local · HTTPS only