Démarrage rapide : Effectuer des actions de ressources Azure avec le fournisseur Terraform AzAPI

Terraform permet la définition, l’aperçu et le déploiement d’une infrastructure cloud. À l’aide de Terraform, vous créez des fichiers de configuration à l’aide de la syntaxe HCL. La syntaxe HCL vous permet de spécifier un fournisseur de services cloud, tel qu’Azure, et les éléments qui composent votre infrastructure cloud. Après avoir créé vos fichiers de configuration, vous créez un plan d’exécution qui vous permet d’afficher un aperçu de vos modifications d’infrastructure avant leur déploiement. Une fois que vous avez vérifié les modifications, vous appliquez le plan d’exécution pour déployer l’infrastructure.

Utilisez azapi_resource_action en tant que ressource Terraform managée pour effectuer des opérations impératives et à changement d’état sur les ressources Azure. Dans cet exemple, vous créez un compte de stockage Azure, puis faites pivoter ses clés d’accès.

azapi_resource_action a deux formes d’utilisation :

Ressource : effectue une opération de modification d’état pendant terraform apply. Terraform suit l'état de l'action et peut éventuellement l'inverser sur terraform destroy.
Source de données : effectue une opération en lecture seule pendant la planification. Consultez le guide de démarrage rapide de la source de données d’action de ressource pour ce scénario.

Utilisez le formulaire de ressource lorsque vous avez besoin de Terraform pour effectuer une opération de Azure qui n'est pas basée sur un cycle de vie de création/lecture/mise à jour/suppression standard, par exemple, en faisant pivoter les informations d'identification, en démarrant ou en arrêtant une machine virtuelle ou en déclenchant un basculement.

Créer un compte de stockage avec le fournisseur AzureRM
Faire pivoter la clé d’accès du compte de stockage avec azapi_resource_action

Prerequisites

Abonnement Azure : si vous n’avez pas d’abonnement Azure, créez un compte gratuit avant de commencer.

Configurez Terraform : Si ce n’est déjà fait, configurez Terraform à l’aide de l’une des options suivantes :

Lorsque vous vous connectez au portail Azure avec un compte Microsoft, l’abonnement Azure par défaut pour ce compte est utilisé.

Terraform s’authentifie automatiquement à l’aide d’informations de l’abonnement Azure par défaut.

Exécutez az account show pour vérifier le compte Microsoft actuel et l’abonnement Azure.

az account show

Toutes les modifications que vous apportez via Terraform se trouvent sur l’abonnement Azure affiché. Si c’est ce que vous voulez, ignorez le reste de cet article.

Implémenter le code Terraform

Créez un répertoire dans lequel tester l’exemple de code Terraform et définissez-le comme répertoire actuel.

Créez un fichier nommé providers.tf et insérez le code suivant :

terraform {
  required_providers {
    azapi = {
      source  = "Azure/azapi"
      version = "~> 2.0"
    }
    azurerm = {
      source  = "hashicorp/azurerm"
      version = "~> 4.0"
    }
    random = {
      source  = "hashicorp/random"
      version = "~> 3.0"
    }
  }
}

provider "azurerm" {
  features {}
}

provider "azapi" {}

Créez un fichier nommé variables.tf et insérez le code suivant :

variable "resource_group_location" {
  type        = string
  default     = "eastus"
  description = "Location of the resource group."
}

variable "resource_group_name_prefix" {
  type        = string
  default     = "rg"
  description = "Prefix of the resource group name that's combined with a random value to create a unique name."
}

variable "storage_account_name_prefix" {
  type        = string
  default     = "st"
  description = "Prefix of the storage account name that's combined with a random value to create a unique name."
}

Créez un fichier nommé main.tf et insérez le code suivant :

resource "random_pet" "rg_name" {
  prefix = var.resource_group_name_prefix
}

resource "random_string" "storage_suffix" {
  length  = 8
  upper   = false
  special = false
}

resource "azurerm_resource_group" "example" {
  location = var.resource_group_location
  name     = random_pet.rg_name.id
}

resource "azurerm_storage_account" "example" {
  name                     = "${var.storage_account_name_prefix}${random_string.storage_suffix.result}"
  resource_group_name      = azurerm_resource_group.example.name
  location                 = azurerm_resource_group.example.location
  account_tier             = "Standard"
  account_replication_type = "LRS"
}

resource "azapi_resource_action" "regenerate_key" {
  type        = "Microsoft.Storage/storageAccounts@2023-01-01"
  resource_id = azurerm_storage_account.example.id
  action      = "regenerateKey"
  method      = "POST"

  body = {
    keyName = "key1"
  }
}

Points clés sur l’utilisation azapi_resource_action en tant que ressource :

Le action champ spécifie l’opération ARM à effectuer. Pour la rotation des clés de compte de stockage, utilisez regenerateKey.
Le method champ spécifie la méthode HTTP. La plupart des actions impératives utilisent POST.
L’attribut body transmet les données à l’action. Pour la régénération des clés, spécifiez la clé (key1 ou key2) à faire pivoter.
L’action est effectuée pendant terraform apply et suivie dans l’état Terraform.

Créez un fichier nommé outputs.tf et insérez le code suivant :

output "resource_group_name" {
  value = azurerm_resource_group.example.name
}

output "storage_account_name" {
  value = azurerm_storage_account.example.name
}

Exécutez terraform init pour initialiser le déploiement Terraform. Cette commande télécharge le fournisseur Azure requis pour gérer vos ressources Azure.

terraform init -upgrade

Points clés :

Le paramètre -upgrade met à niveau les plug-ins de fournisseur nécessaires vers la version la plus récente qui est conforme aux contraintes de version de la configuration.

Exécutez terraform plan pour créer un plan d’exécution.

terraform plan -out main.tfplan

Points clés :

La commande terraform plan crée un plan d’exécution, mais ne l’exécute pas. Au lieu de cela, il détermine les actions nécessaires pour créer la configuration spécifiée dans vos fichiers de configuration. Ce modèle vous permet de vérifier si le plan d’exécution correspond à vos attentes avant d’apporter des modifications aux ressources réelles.
Le paramètre facultatif -out vous permet de spécifier un fichier de sortie pour le plan. L’utilisation du paramètre -out garantit que le plan que vous avez examiné correspond exactement à ce qui est appliqué.

Exécutez terraform apply pour appliquer le plan d’exécution à votre infrastructure cloud.

terraform apply main.tfplan

Points clés :

La commande exemple terraform apply part du principe que vous avez préalablement exécuté terraform plan -out main.tfplan.
Si vous avez spécifié un autre nom de fichier pour le paramètre -out, utilisez ce même nom dans l’appel à terraform apply.
Si vous n’avez pas utilisé le paramètre -out, appelez terraform apply sans aucun paramètre.

Vérifier les résultats

Une fois terraform apply terminée, la clé de compte de stockage a été pivotée. Vous pouvez vérifier la rotation des clés en vérifiant les clés du compte de stockage dans Azure.

Service de contrôle d’accès Azure (CLI)
Azure PowerShell

Exécutez az storage account keys list pour afficher les clés du compte de stockage.

az storage account keys list \
  --resource-group <resource_group_name> \
  --account-name <storage_account_name>

Le value champ affiche la clé active.

Exécutez Get-AzStorageAccountKey pour afficher les clés du compte de stockage.

Get-AzStorageAccountKey `
  -ResourceGroupName <resource_group_name> `
  -Name <storage_account_name>

La Value propriété affiche la clé active.

Exemples d’autres actions de ressources

La ressource azapi_resource_action fonctionne avec de nombreuses opérations de Azure. Voici des exemples courants :

Machines Virtuelles : deallocate, start, restart, powerOff, reimage
Coffres de clés : purge (pour les coffres supprimés de manière réversible), rotate (pour les clés gérées)
App Services : swap (pour les emplacements de déploiement), restart
Bases de données : failover, promote
Ressources de calcul : toute opération exposée par l’API REST Azure qui modifie l’état sans créer ni détruire une ressource.

Nettoyer les ressources

Lorsque vous n’avez plus besoin des ressources créées via Terraform, procédez comme suit :

Exécutez le plan Terraform et spécifiez l’indicateur destroy.
```
terraform plan -destroy -out main.destroy.tfplan
```
Points clés :
- La commande terraform plan crée un plan d’exécution, mais ne l’exécute pas. Au lieu de cela, il détermine les actions nécessaires pour créer la configuration spécifiée dans vos fichiers de configuration. Ce modèle vous permet de vérifier si le plan d’exécution correspond à vos attentes avant d’apporter des modifications aux ressources réelles.
- Le paramètre facultatif -out vous permet de spécifier un fichier de sortie pour le plan. L’utilisation du paramètre -out garantit que le plan que vous avez examiné correspond exactement à ce qui est appliqué.
Exécutez terraform apply pour appliquer le plan d’exécution.
```
terraform apply main.destroy.tfplan
```

Résoudre les problèmes de Terraform sur Azure

Résoudre les problèmes courants liés à l’utilisation de Terraform sur Azure

Étapes suivantes

Vue d’ensemble du fournisseur Terraform AzAPI

Découvrez comment utiliser l’action de ressource AzAPI comme source de données

Commentaires

Cette page a-t-elle été utile ?

Last updated on 2026-05-06

Démarrage rapide : Effectuer des actions de ressources Azure avec le fournisseur Terraform AzAPI

Prerequisites

Implémenter le code Terraform

Vérifier les résultats

Exemples d’autres actions de ressources

Nettoyer les ressources

Résoudre les problèmes de Terraform sur Azure

Étapes suivantes

Commentaires

Ressources supplémentaires