Set-AzDataFactoryPipelineActivePeriod
Configures the active period for data slices.
Syntax
Set-AzDataFactoryPipelineActivePeriod
[-PipelineName] <String>
[-DataFactoryName] <String>
[-StartDateTime] <DateTime>
[[-EndDateTime] <DateTime>]
[-AutoResolve]
[-ForceRecalculate]
[-ResourceGroupName] <String>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-AzDataFactoryPipelineActivePeriod
[-PipelineName] <String>
[-DataFactory] <PSDataFactory>
[-StartDateTime] <DateTime>
[[-EndDateTime] <DateTime>]
[-AutoResolve]
[-ForceRecalculate]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Set-AzDataFactoryPipelineActivePeriod cmdlet configures the active period for the data slices that are processed by a pipeline in Azure Data Factory. If you use the Set-AzDataFactorySliceStatus cmdlet to modify the status of slices for a dataset, make sure that the start time and end time for a slice are in the active period of the pipeline. After you create a pipeline, you can specify the period in which data processing occurs. Specifying the active period for a pipeline defines the time duration in which the data slices are processed based on the Availability properties that were defined for each Data Factory dataset.
Examples
Example 1: Configure the active period
Set-AzDataFactoryPipelineActivePeriod -ResourceGroupName "ADF" -PipelineName "DPWikisample" -DataFactoryName "WikiADF" -StartDateTime 2014-05-21T16:00:00Z -EndDateTime 2014-05-22T16:00:00Z
Confirm
Are you sure you want to set pipeline 'DPWikisample' active period from '05/21/2014 16:00:00' to
'05/22/2014 16:00:00'?
[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y
TrueThis command configures the active period for the data slices that the pipeline named DPWikisample processes. The command provides beginning and end points for the data slices as values. The command returns a value of $True.
Parameters
-AutoResolve
Indicates that this cmdlet uses auto resolve.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DataFactory
Specifies a PSDataFactory object. This cmdlet modifies the active period for a pipeline that belongs 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 a data factory. This cmdlet modifies the active period for a pipeline that belongs 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 |
-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 |
-EndDateTime
Specifies the end of a time period as a DateTime object.
Data processing occurs or data slices are processed within this period.
For more information about DateTime objects, type Get-Help Get-Date.
EndDateTime must be specified in the ISO8601 format as in the following examples:
2015-01-01Z
2015-01-01T00:00:00Z
2015-01-01T00:00:00.000Z (UTC)
2015-01-01T00:00:00-08:00 (Pacific Standard Time)
The default time zone designator is UTC.
| Type: | DateTime |
| Position: | 4 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ForceRecalculate
Indicates that this cmdlet uses force recalculate.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PipelineName
Specifies the name of the pipeline. This cmdlet sets the active period for the pipeline that this parameter specifies.
| Type: | String |
| Aliases: | Name |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ResourceGroupName
Specifies the name of an Azure resource group. This cmdlet modifies the active period for a pipeline that belongs to the group that this parameter specifies.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-StartDateTime
Specifies the start of a time period as a DateTime object. Data processing occurs or data slices are processed within this period. StartDateTime must be specified in the ISO8601 format.
| Type: | DateTime |
| Position: | 3 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Outputs
Notes
- Keywords: azure, azurerm, arm, resource, management, manager, data, factories
