Submit-AzDataLakeAnalyticsJob

Module:

Az.DataLakeAnalytics Module

Submits a job.

Syntax

SubmitUSqlJobWithScriptPath

Submit-AzDataLakeAnalyticsJob
    [-Account] <String>
    [-Name] <String>
    [-ScriptPath] <String>
    [[-Runtime] <String>]
    [[-CompileMode] <String>]
    [[-AnalyticsUnits] <Int32>]
    [[-Priority] <Int32>]
    [-CompileOnly]
    [-ScriptParameter <IDictionary>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

SubmitUSqlJob

Submit-AzDataLakeAnalyticsJob
    [-Account] <String>
    [-Name] <String>
    [-Script] <String>
    [[-Runtime] <String>]
    [[-CompileMode] <String>]
    [[-AnalyticsUnits] <Int32>]
    [[-Priority] <Int32>]
    [-CompileOnly]
    [-ScriptParameter <IDictionary>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

SubmitUSqlJobWithScriptPathAndRecurrence

Submit-AzDataLakeAnalyticsJob
    [-Account] <String>
    [-Name] <String>
    [-ScriptPath] <String>
    [[-Runtime] <String>]
    [[-CompileMode] <String>]
    [[-AnalyticsUnits] <Int32>]
    [[-Priority] <Int32>]
    -RecurrenceId <Guid>
    [-CompileOnly]
    [-ScriptParameter <IDictionary>]
    [-RecurrenceName <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

SubmitUSqlJobWithRecurrence

Submit-AzDataLakeAnalyticsJob
    [-Account] <String>
    [-Name] <String>
    [-Script] <String>
    [[-Runtime] <String>]
    [[-CompileMode] <String>]
    [[-AnalyticsUnits] <Int32>]
    [[-Priority] <Int32>]
    -RecurrenceId <Guid>
    [-CompileOnly]
    [-ScriptParameter <IDictionary>]
    [-RecurrenceName <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

SubmitUSqlJobWithScriptPathAndPipeline

Submit-AzDataLakeAnalyticsJob
    [-Account] <String>
    [-Name] <String>
    [-ScriptPath] <String>
    [[-Runtime] <String>]
    [[-CompileMode] <String>]
    [[-AnalyticsUnits] <Int32>]
    [[-Priority] <Int32>]
    -RecurrenceId <Guid>
    -PipelineId <Guid>
    [-CompileOnly]
    [-ScriptParameter <IDictionary>]
    [-RecurrenceName <String>]
    [-PipelineName <String>]
    [-PipelineUri <String>]
    [-RunId <Guid>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

SubmitUSqlJobWithPipeline

Submit-AzDataLakeAnalyticsJob
    [-Account] <String>
    [-Name] <String>
    [-Script] <String>
    [[-Runtime] <String>]
    [[-CompileMode] <String>]
    [[-AnalyticsUnits] <Int32>]
    [[-Priority] <Int32>]
    -RecurrenceId <Guid>
    -PipelineId <Guid>
    [-CompileOnly]
    [-ScriptParameter <IDictionary>]
    [-RecurrenceName <String>]
    [-PipelineName <String>]
    [-PipelineUri <String>]
    [-RunId <Guid>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The Submit-AzDataLakeAnalyticsJob cmdlet submits an Azure Data Lake Analytics job.

Examples

Example 1: Submit a job

Submit-AzDataLakeAnalyticsJob -Account "ContosoAdlAccount" -Name "New Job" -ScriptPath $LocalScriptPath -AnalyticsUnits 32

This command submits a Data Lake Analytics job.

Example 2: Submit a job with script parameters

$parameters = [ordered]@{}
$parameters["Department"] = "Sales"
$parameters["NumRecords"] = 1000
$parameters["StartDateTime"] = (Get-Date).AddDays(-14)
Submit-AzDataLakeAnalyticsJob -Account "ContosoAdlAccount" -Name "New Job" -ScriptPath $LocalScriptPath -AnalyticsUnits 32 -ScriptParameter $parameters

U-SQL script parameters are prepended above the main script contents, e.g.: DECLARE @Department string = "Sales"; DECLARE @NumRecords int = 1000; DECLARE @StartDateTime DateTime = new DateTime(2017, 12, 6, 0, 0, 0, 0);

Parameters

-Account

Name of Data Lake Analytics account under which the job will be submitted.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AccountName

Parameter sets

(All)

Position:	0
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-AnalyticsUnits

The analytics units to use for this job. Typically, more analytics units dedicated to a script results in faster script execution time.

Parameter properties

Type:	Int32
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	DegreeOfParallelism

Parameter sets

(All)

Position:	6
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-CompileMode

The type of compilation to be done on this job. Valid values:

• Semantic (Only performs semantic checks and necessary sanity checks)
• Full (Full compilation)
• SingleBox (Full compilation performed locally)

Parameter properties

Type:	String
Default value:	None
Accepted values:	Semantic, Full, SingleBox
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	4
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-CompileOnly

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

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	5
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure

Parameter properties

Type:	IAzureContextContainer
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Name

The friendly name of the job to submit.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	1
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-PipelineId

An ID that indicates the submission of this job is a part of a set of recurring jobs and also associated with a job pipeline.

Parameter properties

Type:	Guid
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SubmitUSqlJobWithScriptPathAndPipeline

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

SubmitUSqlJobWithPipeline

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-PipelineName

An optional friendly name for the pipeline associated with this job.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SubmitUSqlJobWithScriptPathAndPipeline

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

SubmitUSqlJobWithPipeline

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-PipelineUri

An optional uri that links to the originating service associated with this pipeline.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SubmitUSqlJobWithScriptPathAndPipeline

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

SubmitUSqlJobWithPipeline

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-Priority

The priority of the job. If not specified, the priority is 1000. A lower number indicates a higher job priority.

Parameter properties

Type:	Int32
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	7
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-RecurrenceId

An ID that indicates the submission of this job is a part of a set of recurring jobs with the same recurrence ID.

Parameter properties

Type:	Guid
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SubmitUSqlJobWithScriptPathAndRecurrence

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

SubmitUSqlJobWithRecurrence

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

SubmitUSqlJobWithScriptPathAndPipeline

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

SubmitUSqlJobWithPipeline

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-RecurrenceName

An optional friendly name for the recurrence correlation between jobs.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SubmitUSqlJobWithScriptPathAndRecurrence

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

SubmitUSqlJobWithRecurrence

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

SubmitUSqlJobWithScriptPathAndPipeline

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

SubmitUSqlJobWithPipeline

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-RunId

An ID that identifies this specific run iteration of the pipeline.

Parameter properties

Type:	Nullable<T>[Guid]
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SubmitUSqlJobWithScriptPathAndPipeline

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

SubmitUSqlJobWithPipeline

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-Runtime

Optionally set the version of the runtime to use for the job. If left unset, the default runtime is used.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	3
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-Script

Script to execute (written inline).

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SubmitUSqlJob

Position:	2
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	True
Value from remaining arguments:	False

SubmitUSqlJobWithRecurrence

Position:	2
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	True
Value from remaining arguments:	False

SubmitUSqlJobWithPipeline

Position:	2
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	True
Value from remaining arguments:	False

-ScriptParameter

The script parameters for this job, as a dictionary of parameter names (string) to values (any combination of byte, sbyte, int, uint (or uint32), long, ulong (or uint64), float, double, decimal, short (or int16), ushort (or uint16), char, string, DateTime, bool, Guid, or byte[]).

Parameter properties

Type:	IDictionary
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-ScriptPath

Path to the script file to submit.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SubmitUSqlJobWithScriptPath

Position:	2
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

SubmitUSqlJobWithScriptPathAndRecurrence

Position:	2
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

SubmitUSqlJobWithScriptPathAndPipeline

Position:	2
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

String

SwitchParameter

Int32

IDictionary

Guid

Nullable<T>

Outputs

JobInformation

Related Links

• Get-AzDataLakeAnalyticsJob
• Stop-AzDataLakeAnalyticsJob
• Wait-AzDataLakeAnalyticsJob