Parameters in ARM-sjablonen

  • Artikel
  • 4 minuten om te lezen

In dit artikel wordt beschreven hoe u parameters in uw Azure Resource Manager (ARM-sjabloon) definieert en gebruikt. Door verschillende waarden voor parameters op te geven, kunt u een sjabloon opnieuw gebruiken voor verschillende omgevingen.

Resource Manager parameterwaarden worden opgelost voordat de implementatiebewerkingen worden uitgevoerd. Overal waar de parameter wordt gebruikt in de sjabloon, Resource Manager vervangen door de om opgeloste waarde.

Elke parameter moet worden ingesteld op een van de gegevenstypen.

Minimale declaratie

Elke parameter heeft minimaal een naam en type nodig.

Wanneer u een sjabloon implementeert via Azure Portal, worden parameternamen met camelcases omgezet in door ruimte gescheiden namen. DemoString in het volgende voorbeeld wordt bijvoorbeeld weergegeven als demotekenreeks. Zie Use a deployment button to deploy templates from GitHub repository (Een implementatieknop gebruiken om sjablonen te implementeren vanuit een GitHub-opslagplaats) en Resources implementeren met ARM-sjablonen en Azure Portal.

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

Beveiligde parameters

U kunt tekenreeks- of objectparameters als veilig markeren. De waarde van een beveiligde parameter wordt niet opgeslagen in de implementatiegeschiedenis en wordt niet geregistreerd.

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

Toegestane waarden

U kunt toegestane waarden voor een parameter definiëren. U geeft de toegestane waarden op in een matrix. De implementatie mislukt tijdens de validatie als er een waarde wordt doorgegeven voor de parameter die niet een van de toegestane waarden is.

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

Standaardwaarde

U kunt een standaardwaarde voor een parameter opgeven. De standaardwaarde wordt gebruikt wanneer er geen waarde wordt opgegeven tijdens de implementatie.

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

Gebruik de volgende syntaxis om een standaardwaarde samen met andere eigenschappen voor de parameter op te geven.

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

U kunt expressies gebruiken met de standaardwaarde. U kunt de referentiefunctie of een van de lijstfuncties in de sectie parameters niet gebruiken. Deze functies krijgen de runtime-status van een resource en kunnen niet worden uitgevoerd vóór de implementatie wanneer parameters worden opgelost.

Expressies zijn niet toegestaan met andere parametereigenschappen.

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

U kunt een andere parameterwaarde gebruiken om een standaardwaarde te maken. Met de volgende sjabloon wordt een hostplannaam gemaakt op basis van de sitenaam.

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

Lengtebeperkingen

U kunt minimale en maximale lengten opgeven voor tekenreeks- en matrixparameters. U kunt een of beide beperkingen instellen. Voor tekenreeksen geeft de lengte het aantal tekens aan. Voor matrices geeft de lengte het aantal items in de matrix aan.

In het volgende voorbeeld worden twee parameters gedeclareert. Eén parameter is voor een opslagaccountnaam die 3-24 tekens moet bevatten. De andere parameter is een matrix die uit 1-5 items moet hebben.

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

Beperkingen voor gehele getallen

U kunt minimum- en maximumwaarden instellen voor parameters met gehele getallen. U kunt een of beide beperkingen instellen.

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

Beschrijving

U kunt een beschrijving toevoegen aan een parameter om gebruikers van uw sjabloon inzicht te geven in de waarde die ze moeten opgeven. Wanneer u de sjabloon implementeert via de portal, wordt de tekst die u in de beschrijving opgeeft automatisch gebruikt als tip voor die parameter. Voeg alleen een beschrijving toe wanneer de tekst meer informatie biedt dan kan worden afgeleid van de parameternaam.

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

Parameter gebruiken

Als u wilt verwijzen naar de waarde van een parameter, gebruikt u de functie parameters. In het volgende voorbeeld wordt een parameterwaarde gebruikt voor de naam van een sleutelkluis.

{
  "$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')]",
      ...
    }
  ]
}

Objecten als parameters

U kunt gerelateerde waarden organiseren door ze door te geven als een -object. Deze aanpak vermindert ook het aantal parameters in de sjabloon.

In het volgende voorbeeld ziet u een parameter die een -object is. De standaardwaarde toont de verwachte eigenschappen voor het object. Deze eigenschappen worden gebruikt bij het definiëren van de resource die moet worden geïmplementeerd.

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

Voorbeeldsjablonen

In de volgende voorbeelden worden scenario's voor het gebruik van parameters gedemonstreerd.

Template Beschrijving
parameters met functies voor standaardwaarden Demonstreert hoe u sjabloonfuncties gebruikt bij het definiëren van standaardwaarden voor parameters. De sjabloon implementeert geen resources. Het maakt parameterwaarden en retourneert deze waarden.
parameterobject Demonstreert het gebruik van een -object voor een parameter. De sjabloon implementeert geen resources. Het maakt parameterwaarden en retourneert deze waarden.

Volgende stappen