Azure-DataFactory/community templates

Community pipeline templates

We are excited to announce that Community Templates are now available to our community members. For more information about this announcement, please see Introducing Azure Data Factory Community Templates.

Pipeline templates should follow ARM templates syntax. For more information about ARM templates, see https://go.microsoft.com/fwlink/?linkid=2181481

Notes for "manifest.json":

1. It must contain a property named "contributorType" set to "Community".
2. The "author" property can be configured as the contributor of the template.
3. The "documentation" property must be set to a link. Please upload your documentation to the documentation folder in community templates.

Create templates from pipelines

In addition to writing a template file directly, you can also create a template from a a new or existing pipeline in Azure Data Factory.

For details about pipelines, please refer Data Integration Pipelines.

To create a template from a pipeline, please go to Azure Data Factory and execute the following steps:

1. Navigate to your data factroy, in the left side menu choose "Author" to open the authoring blade.

   

2. In the authoring blade, click the plus symbol and then click "Pipeline" to open the submenu.

   

3. Click on the 'Pipeline' button in the submenu to open the pipeline configuration pane.

   

4. After your pipeline is ready, click on the "Export template" button in the right side of the authoring blade to export a template.

   

5. At last, in the template file obtained in the previous steps, you need to add "contributorType" and "author" in "manifest.json" and you can add new properties or modify it as well.

Test your templates

To make sure the template is correct, please go to Azure Data Factory and import the template file to see if a pipeline can be created from it correctly or not.

To do so, execute the following steps:

1. Navigate to your data factroy, in the left side menu choose "Author" to open the authoring blade.

   

2. In the authoring blade, click the plus symbol and then click "Pipeline" to open the submenu.

   

3. Click on the 'Import from pipeline template' button in the submenu. Then select the local template file you want to check in the file selection dialog box. The template file should be in zip format.

   

4. Once the template file is imported successfully, a pane will be triggered. If the pane contains one or more input elements for linked services which are configured in the template file, select a linked service for each input.

   

   If the template is incorrect, an error hint will show in the top of the pane and "Use this template" button will be disabled.

   

5. When the "Use this template" button is enabled, click on it and navigate back to the authoring blade.

   

6. If the template is correct, a pipeline will be created from it automatically.

   

Submit your templates

You're very welcomed to provide your templates to Azure-DataFactory！

Put your templates in the "community templates" folder and create a pull request. We will review your templates. Once they are verified to be correct, we will deploy them to the Azure Data Factory template gallery.