Azure - ARM Template
  • Dark

Azure - ARM Template

  • Dark


The Matillion CDC agent can be installed via an ARM Template.

We recommend creating a resource group for your CDC agent and related resources. Please see the Azure documentation on the Resource Manager for full information.


The template provides a blueprint for installation that you may use verbatim, but you may need to modify it to suit your own needs and rules governing your cloud infrastructure.

Created Resources

Container Instance.


Edit the template

Users should inspect the template in a text editor and ensure the values are as-expected before proceeding. In particular, the PLATFORM_WEBSOCKET_ENDPOINT environment variable should be edited to match the expected endpoint and region. See Environment Variables for more information.


To deploy this Azure ARM templates, and in addition to other requirements for Azure environments (for example, secret key uploaded to Azure Key Vault), the customer needs to have provisioned, and provide, the following additional resources within their Azure environment:

Template deployment

  1. Log in to the Azure Portal.
  2. Browse to your resource group (we recommend making a new one if you haven't already).
  3. Click Create in the resource group pane (not the left-hand navigation pane) to start making a new resource in this group.
  4. In your resource group, search for Template specs.
  5. Click Import template.
  6. Click the folder icon and import your downloaded ARM template. Once done, click Import.
  7. The template body has been populated with imported content, but you need to complete a number of additional fields. Once done, click Next:Edit Template.
  8. You can edit your template if needed, then click Next:Tags.
  9. If any tags are required, please provide them. Tags are name:value pairs that allow you to categorize resources. Click Next:Review + create.
  10. Once you have reviewed your template, click Create.

Instance details

Field Description
Region Choose the Azure region that's right for you. not every resources is available in every region.
Agent Id Unique UUID that identifies your agent to the CDC platform
Azure Client Id Client ID of the Azure Active Directory service principal used for authentication
Azure Client Secret Client secret value for the Azure Active Directory service principal used for authentication.
Azure Key Vault URL The URL of the Key Vault where your private key is stored
Azure Tenant Id Tenant ID of your Azure Active Directory
Container DNS Name Arbitrary prefix for the DNS your container will be available at.
Container Group Name Arbitrary name for your new container group.
Container Name Arbitrary name for your new container.
Image URL Agent URL. Do not edit.
Location The Azure Region for your resources to be located
Log Analytics Workspace Id Log Analytics Workspace ID to facilitate log collection and retention.(See Log Analytics for more information)
Log Analytics Workspace Key Log Analytics Workspace key providing full credentials for access. (See Log Analytics for more information)
Organization Id The unique UUID that identifies your account to the CDC platform.
Platform Key Name The name of the Azure Key Vault secret that your generated private key is in.