Zelfstudie: Een resource aan uw ARM-sjabloon toevoegen

  • Artikel

In de vorige zelfstudie hebt u geleerd hoe u uw eerste lege Azure Resource Manager-sjabloon (ARM-sjabloon) maakt en implementeert. U bent nu klaar om een werkelijke resource in die sjabloon te implementeren. In dit geval een Azure-opslagaccount. Deze instructie duurt 9 minuten .

Vereisten

U wordt aangeraden om eerst de inleidende zelfstudie over sjablonen te voltooien, maar dit is niet verplicht.

Visual Studio Code moet zijn geïnstalleerd en werken met de Azure Resource Manager Tools-extensie en Azure PowerShell of Azure Command-Line Interface (CLI). Zie de hulpprogramma's voor sjablonen voor meer informatie.

Resource toevoegen

Als u een definitie van een Azure-opslagaccount wilt toevoegen aan de bestaande sjabloon, bekijkt u het gemarkeerde JSON-bestand in het volgende voorbeeld. In plaats van secties van de sjabloon te kopiëren, kopieert u het hele bestand en vervangt u uw sjabloon door de inhoud ervan.

Vervang {provide-unique-name} en de accolades {} door een unieke naam voor het opslagaccount.

Belangrijk

De naam van het opslagaccount moet uniek zijn in Azure. Het zijn alleen kleine letters of cijfers en hebben een limiet van 24 tekens. U kunt een naam zoals store1 als voorvoegsel gebruiken en vervolgens uw initialen en de datum van vandaag toevoegen. De naam kan bijvoorbeeld store1abc06132022 zijn.

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "resources": [
    {
      "type": "Microsoft.Storage/storageAccounts",
      "apiVersion": "2021-09-01",
      "name": "{provide-unique-name}",
      "location": "eastus",
      "sku": {
        "name": "Standard_LRS"
      },
      "kind": "StorageV2",
      "properties": {
        "supportsHttpsTrafficOnly": true
      }
    }
  ]
}

Het bedenken van een unieke naam voor een opslagaccount is niet eenvoudig en werkt niet goed voor het automatiseren van grote implementaties. Verderop in deze reeks zelfstudies gebruikt u sjabloonfuncties waarmee u eenvoudiger een unieke naam kunt maken.

Resource-eigenschappen

U vraagt zich misschien af hoe u de eigenschappen voor elk resourcetype kunt vinden. U kunt de resourcetypen die u wilt implementeren, vinden in het referentiemateriaal voor ARM-sjablonen.

Elke resource die u implementeert, heeft ten minste de volgende drie eigenschappen:

  • type: Het type resource. Deze waarde is een combinatie van de naamruimte van de resourceprovider en het resourcetype, zoals Microsoft.Storage/storageAccounts.
  • apiVersion: De versie van de REST API die moet worden gebruikt voor het maken van de resource. Elke resourceprovider publiceert eigen API-versies. Met andere woorden, elk type heeft een specifieke waarde.
  • name: De naam van de resource.

De meeste resources hebben ook een location eigenschap, waarmee de regio wordt ingesteld waar u de resource implementeert.

De overige eigenschappen variëren per resourcetype en API-versie. Het is belangrijk om inzicht te krijgen in het verband tussen de API-versie en de beschikbare eigenschappen. Daarom gaan we er hier dieper op in.

In deze zelfstudie voegt u een opslagaccount toe aan de sjabloon. U kunt de API-versie van het opslagaccount zien op storageAccounts 2021-09-01. U ziet dat u niet alle eigenschappen aan de sjabloon toevoegt. Veel eigenschappen zijn optioneel. De resourceprovider Microsoft.Storage kan een nieuwe API-versie uitbrengen, maar de versie die u implementeert, hoeft niet te worden gewijzigd. U kunt die versie blijven gebruiken en weten dat de resultaten van uw implementatie consistent zijn.

Als u een oudere API-versie bekijkt, ziet u mogelijk dat er een kleinere set eigenschappen beschikbaar is.

Als u besluit de API-versie voor een resource te wijzigen, moet u de eigenschappen voor die versie evalueren en de sjabloon dienovereenkomstig aanpassen.

Sjabloon implementeren

U kunt de sjabloon implementeren om het opslagaccount te maken. Geef een andere naam voor uw implementatie op zodat u deze eenvoudig kunt vinden in de geschiedenis.

Zie Resourcegroep maken als u de resourcegroep nog niet hebt gemaakt. In het voorbeeld wordt ervan uitgegaan dat u de variabele templateFile hebt ingesteld op het pad naar het sjabloonbestand, zoals weergegeven in de eerste zelfstudie.

New-AzResourceGroupDeployment `
  -Name addstorage `
  -ResourceGroupName myResourceGroup `
  -TemplateFile $templateFile

Notitie

Als de implementatie mislukt, gebruikt u de verbose schakeloptie om informatie op te halen over de resources die u maakt. Gebruik de schakeloptie debug voor meer informatie over foutopsporing.

Deze fouten zijn twee mogelijke implementatiefouten die kunnen optreden:

  • Error: Code=AccountNameInvalid; Message={provide-unique-name} is geen geldige opslagaccountnaam. De naam van het opslagaccount moet tussen de 3 en 24 tekens lang zijn en alleen cijfers en kleine letters bevatten.

    Vervang {provide-unique-name} (met inbegrip van de accolades) in de sjabloon door een unieke opslagaccountnaam. Zie Resource toevoegen.

  • Error: Code=StorageAccountAlreadyTaken; Message=The storage account named store1abc09092019 wordt al gebruikt.

    Probeer in de sjabloon een andere naam voor het opslagaccount.

Deze implementatie duurt langer dan uw lege sjabloonimplementatie omdat u een opslagaccount maakt. Het kan ongeveer een minuut duren.

Implementatie verifiëren

U kunt de implementatie controleren door de resourcegroep te bekijken vanuit de Azure Portal.

  1. Meld u aan bij de Azure-portal.
  2. Selecteer Resourcegroepen in het linkermenu.
  3. Schakel het selectievakje links van myResourceGroup in en selecteer myResourceGroup
  4. Selecteer de resourcegroep waarin de sjabloon is geïmplementeerd.
  5. U ziet dat een opslagaccount is geïmplementeerd.
  6. U ziet dat het implementatielabel nu de volgende tekst bevat: Implementaties: 2 geslaagd.

Resources opschonen

Als u verdergaat met de volgende zelfstudie, hoeft u de resourcegroep niet te verwijderen.

Als u nu stopt, wilt u de geïmplementeerde resources wellicht opschonen door de resourcegroep te verwijderen.

  1. Selecteer Resourcegroep in het linkermenu van Azure Portal.
  2. Typ de naam van de resourcegroep in het vak Filteren op een veld... .
  3. Schakel het selectievakje naast myResourceGroup in en selecteer myResourceGroup of de naam van de resourcegroep die u hebt gekozen.
  4. Selecteer Resourcegroep verwijderen in het bovenste menu.

Volgende stappen

U hebt een eenvoudige sjabloon voor het implementeren van een Azure-opslagaccount gemaakt. In de volgende zelfstudies leert u hoe u parameters, variabelen, resources en uitvoer toevoegt aan een sjabloon. Deze items zijn de bouwstenen voor veel complexere sjablonen.

Parameters toevoegen