< Back
Get-AzureRmDataLakeAnalyticsJob
Post
NAME Get-AzureRmDataLakeAnalyticsJob
SYNOPSIS
Gets a Data Lake Analytics job.
SYNTAX
Get-AzureRmDataLakeAnalyticsJob [-Account] <String> [-JobId] <Guid> [[-Include] {None | All | DebugInfo | Statistics}] [-DefaultProfile
<IAzureContextContainer>] [<CommonParameters>]
Get-AzureRmDataLakeAnalyticsJob [-Account] <String> [[-Name] <String>] [[-Submitter] <String>] [[-SubmittedAfter] <DateTimeOffset>]
[[-SubmittedBefore] <DateTimeOffset>] [[-State] {Accepted | Compiling | Ended | New | Queued | Running | Scheduling | Starting | Paused |
WaitingForCapacity}] [[-Result] {None | Succeeded | Cancelled | Failed}] [-DefaultProfile <IAzureContextContainer>] [-PipelineId <Guid>]
[-RecurrenceId <Guid>] [-Top <Int32>] [<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.
PARAMETERS
-Account <String>
Specifies the name of a Data Lake Analytics account.
Required? true
Position? 0
Default value None
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
-Include <ExtendedJobData>
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
Required? false
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-JobId <Guid>
Specifies the ID of the job to get.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-Name <String>
Specifies a name to use to filter the job list results. The acceptable values for this parameter are:
- None
- DebugInfo
- Statistics
- All
Required? false
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PipelineId <Guid>
An optional ID that indicates only jobs part of the specified pipeline should be returned.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-RecurrenceId <Guid>
An optional ID that indicates only jobs part of the specified recurrence should be returned.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Result <JobResult[]>
Specifies a result filter for the job results. The acceptable values for this parameter are:
- None
- Cancelled
- Failed
- Succeeded
Required? false
Position? 6
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-State <JobState[]>
Specifies a state filter for the job results. The acceptable values for this parameter are:
- Accepted
- New
- Compiling
- Scheduling
- Queued
- Starting
- Paused
- Running
- Ended
Required? false
Position? 5
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SubmittedAfter <DateTimeOffset>
Specifies a date filter. Use this parameter to filter the job list result to jobs submitted after the specified date.
Required? false
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SubmittedBefore <DateTimeOffset>
Specifies a date filter. Use this parameter to filter the job list result to jobs submitted before the specified date.
Required? false
Position? 4
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Submitter <String>
Specifies the email address of a user. Use this parameter to filter the job list results to jobs submitted by a specified user.
Required? false
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Top <Int32>
An optional value which indicates the number of jobs to return. Default value is 500
Required? false
Position? named
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
Guid
Parameter 'JobId' accepts value of type 'Guid' from the pipeline
OUTPUTS
JobInformation
The specified job information details
List<PSJobInformationBasic>
The list of jobs in the specified Data Lake Analytics account.
NOTES
Example 1: Get a specified job
PS C:\\>Get-AzureRmDataLakeAnalyticsJob -Account "contosoadla" -JobId $JobID01
This 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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... alyticsjob
Stop-AzureRmDataLakeAnalyticsJob
Submit-AzureRmDataLakeAnalyticsJob
Wait-AzureRmDataLakeAnalyticsJob
SYNOPSIS
Gets a Data Lake Analytics job.
SYNTAX
Get-AzureRmDataLakeAnalyticsJob [-Account] <String> [-JobId] <Guid> [[-Include] {None | All | DebugInfo | Statistics}] [-DefaultProfile
<IAzureContextContainer>] [<CommonParameters>]
Get-AzureRmDataLakeAnalyticsJob [-Account] <String> [[-Name] <String>] [[-Submitter] <String>] [[-SubmittedAfter] <DateTimeOffset>]
[[-SubmittedBefore] <DateTimeOffset>] [[-State] {Accepted | Compiling | Ended | New | Queued | Running | Scheduling | Starting | Paused |
WaitingForCapacity}] [[-Result] {None | Succeeded | Cancelled | Failed}] [-DefaultProfile <IAzureContextContainer>] [-PipelineId <Guid>]
[-RecurrenceId <Guid>] [-Top <Int32>] [<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.
PARAMETERS
-Account <String>
Specifies the name of a Data Lake Analytics account.
Required? true
Position? 0
Default value None
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
-Include <ExtendedJobData>
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
Required? false
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-JobId <Guid>
Specifies the ID of the job to get.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-Name <String>
Specifies a name to use to filter the job list results. The acceptable values for this parameter are:
- None
- DebugInfo
- Statistics
- All
Required? false
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PipelineId <Guid>
An optional ID that indicates only jobs part of the specified pipeline should be returned.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-RecurrenceId <Guid>
An optional ID that indicates only jobs part of the specified recurrence should be returned.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Result <JobResult[]>
Specifies a result filter for the job results. The acceptable values for this parameter are:
- None
- Cancelled
- Failed
- Succeeded
Required? false
Position? 6
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-State <JobState[]>
Specifies a state filter for the job results. The acceptable values for this parameter are:
- Accepted
- New
- Compiling
- Scheduling
- Queued
- Starting
- Paused
- Running
- Ended
Required? false
Position? 5
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SubmittedAfter <DateTimeOffset>
Specifies a date filter. Use this parameter to filter the job list result to jobs submitted after the specified date.
Required? false
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SubmittedBefore <DateTimeOffset>
Specifies a date filter. Use this parameter to filter the job list result to jobs submitted before the specified date.
Required? false
Position? 4
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Submitter <String>
Specifies the email address of a user. Use this parameter to filter the job list results to jobs submitted by a specified user.
Required? false
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Top <Int32>
An optional value which indicates the number of jobs to return. Default value is 500
Required? false
Position? named
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
Guid
Parameter 'JobId' accepts value of type 'Guid' from the pipeline
OUTPUTS
JobInformation
The specified job information details
List<PSJobInformationBasic>
The list of jobs in the specified Data Lake Analytics account.
NOTES
Example 1: Get a specified job
PS C:\\>Get-AzureRmDataLakeAnalyticsJob -Account "contosoadla" -JobId $JobID01
This 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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... alyticsjob
Stop-AzureRmDataLakeAnalyticsJob
Submit-AzureRmDataLakeAnalyticsJob
Wait-AzureRmDataLakeAnalyticsJob