Partager via

Déployer des fichiers Bicep avec Azure CLI

  • Article

Cet article explique comment utiliser Azure CLI avec des fichiers Bicep pour déployer vos ressources sur Azure. Si vous n’êtes pas familiarisé avec le déploiement et la gestion de vos solutions Azure, consultez Qu’est-ce que Bicep ?.

Prérequis

Vous avez besoin d’un fichier Bicep pour déployer, et ce fichier doit être local. Vous avez également besoin d’Azure CLI et d’être connecté à Azure :

  • Installez les commandes Azure CLI sur votre ordinateur local. Pour déployer des fichiers Bicep, vous devez disposer d’Azure CLI version 2.20.0 ou ultérieure.
  • Utilisez az login pour vous connecter à Azure. Si vous avez plusieurs abonnements Azure, il peut également être nécessaire d’exécuter az account set.

Des exemples pour l’interface CLI sont écrits pour l’interpréteur de commandes bash. Pour exécuter cet exemple dans Windows PowerShell ou l’invite de commandes (cmd), vous devrez peut-être modifier les éléments du script.

Si vous n’avez pas installé Azure CLI, vous pouvez utiliser Azure Cloud Shell. Pour plus d’informations, consultez Déployer des fichiers Bicep avec Azure Cloud Shell.

Autorisations requises

Pour déployer un fichier Bicep ou un modèle ARM, vous devez disposer d’un accès en écriture aux ressources que vous déployez et un accès à toutes les opérations sur le type de ressource Microsoft.Resources/deployments. Par exemple, pour déployer une machine virtuelle, vous avez besoin des autorisations Microsoft.Compute/virtualMachines/write et Microsoft.Resources/deployments/*. L’opération de simulation présente les mêmes exigences d’autorisation.

Pour obtenir la liste des rôles et autorisations, consultez Rôles intégrés Azure.

Étendue du déploiement

Vous pouvez cibler votre déploiement au niveau d’un groupe de ressources, d’un abonnement, d’un groupe d’administration ou d’un locataire. Selon l’étendue du déploiement, vous utilisez des commandes différentes, et l’utilisateur qui déploie le fichier Bicep doit disposer des autorisations requises pour créer des ressources dans chaque étendue.

Déployer un fichier Bicep local

Vous pouvez déployer un fichier Bicep depuis votre machine locale ou depuis une machine externe. Cette section décrit comment déployer un fichier Bicep local.

Si vous effectuez un déploiement vers un groupe de ressources qui n’existe pas, vous devez commencer par créer ce dernier. Le nom du groupe de ressources ne peut contenir que des caractères alphanumériques, des points, des traits de soulignement, des traits d'union et des parenthèses. Il peut comporter jusqu’à 90 caractères et ne peut pas se terminer par un point.

az group create --name ExampleGroup --location "Central US"

Pour déployer un fichier Bicep local, utilisez le commutateur --template-file dans la commande de déploiement. L’exemple suivant montre également comment définir une valeur de paramètre :

az deployment group create \
  --name ExampleDeployment \
  --resource-group ExampleGroup \
  --template-file <path-to-bicep> \
  --parameters storageAccountType=Standard_GRS

Le déploiement peut prendre plusieurs minutes. Une fois l’opération terminée, un message incluant le résultat suivant s’affiche :

"provisioningState": "Succeeded",

Déployer un fichier Bicep distant

Azure CLI ne prend actuellement pas en charge le déploiement de fichiers Bicep distants. Vous pouvez utiliser l’interface CLI Bicep pour créer le fichier Bicep sous la forme d’un modèle JSON, puis charger le fichier JSON à un emplacement distant. Pour plus d’informations, consultez Déployer un modèle distant.

Paramètres

Pour passer des valeurs de paramètre, vous pouvez utiliser des paramètres inline ou un fichier de paramètres. Le fichier de paramètres peut être un fichier de paramètres Bicep ou un fichier de paramètres JSON.

Paramètres inline

Pour passer des paramètres inline, indiquez les valeurs dans parameters. Par exemple, pour transmettre une chaîne et un tableau à un fichier Bicep dans un interpréteur de commandes Bash, utilisez :

az deployment group create \
  --resource-group testgroup \
  --template-file <path-to-bicep> \
  --parameters exampleString='inline string' exampleArray='["value1", "value2"]'

Si vous utilisez Azure CLI avec cmd ou PowerShell, passez le tableau au format : exampleArray="['value1','value2']".

Vous pouvez également obtenir le contenu du fichier pour fournir ce contenu en tant que paramètre inline. Préfacez le nom du fichier avec @:

az deployment group create \
  --resource-group testgroup \
  --template-file <path-to-bicep> \
  --parameters exampleString=@stringContent.txt exampleArray=@arrayContent.json

Obtenir une valeur de paramètre à partir d’un fichier est utile lorsque vous devez fournir des valeurs de configuration. Par exemple, vous pouvez fournir des valeurs cloud-init pour une machine virtuelle Linux.

Le format arrayContent.json est :

[
  "value1",
  "value2"
]

Pour passer un objet, utilisez JSON (lors de la définition de balises, par exemple). Votre fichier Bicep peut inclure un paramètre comme celui-ci :

"resourceTags": {
  "type": "object",
  "defaultValue": {
    "Cost Center": "IT Department"
  }
}

Comme indiqué dans le script Bash suivant, vous pouvez également transmettre une chaîne JSON pour définir le paramètre. Utilisez des guillemets doubles autour du JSON que vous voulez passer à l’objet :

tags='{"Owner":"Contoso","Cost Center":"2345-324"}'
az deployment group create --name addstorage  --resource-group myResourceGroup \
--template-file $bicepFile \
--parameters resourceName=abcdef4556 resourceTags="$tags"

Si vous utilisez Azure CLI avec cmd ou PowerShell, transmettez l’objet au format suivant :

$tags="{'Owner':'Contoso','Cost Center':'2345-324'}"
az deployment group create --name addstorage  --resource-group myResourceGroup \
--template-file $bicepFile \
--parameters resourceName=abcdef4556 resourceTags=$tags

Vous pouvez utiliser une variable pour contenir les valeurs de paramètre. Définissez la variable sur toutes les valeurs de paramètre dans votre script Bash et ajoutez-la à la commande de déploiement :

params="prefix=start suffix=end"

az deployment group create \
  --resource-group testgroup \
  --template-file <path-to-bicep> \
  --parameters $params

Toutefois, si vous utilisez Azure CLI avec cmd ou PowerShell, définissez la variable sur une chaîne JSON. Échappez les guillemets : $params = '{ \"prefix\": {\"value\":\"start\"}, \"suffix\": {\"value\":\"end\"} }'.

L’évaluation des paramètres suit un ordre séquentiel, ce qui signifie que si une valeur est affectée plusieurs fois, seule la dernière valeur affectée est utilisée. Pour affecter correctement des paramètres, il est recommandé de fournir initialement votre fichier de paramètres, puis d’utiliser la syntaxe KEY=VALUE pour remplacer de manière sélective des paramètres spécifiques. Si vous fournissez un fichier de paramètres .bicepparam, vous ne pouvez utiliser cet argument qu’une seule fois.

Fichiers de paramètres Bicep

Au lieu de passer des paramètres comme valeurs inline dans votre script, vous pouvez utiliser un fichier de paramètres Bicep ou un fichier de paramètres JSON qui contient les valeurs des paramètres. Le fichier de paramètres doit être un fichier local, car Azure CLI ne prend pas en charge les fichiers de paramètres externes. Pour plus d’informations sur les fichiers de paramètres, consultez Créer des fichiers de paramètres pour un déploiement Bicep.

Vous pouvez utiliser un fichier de paramètres Bicep pour déployer un fichier Bicep avec Azure CLI version 2.53.0 ou ultérieure et CLI Bicep version 0.22.X ou ultérieure. Avec l’instruction using dans le fichier de paramètres Bicep, il n’est pas nécessaire de fournir le commutateur --template-file lors de la spécification d’un fichier de paramètres Bicep pour le commutateur --parameters. L’inclusion du commutateur --template-file invite une erreur « Seul un modèle .bicep est autorisé avec un fichier .bicepparam », erreur.

L’exemple suivant montre un fichier de paramètres nommé storage.bicepparam. Le fichier se trouve dans le même répertoire que celui où la commande s’exécute :

az deployment group create \
  --name ExampleDeployment \
  --resource-group ExampleGroup \
  --parameters storage.bicepparam

Fichier de paramètres JSON

L’exemple suivant montre un fichier de paramètres nommé storage.parameters.json. Le fichier se trouve dans le même répertoire que celui où la commande s’exécute :

az deployment group create \
  --name ExampleDeployment \
  --resource-group ExampleGroup \
  --template-file storage.bicep \
  --parameters '@storage.parameters.json'

Vous pouvez utiliser des paramètres inclus et un fichier de paramètres d’emplacement pendant la même opération de déploiement. Pour plus d’informations, consultez Priorité des paramètres.

Prévisualiser les modifications

Avant de déployer votre fichier Bicep, vous pouvez obtenir un aperçu des changements que le fichier Bicep apportera à votre environnement. Utilisez l’opération de simulation pour vérifier que le fichier Bicep apporte les changements prévus. Cette opération vérifie aussi que le fichier Bicep est exempt d’erreurs.

Déployer des specs de modèle

Actuellement, Azure CLI ne fournit pas de fichiers Bicep pour vous aider à créer des spécifications de modèle. Cependant, vous pouvez créer un fichier Bicep avec la ressource Microsoft.Resources/templateSpecs pour déployer une spécification de modèle. L’exemple de création de spécification de modèle montre comment créer une spécification de modèle dans un fichier Bicep. Vous pouvez également créer votre fichier Bicep en JSON en utilisant l’interface CLI Bicep, puis un modèle JSON pour créer une spécification de modèle.

Nom du déploiement

Lorsque vous déployez un fichier Bicep, vous pouvez attribuer un nom au déploiement. Ce nom peut vous aider à récupérer le déploiement à partir de l’historique de déploiement. Si vous n’attribuez pas de nom au déploiement, c’est le nom du fichier Bicep qui est utilisé. Par exemple, si vous déployez un fichier Bicep nommé main.bicep sans spécifier de nom pour le déploiement, le déploiement est nommé main.

Chaque fois que vous exécutez un déploiement, une entrée est ajoutée à l’historique de déploiement du groupe de ressources avec le nom du déploiement. Si vous exécutez un autre déploiement et que vous lui attribuez le même nom, l’entrée précédente est remplacée par le déploiement actuel. Si vous souhaitez conserver des entrées uniques dans l’historique de déploiement, attribuez un nom unique à chaque déploiement.

Pour créer un nom unique, vous pouvez affecter un nombre aléatoire :

deploymentName='ExampleDeployment'$RANDOM

Vous pouvez aussi ajouter une valeur de date :

deploymentName='ExampleDeployment'$(date +"%d-%b-%Y")

Si vous exécutez des déploiements simultanés dans le même groupe de ressources avec le même nom de déploiement, seul le dernier déploiement aboutit. Les déploiements de même nom qui n’arrivent pas à terme sont remplacés par le dernier déploiement. Par exemple, si vous exécutez un déploiement nommé newStorage qui déploie un compte de stockage nommé storage1 et que vous exécutez en même temps un autre déploiement nommé newStorage qui déploie un compte de stockage nommé storage2, vous ne déployez qu’un seul compte de stockage. Le compte de stockage qui en résulte est nommé storage2.

Toutefois, si vous exécutez un déploiement nommé newStorage qui déploie un compte de stockage nommé storage1 et exécutez immédiatement un autre déploiement nommé newStorage qui déploie un compte de stockage nommé storage2 une fois le premier déploiement terminé, vous avez deux comptes de stockage. un nommé storage1 et l’autre nommé storage2. Cependant, l’historique de déploiement ne présente qu’une seule entrée.

Quand vous spécifiez un nom unique pour chaque déploiement, vous pouvez les exécuter simultanément sans conflit. Si vous exécutez un déploiement nommé newStorage1 qui déploie un compte de stockage nommé storage1 et que vous exécutez en même temps un autre déploiement nommé newStorage2 qui déploie un compte de stockage nommé storage2, vous avez deux comptes de stockage et deux entrées dans l’historique des déploiements.

Pour éviter les conflits lors de déploiements simultanés et faire en sorte que l’historique de déploiement présente des entrées uniques, attribuez un nom unique à chaque déploiement.

Étapes suivantes

Pour comprendre comment définir des paramètres dans votre fichier, consultez Comprendre la structure et la syntaxe des fichiers Bicep.