Get-​Azure​Rm​Data​Factory​Slice

Gets data slices for a dataset in Azure Data Factory.

Syntax

Get-AzureRmDataFactorySlice
   [-DataFactory] <PSDataFactory>
   [-DatasetName] <String>
   [-StartDateTime] <DateTime>
   [[-EndDateTime] <DateTime>]
   [<CommonParameters>]
Get-AzureRmDataFactorySlice
   [-ResourceGroupName] <String>
   [-DataFactoryName] <String>
   [-DatasetName] <String>
   [-StartDateTime] <DateTime>
   [[-EndDateTime] <DateTime>]
   [<CommonParameters>]

Description

The Get-AzureRmDataFactorySlice cmdlet gets data slices for a dataset in Azure Data Factory. Specify a start time and an end time to define a range of data slices to view.

The status of a data slice is one of the following values:

- PendingExecution. Data processing has not started.

  • InProgress. Data processing is in progress.
  • Ready. Data processing is completed. The data slice is ready for dependent slices to consume it.
  • Failed. The run that produces the slice failed.
  • Skip. Data Factory skips processing of the slice.
  • Retry. Data Factory retries the run that produces the slice.
  • Timed Out. Data processing has timed out.
  • PendingValidation. Data slice is waiting for validation before it is processed.
  • Retry Validation. Data Factory retries the validation of the slice.
  • Failed Validation. Validation of the slice failed.

    For each of the slices, you can see more information about the run that produces the slice by using the Get-AzureRmDataFactoryRun cmdlet.

Examples

Example 1: Get data slices for a dataset

PS C:\>Get-AzureRmDataFactorySlice -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -DatasetName "DAWikiAggregatedData" -StartDateTime 2014-05-20T10:00:00Z
ResourceGroupName : ADF
DataFactoryName   : WikiADF
DatasetName         : DAWikiAggregatedData
Start             : 5/21/2014 1:00:00 AM
End               : 5/21/2014 2:00:00 AM
RetryCount        : 0
Status            : Ready

ResourceGroupName : ADF
DataFactoryName   : WikiADF
DatasetName         : DAWikiAggregatedData
Start             : 5/21/2014 2:00:00 AM
End               : 5/21/2014 3:00:00 AM
RetryCount        : 0
Status            : Ready

. . . 

ResourceGroupName : ADF
DataFactoryName   : WikiADF
DatasetName         : DAWikiAggregatedData
Start             : 5/21/2014 8:00:00 PM
End               : 5/21/2014 9:00:00 PM
RetryCount        : 0
Status            : PendingExecution

ResourceGroupName : ADF
DataFactoryName   : WikiADF
DatasetName         : DAWikiAggregatedData
Start             : 5/21/2014 9:00:00 PM
End               : 5/21/2014 10:00:00 PM
RetryCount        : 0
Status            : PendingExecution

. . .

This command gets all the data slices for the dataset named WikiAggregatedData in the data factory named WikiADF. The command gets slices produced after the time that the StartDateTime parameter specifies. The following example code sets the availability for this dataset every hour in the JavaScript Object Notation (JSON) file.

availability: { period: "Hour", periodMultiplier: 1 }

Some of the results are Ready and others are PendingExecution. Ready slices have already run. The pending slices are waiting to run at the end of each hour in the interval that the Set-AzureRmDataFactoryPipelineActivePeriod cmdlet specifies. In this example, both start and end periods for the pipeline and the slice have a value of one day (24 hours).

Required Parameters

-DataFactory

Specifies a PSDataFactory object. This cmdlet gets slices that belong to the data factory that this parameter specifies.

Type:PSDataFactory
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-DataFactoryName

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

Type:String
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-DatasetName

Specifies the name of the dataset for which this cmdlet gets slices.

Type:String
Position:3
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceGroupName

Specifies the name of an Azure resource group. This cmdlet gets slices that belong to the group that this parameter specifies.

Type:String
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-StartDateTime

Specifies the start of a time period as a DateTime object. This cmdlet gets slices produced after the time that this parameter specifies.

Type:DateTime
Position:4
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Optional Parameters

-EndDateTime

Specifies the end of a time period as a DateTime object. This cmdlet gets slices produced before the time that this parameter specifies. 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:5
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Outputs

System.Collections.Generic.List`1[[Microsoft.WindowsAzure.Commands.Utilities.PSDataSlice, Microsoft.WindowsAzure.Commands.Utilities, Version=0.8.2.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]

Notes

  • Keywords: azure, azurerm, arm, resource, management, manager, data, factories