Erstellen einer Parameterdatei für die Bicep-Bereitstellung

Die Dateierweiterung für eine Bicep-Parameterdatei ist .bicepparam.

Erstellen Sie mehrere Parameterdatei, um sie in mehreren Umgebungen bereitzustellen. Wenn Sie mehrere Parameterdateien verwenden, bezeichnen Sie sie entsprechend ihrer Verwendung. Verwenden Sie beispielsweise bei der Bereitstellung von Ressourcen die Bezeichnung main.dev.bicepparam für die Entwicklung und die Bezeichnung main.prod.bicepparam für die Produktion.

Die allgemeine Namenskonvention für Parameterdateien besteht darin, Parameter in den Namen der Bicep-Datei einzuschließen. Wenn Ihre Bicep-Datei beispielsweise azuredeploy.bicep heißt, benennen Sie Ihre Parameterdatei azuredeploy.parameters.json. Anhand dieser Namenskonvention können Sie die Verbindung zwischen der Bicep-Datei und den Parametern erkennen.

Um sie in verschiedenen Umgebungen bereitzustellen, erstellen Sie mehrere Parameterdatei. Wenn Sie mehrere Parameterdateien verwenden, bezeichnen Sie sie entsprechend ihrer Verwendung. Verwenden Sie beispielsweise bei der Bereitstellung von Ressourcen die Bezeichnung azuredeploy.parameters-dev.json für die Entwicklung und die Bezeichnung azuredeploy.parameters-prod.json für die 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

Die using-Anweisung verknüpft die Bicep Parameterdatei mit einer Bicep Datei. Sie können mehrere Parameterdateien einer einzelnen Bicep Datei zuordnen. Jede Parameterdatei verknüpft in der Regel mit einer bestimmten Bicep Datei mithilfe der using-Anweisung.

Verwenden Sie using none, wenn Sie die Parameterdatei nicht mit einer bestimmten Bicep Datei verknüpfen möchten. Bicep CLI Version 0.31.0 oder höher unterstützt das Feature using none.

Weitere Informationen finden Sie unter Using-Anweisung.

Die extends Anweisung erbt Parameter aus einer Basisdatei .bicepparam , sodass Parameterwerte wiederverwendet und selektiv in der aktuellen Parameterdatei überschrieben werden können. Weitere Informationen finden Sie unter Erweiterungsparameterdateien.

Wenn Sie das Schlüsselwort param in Visual Studio Code eingeben, werden Ihnen die verfügbaren Parameter und ihre Beschreibungen aus der verknüpften Bicep-Datei angezeigt.

Wenn Sie mit dem Mauszeiger auf einen param-Namen zeigen, können Sie den Parameterdatentyp und die Beschreibung sehen.

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

Verwenden Sie die Bicep-Syntax, um Objekte und Arrays zu deklarieren.

Sie können Ausdrücke als Parameterwerte verwenden. Beispiel:

using './main.bicep'

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

Sie können auf Umgebungsvariablen als Parameterwerte verweisen. Beispiel:

using './main.bicep'

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

Sie können Variablen definieren und verwenden. Sie müssen Bicep CLI Version 0.21.X oder höher für die Verwendung von Variablen in .bicepparam-Dateien verwenden. Hierzu folgende Beispiele:

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
}

Sie können benutzerdefinierte Datentypen definieren. Beispiel:

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

Sie können variablen, benutzerdefinierte Datentypen und Benutzerdefinierte Funktionen auch aus einer Bicep Datei importieren. Weitere Informationen finden Sie unter "Importieren".

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

Ab der Azure CLI-Version 2.53.0 und der Bicep CLI-Version 0.22.X oder höher können Sie eine Bicep-Datei mithilfe einer Bicep-Parameterdatei bereitstellen. Wenn Sie die using-Anweisung in der Parameterdatei Bicep verwenden, müssen Sie die Option --template-file nicht angeben, wenn Sie eine Bicep Parameterdatei für die Option --parameters angeben.

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