Edit

Share via

Set-AzDataFactorySliceStatus

  • Reference
Module:
Az.DataFactory

Sets the status of slices for a dataset in Azure Data Factory.

Syntax

Set-AzDataFactorySliceStatus
   [[-EndDateTime] <DateTime>]
   [-Status] <String>
   [[-UpdateType] <String>]
   [-DataFactoryName] <String>
   [-DatasetName] <String>
   [-StartDateTime] <DateTime>
   [-ResourceGroupName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Set-AzDataFactorySliceStatus
   [[-EndDateTime] <DateTime>]
   [-Status] <String>
   [[-UpdateType] <String>]
   [-DataFactory] <PSDataFactory>
   [-DatasetName] <String>
   [-StartDateTime] <DateTime>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Set-AzDataFactorySliceStatus cmdlet sets the status of slices for a dataset in Azure Data Factory.

Examples

Example 1: Set the status of all slices

Set-AzDataFactorySliceStatus -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -DatasetName "DAWikiAggregatedData" -StartDateTime 2014-05-21T16:00:00Z -EndDateTime 2014-05-21T20:00:00Z -Status "Waiting" -UpdateType "UpstreamInPipeline"

True

This command sets the status of all slices for the dataset named DAWikiAggregatedData to Waiting in the data factory named WikiADF. The UpdateType parameter has a value of UpstreamInPipeline, and so the command sets the status of each slice for the dataset and all dependent datasets. Dependent datasets are used as input datasets for activities in the pipeline. This command returns a value of $True.

Parameters

-DataFactory

Specifies a PSDataFactory object. This cmdlet modifies the status of slices that belong 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 status of slices that belong 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

-DatasetName

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

Type:String
Position:2
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. This time is the end of a data slice. 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

-ResourceGroupName

Specifies the name of an Azure resource group. This cmdlet modifies the status of slices that belong 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. This time is the beginning of a data slice.

Type:DateTime
Position:3
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Status

Specifies a status to assign to the data slice. The acceptable values for this parameter are:

  • Waiting. Data slice is waiting for validation against validation policies before being processed.
  • Ready. Data processing has completed and the data slice is ready.
  • InProgress. Data processing is in-progress.
  • Failed. Data processing failed.
  • Skipped. Skipped processing the data slice.
Type:String
Accepted values:Failed, InProgress, Ready, Skipped, Waiting
Position:5
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-UpdateType

Specifies the type of update to the slice. The acceptable values for this parameter are:

  • Individual. Sets the status of each slice for the dataset in the specified time range.
  • UpstreamInPipeline. Sets the status of each slice for the dataset and all the dependent datasets, which are used as input datasets for activities in the pipeline.
Type:String
Accepted values:Individual, UpstreamInPipeline
Position:6
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

PSDataFactory

String

Outputs

Boolean

Notes

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