Edit

Share via

Get-AzDataFactoryActivityWindow

  • Reference
Module:
Az.DataFactory

Gets information about activity windows associated with a data factory.

Syntax

PowerShell 
Get-AzDataFactoryActivityWindow
   [-DataFactoryName] <String>
   [[-DatasetName] <String>]
   [[-PipelineName] <String>]
   [[-ActivityName] <String>]
   [-WindowState <String>]
   [-WindowSubstate <String>]
   [-Filter <String>]
   [-OrderBy <String>]
   [-WindowStart <DateTime>]
   [-WindowEnd <DateTime>]
   [-RunStart <DateTime>]
   [-RunEnd <DateTime>]
   [-Top <Int32>]
   [-ResourceGroupName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
PowerShell 
Get-AzDataFactoryActivityWindow
   [-DataFactory] <PSDataFactory>
   [[-DatasetName] <String>]
   [[-PipelineName] <String>]
   [[-ActivityName] <String>]
   [-WindowState <String>]
   [-WindowSubstate <String>]
   [-Filter <String>]
   [-OrderBy <String>]
   [-WindowStart <DateTime>]
   [-WindowEnd <DateTime>]
   [-RunStart <DateTime>]
   [-RunEnd <DateTime>]
   [-Top <Int32>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzDataFactoryActivityWindow cmdlet gets information about the activity windows associated with a data factory.

Examples

Example 1: Get activity windows associated with a data factory

PowerShell 
Get-AzDataFactoryActivityWindow -DataFactoryName "WikiADF" -ResourceGroupName "ADF" -Top 3

ResourceGroupName : ADF
DataFactoryName   : WikiADF
PipelineName      : DP_WikipediaSamplePipeline
ActivityName      : BlobToSqlCopyActivity
ActivityType      : Copy
LinkedServiceName : 
WindowState       : Waiting
WindowSubstate    : ConcurrencyLimit
Duration          : 00:00:00
InputDatasets     : {DA_CuratedWikiData}
OutputDatasets    : {DA_WikiAggregatedData}
PercentComplete   : 0
RunAttempts       : 1
RunStart          : 8/17/2016 10:05:51 PM
RunEnd            : 8/17/2016 10:05:51 PM
WindowStart       : 8/17/2016 6:00:00 AM
WindowEnd         : 8/17/2016 7:00:00 AM


ResourceGroupName : ADF
DataFactoryName   : WikiADF
PipelineName      : DP_WikipediaSamplePipeline
ActivityName      : BlobToSqlCopyActivity
ActivityType      : Copy
LinkedServiceName : 
WindowState       : Waiting
WindowSubstate    : ConcurrencyLimit
Duration          : 00:00:00
InputDatasets     : {DA_CuratedWikiData}
OutputDatasets    : {DA_WikiAggregatedData}
PercentComplete   : 0
RunAttempts       : 1
RunStart          : 8/17/2016 10:05:51 PM
RunEnd            : 8/17/2016 10:05:51 PM
WindowStart       : 8/16/2016 10:00:00 PM
WindowEnd         : 8/16/2016 11:00:00 PM


ResourceGroupName : ADF
DataFactoryName   : WikiADF
PipelineName      : DP_WikipediaSamplePipeline
ActivityName      : WikiHiveActivity
ActivityType      : HDInsightHive
LinkedServiceName : HDILinkedService
WindowState       : Ready
WindowSubstate    : 
Duration          : 00:03:37.8020000
InputDatasets     : {DA_WikipediaClickEvents}
OutputDatasets    : {DA_CuratedWikiData}
PercentComplete   : 100
RunAttempts       : 1
RunStart          : 8/17/2016 11:09:23 PM
RunEnd            : 8/17/2016 11:13:01 PM
WindowStart       : 8/17/2016 3:00:00 AM
WindowEnd         : 8/17/2016 4:00:00 AM

This command gets information about all activity window associated with the data factory named WikiADF.

Parameters

-ActivityName

Specifies the name of the activity. This cmdlet gets activity windows for the activity that this parameter specifies.

Type:String
Position:3
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-DataFactory

Specifies a PSDataFactory object returned by a cmdlet. This cmdlet gets activity windows that belong to the data factory that this parameter specifies.

Type:PSDataFactory
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DataFactoryName

Specifies the name of the data factory. This cmdlet gets activity windows that belong to the data factory that this parameter specifies.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DatasetName

Specifies the name of the dataset. This cmdlet gets activity windows that belong to the dataset that this parameter specifies.

Type:String
Position:2
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Filter

Specifies the activity window expressed by using Azure Search filter grammar. For information about the grammar, see OData Expression Syntax for Azure Searchhttps://msdn.microsoft.com/en-us/library/azure/dn798921.aspx (https://msdn.microsoft.com/en-us/library/azure/dn798921.aspx) in MSDN. The activity windows list is filtered by the search string that this parameter specifies.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-OrderBy

Specifies to order the response by one of the activity window list parameters. This is a list of comma separated properties. For example: WindowStart, PercentComplete. By default, the order is ascending order (ASC). Specify DESC if you want to order the list in descending order.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-PipelineName

Specifies the name of the pipeline. This cmdlet gets activity windows that belong to the pipeline that this parameter specifies.

Type:String
Position:2
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroupName

Specifies the name of the resource group. This cmdlet gets activity windows that belong to the resource group that this parameter specifies.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-RunEnd

Specifies the end time of the activity window run. This cmdlet gets activity windows whose run times fall between RunStart and RunEnd times.

Type:Nullable<T>[DateTime]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-RunStart

Specifies the start time of the activity window run. This cmdlet gets activity windows whose run times fall between RunStart and RunEnd times.

Type:Nullable<T>[DateTime]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Top

Specifies the maximum number of activity windows that this cmdlet returns.

Type:Nullable<T>[Int32]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-WindowEnd

Specifies the end time of activity window. This cmdlet gets activity windows whose times fall between WindowStart and WindowEnd times.

Type:Nullable<T>[DateTime]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-WindowStart

Specifies the start time of activity window. This cmdlet gets activity windows whose times fall between WindowStart and WindowEnd times.

Type:Nullable<T>[DateTime]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-WindowState

Specifies the state of the activity window. The acceptable values for this parameter are:

  • None
  • Waiting
  • InProgress
  • Ready
  • Failed
  • Skipped This cmdlet gets activity windows that are in the state that this parameter specifies.
Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-WindowSubstate

Specifies the substate of the activity window. The acceptable values for this parameter are:

  • Canceled
  • timedOut
  • Validating This cmdlet gets activity windows that are in the substate that this parameter specifies.
Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

Inputs

Nullable<T>[[System.DateTime, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Nullable<T>[[System.Int32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Outputs