Get-AzureRmDataLakeAnalyticsJob
Gets a Data Lake Analytics 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
Get-AzureRmDataLakeAnalyticsJob
[-Account] <String>
[[-Name] <String>]
[[-Submitter] <String>]
[[-SubmittedAfter] <DateTimeOffset>]
[[-SubmittedBefore] <DateTimeOffset>]
[[-State] <JobState[]>]
[[-Result] <JobResult[]>]
[-Top <Int32>]
[-PipelineId <Guid>]
[-RecurrenceId <Guid>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzureRmDataLakeAnalyticsJob
[-Account] <String>
[-JobId] <Guid>
[[-Include] <ExtendedJobData>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Description
The Get-AzureRmDataLakeAnalyticsJob 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
PS C:\>Get-AzureRmDataLakeAnalyticsJob -Account "contosoadla" -JobId $JobID01This command gets the job with the specified ID.
Example 2: Get jobs submitted in the past week
PS C:\>Get-AzureRmDataLakeAnalyticsJob -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.
| Type: | String |
| Aliases: | AccountName |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| 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 |
-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
| Type: | Microsoft.Azure.Commands.DataLakeAnalytics.Models.DataLakeAnalyticsEnums+ExtendedJobData |
| Accepted values: | None, All, DebugInfo, Statistics |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-JobId
Specifies the ID of the job to get.
| Type: | Guid |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
Specifies a name to use to filter the job list results. The acceptable values for this parameter are:
- None
- DebugInfo
- Statistics
- All
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PipelineId
An optional ID that indicates only jobs part of the specified pipeline should be returned.
| Type: | Nullable<T>[Guid] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-RecurrenceId
An optional ID that indicates only jobs part of the specified recurrence should be returned.
| Type: | Nullable<T>[Guid] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Result
Specifies a result filter for the job results. The acceptable values for this parameter are:
- None
- Cancelled
- Failed
- Succeeded
| Type: | JobResult[] |
| Accepted values: | None, Succeeded, Cancelled, Failed |
| Position: | 6 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | 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
| Type: | JobState[] |
| Accepted values: | Accepted, Compiling, Ended, New, Queued, Running, Scheduling, Starting, Paused, WaitingForCapacity |
| Position: | 5 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SubmittedAfter
Specifies a date filter. Use this parameter to filter the job list result to jobs submitted after the specified date.
| Type: | Nullable<T>[DateTimeOffset] |
| Position: | 3 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SubmittedBefore
Specifies a date filter. Use this parameter to filter the job list result to jobs submitted before the specified date.
| Type: | Nullable<T>[DateTimeOffset] |
| Position: | 4 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | 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.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Top
An optional value which indicates the number of jobs to return. Default value is 500
| Type: | Nullable<T>[Int32] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Inputs
Microsoft.Azure.Commands.DataLakeAnalytics.Models.DataLakeAnalyticsEnums+ExtendedJobData
Nullable<T>[[System.DateTimeOffset, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
JobState[]
Nullable<T>[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
Nullable<T>[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]