< Back
Get-AzureRmDataFactoryActivityWindow
Post
NAME Get-AzureRmDataFactoryActivityWindow
SYNOPSIS
Gets information about activity windows associated with a data factory.
SYNTAX
Get-AzureRmDataFactoryActivityWindow [-DataFactory] <PSDataFactory> [[-DatasetName] <String>] [[-PipelineName] <String>] [[-ActivityName]
<String>] [-DefaultProfile <IAzureContextContainer>] [-Filter <String>] [-OrderBy <String>] [-RunEnd <DateTime>] [-RunStart <DateTime>] [-Top
<Int32>] [-WindowEnd <DateTime>] [-WindowStart <DateTime>] [-WindowState <String>] [-WindowSubstate <String>] [<CommonParameters>]
Get-AzureRmDataFactoryActivityWindow [-ResourceGroupName] <String> [-DataFactoryName] <String> [[-DatasetName] <String>] [[-PipelineName]
<String>] [[-ActivityName] <String>] [-DefaultProfile <IAzureContextContainer>] [-Filter <String>] [-OrderBy <String>] [-RunEnd <DateTime>]
[-RunStart <DateTime>] [-Top <Int32>] [-WindowEnd <DateTime>] [-WindowStart <DateTime>] [-WindowState <String>] [-WindowSubstate <String>]
[<CommonParameters>]
DESCRIPTION
The Get-AzureRmDataFactoryActivityWindow cmdlet gets information about the activity windows associated with a data factory.
PARAMETERS
-ActivityName <String>
Specifies the name of the activity. This cmdlet gets activity windows for the activity that this parameter specifies.
Required? false
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DataFactory <PSDataFactory>
Specifies a PSDataFactory object returned by a cmdlet. This cmdlet gets activity windows that belong to the data factory that this parameter
specifies.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DataFactoryName <String>
Specifies the name of the data factory. This cmdlet gets activity windows that belong to the data factory that this parameter specifies.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DatasetName <String>
Specifies the name of the dataset. This cmdlet gets activity windows that belong to the dataset that this parameter specifies.
Required? false
Position? 2
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
-Filter <String>
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/librar ... 98921.aspx) in
MSDN. The activity windows list is filtered by the search string that this parameter specifies.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-OrderBy <String>
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.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PipelineName <String>
Specifies the name of the pipeline. This cmdlet gets activity windows that belong to the pipeline that this parameter specifies.
Required? false
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of the resource group. This cmdlet gets activity windows that belong to the resource group that this parameter specifies.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-RunEnd <DateTime>
Specifies the end time of the activity window run. This cmdlet gets activity windows whose run times fall between RunStart and RunEnd times.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-RunStart <DateTime>
Specifies the start time of the activity window run. This cmdlet gets activity windows whose run times fall between RunStart and RunEnd times.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Top <Int32>
Specifies the maximum number of activity windows that this cmdlet returns.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-WindowEnd <DateTime>
Specifies the end time of activity window. This cmdlet gets activity windows whose times fall between WindowStart and WindowEnd times.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-WindowStart <DateTime>
Specifies the start time of activity window. This cmdlet gets activity windows whose times fall between WindowStart and WindowEnd times.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-WindowState <String>
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.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-WindowSubstate <String>
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.
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
None
This cmdlet does not accept any input.
OUTPUTS
System.Collections.Generic.List`1[[Microsoft.WindowsAzure.Commands.Utilities.PSActivyWindow, Microsoft.WindowsAzure.Commands.Utilities,
Version=0.8.2.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]
NOTES
Example 1: Get activity windows associated with a data factory
PS C:\\>Get-AzureRmDataFactoryActivityWindow -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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... vitywindow
Azure Data Factories Cmdlets
SYNOPSIS
Gets information about activity windows associated with a data factory.
SYNTAX
Get-AzureRmDataFactoryActivityWindow [-DataFactory] <PSDataFactory> [[-DatasetName] <String>] [[-PipelineName] <String>] [[-ActivityName]
<String>] [-DefaultProfile <IAzureContextContainer>] [-Filter <String>] [-OrderBy <String>] [-RunEnd <DateTime>] [-RunStart <DateTime>] [-Top
<Int32>] [-WindowEnd <DateTime>] [-WindowStart <DateTime>] [-WindowState <String>] [-WindowSubstate <String>] [<CommonParameters>]
Get-AzureRmDataFactoryActivityWindow [-ResourceGroupName] <String> [-DataFactoryName] <String> [[-DatasetName] <String>] [[-PipelineName]
<String>] [[-ActivityName] <String>] [-DefaultProfile <IAzureContextContainer>] [-Filter <String>] [-OrderBy <String>] [-RunEnd <DateTime>]
[-RunStart <DateTime>] [-Top <Int32>] [-WindowEnd <DateTime>] [-WindowStart <DateTime>] [-WindowState <String>] [-WindowSubstate <String>]
[<CommonParameters>]
DESCRIPTION
The Get-AzureRmDataFactoryActivityWindow cmdlet gets information about the activity windows associated with a data factory.
PARAMETERS
-ActivityName <String>
Specifies the name of the activity. This cmdlet gets activity windows for the activity that this parameter specifies.
Required? false
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DataFactory <PSDataFactory>
Specifies a PSDataFactory object returned by a cmdlet. This cmdlet gets activity windows that belong to the data factory that this parameter
specifies.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DataFactoryName <String>
Specifies the name of the data factory. This cmdlet gets activity windows that belong to the data factory that this parameter specifies.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DatasetName <String>
Specifies the name of the dataset. This cmdlet gets activity windows that belong to the dataset that this parameter specifies.
Required? false
Position? 2
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
-Filter <String>
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/librar ... 98921.aspx) in
MSDN. The activity windows list is filtered by the search string that this parameter specifies.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-OrderBy <String>
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.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PipelineName <String>
Specifies the name of the pipeline. This cmdlet gets activity windows that belong to the pipeline that this parameter specifies.
Required? false
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of the resource group. This cmdlet gets activity windows that belong to the resource group that this parameter specifies.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-RunEnd <DateTime>
Specifies the end time of the activity window run. This cmdlet gets activity windows whose run times fall between RunStart and RunEnd times.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-RunStart <DateTime>
Specifies the start time of the activity window run. This cmdlet gets activity windows whose run times fall between RunStart and RunEnd times.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Top <Int32>
Specifies the maximum number of activity windows that this cmdlet returns.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-WindowEnd <DateTime>
Specifies the end time of activity window. This cmdlet gets activity windows whose times fall between WindowStart and WindowEnd times.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-WindowStart <DateTime>
Specifies the start time of activity window. This cmdlet gets activity windows whose times fall between WindowStart and WindowEnd times.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-WindowState <String>
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.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-WindowSubstate <String>
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.
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
None
This cmdlet does not accept any input.
OUTPUTS
System.Collections.Generic.List`1[[Microsoft.WindowsAzure.Commands.Utilities.PSActivyWindow, Microsoft.WindowsAzure.Commands.Utilities,
Version=0.8.2.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]
NOTES
Example 1: Get activity windows associated with a data factory
PS C:\\>Get-AzureRmDataFactoryActivityWindow -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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... vitywindow
Azure Data Factories Cmdlets