Démarrage rapide : Créer et déployer une spec de modèle

Ce guide de démarrage rapide montre comment empaqueter un modèle Azure Resource Manager (modèle ARM) dans une spec de modèle. Ensuite, vous déployez cette spec de modèle. Votre spec de modèle contient un modèle ARM qui déploie un compte de stockage.

Conseil

Nous recommandons Bicep parce qu’il offre les mêmes fonctionnalités que les modèles ARM et que la syntaxe est plus facile d’utilisation. Pour en savoir plus, consultez Démarrage rapide : Créer et déployer un spec de modèle avec Bicep.

Prérequis

Compte Azure avec un abonnement actif. Créez un compte gratuitement.

Notes

Pour utiliser la spec de modèle avec Azure PowerShell, vous devez installer la version 5.0.0 ou ultérieure. Pour l’utiliser avec Azure CLI, utilisez la version 2.14.2 ou ultérieure.

Créer un modèle

Vous créez une spec de modèle à partir d’un modèle local. Copiez le modèle suivant et enregistrez-le localement dans un fichier nommé azuredeploy.json. Ce démarrage rapide part du principe que vous avez enregistré dans le chemin d’accès c:\Templates\azuredeploy.json, mais vous pouvez utiliser n’importe quel chemin.

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "metadata": {
    "_generator": {
      "name": "bicep",
      "version": "0.13.1.58284",
      "templateHash": "13120038605368246703"
    }
  },
  "parameters": {
    "storageAccountType": {
      "type": "string",
      "defaultValue": "Standard_LRS",
      "allowedValues": [
        "Premium_LRS",
        "Premium_ZRS",
        "Standard_GRS",
        "Standard_GZRS",
        "Standard_LRS",
        "Standard_RAGRS",
        "Standard_RAGZRS",
        "Standard_ZRS"
      ],
      "metadata": {
        "description": "Storage Account type"
      }
    },
    "location": {
      "type": "string",
      "defaultValue": "[resourceGroup().location]",
      "metadata": {
        "description": "The storage account location."
      }
    },
    "storageAccountName": {
      "type": "string",
      "defaultValue": "[format('store{0}', uniqueString(resourceGroup().id))]",
      "metadata": {
        "description": "The name of the storage account"
      }
    }
  },
  "resources": [
    {
      "type": "Microsoft.Storage/storageAccounts",
      "apiVersion": "2022-09-01",
      "name": "[parameters('storageAccountName')]",
      "location": "[parameters('location')]",
      "sku": {
        "name": "[parameters('storageAccountType')]"
      },
      "kind": "StorageV2",
      "properties": {}
    }
  ],
  "outputs": {
    "storageAccountName": {
      "type": "string",
      "value": "[parameters('storageAccountName')]"
    },
    "storageAccountId": {
      "type": "string",
      "value": "[resourceId('Microsoft.Storage/storageAccounts', parameters('storageAccountName'))]"
    }
  }
}

Créer une spec de modèle

La spec de modèle est un type de ressource nommé Microsoft.Resources/templateSpecs. Pour créer une spec de modèle, utilisez PowerShell, Azure CLI, le portail ou un modèle ARM.

PowerShell

1. Créez un groupe de ressources pour contenir la spec de modèle.

   New-AzResourceGroup `
     -Name templateSpecRG `
     -Location westus2
   

2. Créez la spec de modèle dans ce groupe de ressources. Attribuez le nom storageSpec à la nouvelle spec de modèle.

   New-AzTemplateSpec `
     -Name storageSpec `
     -Version "1.0" `
     -ResourceGroupName templateSpecRG `
     -Location westus2 `
     -TemplateFile "c:\Templates\azuredeploy.json"
   

INTERFACE DE LIGNE DE COMMANDE

1. Créez un groupe de ressources pour contenir la spec de modèle.

   az group create \
     --name templateSpecRG \
     --location westus2
   

2. Créez la spec de modèle dans ce groupe de ressources. Attribuez le nom storageSpec à la nouvelle spec de modèle.

   az ts create \
     --name storageSpec \
     --version "1.0" \
     --resource-group templateSpecRG \
     --location "westus2" \
     --template-file "c:\Templates\azuredeploy.json"
   

Portail

1. Connectez-vous au portail Azure.

2. Recherchez specs de modèle. Sélectionnez Specs de modèle parmi les options disponibles.

   

3. Sélectionnez Importer le modèle.

   

4. Sélectionnez l’icône du dossier.

   

5. Accédez au modèle local que vous avez enregistré et sélectionnez-le. Sélectionnez Ouvrir.

6. Sélectionnez Importer.

   

7. Renseignez les valeurs suivantes :

   • Nom : entrez un nom pour la spec de modèle. Par exemple, storageSpec
   • Abonnement : sélectionnez l’abonnement Azure utilisé pour créer la spec de modèle.
   • Groupe de ressources : sélectionnez Créer nouveau, puis entrez un nouveau nom de groupe de ressources. Par exemple, templateSpecRG.
   • Emplacement : sélectionnez un emplacement pour le groupe de ressources. Par exemple, USA Ouest 2.
   • Version : entrez une version pour la spec de modèle. Utilisez 1.0.

8. Sélectionnez Vérifier + créer.

9. Sélectionnez Create (Créer).

Modèle ARM

Notes

Au lieu d’utiliser un modèle ARM, nous vous conseillons d’utiliser PowerShell ou l’interface CLI pour créer votre spec de modèle. Ces outils convertissent automatiquement les modèles liés en artefacts connectés à votre modèle principal. Lorsque vous utilisez un modèle ARM pour créer la spec de modèle, vous devez ajouter manuellement ces modèles liés en tant qu’artefacts, ce qui peut s’avérer compliqué.

1. Lorsque vous utilisez un modèle ARM pour créer la spec de modèle, le modèle est incorporé dans la définition de la ressource. Vous devez apporter certaines modifications à votre modèle local. Copiez le modèle suivant et enregistrez-le localement sous azuredeploy.json.

   Notes

   Dans le modèle incorporé, toutes les expressions de modèle doivent être échappées au moyen d’un deuxième crochet gauche. Utilisez "[[ au lieu de "[. Les tableaux JSON utilisent toujours un seul crochet gauche.

   {
     "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
     "contentVersion": "1.0.0.0",
     "parameters": {},
     "functions": [],
     "variables": {},
     "resources": [
       {
         "type": "Microsoft.Resources/templateSpecs",
         "apiVersion": "2021-05-01",
         "name": "storageSpec",
         "location": "westus2",
         "properties": {
           "displayName": "Storage template spec"
         },
         "tags": {},
         "resources": [
           {
             "type": "versions",
             "apiVersion": "2021-05-01",
             "name": "1.0",
             "location": "westus2",
             "dependsOn": [ "storageSpec" ],
             "properties": {
               "mainTemplate": {
                 "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
                 "contentVersion": "1.0.0.0",
                 "parameters": {
                   "storageAccountType": {
                     "type": "string",
                     "defaultValue": "Standard_LRS",
                     "allowedValues": [
                       "Standard_LRS",
                       "Standard_GRS",
                       "Standard_ZRS",
                       "Premium_LRS"
                     ],
                     "metadata": {
                       "description": "Storage Account type"
                     }
                   },
                   "location": {
                     "type": "string",
                     "defaultValue": "[[resourceGroup().location]",
                     "metadata": {
                       "description": "Location for all resources."
                     }
                   }
                 },
                 "variables": {
                   "storageAccountName": "[[concat('store', uniquestring(resourceGroup().id))]"
                 },
                 "resources": [
                   {
                     "type": "Microsoft.Storage/storageAccounts",
                     "apiVersion": "2022-09-01",
                     "name": "[[variables('storageAccountName')]",
                     "location": "[[parameters('location')]",
                     "sku": {
                       "name": "[[parameters('storageAccountType')]"
                     },
                     "kind": "StorageV2",
                     "properties": {}
                   }
                 ],
                 "outputs": {
                   "storageAccountName": {
                     "type": "string",
                     "value": "[[variables('storageAccountName')]"
                   }
                 }
               }
             },
             "tags": {}
           }
         ]
       }
     ],
     "outputs": {}
   }
   

2. Utilisez Azure CLI ou PowerShell pour créer un groupe de ressources.

   New-AzResourceGroup `
     -Name templateSpecRG `
     -Location westus2
   

   az group create \
     --name templateSpecRG \
     --location westus2
   

3. Déployez votre modèle avec Azure CLI ou PowerShell.

   New-AzResourceGroupDeployment `
     -ResourceGroupName templateSpecRG `
     -TemplateFile "c:\Templates\azuredeploy.json"
   

   az deployment group create \
     --resource-group templateSpecRG \
     --template-file "c:\Templates\azuredeploy.json"
   

Déployer une spec de modèle

Pour déployer une spec de modèle, utilisez les mêmes commandes de déploiement que celles que vous utiliseriez pour déployer un modèle. Transmettez l’ID de ressource de la spec de modèle à déployer.

PowerShell

1. Créez un groupe de ressources pour accueillir le nouveau compte de stockage.

   New-AzResourceGroup `
     -Name storageRG `
     -Location westus2
   

2. Obtenez l’ID de ressource de la spec de modèle.

   $id = (Get-AzTemplateSpec -ResourceGroupName templateSpecRG -Name storageSpec -Version "1.0").Versions.Id
   

3. Déployez la spec de modèle.

   New-AzResourceGroupDeployment `
     -TemplateSpecId $id `
     -ResourceGroupName storageRG
   

4. Vous fournissez les paramètres exactement comme vous le feriez pour un modèle ARM. Redéployez la spec de modèle avec un paramètre pour le type de compte de stockage.

   New-AzResourceGroupDeployment `
     -TemplateSpecId $id `
     -ResourceGroupName storageRG `
     -storageAccountType Standard_GRS
   

INTERFACE DE LIGNE DE COMMANDE

1. Créez un groupe de ressources pour accueillir le nouveau compte de stockage.

   az group create \
     --name storageRG \
     --location westus2
   

2. Obtenez l’ID de ressource de la spec de modèle.

   id=$(az ts show --name storageSpec --resource-group templateSpecRG --version "1.0" --query "id")
   

   Notes

   Il existe un problème connu lié à l’obtention de l’ID de la spec de modèle et à son attribution à une variable dans Windows PowerShell.

3. Déployez la spec de modèle.

   az deployment group create \
     --resource-group storageRG \
     --template-spec $id
   

4. Vous fournissez les paramètres exactement comme vous le feriez pour un modèle ARM. Redéployez la spec de modèle avec un paramètre pour le type de compte de stockage.

   az deployment group create \
     --resource-group storageRG \
     --template-spec $id \
     --parameters storageAccountType='Standard_GRS'
   

Portail

1. Sélectionnez la spec de modèle que vous avez créée.

   

2. Sélectionnez Déployer.

   

3. Renseignez les valeurs suivantes :

   • Abonnement : sélectionnez un abonnement Azure pour créer la ressource.
   • Groupe de ressources  : sélectionnez Créer nouveau, puis entrez storageRG.
   • Type de compte de stockage : sélectionnez Standard_GRS.

4. Sélectionnez Revoir + créer.

5. Sélectionnez Create (Créer).

Modèle ARM

1. Copiez le modèle suivant et enregistrez-le localement dans un fichier nommé storage.json.

   {
     "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
     "contentVersion": "1.0.0.0",
     "parameters": {},
     "functions": [],
     "variables": {},
     "resources": [
       {
         "type": "Microsoft.Resources/deployments",
         "apiVersion": "2021-04-01",
         "name": "demo",
         "properties": {
           "templateLink": {
             "id": "[resourceId('templateSpecRG', 'Microsoft.Resources/templateSpecs/versions', 'storageSpec', '1.0')]"
           },
           "parameters": {
           },
           "mode": "Incremental"
         }
       }
     ],
     "outputs": {}
   }
   

2. Utilisez Azure CLI ou PowerShell pour créer un groupe de ressources pour le compte de stockage.

   New-AzResourceGroup `
     -Name storageRG `
     -Location westus2
   

   az group create \
     --name storageRG \
     --location westus2
   

3. Déployez votre modèle avec Azure CLI ou PowerShell.

   New-AzResourceGroupDeployment `
     -ResourceGroupName storageRG `
     -TemplateFile "c:\Templates\storage.json"
   

   az deployment group create \
     --resource-group storageRG \
     --template-file "c:\Templates\storage.json"
   

Accorder l'accès

Si vous voulez permettre à d’autres utilisateurs de votre organisation de déployer votre spec de modèle, vous devez leur accorder un accès en lecture. Vous pouvez attribuer le rôle Lecteur à un groupe de Microsoft Entra pour le groupe de ressources contenant les specs de modèle que vous souhaitez partager. Pour plus d’informations, consultez le Tutoriel : Accorder à un groupe l’accès aux ressources Azure à l’aide d’Azure PowerShell.

Mettre à jour le modèle

Supposons que vous avez identifié une modification que vous aimeriez apporter au modèle dans votre spec de modèle. Le modèle suivant est similaire à votre précédent modèle, à ceci près qu’il ajoute un préfixe pour le nom du compte de stockage. Copiez le modèle suivant et mettez à jour votre fichier azuredeploy.json.

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "storageAccountType": {
      "type": "string",
      "defaultValue": "Standard_LRS",
      "allowedValues": [
        "Standard_LRS",
        "Standard_GRS",
        "Standard_ZRS",
        "Premium_LRS"
      ],
      "metadata": {
        "description": "Storage Account type"
      }
    },
    "location": {
      "type": "string",
      "defaultValue": "[resourceGroup().location]",
      "metadata": {
        "description": "Location for all resources."
      }
    },
    "namePrefix": {
      "type": "string",
      "maxLength": 11,
      "defaultValue": "store",
      "metadata": {
        "description": "Prefix for storage account name"
      }
    }
  },
  "variables": {
    "storageAccountName": "[concat(parameters('namePrefix'), uniquestring(resourceGroup().id))]"
  },
  "resources": [
    {
      "type": "Microsoft.Storage/storageAccounts",
      "apiVersion": "2021-04-01",
      "name": "[variables('storageAccountName')]",
      "location": "[parameters('location')]",
      "sku": {
        "name": "[parameters('storageAccountType')]"
      },
      "kind": "StorageV2",
      "properties": {}
    }
  ],
  "outputs": {
    "storageAccountName": {
      "type": "string",
      "value": "[variables('storageAccountName')]"
    }
  }
}

Mettre à jour la version de spec de modèle

Au lieu de créer une spec de modèle pour le modèle révisé, ajoutez une nouvelle version nommée 2.0 à la spec de modèle existante. Les utilisateurs peuvent choisir l’une ou l’autre version à déployer.

PowerShell

1. Créez une nouvelle version du spec de modèle.

   New-AzTemplateSpec `
     -Name storageSpec `
     -Version "2.0" `
     -ResourceGroupName templateSpecRG `
     -Location westus2 `
     -TemplateFile "c:\Templates\azuredeploy.json"
   

2. Pour déployer la nouvelle version, récupérez l’ID de ressource pour la version 2.0.

   $id = (Get-AzTemplateSpec -ResourceGroupName templateSpecRG -Name storageSpec -Version "2.0").Versions.Id
   

3. Déployez cette version. Indiquez le préfixe du nom du compte de stockage.

   New-AzResourceGroupDeployment `
     -TemplateSpecId $id `
     -ResourceGroupName storageRG `
     -namePrefix "demoaccount"
   

INTERFACE DE LIGNE DE COMMANDE

1. Créez une nouvelle version du spec de modèle.

   az ts create \
     --name storageSpec \
     --version "2.0" \
     --resource-group templateSpecRG \
     --location "westus2" \
     --template-file "c:\Templates\azuredeploy.json"
   

2. Pour déployer la nouvelle version, récupérez l’ID de ressource pour la version 2.0.

   id=$(az ts show --name storageSpec --resource-group templateSpecRG --version "2.0" --query "id")
   

3. Déployez cette version. Indiquez le préfixe du nom du compte de stockage.

   az deployment group create \
      --resource-group storageRG \
      --template-spec $id \
      --parameters namePrefix='demoaccount'
   

Portail

1. Dans votre spec de modèle, sélectionnez Créer une nouvelle version.

   

2. Nommez la nouvelle version 2.0 et ajoutez éventuellement des notes. Sélectionnez Modifier un modèle.

   

3. Remplacez le contenu du modèle par votre modèle mis à jour. Sélectionnez Vérifier + enregistrer.

4. Sélectionnez Enregistrer les modifications.

5. Pour déployer la nouvelle version, sélectionnez Versions.

   

6. Pour la version que vous souhaitez déployer, sélectionnez les trois points, puis Déployer.

   

7. Renseignez les champs comme vous l’avez fait lors du déploiement de la version antérieure.

8. Sélectionnez Revoir + créer.

9. Sélectionnez Create (Créer).

Modèle ARM

1. Là encore, vous devez apporter quelques modifications à votre modèle local pour qu’il fonctionne avec des specs de modèle. Copiez le modèle suivant et enregistrez-le localement sous azuredeploy.json.

   {
     "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
     "contentVersion": "1.0.0.0",
     "parameters": {},
     "functions": [],
     "variables": {},
     "resources": [
       {
         "type": "Microsoft.Resources/templateSpecs",
         "apiVersion": "2021-05-01",
         "name": "storageSpec",
         "location": "westus2",
         "properties": {
           "displayName": "Storage template spec"
         },
         "tags": {},
         "resources": [
           {
             "type": "versions",
             "apiVersion": "2021-05-01",
             "name": "2.0",
             "location": "westus2",
             "dependsOn": [ "storageSpec" ],
             "properties": {
               "mainTemplate": {
                 "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
                 "contentVersion": "1.0.0.0",
                 "parameters": {
                   "storageAccountType": {
                     "type": "string",
                     "defaultValue": "Standard_LRS",
                     "allowedValues": [
                       "Standard_LRS",
                       "Standard_GRS",
                       "Standard_ZRS",
                       "Premium_LRS"
                     ],
                     "metadata": {
                       "description": "Storage Account type"
                     }
                   },
                   "location": {
                     "type": "string",
                     "defaultValue": "[[resourceGroup().location]",
                     "metadata": {
                       "description": "Location for all resources."
                     }
                   },
                   "namePrefix": {
                     "type": "string",
                     "maxLength": 11,
                     "defaultValue": "store",
                     "metadata": {
                       "description": "Prefix for storage account name"
                     }
                   }
                 },
                 "variables": {
                   "storageAccountName": "[[concat(parameters('namePrefix'), uniquestring(resourceGroup().id))]"
                 },
                 "resources": [
                   {
                     "type": "Microsoft.Storage/storageAccounts",
                     "apiVersion": "2021-04-01",
                     "name": "[[variables('storageAccountName')]",
                     "location": "[[parameters('location')]",
                     "sku": {
                       "name": "[[parameters('storageAccountType')]"
                     },
                     "kind": "StorageV2",
                     "properties": {}
                   }
                 ],
                 "outputs": {
                   "storageAccountName": {
                     "type": "string",
                     "value": "[[variables('storageAccountName')]"
                   }
                 }
               }
             },
             "tags": {}
           }
         ]
       }
     ],
     "outputs": {}
   }
   

2. Pour ajouter la nouvelle version à votre spec de modèle, déployez votre modèle avec Azure CLI ou PowerShell.

   New-AzResourceGroupDeployment `
     -ResourceGroupName templateSpecRG `
     -TemplateFile "c:\Templates\azuredeploy.json"
   

   az deployment group create \
     --resource-group templateSpecRG \
     --template-file "c:\Templates\azuredeploy.json"
   

3. Copiez le modèle suivant et enregistrez-le localement dans un fichier nommé storage.json.

   {
     "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
     "contentVersion": "1.0.0.0",
     "parameters": {},
     "functions": [],
     "variables": {},
     "resources": [
       {
         "type": "Microsoft.Resources/deployments",
         "apiVersion": "2021-04-01",
         "name": "demo",
         "properties": {
           "templateLink": {
             "id": "[resourceId('templateSpecRG', 'Microsoft.Resources/templateSpecs/versions', 'storageSpec', '2.0')]"
           },
           "parameters": {
           },
           "mode": "Incremental"
         }
       }
     ],
     "outputs": {}
   }
   

4. Déployez votre modèle avec Azure CLI ou PowerShell.

   New-AzResourceGroupDeployment `
     -ResourceGroupName storageRG `
     -TemplateFile "c:\Templates\storage.json"
   

   az deployment group create \
     --resource-group storageRG \
     --template-file "c:\Templates\storage.json"
   

Nettoyer les ressources

Pour nettoyer la ressource que vous avez déployée dans le cadre de ce démarrage rapide, supprimez les deux groupes de ressources que vous avez créés.

1. Dans le portail Azure, sélectionnez Groupe de ressources dans le menu de gauche.

2. Entrez le nom du groupe de ressources (templateSpecRG et storageRG) dans le champ Filtrer par nom.

3. Sélectionnez le nom du groupe de ressources.

4. Sélectionnez Supprimer le groupe de ressources dans le menu supérieur.

Étapes suivantes

Pour découvrir la création d’une spec de modèle incluant des modèles liés, consultez Créer une spec de modèle d’un modèle lié.