Erkunden von Azure Resource Manager-Vorlagenstruktur und -schema

  • 6 Minuten

Eine Azure Resource Manager-Vorlage enthält eine als JSON formatierte Definition mindestens einer Azure-Ressource, zusammen mit Parametern und Variablen, die das Anpassen ihrer Konfiguration erleichtern.

In der einfachsten Struktur weist eine Vorlage die folgenden Elemente auf:

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "",
  "apiProfile": "",
  "parameters": {  },
  "variables": {  },
  "functions": [  ],
  "resources": [  ],
  "outputs": {  }
}
Elementname Erforderlich BESCHREIBUNG
$schema Ja Speicherort der JSON-Schemadatei (JavaScript Object Notation), die die Version der Vorlagensprache beschreibt. Die von Ihnen verwendete Versionsnummer hängt vom Umfang der Bereitstellung und vom JSON-Editor ab.

Wenn Sie Visual Studio Code mit der Erweiterung für Azure Resource Manager-Tools nutzen, verwenden Sie die aktuelle Version für Bereitstellungen von Ressourcengruppen:
https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#

Andere Editoren (einschließlich Visual Studio) können dieses Schema unter Umständen nicht verarbeiten. Verwenden Sie für diese Editoren Folgendes:
https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#

Verwenden Sie Folgendes für Bereitstellungen von Abonnements:
https://schema.management.azure.com/schemas/2018-05-01/subscriptionDeploymentTemplate.json#

Verwenden Sie für Bereitstellungen von Verwaltungsgruppen Folgendes:
https://schema.management.azure.com/schemas/2019-08-01/managementGroupDeploymentTemplate.json#

Verwenden Sie für Bereitstellungen von Mandanten Folgendes:
https://schema.management.azure.com/schemas/2019-08-01/tenantDeploymentTemplate.json#
contentVersion Ja Version der Vorlage (z. B. 1.0.0.0). Sie können einen beliebigen Wert für dieses Element resources. Mit diesem Wert können Sie wichtige Änderungen in der Vorlage dokumentieren. Bei der Bereitstellung von Ressourcen mithilfe der Vorlage kann mit diesem Wert sichergestellt werden, dass die richtige Vorlage verwendet wird.
apiProfile Nein Eine API-Version, die als Sammlung von API-Versionen für Ressourcentypen dient. Verwenden Sie diesen Wert, um zu vermeiden, dass Sie API-Versionen für jede Ressource in der Vorlage angeben müssen. Wenn Sie eine API-Profilversion aber keine API-Version für den Ressourcentyp angeben, verwendet Resource Manager die API-Version für diesen Ressourcentyp, der im Profil bestimmt wurde.

Die API-Profileigenschaft ist besonders hilfreich, wenn Sie eine Vorlage in verschiedenen Umgebungen wie Azure Stack und der globalen Azure-Umgebung bereitstellen. Verwenden Sie die API-Profilversion, um sicherzustellen, dass Ihre Vorlage automatisch Versionen verwendet, die in beiden Umgebungen unterstützt werden. Eine Liste der im Profil definierten aktuellen API-Profilversionen und Ressourcen-API-Versionen finden Sie unter API Profile (API-Profil).

Weitere Informationen finden Sie unter Nachverfolgen von Versionen mithilfe von API-Profilen.
parameters Nein Werte, die bei der Bereitstellung angegeben werden, um die Bereitstellung der Ressourcen anpassen.
variables Nein Werte, die als JSON-Fragmente in der Vorlage verwendet werden, um Vorlagensprachausdrücke zu vereinfachen.
functions Nein Benutzerdefinierte Funktionen, die in der Vorlage verfügbar sind.
resources Ja Ressourcentypen, die in einer Ressourcengruppe oder einem Abonnement bereitgestellt oder aktualisiert werden.
outputs Nein Werte, die nach der Bereitstellung zurückgegeben werden.

Optionale Demo