Edit

Share via

Get-AzDataLakeAnalyticsJob

Module:
Az.DataLakeAnalytics Module

Gets a Data Lake Analytics job.

Syntax

GetAllInResourceGroupAndAccount (Default) 

Get-AzDataLakeAnalyticsJob
    [-Account] <String>
    [[-Name] <String>]
    [[-Submitter] <String>]
    [[-SubmittedAfter] <DateTimeOffset>]
    [[-SubmittedBefore] <DateTimeOffset>]
    [[-State] <JobState[]>]
    [[-Result] <JobResult[]>]
    [-Top <Int32>]
    [-PipelineId <Guid>]
    [-RecurrenceId <Guid>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

GetBySpecificJobInformation 

Get-AzDataLakeAnalyticsJob
    [-Account] <String>
    [-JobId] <Guid>
    [[-Include] <ExtendedJobData>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The Get-AzDataLakeAnalyticsJob cmdlet gets an Azure Data Lake Analytics job. If you do not specify a job, this cmdlet gets all jobs.

Examples

Example 1: Get a specified job

Get-AzDataLakeAnalyticsJob -Account "contosoadla" -JobId $JobID01

This command gets the job with the specified ID.

Example 2: Get jobs submitted in the past week

Get-AzDataLakeAnalyticsJob -Account "contosoadla" -SubmittedAfter (Get-Date).AddDays(-7)

This command gets jobs submitted in the past week.

Parameters

-Account

Specifies the name of a Data Lake Analytics account.

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

-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

-Include

Specifies options that indicate the type of additional information to retrieve about the job. The acceptable values for this parameter are:

  • None
  • DebugInfo
  • Statistics
  • All

Parameter properties

Type:Microsoft.Azure.Commands.DataLakeAnalytics.Models.DataLakeAnalyticsEnums+ExtendedJobData
Default value:None
Accepted values:None, All, DebugInfo, Statistics
Supports wildcards:False
DontShow:False

Parameter sets

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

-JobId

Specifies the ID of the job to get.

Parameter properties

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

Parameter sets

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

-Name

Specifies a name to use to filter the job list results. The acceptable values for this parameter are:

  • None
  • DebugInfo
  • Statistics
  • All

Parameter properties

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

Parameter sets

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

-PipelineId

An optional ID that indicates only jobs part of the specified pipeline should be returned.

Parameter properties

Type:

Nullable<T>[Guid]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

-RecurrenceId

An optional ID that indicates only jobs part of the specified recurrence should be returned.

Parameter properties

Type:

Nullable<T>[Guid]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

-Result

Specifies a result filter for the job results. The acceptable values for this parameter are:

  • None
  • Cancelled
  • Failed
  • Succeeded

Parameter properties

Type:

Microsoft.Azure.Management.DataLake.Analytics.Models.JobResult[]

Default value:None
Accepted values:None, Succeeded, Cancelled, Failed
Supports wildcards:False
DontShow:False

Parameter sets

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

-State

Specifies a state filter for the job results. The acceptable values for this parameter are:

  • Accepted
  • New
  • Compiling
  • Scheduling
  • Queued
  • Starting
  • Paused
  • Running
  • Ended

Parameter properties

Type:

Microsoft.Azure.Management.DataLake.Analytics.Models.JobState[]

Default value:None
Accepted values:Accepted, Compiling, Ended, New, Queued, Running, Scheduling, Starting, Paused, WaitingForCapacity
Supports wildcards:False
DontShow:False

Parameter sets

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

-SubmittedAfter

Specifies a date filter. Use this parameter to filter the job list result to jobs submitted after the specified date.

Parameter properties

Type:

Nullable<T>[DateTimeOffset]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

-SubmittedBefore

Specifies a date filter. Use this parameter to filter the job list result to jobs submitted before the specified date.

Parameter properties

Type:

Nullable<T>[DateTimeOffset]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

-Submitter

Specifies the email address of a user. Use this parameter to filter the job list results to jobs submitted by a specified user.

Parameter properties

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

Parameter sets

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

-Top

An optional value which indicates the number of jobs to return. Default value is 500

Parameter properties

Type:

Nullable<T>[Int32]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GetAllInResourceGroupAndAccount
Position:Named
Mandatory:False
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

Guid

Microsoft.Azure.Commands.DataLakeAnalytics.Models.DataLakeAnalyticsEnums+ExtendedJobData

Nullable<T>

Microsoft.Azure.Management.DataLake.Analytics.Models.JobState

Microsoft.Azure.Management.DataLake.Analytics.Models.JobResult

Nullable<T>

Nullable<T>

Outputs

Microsoft.Azure.Management.DataLake.Analytics.Models.JobInformation