< Back
Set-AzureRmDataFactorySliceStatus
Post
NAME Set-AzureRmDataFactorySliceStatus
SYNOPSIS
Sets the status of slices for a dataset in Azure Data Factory.
SYNTAX
Set-AzureRmDataFactorySliceStatus [-DataFactory] <PSDataFactory> [-DatasetName] <String> [-StartDateTime] <DateTime> [[-EndDateTime] <DateTime>]
[-Status] {Failed | InProgress | Ready | Skipped | Waiting} [[-UpdateType] {Individual | UpstreamInPipeline}] [-DefaultProfile
<IAzureContextContainer>] [<CommonParameters>]
Set-AzureRmDataFactorySliceStatus [-ResourceGroupName] <String> [-DataFactoryName] <String> [-DatasetName] <String> [-StartDateTime] <DateTime>
[[-EndDateTime] <DateTime>] [-Status] {Failed | InProgress | Ready | Skipped | Waiting} [[-UpdateType] {Individual | UpstreamInPipeline}]
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmDataFactorySliceStatus cmdlet sets the status of slices for a dataset in Azure Data Factory.
PARAMETERS
-DataFactory <PSDataFactory>
Specifies a PSDataFactory object. This cmdlet modifies the status of slices that belong 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 status of slices that belong to the data factory that this parameter specifies.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DatasetName <String>
Specifies the name of the dataset for which this cmdlet modifies slices.
Required? true
Position? 2
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. 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.
Required? false
Position? 4
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of an Azure resource group. This cmdlet modifies the status of slices that belong 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. This time is the beginning of a data slice.
Required? true
Position? 3
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Status <String>
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.
Required? true
Position? 5
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-UpdateType <String>
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.
Required? false
Position? 6
Default value None
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: Set the status of all slices
PS C:\\>Set-AzureRmDataFactorySliceStatus -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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... licestatus
Get-AzureRmDataFactorySlice
SYNOPSIS
Sets the status of slices for a dataset in Azure Data Factory.
SYNTAX
Set-AzureRmDataFactorySliceStatus [-DataFactory] <PSDataFactory> [-DatasetName] <String> [-StartDateTime] <DateTime> [[-EndDateTime] <DateTime>]
[-Status] {Failed | InProgress | Ready | Skipped | Waiting} [[-UpdateType] {Individual | UpstreamInPipeline}] [-DefaultProfile
<IAzureContextContainer>] [<CommonParameters>]
Set-AzureRmDataFactorySliceStatus [-ResourceGroupName] <String> [-DataFactoryName] <String> [-DatasetName] <String> [-StartDateTime] <DateTime>
[[-EndDateTime] <DateTime>] [-Status] {Failed | InProgress | Ready | Skipped | Waiting} [[-UpdateType] {Individual | UpstreamInPipeline}]
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmDataFactorySliceStatus cmdlet sets the status of slices for a dataset in Azure Data Factory.
PARAMETERS
-DataFactory <PSDataFactory>
Specifies a PSDataFactory object. This cmdlet modifies the status of slices that belong 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 status of slices that belong to the data factory that this parameter specifies.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DatasetName <String>
Specifies the name of the dataset for which this cmdlet modifies slices.
Required? true
Position? 2
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. 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.
Required? false
Position? 4
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of an Azure resource group. This cmdlet modifies the status of slices that belong 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. This time is the beginning of a data slice.
Required? true
Position? 3
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Status <String>
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.
Required? true
Position? 5
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-UpdateType <String>
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.
Required? false
Position? 6
Default value None
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: Set the status of all slices
PS C:\\>Set-AzureRmDataFactorySliceStatus -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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... licestatus
Get-AzureRmDataFactorySlice