< Back

Submit-AzureRmDataLakeAnalyticsJob

Tue Jan 29, 2019 9:44 pm

NAME Submit-AzureRmDataLakeAnalyticsJob



SYNOPSIS

Submits a job.





SYNTAX

Submit-AzureRmDataLakeAnalyticsJob [-Account] <String> [-Name] <String> [-ScriptPath] <String> [[-Runtime] <String>] [[-CompileMode] {Semantic |

Full | SingleBox}] [[-CompileOnly]] [[-AnalyticsUnits] <Int32>] [[-Priority] <Int32>] [-DefaultProfile <IAzureContextContainer>] -PipelineId

<Guid> [-PipelineName <String>] [-PipelineUri <String>] -RecurrenceId <Guid> [-RecurrenceName <String>] [-RunId <Guid>] [-ScriptParameter

<IDictionary>] [<CommonParameters>]



Submit-AzureRmDataLakeAnalyticsJob [-Account] <String> [-Name] <String> [-Script] <String> [[-Runtime] <String>] [[-CompileMode] {Semantic | Full

| SingleBox}] [[-CompileOnly]] [[-AnalyticsUnits] <Int32>] [[-Priority] <Int32>] [-DefaultProfile <IAzureContextContainer>] -PipelineId <Guid>

[-PipelineName <String>] [-PipelineUri <String>] -RecurrenceId <Guid> [-RecurrenceName <String>] [-RunId <Guid>] [-ScriptParameter <IDictionary>]

[<CommonParameters>]



Submit-AzureRmDataLakeAnalyticsJob [-Account] <String> [-Name] <String> [-ScriptPath] <String> [[-Runtime] <String>] [[-CompileMode] {Semantic |

Full | SingleBox}] [[-CompileOnly]] [[-AnalyticsUnits] <Int32>] [[-Priority] <Int32>] [-DefaultProfile <IAzureContextContainer>] -RecurrenceId

<Guid> [-RecurrenceName <String>] [-ScriptParameter <IDictionary>] [<CommonParameters>]



Submit-AzureRmDataLakeAnalyticsJob [-Account] <String> [-Name] <String> [-Script] <String> [[-Runtime] <String>] [[-CompileMode] {Semantic | Full

| SingleBox}] [[-CompileOnly]] [[-AnalyticsUnits] <Int32>] [[-Priority] <Int32>] [-DefaultProfile <IAzureContextContainer>] -RecurrenceId <Guid>

[-RecurrenceName <String>] [-ScriptParameter <IDictionary>] [<CommonParameters>]



Submit-AzureRmDataLakeAnalyticsJob [-Account] <String> [-Name] <String> [-Script] <String> [[-Runtime] <String>] [[-CompileMode] {Semantic | Full

| SingleBox}] [[-CompileOnly]] [[-AnalyticsUnits] <Int32>] [[-Priority] <Int32>] [-DefaultProfile <IAzureContextContainer>] [-ScriptParameter

<IDictionary>] [<CommonParameters>]



Submit-AzureRmDataLakeAnalyticsJob [-Account] <String> [-Name] <String> [-ScriptPath] <String> [[-Runtime] <String>] [[-CompileMode] {Semantic |

Full | SingleBox}] [[-CompileOnly]] [[-AnalyticsUnits] <Int32>] [[-Priority] <Int32>] [-DefaultProfile <IAzureContextContainer>] [-ScriptParameter

<IDictionary>] [<CommonParameters>]





DESCRIPTION

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





PARAMETERS

-Account <String>

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



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-CompileMode <String>

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)



Required? false

Position? 4

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-CompileOnly [<SwitchParameter>]

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



Required? false

Position? 5

Default value False

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-DefaultProfile <IAzureContextContainer>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-AnalyticsUnits <Int32>

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



Required? false

Position? 6

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Name <String>

The friendly name of the job to submit.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-PipelineId <Guid>

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.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-PipelineName <String>

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



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-PipelineUri <String>

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



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Priority <Int32>

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



Required? false

Position? 7

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-RecurrenceId <Guid>

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



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-RecurrenceName <String>

An optional friendly name for the recurrence correlation between jobs.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-RunId <Guid>

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



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Runtime <String>

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



Required? false

Position? 3

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Script <String>

Script to execute (written inline).



Required? true

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName, ByValue)

Accept wildcard characters? false



-ScriptParameter <IDictionary>

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[]).



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ScriptPath <String>

Path to the script file to submit.



Required? true

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

String

Parameter 'Script' accepts value of type 'String' from the pipeline





OUTPUTS

JobInformation

The initial job details for the submitted job.





NOTES









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);







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... alyticsjob

Get-AzureRmDataLakeAnalyticsJob

Stop-AzureRmDataLakeAnalyticsJob

Wait-AzureRmDataLakeAnalyticsJob