Förstå strukturen och syntaxen för ARM-mallar

I den här artikeln beskrivs strukturen för en Azure Resource Manager mall (ARM-mall). Den visar de olika avsnitten i en mall och de egenskaper som är tillgängliga i dessa avsnitt.

Den här artikeln är avsedd för användare som har viss kunskap om ARM-mallar. Den innehåller detaljerad information om mallens struktur. En stegvis självstudiekurs som vägleder dig genom processen för att skapa en mall finns i Självstudie: Skapa och distribuera din första ARM-mall. Mer information om ARM-mallar via en guidad uppsättning moduler på Microsoft Learn finns i Distribuera och hantera resurser i Azure med hjälp av ARM-mallar.

Mallformat

I sin enklaste struktur har en mall följande element:

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "",
  "apiProfile": "",
  "parameters": {  },
  "variables": {  },
  "functions": [  ],
  "resources": [  ],
  "outputs": {  }
}

Varje element har egenskaper som du kan ange. Den här artikeln beskriver avsnitten i mallen i detalj.

Parametrar

I avsnittet parameters i mallen anger du vilka värden du kan ange när du distribuerar resurserna. Du kan ha högst 256 parametrar i en mall. Du kan minska antalet parametrar genom att använda objekt som innehåller flera egenskaper.

Tillgängliga egenskaper för en parameter är:

"parameters": {
  "<parameter-name>" : {
    "type" : "<type-of-parameter-value>",
    "defaultValue": "<default-value-of-parameter>",
    "allowedValues": [ "<array-of-allowed-values>" ],
    "minValue": <minimum-value-for-int>,
    "maxValue": <maximum-value-for-int>,
    "minLength": <minimum-length-for-string-or-array>,
    "maxLength": <maximum-length-for-string-or-array-parameters>,
    "metadata": {
      "description": "<description-of-the parameter>"
    }
  }
}

Exempel på hur du använder parametrar finns i Parametrar i ARM-mallar.

Variabler

I avsnittet variables skapar du värden som kan användas i hela mallen. Du behöver inte definiera variabler, men de förenklar ofta mallen genom att minska antalet komplexa uttryck. Formatet för varje variabel matchar en av datatyperna.

I följande exempel visas de tillgängliga alternativen för att definiera en variabel:

"variables": {
  "<variable-name>": "<variable-value>",
  "<variable-name>": {
    <variable-complex-type-value>
  },
  "<variable-object-name>": {
    "copy": [
      {
        "name": "<name-of-array-property>",
        "count": <number-of-iterations>,
        "input": <object-or-value-to-repeat>
      }
    ]
  },
  "copy": [
    {
      "name": "<variable-array-name>",
      "count": <number-of-iterations>,
      "input": <object-or-value-to-repeat>
    }
  ]
}

Information om hur du copy använder för att skapa flera värden för en variabel finns i Variabel iteration.

Exempel på hur du använder variabler finns i Variables in ARM template (Variabler i ARM-mall).

Functions

I mallen kan du skapa egna funktioner. Dessa funktioner är tillgängliga för användning i mallen. Vanligtvis definierar du komplicerade uttryck som du inte vill upprepa i mallen. Du skapar användardefinierade funktioner från uttryck och funktioner som stöds i mallar.

När du definierar en användarfunktion finns det vissa begränsningar:

• Funktionen kan inte komma åt variabler.
• Funktionen kan bara använda parametrar som definieras i funktionen. När du använder parameterfunktionen i en användardefinierad funktion är du begränsad till parametrarna för den funktionen.
• Funktionen kan inte anropa andra användardefinierade funktioner.
• Funktionen kan inte använda referensfunktionen.
• Parametrar för funktionen kan inte ha standardvärden.

"functions": [
  {
    "namespace": "<namespace-for-functions>",
    "members": {
      "<function-name>": {
        "parameters": [
          {
            "name": "<parameter-name>",
            "type": "<type-of-parameter-value>"
          }
        ],
        "output": {
          "type": "<type-of-output-value>",
          "value": "<function-return-value>"
        }
      }
    }
  }
],

Exempel på hur du använder anpassade funktioner finns i Användardefinierade funktioner i ARM-mallen.

Resurser

I avsnittet resources definierar du de resurser som distribueras eller uppdateras.

Du definierar resurser med följande struktur:

"resources": [
  {
      "condition": "<true-to-deploy-this-resource>",
      "type": "<resource-provider-namespace/resource-type-name>",
      "apiVersion": "<api-version-of-resource>",
      "name": "<name-of-the-resource>",
      "comments": "<your-reference-notes>",
      "location": "<location-of-resource>",
      "dependsOn": [
          "<array-of-related-resource-names>"
      ],
      "tags": {
          "<tag-name1>": "<tag-value1>",
          "<tag-name2>": "<tag-value2>"
      },
      "identity": {
        "type": "<system-assigned-or-user-assigned-identity>",
        "userAssignedIdentities": {
          "<resource-id-of-identity>": {}
        }
      },
      "sku": {
          "name": "<sku-name>",
          "tier": "<sku-tier>",
          "size": "<sku-size>",
          "family": "<sku-family>",
          "capacity": <sku-capacity>
      },
      "kind": "<type-of-resource>",
      "scope": "<target-scope-for-extension-resources>",
      "copy": {
          "name": "<name-of-copy-loop>",
          "count": <number-of-iterations>,
          "mode": "<serial-or-parallel>",
          "batchSize": <number-to-deploy-serially>
      },
      "plan": {
          "name": "<plan-name>",
          "promotionCode": "<plan-promotion-code>",
          "publisher": "<plan-publisher>",
          "product": "<plan-product>",
          "version": "<plan-version>"
      },
      "properties": {
          "<settings-for-the-resource>",
          "copy": [
              {
                  "name": ,
                  "count": ,
                  "input": {}
              }
          ]
      },
      "resources": [
          "<array-of-child-resources>"
      ]
  }
]

Utdata

I avsnittet outputs anger du värden som returneras från distributionen. Normalt returnerar du värden från resurser som har distribuerats.

I följande exempel visas strukturen för en utdatadefinition:

"outputs": {
  "<output-name>": {
    "condition": "<boolean-value-whether-to-output-value>",
    "type": "<type-of-output-value>",
    "value": "<output-value-expression>",
    "copy": {
      "count": <number-of-iterations>,
      "input": <values-for-the-variable>
    }
  }
}

Exempel på hur du använder utdata finns i Utdata i ARM-mallen.

Kommentarer och metadata

Du har några alternativ för att lägga till kommentarer och metadata i mallen.

Kommentarer

För infogade kommentarer kan du använda antingen // eller /* ... */ .

{
  "type": "Microsoft.Compute/virtualMachines",
  "apiVersion": "2018-10-01",
  "name": "[variables('vmName')]", // to customize name, change it in variables
  "location": "[parameters('location')]", //defaults to resource group location
  "dependsOn": [ /* storage account and network interface must be deployed first */
    "[resourceId('Microsoft.Storage/storageAccounts/', variables('storageAccountName'))]",
    "[resourceId('Microsoft.Network/networkInterfaces/', variables('nicName'))]"
  ],

I Visual Studio Code kan Azure Resource Manager Tools-tillägget automatiskt identifiera en ARM-mall och ändra språkläget. Om du Azure Resource Manager mallen längst ned till höger i Visual Studio Code kan du använda de infogade kommentarerna. De infogade kommentarerna markeras inte längre som ogiltiga.

Metadata

Du kan lägga till ett metadata objekt nästan var som helst i mallen. Resource Manager ignorerar objektet, men JSON-redigeraren kan varna dig om att egenskapen inte är giltig. I objektet definierar du de egenskaper som du behöver.

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "metadata": {
    "comments": "This template was developed for demonstration purposes.",
    "author": "Example Name"
  },

För parameters lägger du till ett metadata -objekt med en description -egenskap.

"parameters": {
  "adminUsername": {
    "type": "string",
    "metadata": {
      "description": "User name for the Virtual Machine."
    }
  },

När du distribuerar mallen via portalen används den text som du anger i beskrivningen automatiskt som ett tips för den parametern.

För resources lägger du till ett element eller ett comments metadata -objekt. I följande exempel visas både ett comments -element och ett metadata -objekt.

"resources": [
  {
    "type": "Microsoft.Storage/storageAccounts",
    "apiVersion": "2018-07-01",
    "name": "[concat('storage', uniqueString(resourceGroup().id))]",
    "comments": "Storage account used to store VM disks",
    "location": "[parameters('location')]",
    "metadata": {
      "comments": "These tags are needed for policy compliance."
    },
    "tags": {
      "Dept": "[parameters('deptName')]",
      "Environment": "[parameters('environment')]"
    },
    "sku": {
      "name": "Standard_LRS"
    },
    "kind": "Storage",
    "properties": {}
  }
]

För outputs lägger du till ett metadata -objekt i utdatavärdet.

"outputs": {
  "hostname": {
    "type": "string",
    "value": "[reference(variables('publicIPAddressName')).dnsSettings.fqdn]",
    "metadata": {
      "comments": "Return the fully qualified domain name"
    }
  },

Du kan inte lägga till ett metadata -objekt i användardefinierade funktioner.

Flerradssträngar

Du kan dela upp en sträng i flera rader. Se till exempel egenskapen location och en av kommentarerna i följande JSON-exempel.

{
  "type": "Microsoft.Compute/virtualMachines",
  "apiVersion": "2018-10-01",
  "name": "[variables('vmName')]", // to customize name, change it in variables
  "location": "[
    parameters('location')
    ]", //defaults to resource group location
  /*
    storage account and network interface
    must be deployed first
  */
  "dependsOn": [
    "[resourceId('Microsoft.Storage/storageAccounts/', variables('storageAccountName'))]",
    "[resourceId('Microsoft.Network/networkInterfaces/', variables('nicName'))]"
  ],

Nästa steg

• Om du vill visa kompletta mallar för många olika typer av lösningar kan du se Azure-snabbstartsmallar.
• Mer information om de funktioner som du kan använda inifrån en mall finns i ARM-mallfunktioner.
• Om du vill kombinera flera mallar under distributionen kan du se Använda länkade och kapslade mallar när du distribuerar Azure-resurser.
• Rekommendationer om hur du skapar mallar finns i Metodtips för ARM-mallar.
• Svar på vanliga frågor finns i Vanliga frågor och svar om ARM-mallar.