Sdílet prostřednictvím

Proměnné v Bicep

  • Článek

Tento článek popisuje, jak definovat a používat proměnné v souboru Bicep. Proměnné se používají ke zjednodušení vývoje souborů Bicep. Místo opakování složitých výrazů v souboru Bicep definujete proměnnou, která obsahuje složitý výraz. Tuto proměnnou pak použijete podle potřeby v celém souboru Bicep.

Resource Manager před zahájením operací nasazení přeloží proměnné. Kdykoli se proměnná použije v souboru Bicep, Resource Manager ji nahradí přeloženou hodnotou.

V souboru Bicep jste omezeni na 512 proměnných. Další informace najdete v tématu Omezení šablon.

Definování proměnných

Syntaxe pro definování proměnné je:

@<decorator>(<argument>)
var <variable-name> = <variable-value>

Proměnná nemůže mít stejný název jako parametr, modul nebo prostředek.

Všimněte si, že pro proměnnou nezadáte datový typ . Typ je odvozen z hodnoty. Následující příklad nastaví proměnnou na řetězec.

var stringVar = 'example value'

Hodnotu z parametru nebo jiné proměnné můžete použít při vytváření proměnné.

param inputValue string = 'deployment parameter'

var stringVar = 'preset variable'
var concatToVar =  '${stringVar}AddToVar'
var concatToParam = '${inputValue}AddToParam'

output addToVar string = concatToVar
output addToParam string = concatToParam

Předchozí příklad vrátí:

{
  "addToParam": {
    "type": "String",
    "value": "deployment parameterAddToParam"
  },
  "addToVar": {
    "type": "String",
    "value": "preset variableAddToVar"
  }
}

K vytvoření hodnoty proměnné můžete použít funkce Bicep. Následující příklad používá funkce Bicep k vytvoření řetězcové hodnoty pro název účtu úložiště.

param storageNamePrefix string = 'stg'
var storageName = '${toLower(storageNamePrefix)}${uniqueString(resourceGroup().id)}'

output uniqueStorageName string = storageName

Předchozí příklad vrátí hodnotu jako následující:

"uniqueStorageName": {
  "type": "String",
  "value": "stghzuunrvapn6sw"
}

Při definování proměnné můžete použít iterativní smyčky. Následující příklad vytvoří pole objektů se třemi vlastnostmi.

param itemCount int = 3

var objectArray = [for i in range(0, itemCount): {
  name: 'myDataDisk${(i + 1)}'
  diskSizeGB: '1'
  diskIndex: i
}]

output arrayResult array = objectArray

Výstup vrátí matici s následujícími hodnotami:

[
  {
    "name": "myDataDisk1",
    "diskSizeGB": "1",
    "diskIndex": 0
  },
  {
    "name": "myDataDisk2",
    "diskSizeGB": "1",
    "diskIndex": 1
  },
  {
    "name": "myDataDisk3",
    "diskSizeGB": "1",
    "diskIndex": 2
  }
]

Další informace o typech smyček, které můžete použít s proměnnými, najdete v tématu Iterativní smyčky v bicep.

Použití dekorátorů

Dekorátory jsou zapsány ve formátu @expression a jsou umístěny nad deklaracemi proměnných. V následující tabulce jsou uvedeny dostupné dekorátory proměnných.

Dekoratér Argument Popis
popis string Zadejte popisy proměnné.
export Žádná Označuje, že proměnná je k dispozici pro import jiným souborem Bicep.

Dekorátory jsou v oboru názvů sys. Pokud potřebujete odlišit dekorátor od jiné položky se stejným názvem, předkožte dekorátorem .sys Pokud například váš soubor Bicep obsahuje proměnnou s názvem description, musíte přidat obor názvů sys při použití dekorátoru popisu .

Popis

Pokud chcete přidat vysvětlení, přidejte popis do deklarace proměnné. Příklad:

@description('Create a unique storage account name.')
var storageAccountName = uniqueString(resourceGroup().id)

Text ve formátu Markdown lze použít pro text popisu.

Export

Slouží @export() ke sdílení proměnné s jinými soubory Bicep. Další informace najdete v tématu Export proměnných, typů a funkcí.

Použití proměnných

Následující příklad ukazuje, jak použít proměnnou pro vlastnost prostředku. Na hodnotu proměnné odkazujete zadáním názvu proměnné: storageName.

param rgLocation string
param storageNamePrefix string = 'STG'

var storageName = '${toLower(storageNamePrefix)}${uniqueString(resourceGroup().id)}'

resource demoAccount 'Microsoft.Storage/storageAccounts@2023-04-01' = {
  name: storageName
  location: rgLocation
  kind: 'Storage'
  sku: {
    name: 'Standard_LRS'
  }
}

output stgOutput string = storageName

Vzhledem k tomu, že názvy účtů úložiště musí používat malá písmena, storageName proměnná používá toLower funkci k nastavení storageNamePrefix hodnoty malými písmeny. Funkce uniqueString vytvoří jedinečnou hodnotu z ID skupiny prostředků. Hodnoty jsou zřetězeny do řetězce.

Proměnné konfigurace

Můžete definovat proměnné, které obsahují související hodnoty pro konfiguraci prostředí. Proměnnou definujete jako objekt s hodnotami. Následující příklad ukazuje objekt, který obsahuje hodnoty pro dvě prostředí – test a prod. Předejte jednu z těchto hodnot během nasazení.

@allowed([
  'test'
  'prod'
])
param environmentName string

var environmentSettings = {
  test: {
    instanceSize: 'Small'
    instanceCount: 1
  }
  prod: {
    instanceSize: 'Large'
    instanceCount: 4
  }
}

output instanceSize string = environmentSettings[environmentName].instanceSize
output instanceCount int = environmentSettings[environmentName].instanceCount

Další kroky