Skip to content

Getting started Scenario 1 Consume library

CARMLPipelinePrincipal edited this page Jun 20, 2022 · 12 revisions

In case you want to simply consume the modules of the library to build a solution, you only have to perform a few simple steps:

1. Download the library

To gather a local copy of the library, you have a few options to choose from:

Download a release

To download a specific release version of the repository:

  1. Navigate to the releases page.

  2. Scroll to the 'Assets' section at the bottom end of the release you'd like to download.

  3. Here, you will find a packaged version of the repository (as it was when the release was created) and can download it with a simple click on the 'Source code' package (e.g., Source code (zip)) itself. This will download the file in your default download folder.

    Download zip
  4. Finally, you need to unpack the downloaded file to a location of your choice.

Download latest

To download the latest version of the repository

  1. Navigate to the main page of CARML.

  2. On the overview page, select the <> Code button to the top right, and select the Download ZIP button in the opening pop-up to trigger the repository to be downloaded as a compressed file into your default download folder.

    Download zip
  3. Finally, you need to unpack the downloaded file to a location of your choice.

Clone latest

To clone the latest version of the repository

  1. On your local machine, open a PowerShell session.

  2. Navigate to the location you want to clone the repository into.

  3. Run

    git clone 'https://github.com/Azure/ResourceModules.git'

2. (Optional) Convert library to ARM

Note that in case you don't want to use Bicep, you always have the option to use the utility ConvertTo-ARMTemplate we provide in path utilities/tools, to convert the repository to an ARM-only repository. For further information on how to use the tool, please refer to the tool-specific documentation.

3. Build a solution

With the codebase ready, you can now start to build a solution. For examples on how to do so, please refer to the corresponding solution creation section.

Clone this wiki locally