⚠️ Important Notice

This repository has been archived and is no longer maintained. Some alternatives are:

1. Using the action "as is": You are welcome to use the action from the marketplace.
2. Fork the repository: Feel free to fork this repository and continue its development to attend your needs under the terms of the project LICENSE.
3. Build your own action: Create your action by interacting with the azure-data-factory-utilities npm package.

Azure Data Factory Export Action

GitHub Action that exports all the Azure Data Factory resources stored in your Git repository to an ARM Template using the Azure Data Factory utilities package.

When to use

The action is particularly useful on deployment scenarios, where a step can be added in a workflow to generate a Data Factory ARM template from a Git repository branch and then use it as the source for an ARM template deployment.

Getting Started

Prerequisites

1. Ensure your Data Factory is connected with a Git repository. For more info, see Connect to a Git repository and Bicep & ARM Template formats.

2. Ensure the following package.json file exists in the same directory that contains your Data Factory resources in the Git repository:

   {
     "scripts":{
       "build":"node node_modules/@microsoft/azure-data-factory-utilities/lib/index"
     },
     "dependencies":{
       "@microsoft/azure-data-factory-utilities":"^0.1.5"
     }
   }
   

Example Usage

steps:
  - name: Export ARM Template
    id: export
    uses: Azure/data-factory-export-action@v1.2.1
    # with:
    #   path: ./mydir [optional]
    #   id: <data factory resource ID> [optional]

  - name: Publish ARM template
    uses: actions/upload-artifact@v2
    with:
      name: my-artifact
      path: ${{ steps.export.outputs.arm-template-directory }}
      if-no-files-found: error

Note: The action creates an armTemplate subdirectory dynamically and exports the ARM Template (ARMTemplateForFactory.json) inside it.

Inputs

• path (optional): Directory that contains all Data Factory resources. Defaults to ./ directory.

• id (optional): Data Factory resource ID. Defaults to /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup/providers/Microsoft.DataFactory/factories/dataFactory.

Outputs

• arm-template-directory: Directory where the generated ARM template is stored.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.