< Back
New-AzureRmDataFactoryPipeline
Post
NAME New-AzureRmDataFactoryPipeline
SYNOPSIS
Creates a pipeline in Data Factory.
SYNTAX
New-AzureRmDataFactoryPipeline [-DataFactory] <PSDataFactory> [[-Name] <String>] [-File] <String> [-DefaultProfile <IAzureContextContainer>]
[-Force] [-Confirm] [-WhatIf] [<CommonParameters>]
New-AzureRmDataFactoryPipeline [-ResourceGroupName] <String> [-DataFactoryName] <String> [[-Name] <String>] [-File] <String> [-DefaultProfile
<IAzureContextContainer>] [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The New-AzureRmDataFactoryPipeline cmdlet creates a pipeline in Azure Data Factory. If you specify a name for a pipeline that already exists, the
cmdlet prompts you for confirmation before it replaces the pipeline. If you specify the Force parameter, the cmdlet replaces the existing pipeline
without confirmation.
Perform these operations in the following order:
- Create a data factory.
- Create linked services.
- Create datasets.
- Create a pipeline.
If a pipeline with the same name already exists in the data factory, this cmdlet prompts you to confirm whether to overwrite the existing pipeline
with the new pipeline. If you confirm to overwrite the existing pipeline, the pipeline definition is also replaced.
PARAMETERS
-DataFactory <PSDataFactory>
Specifies a PSDataFactory object. This cmdlet creates a pipeline for 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 creates a pipeline for the data factory that this parameter specifies.
Required? true
Position? 1
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
-File <String>
Specifies the full path of the JavaScript Object Notation (JSON) file that contains the description of the pipeline.
Required? true
Position? 3
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Force [<SwitchParameter>]
Indicates that this cmdlet replaces an existing pipeline without prompting you for confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the pipeline to create.
Required? false
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of an Azure resource group. This cmdlet creates a pipeline for the group that this parameter specifies.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
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
Microsoft.WindowsAzure.Commands.Utilities.PSPipeline
NOTES
* Keywords: azure, azurerm, arm, resource, management, manager, data, factories
Example 1: Create a pipeline
PS C:\\>New-AzureRmDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF" -File "C:\\DPWikisample.json"
PipelineName : DPWikisample
ResourceGroupName : ADF
DataFactoryName : WikiADF11
Properties : Microsoft.DataFactories.PipelineProperties
This command creates a pipeline named DPWikisample in the data factory named ADF. The command bases the pipeline on information in the
DPWikisample.json file. This file includes information about activities such as Copy Activity and HDInsight Activity in the pipeline.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... rypipeline
Get-AzureRmDataFactoryPipeline
Remove-AzureRmDataFactoryPipeline
Resume-AzureRmDataFactoryPipeline
Set-AzureRmDataFactoryPipelineActivePeriod
Suspend-AzureRmDataFactoryPipeline
SYNOPSIS
Creates a pipeline in Data Factory.
SYNTAX
New-AzureRmDataFactoryPipeline [-DataFactory] <PSDataFactory> [[-Name] <String>] [-File] <String> [-DefaultProfile <IAzureContextContainer>]
[-Force] [-Confirm] [-WhatIf] [<CommonParameters>]
New-AzureRmDataFactoryPipeline [-ResourceGroupName] <String> [-DataFactoryName] <String> [[-Name] <String>] [-File] <String> [-DefaultProfile
<IAzureContextContainer>] [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The New-AzureRmDataFactoryPipeline cmdlet creates a pipeline in Azure Data Factory. If you specify a name for a pipeline that already exists, the
cmdlet prompts you for confirmation before it replaces the pipeline. If you specify the Force parameter, the cmdlet replaces the existing pipeline
without confirmation.
Perform these operations in the following order:
- Create a data factory.
- Create linked services.
- Create datasets.
- Create a pipeline.
If a pipeline with the same name already exists in the data factory, this cmdlet prompts you to confirm whether to overwrite the existing pipeline
with the new pipeline. If you confirm to overwrite the existing pipeline, the pipeline definition is also replaced.
PARAMETERS
-DataFactory <PSDataFactory>
Specifies a PSDataFactory object. This cmdlet creates a pipeline for 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 creates a pipeline for the data factory that this parameter specifies.
Required? true
Position? 1
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
-File <String>
Specifies the full path of the JavaScript Object Notation (JSON) file that contains the description of the pipeline.
Required? true
Position? 3
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Force [<SwitchParameter>]
Indicates that this cmdlet replaces an existing pipeline without prompting you for confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the pipeline to create.
Required? false
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of an Azure resource group. This cmdlet creates a pipeline for the group that this parameter specifies.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
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
Microsoft.WindowsAzure.Commands.Utilities.PSPipeline
NOTES
* Keywords: azure, azurerm, arm, resource, management, manager, data, factories
Example 1: Create a pipeline
PS C:\\>New-AzureRmDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF" -File "C:\\DPWikisample.json"
PipelineName : DPWikisample
ResourceGroupName : ADF
DataFactoryName : WikiADF11
Properties : Microsoft.DataFactories.PipelineProperties
This command creates a pipeline named DPWikisample in the data factory named ADF. The command bases the pipeline on information in the
DPWikisample.json file. This file includes information about activities such as Copy Activity and HDInsight Activity in the pipeline.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... rypipeline
Get-AzureRmDataFactoryPipeline
Remove-AzureRmDataFactoryPipeline
Resume-AzureRmDataFactoryPipeline
Set-AzureRmDataFactoryPipelineActivePeriod
Suspend-AzureRmDataFactoryPipeline