Paraméterek ARM-sablonokban

Ez a cikk azt ismerteti, hogyan definiálhat és használhat paramétereket az Azure Resource Manager-sablonban (ARM-sablonban). Ha különböző értékeket ad meg a paramétereknek, a sablonokat újra felhasználhatja a különböző környezetekhez.

Resource Manager az üzembehelyezési műveletek megkezdése előtt feloldja a paraméterértékeket. Bárhol is használja a paramétert a sablonban, Resource Manager lecseréli a feloldott értékre.

Minden paramétert az egyik adattípusra kell beállítani.

Tipp

A Bicep használatát javasoljuk, mert ugyanazokat a képességeket kínálja, mint az ARM-sablonok, és a szintaxis használata is egyszerűbb. További információért tekintse meg a paramétereket.

Egy sablonban legfeljebb 256 paraméter szerepelhet. További információ: Sablonkorlátok.

A paraméterekkel kapcsolatos ajánlott eljárásokért lásd: Paraméterek.

Minimális deklaráció

Legalább minden paraméternek nevet és típust kell megadnia.

Amikor sablont helyez üzembe a Azure Portal keresztül, a camel-cased paraméternevek szóközzel elválasztott nevekké lesznek alakítva. Az alábbi példában a demoString például Demo Stringként jelenik meg. További információ: Sablonok üzembe helyezése a GitHub-adattárból üzembe helyezési gombbal és Erőforrások üzembe helyezése ARM-sablonokkal és Azure Portal.

"parameters": {
  "demoString": {
    "type": "string"
  },
  "demoInt": {
    "type": "int"
  },
  "demoBool": {
    "type": "bool"
  },
  "demoObject": {
    "type": "object"
  },
  "demoArray": {
    "type": "array"
  }
}

Biztonságos paraméterek

A sztring- vagy objektumparamétereket biztonságosként jelölheti meg. A rendszer nem menti a biztonságos paraméter értékét az üzembe helyezési előzményekbe, és nincs naplózva.

"parameters": {
  "demoPassword": {
    "type": "secureString"
  },
  "demoSecretObject": {
    "type": "secureObject"
  }
}

Megengedett értékek

Egy paraméterhez megadhat engedélyezett értékeket. Megadhatja az engedélyezett értékeket egy tömbben. Az üzembe helyezés sikertelen az ellenőrzés során, ha a paraméternek olyan értéket ad át, amely nem az engedélyezett értékek egyike.

"parameters": {
  "demoEnum": {
    "type": "string",
    "allowedValues": [
      "one",
      "two"
    ]
  }
}

Alapértelmezett érték

Megadhat egy alapértelmezett értéket egy paraméterhez. Az alapértelmezett értéket akkor használja a rendszer, ha az üzembe helyezés során nem ad meg értéket.

"parameters": {
  "demoParam": {
    "type": "string",
    "defaultValue": "Contoso"
  }
}

Ha alapértelmezett értéket szeretne megadni a paraméter egyéb tulajdonságaival együtt, használja az alábbi szintaxist.

"parameters": {
  "demoParam": {
    "type": "string",
    "defaultValue": "Contoso",
    "allowedValues": [
      "Contoso",
      "Fabrikam"
    ]
  }
}

Az alapértelmezett értékkel használhat kifejezéseket. Nem használhatja a referenciafüggvényt vagy a paraméterek szakaszban található listafüggvényeket. Ezek a függvények lekérik egy erőforrás futtatókörnyezeti állapotát, és nem hajtható végre az üzembe helyezés előtt a paraméterek feloldásakor.

A kifejezések más paramétertulajdonságokkal nem használhatók.

"parameters": {
  "location": {
    "type": "string",
    "defaultValue": "[resourceGroup().location]"
  }
}

Egy másik paraméterérték használatával létrehozhat egy alapértelmezett értéket. Az alábbi sablon egy gazdagépterv-nevet hoz létre a webhely nevéből.

"parameters": {
  "siteName": {
    "type": "string",
    "defaultValue": "[concat('site', uniqueString(resourceGroup().id))]"
  },
  "hostingPlanName": {
    "type": "string",
    "defaultValue": "[concat(parameters('siteName'),'-plan')]"
  }
}

Hosszkorlátozások

Megadhatja a sztring- és tömbparaméterek minimális és maximális hosszát. Beállíthat egy vagy mindkét kényszert. Sztringek esetén a hossz a karakterek számát jelzi. Tömbök esetén a hossz a tömb elemeinek számát jelzi.

Az alábbi példa két paramétert deklarál. Az egyik paraméter egy 3–24 karakter hosszúságú tárfióknév. A másik paraméter egy tömb, amely 1–5 elemből állhat.

"parameters": {
  "storageAccountName": {
    "type": "string",
    "minLength": 3,
    "maxLength": 24
  },
  "appNames": {
    "type": "array",
    "minLength": 1,
    "maxLength": 5
  }
}

Egész számokra vonatkozó korlátozások

Beállíthatja az egész számparaméterek minimális és maximális értékeit. Beállíthat egy vagy mindkét kényszert.

"parameters": {
  "month": {
    "type": "int",
    "minValue": 1,
    "maxValue": 12
  }
}

Description

Leírást adhat hozzá egy paraméterhez, hogy segítsen a sablon felhasználóinak megérteni a megadható értéket. Amikor a sablont a portálon helyezi üzembe, a leírásban megadott szöveg automatikusan az adott paraméter tippjeként lesz használva. Csak akkor adjon hozzá leírást, ha a szöveg több információt tartalmaz, mint amennyi a paraméter nevéből kikövetkezésre következtethető.

"parameters": {
  "virtualMachineSize": {
    "type": "string",
    "metadata": {
      "description": "Must be at least Standard_A3 to support 2 NICs."
    },
    "defaultValue": "Standard_DS1_v2"
  }
}

Paraméter használata

Ha egy paraméter értékére szeretne hivatkozni, használja a paraméterfüggvényt . Az alábbi példa egy paraméterértéket használ egy kulcstartónévhez.

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "vaultName": {
      "type": "string",
      "defaultValue": "[format('keyVault{0}', uniqueString(resourceGroup().id))]"
    }
  },
  "resources": [
    {
      "type": "Microsoft.KeyVault/vaults",
      "apiVersion": "2021-06-01-preview",
      "name": "[parameters('vaultName')]",
      ...
    }
  ]
}

Objektumok paraméterként

A kapcsolódó értékeket úgy rendszerezheti, hogy objektumként adja át őket. Ez a módszer a sablonban lévő paraméterek számát is csökkenti.

Az alábbi példa egy objektumnak számító paramétert mutat be. Az alapértelmezett érték az objektum várt tulajdonságait jeleníti meg. Ezeket a tulajdonságokat a rendszer az üzembe helyezendő erőforrás meghatározásakor használja.

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "vNetSettings": {
      "type": "object",
      "defaultValue": {
        "name": "VNet1",
        "location": "eastus",
        "addressPrefixes": [
          {
            "name": "firstPrefix",
            "addressPrefix": "10.0.0.0/22"
          }
        ],
        "subnets": [
          {
            "name": "firstSubnet",
            "addressPrefix": "10.0.0.0/24"
          },
          {
            "name": "secondSubnet",
            "addressPrefix": "10.0.1.0/24"
          }
        ]
      }
    }
  },
  "resources": [
    {
      "type": "Microsoft.Network/virtualNetworks",
      "apiVersion": "2021-02-01",
      "name": "[parameters('vNetSettings').name]",
      "location": "[parameters('vNetSettings').location]",
      "properties": {
        "addressSpace": {
          "addressPrefixes": [
            "[parameters('vNetSettings').addressPrefixes[0].addressPrefix]"
          ]
        },
        "subnets": [
          {
            "name": "[parameters('vNetSettings').subnets[0].name]",
            "properties": {
              "addressPrefix": "[parameters('vNetSettings').subnets[0].addressPrefix]"
            }
          },
          {
            "name": "[parameters('vNetSettings').subnets[1].name]",
            "properties": {
              "addressPrefix": "[parameters('vNetSettings').subnets[1].addressPrefix]"
            }
          }
        ]
      }
    }
  ]
}

Példasablonok

Az alábbi példák a paraméterek használatára vonatkozó forgatókönyveket mutatják be.

Sablon Description
paraméterek az alapértelmezett értékek függvényeivel Bemutatja, hogyan használhat sablonfüggvényeket a paraméterek alapértelmezett értékeinek meghatározásakor. A sablon nem helyez üzembe erőforrásokat. Paraméterértékeket állít össze, és visszaadja ezeket az értékeket.
paraméterobjektum Bemutatja, hogy egy objektumot használ-e egy paraméterhez. A sablon nem helyez üzembe erőforrásokat. Paraméterértékeket állít össze, és visszaadja ezeket az értékeket.

Következő lépések