Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-AzureDataFactoryPipelineActivePeriod

Set-AzureDataFactoryPipelineActivePeriod

microsoft.azure.commands.datafactories.dll

Synopsis

Configures the active period for data slices.

Syntax

Set-AzureDataFactoryPipelineActivePeriod [-ResourceGroupName] [-DataFactoryName] [-PipelineName] [-StartDateTime] [-EndDateTime] [-AutoResolve] [-Force] [-ForceRecalculate] [<CommonParameters>]

Set-AzureDataFactoryPipelineActivePeriod [-DataFactory] [-PipelineName] [-StartDateTime] [-EndDateTime] [-AutoResolve] [-Force] [-ForceRecalculate] [<CommonParameters>]

Detailed Description

The Set-AzureDataFactoryPipelineActivePeriod cmdlet configures the active period for the data slices that are processed by a pipeline in Azure Data Factory. If you use the Set-AzureDataFactorySliceStatus cmdlet to modify the status of slices for a table, 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 table.

You must be in AzureResourceManager mode to run Azure Data Factory cmdlets. To switch to AzureResourceManager mode, type Switch-AzureMode AzureResourceManager.

Parameters

-AutoResolve <SwitchParameter>

Indicates that this cmdlet uses auto resolve.

Aliases

None

Required?

false

Position

named

Default value

None

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.

Aliases

None

Required?

true

Position

1

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.

Aliases

None

Required?

true

Position

2

Default value

None

Accept pipeline input?

True (ByPropertyName)

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. 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. If the time zone designator is omitted (ex: 2014-10-01), it is considered as an UTC time 2014-10-01T00:00:00Z.

Aliases

None

Required?

false

Position

5

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Force <SwitchParameter>

Indicates that this cmdlet sets the active period without prompting you for confirmation.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ForceRecalculate <SwitchParameter>

Indicates that this cmdlet uses force recalculate.

Aliases

None

Required?

false

Position

named

Default value

None

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.

Aliases

Name

Required?

true

Position

2

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.

Aliases

None

Required?

true

Position

1

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. 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. If the time zone designator is omitted (ex: 2014-10-01), it is considered as an UTC time 2014-10-01T00:00:00Z.

Aliases

None

Required?

true

Position

4

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type

System.Boolean

Notes

None

Examples

Example 1: Configure the active period

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.

                    PS C:\> Set-AzureDataFactoryPipelineActivePeriod -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
                

New-AzureDataFactoryPipeline
Set-AzureDataFactorySliceStatus