Edit

Share via

Set-AzDataFactorySliceStatus

Module:
Az.DataFactory Module

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

Syntax

ByFactoryName (Default) 

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

ByFactoryObject 

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.

Parameter properties

Type:PSDataFactory
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByFactoryObject
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments: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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByFactoryName
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-DatasetName

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:2
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:DateTime
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:4
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByFactoryName
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-StartDateTime

Specifies the start of a time period as a DateTime object. This time is the beginning of a data slice.

Parameter properties

Type:DateTime
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:3
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:String
Default value:None
Accepted values:Failed, InProgress, Ready, Skipped, Waiting
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:5
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:String
Default value:None
Accepted values:Individual, UpstreamInPipeline
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:6
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

PSDataFactory

String

Outputs

Boolean

Notes

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