Terraform Provider for Azure Resource Manager Rest API

The AzAPI provider is a very thin layer on top of the Azure ARM REST APIs. Use this new provider to authenticate to and manage Azure resources and functionality using the Azure Resource Manager APIs directly.

This provider compliments the AzureRM provider by enabling the management of Azure resources that are not yet or may never be supported in the AzureRM provider such as private/public preview services and features.

Get started with AzApi

• AzApi Provider Overview

• Learn how to use azapi_resource

• Learn how to use azapi_update_resource

• AzApi VSCode Extension provides a rich authoring experience to help you use the AzApi provider.

Also, there is a rich library of examples to help you get started.

Usage Example

The following example shows how to use azapi_resource to manage machine learning compute resource.

terraform {
  required_providers {
    azapi = {
      source  = "Azure/azapi"
    }
  }
}

provider "azapi" {
  # More information on the authentication methods supported by
  # the AzApi Provider can be found here:
  # https://registry.terraform.io/providers/Azure/azapi/latest/docs

  # subscription_id = "..."
  # client_id       = "..."
  # client_secret   = "..."
  # tenant_id       = "..."
}

// azurerm provider
provider "azurerm" {
  features {}
}

// create a resource group, it's recommended to use azapi provider with azurerm provider
resource "azurerm_resource_group" "example" {
  name     = "example-resources"
  location = "West Europe"
}

// create a automation account
resource "azapi_resource" "automationAccount" {
  type      = "Microsoft.Automation/automationAccounts@2021-06-22"
  name      = "myAccount"
  parent_id = azurerm_resource_group.test.id

  location = azurerm_resource_group.test.location
  body = {
    properties = {
      disableLocalAuth    = true
      publicNetworkAccess = false
      sku = {
        name = "Basic"
      }
    }
  }
}

Further usage documentation is available on the Terraform website.

Developer Requirements

• Terraform version 0.12.x + (but 1.x is recommended)
• Go version 1.18.x (to build the provider plugin)

On Windows

If you're on Windows you'll also need:

• Git Bash for Windows
• Make for Windows

For GNU32 Make, make sure its bin path is added to PATH environment variable.*

For Git Bash for Windows, at the step of "Adjusting your PATH environment", please choose "Use Git and optional Unix tools from Windows Command Prompt".*

Or install via Chocolatey (Git Bash for Windows must be installed per steps above)

choco install make golang terraform -y
refreshenv

You must run Developing the Provider commands in bash because sh scrips are invoked as part of these.

Developing the Provider

If you wish to work on the provider, you'll first need Go installed on your machine (version 1.18+ is required). You'll also need to correctly setup a GOPATH, as well as adding $GOPATH/bin to your $PATH.

First clone the repository to: $GOPATH/src/github.com/Azure/terraform-provider-azapi

$ mkdir -p $GOPATH/src/github.com/Azure; cd $GOPATH/src/github.com/Azure
$ git clone [email protected]:Azure/terraform-provider-azapi
$ cd $GOPATH/src/github.com/Azure/terraform-provider-azapi

Once inside the provider directory, you can run make tools to install the dependent tooling required to compile the provider.

At this point you can compile the provider by running make build, which will build the provider and put the provider binary in the $GOPATH/bin directory.

$ make build
...
$ $GOPATH/bin/terraform-provider-azapi
...

You can also cross-compile if necessary:

GOOS=windows GOARCH=amd64 make build

In order to run the Unit Tests for the provider, you can run:

$ make test

The majority of tests in the provider are Acceptance Tests - which provisions real resources in Azure. It's possible to run the entire acceptance test suite by running make testacc - however it's likely you'll want to run a subset, which you can do using a prefix, by running:

make acctests TESTARGS='-run=<nameOfTheTest>' TESTTIMEOUT='60m'

• <nameOfTheTest> should be self-explanatory as it is the name of the test you want to run. An example could be TestAccGenericResource_basic. Since -run can be used with regular expressions you can use it to specify multiple tests like in TestAccGenericResource_ to run all tests that match that expression

The following Environment Variables must be set in your shell prior to running acceptance tests:

• ARM_CLIENT_ID
• ARM_CLIENT_SECRET
• ARM_SUBSCRIPTION_ID
• ARM_TENANT_ID
• ARM_ENVIRONMENT
• ARM_METADATA_HOST
• ARM_TEST_LOCATION
• ARM_TEST_LOCATION_ALT
• ARM_TEST_LOCATION_ALT2

Note: Acceptance tests create real resources in Azure which often cost money to run.

Developer: Using the locally compiled Azure Provider binary

When using Terraform 0.14 and later, after successfully compiling the Azure Provider, you must instruct Terraform to use your locally compiled provider binary instead of the official binary from the Terraform Registry.

For example, add the following to ~/.terraformrc for a provider binary located in /home/developer/go/bin:

provider_installation {

  # Use /home/developer/go/bin as an overridden package directory
  # for the Azure/azapi provider. This disables the version and checksum
  # verifications for this provider and forces Terraform to look for the
  # azapi provider plugin in the given directory.
  dev_overrides {
    "Azure/azapi" = "/home/developer/go/bin"
  }

  # For all other providers, install them directly from their origin provider
  # registries as normal. If you omit this, Terraform will _only_ use
  # the dev_overrides block, and so no other providers will be available.
  direct {}
}

Credits

We wish to thank HashiCorp for the use of some MPLv2-licensed code from their open source project terraform-provider-azurerm.