Créer un fichier de paramètres pour le déploiement Bicep

L’extension de fichier pour un fichier de paramètres Bicep est .bicepparam.

Pour effectuer un déploiement sur plusieurs environnements, créez plusieurs fichiers de paramètres. Lorsque vous utilisez plusieurs fichiers de paramètres, étiquetez-les en fonction de leur utilisation. Par exemple, pour déployer des ressources, utilisez l’étiquette main.dev.bicepparam pour le développement et l’étiquette main.prod.bicepparam pour la production.

La convention d’affectation de noms générale pour un fichier de paramètres consiste à inclure paramètres dans le nom du fichier Bicep. Par exemple, si votre fichier Bicep est nommé azuredeploy.bicep, nommez votre fichier de paramètres azuredeploy.parameters.json. Cette convention d'affectation de noms vous permet de comprendre le lien entre le fichier Bicep et les paramètres.

Pour effectuer un déploiement dans différents environnements, créez plusieurs fichiers de paramètres. Lorsque vous utilisez plusieurs fichiers de paramètres, étiquetez-les en fonction de leur utilisation. Par exemple, pour déployer des ressources, utilisez l’étiquette azuredeploy.parameters-dev.json pour le développement et l’étiquette azuredeploy.parameters-prod.json pour la production.

using '<path>/<file-name>.bicep' | using none
extends '<path>/<file-name>.bicepparam' 

type <user-defined-data-type-name> = <type-expression>

var <variable-name> <data-type> = <variable-value>

import {<symbol_name> [as <alias_name>], ...} from '<bicep_file_name>'

param <first-parameter-name> = <first-value>
param <second-parameter-name> = <second-value>
param <third-parameter-name> = <variable-name>

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "<first-parameter-name>": {
      "value": "<first-value>"
    },
    "<second-parameter-name>": {
      "value": "<second-value>"
    }
  }
}

using 'main.bicep'

param storagePrefix
param storageAccountType

L’instruction using associe le fichier de paramètres Bicep à un fichier Bicep. Vous pouvez associer plusieurs fichiers de paramètres à un seul fichier Bicep. Chaque fichier de paramètres est généralement lié à un fichier de Bicep spécifique à l’aide de l’instruction using.

Utilisez using none si vous ne souhaitez pas lier le fichier de paramètres à un fichier Bicep particulier. Bicep CLI version 0.31.0 ou ultérieure prend en charge la fonctionnalité using none.

Si vous souhaitez en savoir plus, veuillez consulter la rubrique Instruction d’utilisation.

L’instruction extends hérite des paramètres d’un fichier de base .bicepparam , ce qui permet aux valeurs de paramètres d’être réutilisées et remplacées de manière sélective dans le fichier de paramètres actuel. Pour plus d’informations, consultez les fichiers de paramètres extensibles.

Lorsque vous tapez le mot clé param dans Visual Studio Code, il vous invite à entrer les paramètres disponibles et leurs descriptions à partir du fichier Bicep lié.

Lorsque vous pointez sur un nom param, vous pouvez voir le type de données et la description du paramètre.

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "storagePrefix": {
    },
    "storageAccountType": {
    }
  }
}

using 'main.bicep'

param storagePrefix = ''
param storageAccountType = ''

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "storagePrefix": {
      "value": ""
    },
    "storageAccountType": {
      "value": ""
    }
  }
}

using 'main.bicep'

param storagePrefix = '' // This value must be provided.
param storageAccountType = '' // This value is optional. Bicep uses default value if not provided.

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "storagePrefix": {
      "value": "" // This value must be provided.
    },
    "storageAccountType": {
      "value": "" // This value is optional. Bicep uses default value if not provided.
    }
  }
}

using 'main.bicep'

param storagePrefix = 'storage'
param storageAccountType = 'Standard_ZRS'

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "storagePrefix": {
      "value": "storage"
    },
    "storageAccountType": {
      "value": "Standard_ZRS"
    }
  }
}

using './main.bicep'

param exampleString = 'test string'
param exampleInt = 2 + 2
param exampleBool = true
param exampleArray = [
  'value 1'
  'value 2'
]
param exampleObject = {
  property1: 'value 1'
  property2: 'value 2'
}

Utilisez la syntaxe Bicep pour déclarer des objets et des tableaux.

Vous pouvez utiliser des expressions comme valeurs de paramètre. Exemple :

using './main.bicep'

param storageName = toLower('MyStorageAccount')
param intValue = 2 + 2

Vous pouvez référencer des variables d’environnement en tant que valeurs de paramètre. Exemple :

using './main.bicep'

param intFromEnvironmentVariables = int(readEnvironmentVariable('intEnvVariableName'))

Vous pouvez définir et utiliser des variables. Vous devez utiliser Bicep CLI version 0.21.X ou ultérieure pour utiliser des variables dans les fichiers .bicepparam. Regardez les exemples suivants :

using './main.bicep'

var storagePrefix = 'myStorage'
param primaryStorageName = '${storagePrefix}Primary'
param secondaryStorageName = '${storagePrefix}Secondary'

using './main.bicep'

var testSettings = {
  instanceSize: 'Small'
  instanceCount: 1
}

var prodSettings = {
  instanceSize: 'Large'
  instanceCount: 4
}

param environmentSettings = {
  test: testSettings
  prod: prodSettings
}

Vous pouvez définir des types de données définis par l’utilisateur. Exemple :

using './main.bicep'

// Define a reusable type for tags with optional properties
type TagValues = {
  environment: 'dev' | 'test' | 'production'
  project: string
}

var tagsExample TagValues = {
  environment: 'dev'
  project: 'bicep-sample'
}

param tags = tagsExample

Vous pouvez également importer des variables, des types de données définis par l’utilisateur et des fonctions définies par l’utilisateur à partir d’un fichier Bicep. Pour plus d’informations, consultez Importer.

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "exampleString": {
      "value": "test string"
    },
    "exampleInt": {
      "value": 4
    },
    "exampleBool": {
      "value": true
    },
    "exampleArray": {
      "value": [
        "value 1",
        "value 2"
      ]
    },
    "exampleObject": {
      "value": {
        "property1": "value1",
        "property2": "value2"
      }
    }
  }
}

Vous pouvez déployer un fichier Bicep en utilisant un fichier de paramètres Bicep avec Azure CLI version 2.53.0 ou ultérieure, et avec Bicep CLI version 0.22.X ou ultérieure. En utilisant l'instruction using dans le fichier de paramètres Bicep, vous n'avez pas besoin de fournir le commutateur --template-file lors de la spécification d'un fichier de paramètres Bicep pour le commutateur --parameters.

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

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

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

az deployment group create \
  --name ExampleDeployment \
  --resource-group ExampleGroup \
  --template-file storage.bicep \
  --parameters storage.parameters.json \
  --parameters storageAccountType=Standard_LRS

New-AzResourceGroupDeployment `
  -Name ExampleDeployment `
  -ResourceGroupName ExampleResourceGroup `
  -TemplateFile C:\MyTemplates\storage.bicep `
  -TemplateParameterFile C:\MyTemplates\storage.bicepparam

New-AzResourceGroupDeployment `
  -Name ExampleDeployment `
  -ResourceGroupName ExampleResourceGroup `
  -TemplateFile C:\MyTemplates\storage.bicep `
  -TemplateParameterFile C:\MyTemplates\storage.parameters.json

New-AzResourceGroupDeployment `
  -Name ExampleDeployment `
  -ResourceGroupName ExampleResourceGroup `
  -TemplateFile C:\MyTemplates\storage.bicep `
  -TemplateParameterFile C:\MyTemplates\storage.bicepparam `
  -storageAccountType Standard_LRS

New-AzResourceGroupDeployment `
  -Name ExampleDeployment `
  -ResourceGroupName ExampleResourceGroup `
  -TemplateFile C:\MyTemplates\storage.bicep `
  -TemplateParameterFile C:\MyTemplates\storage.parameters.json `
  -storageAccountType Standard_LRS