Definieren der Reihenfolge für die Bereitstellung von Ressourcen in ARM-Vorlagen

Artikel
09/26/2024

Beim Bereitstellen einer Ressource müssen Sie möglicherweise sicherstellen, dass andere Ressourcen bereits vorhanden sind. So benötigen Sie beispielsweise einen logischen SQL-Server, bevor Sie eine Datenbank bereitstellen. Diese Beziehung richten Sie ein, indem Sie eine Ressource als von einer anderen Ressource abhängig kennzeichnen. Verwenden Sie das dependsOn-Element, um eine explizite Abhängigkeit zu definieren. Verwenden Sie die Funktionen reference oder list, um eine implizite Abhängigkeit zu definieren.

Azure Resource Manager wertet die Abhängigkeiten zwischen den Ressourcen aus und stellt sie in der Reihenfolge ihrer Abhängigkeiten bereit. Wenn Ressourcen nicht voneinander abhängig sind, stellt Resource Manager sie parallel bereit. Sie müssen nur Abhängigkeiten für Ressourcen definieren, die in der gleichen Vorlage bereitgestellt werden.

Tipp

Wir empfehlen Bicep, weil es dieselben Funktionen wie ARM-Vorlagen bietet und die Syntax einfacher zu verwenden ist. Weitere Informationen finden Sie unter Ressourcenabhängigkeiten.

dependsOn

Innerhalb Ihrer Azure Resource Manager-Vorlage (ARM-Vorlage) bietet das dependsOn-Element die Möglichkeit, eine Ressource als von einer oder mehreren Ressourcen abhängig zu definieren. Sein Wert ist ein JSON-Array (JavaScript Object Notation) von Zeichenfolgen, die jeweils einen Ressourcennamen oder eine ID darstellen. Das Array kann Ressourcen mit bedingter Bereitstellung enthalten. Wenn eine bedingte Ressource nicht bereitgestellt wurde, entfernt Azure Resource Manager sie automatisch aus den erforderlichen Abhängigkeiten.

Das folgende Beispiel zeigt eine Netzwerkschnittstelle, die von einem virtuellen Netzwerk, einer Netzwerksicherheitsgruppe und einer öffentlichen IP-Adresse abhängig ist. Die vollständige Vorlage finden Sie in der Schnellstartvorlage für eine Linux-VM.

{
  "type": "Microsoft.Network/networkInterfaces",
  "apiVersion": "2022-07-01",
  "name": "[variables('networkInterfaceName')]",
  "location": "[parameters('location')]",
  "dependsOn": [
    "[resourceId('Microsoft.Network/networkSecurityGroups/', parameters('networkSecurityGroupName'))]",
    "[resourceId('Microsoft.Network/virtualNetworks/', parameters('virtualNetworkName'))]",
    "[resourceId('Microsoft.Network/publicIpAddresses/', variables('publicIpAddressName'))]"
  ],
  ...
}

Verwenden Sie mit languageVersion 2.0 den symbolischen Ressourcennamen in dependsOn-Arrays. Zum Beispiel:

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "languageVersion": "2.0",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "location": {
      "type": "string",
      "defaultValue": "[resourceGroup().location]"
    }
  },
  "resources": {
    "myStorage": {
      "type": "Microsoft.Storage/storageAccounts",
      "apiVersion": "2023-01-01",
      "name": "[format('storage{0}', uniqueString(resourceGroup().id))]",
      "location": "[parameters('location')]",
      "sku": {
        "name": "Standard_LRS"
      },
      "kind": "StorageV2"
    },
    "myVm": {
      "type": "Microsoft.Compute/virtualMachines",
      "apiVersion": "2023-03-01",
      "name": "[format('vm{0}', uniqueString(resourceGroup().id))]",
      "location": "[parameters('location')]",
      "dependsOn": [
        "myStorage"
      ],
      ...
    }
  }
}

Sie können Beziehungen zwischen Ihren Ressourcen mithilfe von dependsOn zuordnen, dabei sollte Ihnen jedoch bewusst sein, welchen Zweck diese Zuordnung erfüllt. Um beispielsweise zu dokumentieren, wie Ressourcen miteinander verbunden sind, ist dependsOn nicht der richtige Ansatz. Nach der Bereitstellung behält die Ressource keine Bereitstellungsabhängigkeiten in ihren Eigenschaften bei, sodass keine Befehle oder Vorgänge mehr vorhanden sind, mit denen Sie Abhängigkeiten anzeigen können. Das Festlegen unnötiger Abhängigkeiten verlangsamt die Bereitstellung, da Resource Manager diese Ressourcen nicht gleichzeitig bereitstellen kann.

Untergeordnete Ressourcen

Es wird nicht automatisch eine implizite Bereitstellungsabhängigkeit zwischen einer untergeordneten Ressource und der übergeordneten Ressource erstellt. Wenn Sie die untergeordnete Ressource nach der übergeordneten Ressource bereitstellen müssen, legen Sie die dependsOn-Eigenschaft fest.

Das folgende Beispiel zeigt einen logischen SQL-Server und eine Datenbank. Beachten Sie, dass eine explizite Abhängigkeit zwischen der Datenbank und dem Server definiert wird, obwohl die Datenbank ein untergeordnetes Element des Servers ist.

"resources": [
  {
    "type": "Microsoft.Sql/servers",
    "apiVersion": "2022-05-01-preview",
    "name": "[parameters('serverName')]",
    "location": "[parameters('location')]",
    "properties": {
      "administratorLogin": "[parameters('administratorLogin')]",
      "administratorLoginPassword": "[parameters('administratorLoginPassword')]"
    },
    "resources": [
      {
        "type": "databases",
        "apiVersion": "2022-05-01-preview",
        "name": "[parameters('sqlDBName')]",
        "location": "[parameters('location')]",
        "sku": {
          "name": "Standard",
          "tier": "Standard"
          },
        "dependsOn": [
          "[resourceId('Microsoft.Sql/servers', parameters('serverName'))]"
        ]
      }
    ]
  }
]

Die vollständige Vorlage finden Sie in der Schnellstartvorlage für Azure SQL-Datenbank.

Funktionen „reference“ und „list“

Mit der reference -Funktion kann ein Ausdruck seinen Wert von anderen Paaren aus JSON-Name und -Wert oder Laufzeitressourcen ableiten. Die list*-Funktionen geben Werte für eine Ressource aus einem list-Vorgang zurück.

reference- und list-Ausdrücke deklarieren implizit, dass eine Ressource von einer anderen abhängt. Verwenden Sie nach Möglichkeit einen impliziten Verweis, um das Hinzufügen einer unnötigen Abhängigkeit zu vermeiden.

Um eine implizite Abhängigkeit zu erzwingen, verweisen Sie über den Namen auf die Ressource und nicht über die Ressourcen-ID. Wenn Sie die Ressourcen-ID an die reference- oder list-Funktionen übergeben, wird kein impliziter Verweis erstellt.

Das allgemeine Format der reference-Funktion sieht folgendermaßen aus:

reference('resourceName').propertyPath

Das allgemeine Format der listKeys-Funktion sieht folgendermaßen aus:

listKeys('resourceName', 'yyyy-mm-dd')

Im folgenden Beispiel hängt ein CDN-Endpunkt explizit vom CDN-Profil und implizit von einer Web-App ab.

{
    "type": "endpoints",
    "apiVersion": "2021-06-01",
    "name": "[variables('endpointName')]",
    "location": "[resourceGroup().location]",
    "dependsOn": [
      "[variables('profileName')]"
    ],
    "properties": {
      "originHostHeader": "[reference(variables('webAppName')).hostNames[0]]",
      ...
    }
    ...
}

Weitere Informationen finden Sie unter reference-Funktion.

Abhängigkeit von Ressourcen in einer Schleife

Für das Bereitstellen von Ressourcen, die von Ressourcen in einer Kopierschleife abhängig sind, haben Sie zwei Möglichkeiten. Sie können eine Abhängigkeit von einzelnen Ressourcen in der Schleife oder von der gesamten Schleife festlegen.

Hinweis

In den meisten Szenarien sollten Sie die Abhängigkeit von einzelnen Ressourcen innerhalb der Kopierschleife festlegen. Legen Sie eine Abhängigkeit von der gesamten-Schleife nur dann fest, wenn alle Ressourcen in der Schleife vorhanden sein müssen, bevor Sie die nächste Ressource erstellen. Das Festlegen der Abhängigkeit von der gesamten Schleife führt zu einer erheblichen Erweiterung des Abhängigkeitsgraphen. Dies gilt insbesondere, wenn diese Schleifenressourcen wiederum von anderen Ressourcen abhängig sind. Die erweiterten Abhängigkeiten erschweren die effiziente Ausführung der Bereitstellung.

Im folgenden Beispiel wird veranschaulicht, wie Sie mehrere VMs bereitstellen. Die Vorlage erstellt die gleiche Anzahl von Netzwerkschnittstellen. Jede VM ist von einer Netzwerkschnittstelle abhängig und nicht von der gesamten Schleife.

{
  "type": "Microsoft.Network/networkInterfaces",
  "apiVersion": "2022-07-01",
  "name": "[format('{0}-{1}', variables('nicPrefix'), copyIndex())]",
  "location": "[parameters('location')]",
  "copy": {
    "name": "nicCopy",
    "count": "[parameters('vmCount')]"
  },
  ...
},
{
  "type": "Microsoft.Compute/virtualMachines",
  "apiVersion": "2022-11-01",
  "name": "[format('{0}{1}', variables('vmPrefix'), copyIndex())]",
  "location": "[parameters('location')]",
  "dependsOn": [
    "[resourceId('Microsoft.Network/networkInterfaces',format('{0}-{1}', variables('nicPrefix'),copyIndex()))]"
  ],
  "copy": {
    "name": "vmCopy",
    "count": "[parameters('vmCount')]"
  },
  "properties": {
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "[resourceId('Microsoft.Network/networkInterfaces',format('(0)-(1)', variables('nicPrefix'), copyIndex()))]",
          "properties": {
            "primary": "true"
          }
        }
      ]
    },
    ...
  }
}

Das folgende Beispiel zeigt, wie drei Speicherkonten vor dem Bereitstellen des virtuellen Computers bereitgestellt werden. Beachten Sie, dass name für das copy-Element auf storagecopy und auch das dependsOn-Element für den virtuellen Computer auf storagecopy festgelegt ist.

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "location": {
      "type": "string",
      "defaultValue": "[resourceGroup().location]"
    }
  },
  "resources": [
    {
      "type": "Microsoft.Storage/storageAccounts",
      "apiVersion": "2022-09-01",
      "name": "[format('{0}storage{1}, copyIndex(), uniqueString(resourceGroup().id))]",
      "location": "[parameters('location')]",
      "sku": {
        "name": "Standard_LRS"
      },
      "kind": "Storage",
      "copy": {
        "name": "storagecopy",
        "count": 3
      },
      "properties": {}
    },
    {
      "type": "Microsoft.Compute/virtualMachines",
      "apiVersion": "2022-11-01",
      "name": "[format('VM{0}', uniqueString(resourceGroup().id))]",
      "dependsOn": ["storagecopy"],
      ...
    }
  ]
}

Symbolische Namen können in dependsOn-Arrays verwendet werden. Wenn ein symbolischer Name für eine Kopierschleife steht, werden alle Ressourcen in der Schleife als Abhängigkeiten hinzugefügt. Das obige Beispiel kann als der folgende JSON-Code geschrieben werden. Im Beispiel hängt myVM von allen Speicherkonten in der myStorages-Schleife ab.

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "languageVersion": "2.0",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "location": {
      "type": "string",
      "defaultValue": "[resourceGroup().location]"
    }
  },
  "resources": {
    "myStorages": {
      "type": "Microsoft.Storage/storageAccounts",
      "apiVersion": "2022-09-01",
      "name": "[format('{0}storage{1}, copyIndex(), uniqueString(resourceGroup().id))]",
      "location": "[parameters('location')]",
      "sku": {
        "name": "Standard_LRS"
      },
      "kind": "Storage",
      "copy": {
        "name": "storagecopy",
        "count": 3
      },
      "properties": {}
    },
    "myVM": {
      "type": "Microsoft.Compute/virtualMachines",
      "apiVersion": "2022-11-01",
      "name": "[format('VM{0}', uniqueString(resourceGroup().id))]",
      "dependsOn": ["myStorages"],
      ...
    }
  }
}

Ringabhängigkeiten

Resource Manager kennzeichnet Ringabhängigkeiten während der Überprüfung der Vorlage. Falls ein Fehler aufgrund einer Ringabhängigkeit ausgegeben wird, überprüfen Sie Ihre Vorlage, um festzustellen, ob bestimmte Abhängigkeiten entfernt werden können. Wenn das Entfernen der Abhängigkeiten nicht funktioniert, können Sie Ringabhängigkeiten vermeiden, indem Sie einige Bereitstellungsvorgänge in untergeordnete Ressourcen verschieben. Stellen Sie die untergeordneten Ressourcen nach den Ressourcen mit der Ringabhängigkeit bereit. Nehmen wir beispielsweise an, Sie stellen zwei virtuelle Computer bereit, müssen aber Eigenschaften festlegen, die auf den jeweils anderen verweisen. Sie können diese in der folgenden Reihenfolge bereitstellen:

VM1
VM2
Die Erweiterung auf VM1 hängt von VM1 und VM2 ab. Die Erweiterung legt Werte auf VM1 fest, die sie von VM2 abruft.
Die Erweiterung auf VM2 hängt von VM1 und VM2 ab. Die Erweiterung legt Werte auf VM2 fest, die sie von VM1 abruft.

Informationen über das Bewerten der Bereitstellungsreihenfolge und das Beheben von Abhängigkeitsfehlern finden Sie unter Beheben gängiger Azure-Bereitstellungsfehler mit Azure Resource Manager.

Nächste Schritte

Ein entsprechendes Tutorial finden Sie unter Tutorial: Erstellen von ARM-Vorlagen mit abhängigen Ressourcen.
Ein Lernmodul, das Ressourcenabhängigkeiten abdeckt, finden Sie unter Verwalten komplexer Cloudbereitstellungen mithilfe erweiterter ARM-Vorlagenfunktionen.
Empfehlungen zum Festlegen von Abhängigkeiten finden Sie unter Bewährte Methoden für ARM-Vorlagen.
Informationen zur Behebung von Abhängigkeiten während der Bereitstellung finden Sie unter Beheben gängiger Azure-Bereitstellungsfehler mit Azure Resource Manager.
Informationen zum Erstellen von Azure Resource Manager-Vorlagen finden Sie unter Verstehen der Struktur und Syntax von ARM-Vorlagen.
Eine Liste der verfügbaren Funktionen in einer Vorlage finden Sie unter ARM-Vorlagenfunktionen.

Freigeben über