Skapa en parameterfil för Bicep-distribution

Filnamnstillägget för en Bicep-parameterfil är .bicepparam.

Om du vill distribuera till flera miljöer skapar du fler än en parameterfil. När du använder flera parameterfiler ska du märka dem enligt deras användning. Om du till exempel vill distribuera resurser använder du etiketten main.dev.bicepparam för utveckling och etiketten main.prod.bicepparam för produktion.

Den allmänna namngivningskonventionen för en parameterfil är att inkludera parametrar i Bicep-filnamnet. Om din Bicep-fil till exempel heter azuredeploy.bicep namnger du parameterfilen azuredeploy.parameters.json. Den här namngivningskonventionen hjälper dig att se anslutningen mellan Bicep-filen och parametrarna.

Om du vill distribuera till olika miljöer skapar du fler än en parameterfil. När du använder flera parameterfiler ska du märka dem enligt deras användning. Om du till exempel vill distribuera resurser använder du etiketten azuredeploy.parameters-dev.json för utveckling och etiketten azuredeploy.parameters-prod.json för produktion.

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

Instruktionen using länkar Bicep-parameterfilen till en Bicep fil. Du kan associera flera parameterfiler med en enda Bicep fil. Varje parameterfil länkar vanligtvis till en specifik Bicep fil med hjälp av instruktionen using.

Använd using none om du inte vill länka parameterfilen till en viss Bicep fil. Bicep CLI version 0.31.0 eller senare stöder funktionen using none.

Mer information finns i Använda -instruktion.

-instruktionen extends ärver parametrar från en basfil .bicepparam , vilket gör att parametervärden kan återanvändas och selektivt åsidosättas i den aktuella parameterfilen. Mer information finns i Utökade parameterfiler.

När du skriver nyckelordet param i Visual Studio Code uppmanas du att ange tillgängliga parametrar och deras beskrivningar från den länkade Bicep filen.

När du hovra över ett param namn kan du se parameterdatatypen och beskrivningen.

{
  "$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'
}

Använd Bicep-syntax för att deklarera objekt och matriser.

Du kan använda uttryck som parametervärden. Till exempel:

using './main.bicep'

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

Du kan referera till miljövariabler som parametervärden. Till exempel:

using './main.bicep'

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

Du kan definiera och använda variabler. Du måste använda Bicep CLI version 0.21.X eller senare för att kunna använda variabler i .bicepparam filer. Se följande exempel:

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
}

Du kan definiera användardefinierade datatyper. Till exempel:

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

Du kan också importera variabler, användardefinierade datatyper och användardefinierade funktioner från en Bicep fil. Mer information finns i Importera.

{
  "$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"
      }
    }
  }
}

Du kan distribuera en Bicep-fil med hjälp av en Bicep-parameterfil med Azure CLI version 2.53.0 eller senare och Bicep CLI version 0.22.X eller senare. Genom att använda instruktionen using i Bicep-parameterfilen behöver du inte ange växeln --template-file när du anger en Bicep parameterfil för växeln --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