Tutoriel : Ajouter une ressource à votre modèle ARM

Article
06/20/2024

Dans le tutoriel précédent, vous avez appris à créer et à déployer votre premier modèle Azure Resource Manager (modèle ARM) vide. Vous voici prêt à déployer une ressource réelle sur ce modèle. Dans ce cas, un compte de stockage Azure. Cette instruction prend 9 minutes.

Prérequis

Nous vous recommandons de suivre le tutoriel de présentation sur les modèles, mais ce n’est pas obligatoire.

Visual Studio Code doit être installé et compatible avec l’extension Azure Resource Manager Tools et, au choix, Azure PowerShell ou l’interface de ligne de commande Azure (CLI). Pour plus d’informations, consultez les outils de modèle.

Ajouter une ressource

Pour ajouter une définition de compte de stockage Azure au modèle existant, examinez le fichier JSON mis en évidence dans l’exemple suivant. Plutôt que d’essayer de copier des sections du modèle, copiez l’intégralité du fichier et remplacez votre modèle par son contenu.

Remplacez {provide-unique-name} et les accolades {} par un nom de compte de stockage unique.

Important

Le nom du compte de stockage doit être unique dans Azure. Il ne s’agit que de lettres minuscules ou de chiffres et il est limité à 24 caractères. Vous pouvez utiliser un nom comme store1 en tant que préfixe, puis ajouter vos initiales et la date du jour. Le nom, par exemple, peut être store1abc06132022.

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "resources": [
    {
      "type": "Microsoft.Storage/storageAccounts",
      "apiVersion": "2021-09-01",
      "name": "{provide-unique-name}",
      "location": "eastus",
      "sku": {
        "name": "Standard_LRS"
      },
      "kind": "StorageV2",
      "properties": {
        "supportsHttpsTrafficOnly": true
      }
    }
  ]
}

Trouver un nom unique pour un compte de stockage n’est pas facile, et ne fonctionne pas bien dans l’automatisation des déploiements à grande échelle. Plus loin dans cette série de tutoriels, vous utiliserez des fonctionnalités de modèle qui aident à la création d’un nom unique.

Propriétés de la ressource

Vous vous demandez peut-être comment trouver les propriétés à utiliser pour chaque type de ressource. Vous pouvez utiliser la référence de modèle ARM pour rechercher les types de ressources que vous souhaitez déployer.

Chaque ressource que vous déployez présente au moins les trois propriétés suivantes :

type : Type de la ressource. Cette valeur est une combinaison de l’espace de noms du fournisseur de ressources et du type de ressource (comme Microsoft.Storage/storageAccounts).
apiVersion : La version de l'API REST à utiliser pour la création de la ressource. Chaque fournisseur de ressources publiant ses propres versions d’API, cette valeur est donc propre au type.
name : Nom de la ressource.

La plupart des ressources possèdent également une propriété location, qui définit la région dans laquelle vous déployez la ressource.

Les autres propriétés varient selon le type de la ressource et la version de l’API. Il est important de comprendre le lien existant entre la version de l’API et les propriétés disponibles. Voyons donc cela d’un peu plus près.

Dans ce tutoriel, vous ajoutez un compte de stockage au modèle. Vous pouvez voir que la version d’API du compte de stockage est storageAccounts 2021-09-01. Notez que vous n’ajoutez pas toutes les propriétés à votre modèle. Beaucoup de ces propriétés sont facultatives. Le fournisseur de ressources Microsoft.Storage peut publier une nouvelle version de l’API, pour autant la version que vous déployez ne doit pas nécessairement être changée. Vous pouvez continuer à utiliser cette version tout en sachant que les résultats de votre déploiement sont cohérents.

Si la version d’API affichée est plus ancienne, vous verrez peut-être qu’un ensemble de propriétés plus restreint est disponible.

Si vous décidez de modifier la version de l’API pour une ressource, veillez à évaluer les propriétés de cette version et à ajuster votre modèle en conséquence.

Déployer un modèle

Vous pouvez déployer le modèle pour créer le compte de stockage. Donnez un nom différent à votre déploiement, afin de pouvoir le retrouver facilement dans l’historique.

Si vous n’avez pas créé le groupe de ressources, consultez Créer un groupe de ressources. L’exemple suppose que vous avez défini la variable templateFile sur le chemin du fichier de modèle, comme indiqué dans le premier tutoriel.

PowerShell
Azure CLI

New-AzResourceGroupDeployment `
  -Name addstorage `
  -ResourceGroupName myResourceGroup `
  -TemplateFile $templateFile

Pour exécuter cette commande de déploiement, vous devez disposer de la dernière version d’Azure CLI.

az deployment group create \
  --name addstorage \
  --resource-group myResourceGroup \
  --template-file $templateFile

Notes

En cas d’échec du déploiement, utilisez le commutateur verbose pour obtenir des informations sur les ressources que vous créez. Utilisez le commutateur debug pour obtenir des informations supplémentaires sur le débogage.

Ces erreurs constituent deux échecs de déploiement qui peuvent se produire :

Error: Code=AccountNameInvalid; Message={provide-unique-name} n’est pas un nom de compte de stockage valide. Le nom du compte de stockage doit comprendre entre 3 et 24 caractères, uniquement des lettres en minuscules et des nombres.

Dans le modèle, remplacez {provide-unique-name} par un nom de compte de stockage unique. Consultez Ajouter une ressource.
Error: Code=StorageAccountAlreadyTaken; Message=The storage account named store1abc09092019 est déjà pris.

Dans le modèle, essayez un autre nom de compte de stockage.

Ce déploiement prend plus de temps que celui de votre modèle vide, car vous créez un compte de stockage. Cela peut prendre environ une minute.

Vérifier le déploiement

Vous pouvez vérifier le déploiement en explorant le groupe de ressources à partir du portail Azure.

Connectez-vous au portail Azure.
Dans le menu de gauche, sélectionnez Groupes de ressources.
Cochez la case à gauche de myResourceGroup et sélectionnez myResourceGroup
Sélectionnez le groupe de ressources sur lequel vous avez effectué le déploiement.
Vous voyez qu’un compte de stockage a été déployé.
Remarquez que l’étiquette de déploiement indique maintenant : Déploiements : 2 Réussites.

Nettoyer les ressources

Si vous passez au tutoriel suivant, vous n’avez pas besoin de supprimer le groupe de ressources.

Si vous arrêtez maintenant, vous pouvez nettoyer les ressources que vous avez déployées en supprimant le groupe de ressources.

Dans le portail Azure, sélectionnez Groupe de ressources dans le menu de gauche.
Tapez le nom du groupe de ressources dans la zone Filtre pour n’importe quel champ....
Cochez la case en regard de myResourceGroup et sélectionnez myResourceGroup ou le nom du groupe de ressources que vous avez choisi.
Sélectionnez Supprimer le groupe de ressources dans le menu supérieur.

Étapes suivantes

Vous avez créé un modèle simple pour déployer un compte de stockage Azure. Dans les tutoriels suivants, vous allez découvrir comment ajouter des paramètres, des variables, des ressources et des sorties à un modèle. Ces fonctionnalités constituent les composants élémentaires de modèles bien plus complexes.

Ajouter des paramètres

Partager via