Terraform Provider for MSGraph Rest API

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

Get started with MSGraph

• Microsoft Terraform VSCode Extension provides a rich authoring experience to help you use the MSGraph provider.

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

Usage Example

The following example shows how to use msgraph_resource to manage application resource.

terraform {
  required_providers {
    msgraph = {
      source  = "Microsoft/msgraph"
    }
  }
}

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

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

resource "msgraph_resource" "application" {
  url  = "applications"
  body = {
    displayName = "My Application"
  }
}

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/Microsoft/terraform-provider-msgraph

mkdir -p $GOPATH/src/github.com/Microsoft; cd $GOPATH/src/github.com/Microsoft
git clone git@github.com:Microsoft/terraform-provider-msgraph.git
cd $GOPATH/src/github.com/Microsoft/terraform-provider-msgraph

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-msgraph
...

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_TENANT_ID

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

Generating Documentation

We use tfplugindocs to automatically generate documentation for the provider. Please ensure that the MarkdownDescription field is set in the schema for each resource and data source.

To generate the documentation run either:

$ make docs

or...

$ go generate ./...

Templates

Each resource is documented using a template. The template is located in the templates directory. The template is a markdown file with placeholders that are replaced with the actual values from the schema. There is a general template for all resources/data sources, and an optional specific template for each resource/data source where customization is required.

Guides

Guides should be stored in the templates/guides directory. They will be inclided in the documentation and copied to the docs directory by the tfplugindocs tool.

Examples

The examples/resources and examples/data-sources directory contains examples for each resource and data source. The examples are used to generate the documentation for each resource and data source. The examples are written in HCL and must be called resource.tf or data-source.tf. These are then embedded into the documentation and are used to generate the Example section.

---

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 Microsoft/msgraph provider. This disables the version and checksum
  # verifications for this provider and forces Terraform to look for the
  # msgraph provider plugin in the given directory.
  dev_overrides {
    "Microsoft/msgraph" = "/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-azuread.