Tutorial: Hinzufügen einer Ressource zu Ihrer ARM-Vorlage

  • Artikel

Im vorherigen Tutorial haben Sie erfahren, wie Sie Ihre erste leere Azure Resource Manager-Vorlage (ARM-Vorlage) erstellen und bereitstellen. Nun können Sie eine tatsächliche Ressource in dieser Vorlage bereitstellen. In diesem Fall ist es ein Azure Storage-Konto. Die Anleitung dauert 9 Minuten.

Voraussetzungen

Wir empfehlen, das Einführungstutorial zu Vorlagen durchzuführen. Dies ist jedoch keine Voraussetzung.

Visual Studio Code muss mit der Azure Resource Manager-Tools-Erweiterung installiert und funktionsfähig sein, und Sie benötigen entweder Azure PowerShell oder die Azure-Befehlszeilenschnittstelle (Azure CLI). Weitere Informationen finden Sie unter Vorlagentools.

Ressource hinzufügen

Die hervorgehobene JSON-Datei im folgenden Beispiel zeigt, wie Sie der vorhandenen Vorlage eine Definition für ein Azure Storage-Konto hinzufügen. Anstatt Abschnitte der Vorlage zu kopieren, kopieren Sie die gesamte Datei und ersetzen Ihre Vorlage durch den Inhalt der Datei.

Ersetzen Sie {provide-unique-name} und die geschweiften Klammern {} durch einen eindeutigen Speicherkontonamen.

Wichtig

Der Name des Speicherkontos muss innerhalb von Azure eindeutig sein. Er darf nur Kleinbuchstaben oder Zahlen enthalten und maximal 24 Zeichen lang sein. Sie können beispielsweise store1 als Präfix verwenden und dahinter Ihre Initialen und das aktuelle Datum anfügen. Der Name könnte beispielsweise store1abc06132022 lauten.

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

Das Erraten des eindeutigen Namens für ein Speicherkonto ist nicht einfach und keine gute Lösung, wenn Sie umfangreiche Bereitstellungen automatisieren möchten. In einem späteren Teil dieser Tutorialreihe lernen Sie Vorlagenfunktionen kennen, die das Erstellen eines eindeutigen Namens vereinfachen.

Ressourceneigenschaften

Vielleicht fragen Sie sich, wie Sie die zu verwendenden Eigenschaften für die einzelnen Ressourcentypen herausfinden können. Die Referenz zur ARM-Vorlage kann Ihnen als Hilfe beim Suchen nach den gewünschten Ressourcentypen für Ihre Bereitstellung dienen.

Jede Ressource, die Sie bereitstellen, verfügt mindestens über die folgenden drei Eigenschaften:

  • type: Der Typ der Ressource. Dieser Wert ist eine Kombination aus dem Namespace des Ressourcenanbieters und dem Ressourcentyp (z. B. Microsoft.Storage/storageAccounts).
  • apiVersion: Version der REST-API zum Erstellen der Ressource. Jeder Ressourcenanbieter veröffentlicht seine eigenen API-Versionen. Dieser Wert unterscheidet sich daher je nach Typ.
  • name Der Name der Ressource.

Die meisten Ressourcen verfügen auch über eine location-Eigenschaft, mit der Sie die Region festlegen, in der die Ressource bereitgestellt wird.

Die anderen Eigenschaften variieren je nach Ressourcentyp und API-Version. Das Verständnis der Beziehung zwischen der API-Version und den verfügbaren Eigenschaften ist wichtig. Wir werden daher ausführlicher darauf eingehen.

In diesem Tutorial fügen Sie der Vorlage ein Speicherkonto hinzu. Sie finden die API-Version für dieses Speicherkonto unter storageAccounts 2021-09-01. Bedenken Sie, dass Sie Ihrer Vorlage nicht alle Eigenschaften hinzugefügt haben. Viele der Eigenschaften sind optional. Der Microsoft.Storage-Ressourcenanbieter könnte eine neue API-Version veröffentlichen, ohne dass sich die von Ihnen bereitgestellte Version ändert. Sie können diese Version weiterhin verwenden und dabei sicher sein, dass die Ergebnisse Ihrer Bereitstellung immer konsistent sind.

Wenn eine ältere API-Version angezeigt wird, stellen Sie möglicherweise fest, dass weniger Eigenschaften verfügbar sind.

Falls Sie sich entscheiden, die API-Version für eine Ressource zu ändern, müssen Sie die Eigenschaften für diese Version prüfen und die Vorlage entsprechend anpassen.

Bereitstellen der Vorlage

Sie können die Vorlage bereitstellen, um das Speicherkonto zu erstellen. Verwenden Sie einen anderen Namen für Ihre Bereitstellung, damit Sie sie problemlos im Verlauf finden können.

Falls Sie die Ressourcengruppe noch nicht erstellt haben, folgen Sie den Anweisungen unter Erstellen einer Ressourcengruppe. Dieses Beispiel setzt voraus, dass Sie die Variable templateFile wie im ersten Tutorial beschrieben auf den Pfad zur Vorlagendatei festgelegt haben.

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

Hinweis

Wenn bei der Bereitstellung ein Fehler auftritt, verwenden Sie den Schalter verbose, um Informationen zu den erstellten Ressourcen abzurufen. Verwenden Sie den Schalter debug, um weitere Informationen zum Debuggen zu erhalten.

Bei der Bereitstellung können die folgenden zwei Fehler auftreten:

  • Error: Code=AccountNameInvalid; Message={provide-unique-name} ist kein gültiger Speicherkontoname. Der Speicherkontoname muss zwischen 3 und 24 Zeichen lang sein und darf nur Zahlen und Kleinbuchstaben enthalten.

    Ersetzen Sie in der Vorlage {provide-unique-name} durch einen eindeutigen Namen für das Speicherkonto. Weitere Informationen finden Sie unter Hinzufügen einer Ressource.

  • Error: Code=StorageAccountAlreadyTaken; Message=The storage account named store1abc09092019 wird bereits verwendet.

    Verwenden Sie in der Vorlage einen anderen Speicherkontonamen.

Diese Bereitstellung dauert länger als die der leeren Vorlage, da Sie ein Speicherkonto erstellen. Sie kann etwa fünf Minuten dauern.

Überprüfen der Bereitstellung

Sie können die Bereitstellung überprüfen, indem Sie sich die Ressourcengruppe im Azure-Portal ansehen.

  1. Melden Sie sich beim Azure-Portal an.
  2. Wählen Sie im linken Menü Ressourcengruppen aus.
  3. Aktivieren Sie das Kontrollkästchen links neben myResourceGroup, und wählen Sie myResourceGroup aus.
  4. Wählen Sie die Ressourcengruppe aus, in der Sie die Vorlage bereitgestellt haben.
  5. Sie sehen, dass ein Speicherkonto bereitgestellt wurde.
  6. Beachten Sie, dass die Bereitstellungsbezeichnung nun Bereitstellungen: 2 erfolgreich lautet.

Bereinigen von Ressourcen

Wenn Sie mit dem nächsten Tutorial fortfahren, müssen Sie die Ressourcengruppe nicht löschen.

Falls Sie keine weiteren Tutorials durchführen möchten, können Sie die bereitgestellten Ressourcen bereinigen, indem Sie die Ressourcengruppe löschen.

  1. Wählen Sie im Azure-Portal im linken Menü die Option Ressourcengruppe aus.
  2. Geben Sie den Ressourcengruppennamen im Feld Nach einem beliebigen Feld filtern ein.
  3. Aktivieren Sie das Kontrollkästchen neben „myResourceGroup“, und wählen Sie myResourceGroup oder den von Ihnen ausgewählten Ressourcengruppennamen aus.
  4. Wählen Sie Ressourcengruppe löschen aus dem Menü ganz oben aus.

Nächste Schritte

Sie haben eine einfache Vorlage zum Bereitstellen eines Azure-Speicherkontos erstellt. In den nächsten Tutorials erfahren Sie, wie Sie einer Vorlage Parameter, Variablen, Ressourcen und Ausgaben hinzufügen. Diese Features sind die Bausteine für weitaus komplexere Vorlagen.

Hinzufügen von Parametern