Uživatelsky definované funkce v šabloně ARM

V rámci šablony můžete vytvořit vlastní funkce. Tyto funkce jsou k dispozici pro použití ve vaší šabloně. Uživatelsky definované funkce jsou oddělené od standardních funkcí šablon , které jsou automaticky dostupné v rámci šablony. Vytvářejte vlastní funkce, pokud máte složité výrazy, které se ve vaší šabloně opakovaně používají.

Tento článek popisuje, jak přidat uživatelsky definované funkce v šabloně Azure Resource Manager (šablona ARM).

Definovat funkci

Vaše funkce vyžadují hodnotu oboru názvů, aby se zabránilo konfliktům názvů s funkcemi šablon. Následující příklad ukazuje funkci, která vrací jedinečný název:

"functions": [
  {
    "namespace": "contoso",
    "members": {
      "uniqueName": {
        "parameters": [
          {
            "name": "namePrefix",
            "type": "string"
          }
        ],
        "output": {
          "type": "string",
          "value": "[concat(toLower(parameters('namePrefix')), uniqueString(resourceGroup().id))]"
        }
      }
    }
  }
],

Použití funkce

Následující příklad ukazuje šablonu, která obsahuje uživatelsky definovanou funkci pro získání jedinečného názvu pro účet úložiště. Šablona obsahuje parametr s názvem storageNamePrefix , který je předán jako parametr funkci.

{
 "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
 "contentVersion": "1.0.0.0",
 "parameters": {
   "storageNamePrefix": {
     "type": "string",
     "maxLength": 11
   }
 },
 "functions": [
  {
    "namespace": "contoso",
    "members": {
      "uniqueName": {
        "parameters": [
          {
            "name": "namePrefix",
            "type": "string"
          }
        ],
        "output": {
          "type": "string",
          "value": "[concat(toLower(parameters('namePrefix')), uniqueString(resourceGroup().id))]"
        }
      }
    }
  }
],
 "resources": [
   {
     "type": "Microsoft.Storage/storageAccounts",
     "apiVersion": "2019-04-01",
     "name": "[contoso.uniqueName(parameters('storageNamePrefix'))]",
     "location": "South Central US",
     "sku": {
       "name": "Standard_LRS"
     },
     "kind": "StorageV2",
     "properties": {
       "supportsHttpsTrafficOnly": true
     }
   }
 ]
}

Během nasazování se storageNamePrefix Parametr předává funkci:

  • Šablona definuje parametr s názvem storageNamePrefix .
  • Funkce používá, namePrefix protože můžete použít pouze parametry definované ve funkci. Další informace najdete v tématu omezení.
  • V resources oddílu šablony name prvek používá funkci a předá storageNamePrefix hodnotu funkci namePrefix .

Omezení

Při definování uživatelské funkce existují určitá omezení:

  • Funkce nemá přístup k proměnným.
  • Funkce může používat pouze parametry, které jsou definovány ve funkci. Použijete-li funkci Parameters v rámci uživatelsky definované funkce, budete omezeni na parametry této funkce.
  • Funkce nemůže volat jiné uživatelsky definované funkce.
  • Funkce nemůže používat odkazovou funkci ani žádnou z funkcí seznamu .
  • Funkce nemůže používat funkci dateTimeAdd .
  • Parametry pro funkci nemohou mít výchozí hodnoty.

Další kroky