< Back
Set-AzureRmDataFactoryPipelineActivePeriod
Post
NAME Set-AzureRmDataFactoryPipelineActivePeriod
SYNOPSIS
Configures the active period for data slices.
SYNTAX
Set-AzureRmDataFactoryPipelineActivePeriod [-DataFactory] <PSDataFactory> [-PipelineName] <String> [-StartDateTime] <DateTime> [[-EndDateTime]
<DateTime>] [-AutoResolve] [-DefaultProfile <IAzureContextContainer>] [-ForceRecalculate] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-AzureRmDataFactoryPipelineActivePeriod [-ResourceGroupName] <String> [-DataFactoryName] <String> [-PipelineName] <String> [-StartDateTime]
<DateTime> [[-EndDateTime] <DateTime>] [-AutoResolve] [-DefaultProfile <IAzureContextContainer>] [-ForceRecalculate] [-Confirm] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
The Set-AzureRmDataFactoryPipelineActivePeriod cmdlet configures the active period for the data slices that are processed by a pipeline in Azure
Data Factory. If you use the Set-AzureRmDataFactorySliceStatus 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.
PARAMETERS
-AutoResolve [<SwitchParameter>]
Indicates that this cmdlet uses auto resolve.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-DataFactory <PSDataFactory>
Specifies a PSDataFactory object. This cmdlet modifies the active period for a pipeline that belongs 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 a data factory. This cmdlet modifies the active period for a pipeline that belongs to the data factory that this
parameter specifies.
Required? true
Position? 1
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
-EndDateTime <DateTime>
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.
Required? false
Position? 4
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ForceRecalculate [<SwitchParameter>]
Indicates that this cmdlet uses force recalculate.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-PipelineName <String>
Specifies the name of the pipeline. This cmdlet sets the active period for the pipeline that this parameter specifies.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
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.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-StartDateTime <DateTime>
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.
Required? true
Position? 3
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
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.Boolean
NOTES
* Keywords: azure, azurerm, arm, resource, management, manager, data, factories
Example 1: Configure the active period
PS C:\\>Set-AzureRmDataFactoryPipelineActivePeriod -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
True
This 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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... tiveperiod
New-AzureRmDataFactoryPipeline
Set-AzureRmDataFactorySliceStatus
SYNOPSIS
Configures the active period for data slices.
SYNTAX
Set-AzureRmDataFactoryPipelineActivePeriod [-DataFactory] <PSDataFactory> [-PipelineName] <String> [-StartDateTime] <DateTime> [[-EndDateTime]
<DateTime>] [-AutoResolve] [-DefaultProfile <IAzureContextContainer>] [-ForceRecalculate] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-AzureRmDataFactoryPipelineActivePeriod [-ResourceGroupName] <String> [-DataFactoryName] <String> [-PipelineName] <String> [-StartDateTime]
<DateTime> [[-EndDateTime] <DateTime>] [-AutoResolve] [-DefaultProfile <IAzureContextContainer>] [-ForceRecalculate] [-Confirm] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
The Set-AzureRmDataFactoryPipelineActivePeriod cmdlet configures the active period for the data slices that are processed by a pipeline in Azure
Data Factory. If you use the Set-AzureRmDataFactorySliceStatus 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.
PARAMETERS
-AutoResolve [<SwitchParameter>]
Indicates that this cmdlet uses auto resolve.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-DataFactory <PSDataFactory>
Specifies a PSDataFactory object. This cmdlet modifies the active period for a pipeline that belongs 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 a data factory. This cmdlet modifies the active period for a pipeline that belongs to the data factory that this
parameter specifies.
Required? true
Position? 1
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
-EndDateTime <DateTime>
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.
Required? false
Position? 4
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ForceRecalculate [<SwitchParameter>]
Indicates that this cmdlet uses force recalculate.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-PipelineName <String>
Specifies the name of the pipeline. This cmdlet sets the active period for the pipeline that this parameter specifies.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
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.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-StartDateTime <DateTime>
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.
Required? true
Position? 3
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
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.Boolean
NOTES
* Keywords: azure, azurerm, arm, resource, management, manager, data, factories
Example 1: Configure the active period
PS C:\\>Set-AzureRmDataFactoryPipelineActivePeriod -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
True
This 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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... tiveperiod
New-AzureRmDataFactoryPipeline
Set-AzureRmDataFactorySliceStatus