Set-AzDataFactoryV2Pipeline
Creates a pipeline in Data Factory.
Syntax
Set-AzDataFactoryV2Pipeline
[-Name] <String>
[-DefinitionFile] <String>
[-ResourceGroupName] <String>
[-DataFactoryName] <String>
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-AzDataFactoryV2Pipeline
[-DefinitionFile] <String>
[-ResourceId] <String>
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Set-AzDataFactoryV2Pipeline 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.
Examples
Example 1: Create a pipeline
Set-AzDataFactoryV2Pipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF" -File "C:\DPWikisample.json"
PipelineName : DPWikisample
ResourceGroupName : ADF
DataFactoryName : WikiADF11
Activities : {MyCopyActivity_0_0, MyCopyActivity_1_0}
Parameters : {[OutputBlobName, Microsoft.Azure.Management.DataFactory.Models.ParameterSpecification]}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.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DataFactoryName
Specifies the name of a data factory. This cmdlet creates a pipeline for the data factory that this parameter specifies.
| Type: | String |
| Position: | 1 |
| 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 |
-DefinitionFile
The JSON file path.
| Type: | String |
| Aliases: | File |
| Position: | 3 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Force
Indicates that this cmdlet replaces an existing pipeline without prompting you for confirmation.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
Specifies the name of the pipeline to create.
| Type: | String |
| Aliases: | PipelineName |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ResourceGroupName
Specifies the name of an Azure resource group. This cmdlet creates a pipeline for the group that this parameter specifies.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ResourceId
The Azure resource ID.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WhatIf
Shows what happens if the cmdlet runs, but doesn't run the cmdlet.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Outputs
Notes
Keywords: azure, azurerm, arm, resource, management, manager, data, factories