Submit-AzureRmDataLakeAnalyticsJob

Module:

AzureRM.DataLakeAnalytics

Submits a job.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

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

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

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

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

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

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

Description

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

Examples

Example 1: Submit a job

PS C:\>Submit-AzureRmDataLakeAnalyticsJob -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

PS C:\>$parameters = [ordered]@{}
$parameters["Department"] = "Sales"
$parameters["NumRecords"] = 1000
$parameters["StartDateTime"] = (Get-Date).AddDays(-14)
Submit-AzureRmDataLakeAnalyticsJob -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.

Type:	String
Aliases:	AccountName
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-AnalyticsUnits

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

Type:	Int32
Aliases:	DegreeOfParallelism
Position:	6
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	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)

Type:	String
Accepted values:	Semantic, Full, SingleBox
Position:	4
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-CompileOnly

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

Type:	SwitchParameter
Position:	5
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-DefaultProfile

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

Type:	IAzureContextContainer
Aliases:	AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

The friendly name of the job to submit.

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	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.

Type:	Guid
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-PipelineName

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

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-PipelineUri

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

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Priority

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

Type:	Int32
Position:	7
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	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.

Type:	Guid
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-RecurrenceName

An optional friendly name for the recurrence correlation between jobs.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-RunId

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

Type:	Nullable<T>[Guid]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Runtime

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

Type:	String
Position:	3
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Script

Script to execute (written inline).

Type:	String
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	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[]).

Type:	IDictionary
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-ScriptPath

Path to the script file to submit.

Type:	String
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

Inputs

String

SwitchParameter

Int32

IDictionary

Guid

Nullable<T>[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]

Outputs

JobInformation

Related Links

• Get-AzureRmDataLakeAnalyticsJob
• Stop-AzureRmDataLakeAnalyticsJob
• Wait-AzureRmDataLakeAnalyticsJob