Skip to content

Latest commit

 

History

History
313 lines (243 loc) · 7.74 KB

Get-AzDataLakeAnalyticsJob.md

File metadata and controls

313 lines (243 loc) · 7.74 KB
external help file Module Name ms.assetid online version schema
Microsoft.Azure.PowerShell.Cmdlets.DataLakeAnalytics.dll-Help.xml
Az.DataLakeAnalytics
A0293D80-5935-4D2C-AF11-2837FEC95760
2.0.0

Get-AzDataLakeAnalyticsJob

SYNOPSIS

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.

Type: System.String
Parameter Sets: (All)
Aliases: AccountName

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-DefaultProfile

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

Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzContext, AzureRmContext, AzureCredential

Required: False
Position: Named
Default value: None
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
Parameter Sets: GetBySpecificJobInformation
Aliases:
Accepted values: None, All, DebugInfo, Statistics

Required: False
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-JobId

Specifies the ID of the job to get.

Type: System.Guid
Parameter Sets: GetBySpecificJobInformation
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
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: System.String
Parameter Sets: GetAllInResourceGroupAndAccount
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-PipelineId

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

Type: System.Nullable`1[System.Guid]
Parameter Sets: GetAllInResourceGroupAndAccount
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-RecurrenceId

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

Type: System.Nullable`1[System.Guid]
Parameter Sets: GetAllInResourceGroupAndAccount
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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: Microsoft.Azure.Management.DataLake.Analytics.Models.JobResult[]
Parameter Sets: GetAllInResourceGroupAndAccount
Aliases:
Accepted values: None, Succeeded, Cancelled, Failed

Required: False
Position: 6
Default value: None
Accept pipeline input: True (ByPropertyName)
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: Microsoft.Azure.Management.DataLake.Analytics.Models.JobState[]
Parameter Sets: GetAllInResourceGroupAndAccount
Aliases:
Accepted values: Accepted, Compiling, Ended, New, Queued, Running, Scheduling, Starting, Paused, WaitingForCapacity

Required: False
Position: 5
Default value: None
Accept pipeline input: True (ByPropertyName)
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: System.Nullable`1[System.DateTimeOffset]
Parameter Sets: GetAllInResourceGroupAndAccount
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: True (ByPropertyName)
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: System.Nullable`1[System.DateTimeOffset]
Parameter Sets: GetAllInResourceGroupAndAccount
Aliases:

Required: False
Position: 4
Default value: None
Accept pipeline input: True (ByPropertyName)
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: System.String
Parameter Sets: GetAllInResourceGroupAndAccount
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Top

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

Type: System.Nullable`1[System.Int32]
Parameter Sets: GetAllInResourceGroupAndAccount
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

System.String

System.Guid

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

System.Nullable`1[[System.DateTimeOffset, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

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

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

System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

System.Nullable`1[[System.Guid, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

OUTPUTS

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

NOTES

RELATED LINKS

Stop-AzDataLakeAnalyticsJob

Submit-AzDataLakeAnalyticsJob

Wait-AzDataLakeAnalyticsJob