Démarrage rapide : Répertorier les 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.

Dans cet article, vous utilisez la source de données azapi_resource_list pour répertorier les ressources Azure et filtrer les résultats avec JMESPath expressions. Vous créez deux comptes de stockage, puis utilisez-les azapi_resource_list pour répertorier et extraire leurs propriétés.

  • Créer un groupe de ressources et deux comptes de stockage avec le fournisseur AzureRM
  • Permet azapi_resource_list de répertorier les comptes de stockage et d’extraire leurs noms et emplacements à l’aide de JMESPath

Prerequisites

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

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.

Comprendre response_export_values

L’attribut response_export_values contrôle les propriétés extraites de la réponse de l’API et mis à disposition dans l’attribut output de la source de données. Il accepte une liste ou une carte :

  • Liste : spécifie les chemins JSON à extraire. Utilisez ["*"] pour exporter le corps de réponse complet.
  • Carte: utilise des expressions JMESPath pour filtrer et remodeler la réponse. La clé est le nom du résultat et la valeur est l’expression JMESPath.

Le formulaire de carte est préféré lorsque vous devez extraire des champs spécifiques ou transformer des réponses de liste, car il produit des valeurs de sortie plus propres et plus utilisables.

Implémenter le code Terraform

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

  2. 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" {}

  3. 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."
}

  4. 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" {
  count                    = 2
  name                     = "st${random_string.storage_suffix.result}${count.index}"
  resource_group_name      = azurerm_resource_group.example.name
  location                 = azurerm_resource_group.example.location
  account_tier             = "Standard"
  account_replication_type = "LRS"
}

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.

Répertorier les ressources avec azapi_resource_list

Maintenant que les comptes de stockage sont créés, ajoutez une source de données pour les répertorier et extraire des propriétés à l’aide de JMESPath.

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

    data "azapi_resource_list" "storage_accounts" {
  type      = "Microsoft.Storage/storageAccounts@2023-01-01"
  parent_id = azurerm_resource_group.example.id

  # Use JMESPath expressions to extract specific fields from the response.
  # The API returns a list of resources in a top-level "value" array.
  response_export_values = {
    "names"     = "value[].name"
    "locations" = "value[].location"
    "skus"      = "value[].sku.name"
  }
}

  2. 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_names" {
  value = data.azapi_resource_list.storage_accounts.output.names
}

output "storage_account_locations" {
  value = data.azapi_resource_list.storage_accounts.output.locations
}

output "storage_account_skus" {
  value = data.azapi_resource_list.storage_accounts.output.skus
}

  3. Réexécutez terraform apply pour créer la source de données et extraire les sorties :

    terraform apply

Points clés sur azapi_resource_list

  • Le type champ identifie le type de ressource et la version de l’API à répertorier.
  • Le parent_id champ définit l’étendue : un ID de groupe de ressources à répertorier dans un groupe de ressources, un ID d’abonnement à répertorier dans un abonnement ou un ID de ressource parent pour répertorier les ressources enfants (par exemple, sous-réseaux sous un réseau virtuel).
  • La forme de mappage de response_export_values utilise des expressions JMESPath sur la réponse brute de l'API. L’API de liste de comptes de stockage retourne des résultats dans un tableau de niveau value supérieur. Par conséquent, les expressions commencent par value[].

Répertorier les ressources à différents niveaux

Détermine parent_id la portée de la liste. Exemples :

# List all storage accounts in a subscription
data "azapi_resource_list" "all_storage" {
  type      = "Microsoft.Storage/storageAccounts@2023-01-01"
  parent_id = "/subscriptions/${var.subscription_id}"
  response_export_values = {
    "names" = "value[].name"
  }
}

# List subnets in a virtual network (child resource listing)
data "azapi_resource_list" "subnets" {
  type      = "Microsoft.Network/virtualNetworks/subnets@2023-11-01"
  parent_id = azurerm_virtual_network.example.id
  response_export_values = ["*"]
}

Nettoyer les ressources

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

  1. 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é.

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

Utiliser des fonctions de fournisseur dans le fournisseur Terraform AzAPI

  • Last updated on