How to Import an Existing Azure Resource into Your Terraform State with Azure Storage Backend
Have you ever for any reason didn’t had your Azure resource under Terraform and want to starting managing it by the HashCorp Tool? In this step-by-step guide, we’ll walk you through the process of importing an existing Azure resource into your Terraform state file, where your backend is configured to use an Azure Storage Account.
Preparing the Backend: Creating the Storage Account for State Management
Before we start, we need to set up an Azure Storage Account, which will be the backend for your Terraform state files. This ensures that your state is kept in a secure, centralized location, making it easier to manage, especially when working within a team.
The Azure CLI script below will create a Resource Group and a Storage Account with the container, where the state files will be created later:
az group create -l uksouth -n rg-tfstate
az storage account create -n sttfstateimport -g rg-tfstate
az storage container create -n tfstate --account-name sttfstateimportPreparation of the Terraform File
Now that our Azure backend ready, lets configure the Terraform files to use it.
We will first add the azurerm backend, to do so, we will need to provide the the details from the storage account created previously, it will be required the storage account name, container name, the resource group, and the key of our workload. After that, we will create a simple resource group:
provider "azurerm" {
features {}
}
terraform {
backend "azurerm" {
container_name = "tfstate"
key = "myworkload"
resource_group_name = "rg-tfstate"
storage_account_name = "sttfstateimport"
}
}
# Create a resource group
resource "azurerm_resource_group" "example" {
name = "rg-myresourcegroup"
location = "UKSouth"
}Initialize the Terraform workspace and apply the changes:
terraform init;
terraform apply;Terraform State file
After the creation of this resource, lets check the state file hosted on our storage account. Note that we only have the resource group being managed by Terraform.
{
"version": 4,
"terraform_version": "1.6.5",
"serial": 5,
"lineage": "f5c71b49-ac3a-e0ec-2529-b017b3c3965f",
"outputs": {},
"resources": [
{
"mode": "managed",
"type": "azurerm_resource_group",
"name": "example",
"provider": "provider[\"registry.terraform.io/hashicorp/azurerm\"]",
"instances": [
{
"schema_version": 0,
"attributes": {
"id": "/subscriptions/337ba254-3aa0-4551-ba8e-89debefaa373/resourceGroups/rg-myresourcegroup",
"location": "uksouth",
"managed_by": "",
"name": "rg-myresourcegroup",
"tags": {},
"timeouts": null
},
"sensitive_attributes": [],
"private": "eyJlMmJmYjczMC1lY2FhLTExZTYtOGY4OC0zNDM2M2JjN2M0YzAiOnsiY3JlYXRlIjo1NDAwMDAwMDAwMDAwLCJkZWxldGUiOjU0MDAwMDAwMDAwMDAsInJlYWQiOjMwMDAwMDAwMDAwMCwidXBkYXRlIjo1NDAwMDAwMDAwMDAwfX0="
}
]
}
],
"check_results": null
}Creation of Resource Outside Terraform Using Azure CLI
Sometimes, resources are created outside of Terraform, maybe manually or through scripts, or they might even be there before we start to adopt an Infra as Code strategy. In our case we will simulate it using Azure CLI. Create the Azure resource you want to manage with Terraform. For example, you can create a storage account, VM, or any other resource.
az storage account create -n sttoimport -g rg-myresourcegroupAfter the resource creation, note the id of the resource. It will be needed later for the import process:
The Import Process on Terraform
Now that we have our resource and the Terraform backend is ready, we can import the existing resource into the Terraform state
Write a Terraform resource block in your configuration file that corresponds to the resource you created. Make sure the name and type match the Azure resource.
resource "azurerm_storage_account" "example" {
name = "sttoimport"
resource_group_name = azurerm_resource_group.example.name
location = azurerm_resource_group.example.location
account_tier = "Standard"
account_replication_type = "LRS"
}If you try to apply, an error message will appear, stating that the resource already existis and must be imported
The simplest way to achieve this is by adding the import block of code into your tf file. You will need to specify the if of the resource (that one we noted before) and to which resource it should be imported.
import {
to = azurerm_storage_account.example
id = "/subscriptions/<subscription id>/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/stportalcreated"
}
# # Create a storage account
resource "azurerm_storage_account" "example" {
name = "sttoimport"
resource_group_name = azurerm_resource_group.example.name
location = azurerm_resource_group.example.location
account_tier = "Standard"
account_replication_type = "LRS"
}After adding it, run terraform apply once again.
Terraform State file
Now we can check once again our Terraform state file. We can note that it’s much more extense, and has not only the resource group as in the first deployment, but the storage account as well.
{
"version": 4,
"terraform_version": "1.6.5",
"serial": 6,
"lineage": "f5c71b49-ac3a-e0ec-2529-b017b3c3965f",
"outputs": {},
"resources": [
{
"mode": "managed",
"type": "azurerm_resource_group",
"name": "example",
"provider": "provider[\"registry.terraform.io/hashicorp/azurerm\"]",
"instances": [
{
"schema_version": 0,
"attributes": {
"id": "/subscriptions/337ba254-3aa0-4551-ba8e-89debefaa373/resourceGroups/rg-myresourcegroup",
"location": "uksouth",
"managed_by": "",
"name": "rg-myresourcegroup",
"tags": {},
"timeouts": null
},
"sensitive_attributes": [],
"private": "eyJlMmJmYjczMC1lY2FhLTExZTYtOGY4OC0zNDM2M2JjN2M0YzAiOnsiY3JlYXRlIjo1NDAwMDAwMDAwMDAwLCJkZWxldGUiOjU0MDAwMDAwMDAwMDAsInJlYWQiOjMwMDAwMDAwMDAwMCwidXBkYXRlIjo1NDAwMDAwMDAwMDAwfX0="
}
]
},
{
"mode": "managed",
"type": "azurerm_storage_account",
"name": "example",
"provider": "provider[\"registry.terraform.io/hashicorp/azurerm\"]",
"instances": [
{
"schema_version": 4,
"attributes": {
"access_tier": "Hot",
"account_kind": "StorageV2",
"account_replication_type": "LRS",
"account_tier": "Standard",
"allow_nested_items_to_be_public": true,
"allowed_copy_scope": "",
"azure_files_authentication": [],
"blob_properties": [
{
"change_feed_enabled": false,
"change_feed_retention_in_days": 0,
"container_delete_retention_policy": [],
"cors_rule": [],
"default_service_version": "",
"delete_retention_policy": [],
"last_access_time_enabled": false,
"restore_policy": [],
"versioning_enabled": false
}
],
"cross_tenant_replication_enabled": true,
"custom_domain": [],
"customer_managed_key": [],
"default_to_oauth_authentication": false,
"edge_zone": "",
"enable_https_traffic_only": true,
"id": "/subscriptions/337ba254-3aa0-4551-ba8e-89debefaa373/resourceGroups/rg-myresourcegroup/providers/Microsoft.Storage/storageAccounts/sttoimport",
"identity": [],
"immutability_policy": [],
"infrastructure_encryption_enabled": false,
"is_hns_enabled": false,
"large_file_share_enabled": null,
"local_user_enabled": true,
"location": "uksouth",
"min_tls_version": "TLS1_2",
"name": "sttoimport",
"network_rules": [
{
"bypass": [
"AzureServices"
],
"default_action": "Allow",
"ip_rules": [],
"private_link_access": [],
"virtual_network_subnet_ids": []
}
],
"nfsv3_enabled": false,
"primary_access_key": "Jsqu2+nBI94oAWKMw5JkcLppmHexljMQClHNuRrBcSTf0XCF7P7F1lGHmwa/Ux9yqhI+EWbp1rtN+ASt+jc+rQ==",
"primary_blob_connection_string": "DefaultEndpointsProtocol=https;BlobEndpoint=https://sttoimport.blob.core.windows.net/;AccountName=sttoimport;AccountKey=Jsqu2+nBI94oAWKMw5JkcLppmHexljMQClHNuRrBcSTf0XCF7P7F1lGHmwa/Ux9yqhI+EWbp1rtN+ASt+jc+rQ==",
"primary_blob_endpoint": "https://sttoimport.blob.core.windows.net/",
"primary_blob_host": "sttoimport.blob.core.windows.net",
"primary_blob_internet_endpoint": null,
"primary_blob_internet_host": null,
"primary_blob_microsoft_endpoint": null,
"primary_blob_microsoft_host": null,
"primary_connection_string": "DefaultEndpointsProtocol=https;AccountName=sttoimport;AccountKey=Jsqu2+nBI94oAWKMw5JkcLppmHexljMQClHNuRrBcSTf0XCF7P7F1lGHmwa/Ux9yqhI+EWbp1rtN+ASt+jc+rQ==;EndpointSuffix=core.windows.net",
"primary_dfs_endpoint": "https://sttoimport.dfs.core.windows.net/",
"primary_dfs_host": "sttoimport.dfs.core.windows.net",
"primary_dfs_internet_endpoint": null,
"primary_dfs_internet_host": null,
"primary_dfs_microsoft_endpoint": null,
"primary_dfs_microsoft_host": null,
"primary_file_endpoint": "https://sttoimport.file.core.windows.net/",
"primary_file_host": "sttoimport.file.core.windows.net",
"primary_file_internet_endpoint": null,
"primary_file_internet_host": null,
"primary_file_microsoft_endpoint": null,
"primary_file_microsoft_host": null,
"primary_location": "uksouth",
"primary_queue_endpoint": "https://sttoimport.queue.core.windows.net/",
"primary_queue_host": "sttoimport.queue.core.windows.net",
"primary_queue_microsoft_endpoint": null,
"primary_queue_microsoft_host": null,
"primary_table_endpoint": "https://sttoimport.table.core.windows.net/",
"primary_table_host": "sttoimport.table.core.windows.net",
"primary_table_microsoft_endpoint": null,
"primary_table_microsoft_host": null,
"primary_web_endpoint": "https://sttoimport.z33.web.core.windows.net/",
"primary_web_host": "sttoimport.z33.web.core.windows.net",
"primary_web_internet_endpoint": null,
"primary_web_internet_host": null,
"primary_web_microsoft_endpoint": null,
"primary_web_microsoft_host": null,
"public_network_access_enabled": true,
"queue_encryption_key_type": "Service",
"queue_properties": [
{
"cors_rule": [],
"hour_metrics": [
{
"enabled": true,
"include_apis": true,
"retention_policy_days": 7,
"version": "1.0"
}
],
"logging": [
{
"delete": false,
"read": false,
"retention_policy_days": 0,
"version": "1.0",
"write": false
}
],
"minute_metrics": [
{
"enabled": false,
"include_apis": false,
"retention_policy_days": 0,
"version": "1.0"
}
]
}
],
"resource_group_name": "rg-myresourcegroup",
"routing": [],
"sas_policy": [],
"secondary_access_key": "Zei+/3BIXCDaSg1n5RO46R6T5wWfItXH5ZtUKDSycQfIf3cKbQ+MXKx9LWukoporypPDcVI1Lldk+AStImwQJQ==",
"secondary_blob_connection_string": "",
"secondary_blob_endpoint": "https://sttoimport-secondary.blob.core.windows.net/",
"secondary_blob_host": "sttoimport-secondary.blob.core.windows.net",
"secondary_blob_internet_endpoint": null,
"secondary_blob_internet_host": null,
"secondary_blob_microsoft_endpoint": null,
"secondary_blob_microsoft_host": null,
"secondary_connection_string": "DefaultEndpointsProtocol=https;AccountName=sttoimport;AccountKey=Zei+/3BIXCDaSg1n5RO46R6T5wWfItXH5ZtUKDSycQfIf3cKbQ+MXKx9LWukoporypPDcVI1Lldk+AStImwQJQ==;EndpointSuffix=core.windows.net",
"secondary_dfs_endpoint": "https://sttoimport-secondary.dfs.core.windows.net/",
"secondary_dfs_host": "sttoimport-secondary.dfs.core.windows.net",
"secondary_dfs_internet_endpoint": null,
"secondary_dfs_internet_host": null,
"secondary_dfs_microsoft_endpoint": null,
"secondary_dfs_microsoft_host": null,
"secondary_file_endpoint": "",
"secondary_file_host": "",
"secondary_file_internet_endpoint": null,
"secondary_file_internet_host": null,
"secondary_file_microsoft_endpoint": null,
"secondary_file_microsoft_host": null,
"secondary_location": "",
"secondary_queue_endpoint": "https://sttoimport-secondary.queue.core.windows.net/",
"secondary_queue_host": "sttoimport-secondary.queue.core.windows.net",
"secondary_queue_microsoft_endpoint": null,
"secondary_queue_microsoft_host": null,
"secondary_table_endpoint": "https://sttoimport-secondary.table.core.windows.net/",
"secondary_table_host": "sttoimport-secondary.table.core.windows.net",
"secondary_table_microsoft_endpoint": null,
"secondary_table_microsoft_host": null,
"secondary_web_endpoint": "https://sttoimport-secondary.z33.web.core.windows.net/",
"secondary_web_host": "sttoimport-secondary.z33.web.core.windows.net",
"secondary_web_internet_endpoint": null,
"secondary_web_internet_host": null,
"secondary_web_microsoft_endpoint": null,
"secondary_web_microsoft_host": null,
"sftp_enabled": false,
"share_properties": [
{
"cors_rule": [],
"retention_policy": [
{
"days": 7
}
],
"smb": []
}
],
"shared_access_key_enabled": true,
"static_website": [],
"table_encryption_key_type": "Service",
"tags": {},
"timeouts": null
},
"sensitive_attributes": [],
"private": "eyJlMmJmYjczMC1lY2FhLTExZTYtOGY4OC0zNDM2M2JjN2M0YzAiOnsiY3JlYXRlIjozNjAwMDAwMDAwMDAwLCJkZWxldGUiOjM2MDAwMDAwMDAwMDAsInJlYWQiOjMwMDAwMDAwMDAwMCwidXBkYXRlIjozNjAwMDAwMDAwMDAwfSwic2NoZW1hX3ZlcnNpb24iOiI0In0=",
"dependencies": [
"azurerm_resource_group.example"
]
}
]
}
],
"check_results": null
}Conclusion
Integrating existing Azure resources into Terraform doesn’t have to be complex. By following the steps described in this guide, you can quickly and efficiently bring your Azure infrastructure under Terraform’s infrastructure-as-code management. Happy coding!
