az dla job

Command group 'dla' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage Data Lake Analytics jobs.

Commands

Name Description Type Status
az dla job cancel

Cancel a Data Lake Analytics job.

Core Preview
az dla job list

List Data Lake Analytics jobs.

Core Preview
az dla job pipeline

Manage Data Lake Analytics job pipelines.

Core Preview
az dla job pipeline list

List job pipelines in a Data Lake Analytics account.

Core Preview
az dla job pipeline show

Retrieve a job pipeline in a Data Lake Analytics account.

Core Preview
az dla job recurrence

Manage Data Lake Analytics job recurrences.

Core Preview
az dla job recurrence list

List job recurrences in a Data Lake Analytics account.

Core Preview
az dla job recurrence show

Retrieve a job recurrence in a Data Lake Analytics account.

Core Preview
az dla job show

Get information for a Data Lake Analytics job.

Core Preview
az dla job submit

Submit a job to a Data Lake Analytics account.

Core Preview
az dla job wait

Wait for a Data Lake Analytics job to finish.

Core Preview

az dla job cancel

Preview

Command group 'dla' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Cancel a Data Lake Analytics job.

az dla job cancel --job-identity
                  [--account]
                  [--ids]
                  [--subscription]

Required Parameters

--job-identity

JobInfo ID to cancel.

Optional Parameters

--account -n

Name of the Data Lake Analytics account.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az dla job list

Preview

Command group 'dla' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List Data Lake Analytics jobs.

az dla job list [--account]
                [--ids]
                [--name]
                [--pipeline-id]
                [--recurrence-id]
                [--result {Cancelled, Failed, None, Succeeded}]
                [--state {Accepted, Compiling, Ended, New, Paused, Queued, Running, Scheduling, Starting, WaitingForCapacity}]
                [--submitted-after]
                [--submitted-before]
                [--submitter]
                [--subscription]
                [--top]

Optional Parameters

--account -n

Name of the Data Lake Analytics account.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name

A filter which returns jobs only by the specified friendly name.

--pipeline-id

A filter which returns jobs only containing the specified pipeline_id.

--recurrence-id

A filter which returns jobs only containing the specified recurrence_id.

--result

A filter which returns jobs with only the specified result(s).

accepted values: Cancelled, Failed, None, Succeeded
--state

A filter which returns jobs with only the specified state(s).

accepted values: Accepted, Compiling, Ended, New, Paused, Queued, Running, Scheduling, Starting, WaitingForCapacity
--submitted-after

A filter which returns jobs only submitted after the specified time, in ISO-8601 format.

--submitted-before

A filter which returns jobs only submitted before the specified time, in ISO-8601 format.

--submitter

A filter which returns jobs only by the specified submitter.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--top

Maximum number of items to return.

default value: 500
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az dla job show

Preview

Command group 'dla' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get information for a Data Lake Analytics job.

az dla job show --job-identity
                [--account]
                [--ids]
                [--subscription]

Required Parameters

--job-identity

JobInfo ID.

Optional Parameters

--account -n

Name of the Data Lake Analytics account.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az dla job submit

Preview

Command group 'dla' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Submit a job to a Data Lake Analytics account.

az dla job submit --job-name
                  --script
                  [--account]
                  [--compile-mode {Full, Semantic, SingleBox}]
                  [--compile-only]
                  [--degree-of-parallelism]
                  [--ids]
                  [--pipeline-id]
                  [--pipeline-name]
                  [--pipeline-uri]
                  [--priority]
                  [--recurrence-id]
                  [--recurrence-name]
                  [--run-id]
                  [--runtime-version]
                  [--subscription]

Required Parameters

--job-name

Name for the submitted job.

--script

Script to submit. This may be '@{file}' to load from a file.

Optional Parameters

--account -n

Name of the Data Lake Analytics account.

--compile-mode

Indicates the type of compilation to be done on this job. Valid values are: 'Semantic' (Only performs semantic checks and necessary sanity checks), 'Full' (full compilation) and 'SingleBox' (Full compilation performed locally).

accepted values: Full, Semantic, SingleBox
--compile-only

Indicates that the submission should only build the job and not execute if set to true.

default value: False
--degree-of-parallelism

The degree of parallelism for the job.

Higher values equate to more parallelism and will usually yield faster running jobs, at the cost of more AUs.

default value: 1
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--pipeline-id

Job relationship pipeline GUID.

--pipeline-name

Friendly name of the job relationship pipeline.

--pipeline-uri

Unique pipeline URI which links to the originating service for this pipeline.

--priority

The priority of the job.

Lower values increase the priority, with the lowest value being 1. This determines the order jobs are run in.

default value: 1000
--recurrence-id

Recurrence GUID, unique per activity/script, regardless of iteration. Links different occurrences of the same job together.

--recurrence-name

Friendly recurrence nae for the correlation between jobs.

--run-id

GUID of the iteration of this pipeline.

--runtime-version

The runtime version to use.

This parameter is used for explicitly overwriting the default runtime. It should only be done if you know what you are doing.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az dla job wait

Preview

Command group 'dla' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Wait for a Data Lake Analytics job to finish.

This command exits when the job completes.

az dla job wait --job-id
                [--account]
                [--ids]
                [--max-wait-time-sec]
                [--subscription]
                [--wait-interval-sec]

Required Parameters

--job-id

Job ID to poll for completion.

Optional Parameters

--account -n

Name of the Data Lake Analytics account.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--max-wait-time-sec

The maximum amount of time to wait before erroring out. Default value is to never timeout. Any value <= 0 means never timeout.

default value: -1
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--wait-interval-sec

The polling interval between checks for the job status, in seconds.

default value: 5
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.