ARM şablonlarının yapısını ve söz dizimini anlama

Bu makalede bir Azure Resource Manager şablonunun yapısı açıklanmaktadır (ARM şablonu). Bir şablonun farklı bölümlerini ve bu bölümlerde kullanılabilen özellikleri gösterir.

Bu makale, ARM şablonları hakkında bazı benzerlik sahibi olan kullanıcılar için tasarlanmıştır. Şablonun yapısı hakkında ayrıntılı bilgi sağlar. Şablon oluşturma sürecinde size kılavuzluk eden adım adım bir öğretici için bkz. öğretici: Ilk ARM şablonunuzu oluşturma ve dağıtma. Microsoft Learn üzerinde bir Kılavuzlu dizi modülle ARM şablonları hakkında bilgi edinmek için bkz. ARM şablonlarını kullanarak Azure 'da kaynakları dağıtma ve yönetme.

Şablon biçimi

En basit yapısında, bir şablon aşağıdaki öğelere sahiptir:

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "",
  "apiProfile": "",
  "parameters": {  },
  "variables": {  },
  "functions": [  ],
  "resources": [  ],
  "outputs": {  }
}

Her öğenin ayarlayabileceğiniz özellikleri vardır. Bu makalede, şablonun bölümleri daha ayrıntılı olarak açıklanmaktadır.

Parametreler

parametersŞablonun bölümünde, kaynakları dağıttığınızda hangi değerleri gir, istediğinizi belirtirsiniz. Bir şablonda 256 parametreyle sınırlı olursunuz. Birden çok özellik içeren nesneleri kullanarak parametre sayısını azaltabilirsiniz.

Bir parametre için kullanılabilir özellikler şunlardır:

"parameters": {
  "<parameter-name>" : {
    "type" : "<type-of-parameter-value>",
    "defaultValue": "<default-value-of-parameter>",
    "allowedValues": [ "<array-of-allowed-values>" ],
    "minValue": <minimum-value-for-int>,
    "maxValue": <maximum-value-for-int>,
    "minLength": <minimum-length-for-string-or-array>,
    "maxLength": <maximum-length-for-string-or-array-parameters>,
    "metadata": {
      "description": "<description-of-the parameter>"
    }
  }
}

Parametrelerin nasıl kullanılacağına ilişkin örnekler için bkz. ARM şablonlarındaki parametreler.

Değişkenler

variablesBölümünde, şablonunuzun tamamında kullanılabilecek değerler oluşturursunuz. Değişken tanımlamanız gerekmez, ancak genellikle karmaşık ifadeleri azaltarak şablonunuzu basitleştirir. Her değişkenin biçimi, veri türlerindenbiriyle eşleşir.

Aşağıdaki örnekte değişken tanımlamaya uygun seçenekler ve seçenekler açık bir şekilde ve açık bir şekilde ve daha sonra açık bir şekilde açık bir şekilde ve daha fazla değişkenle birlikte kullanılabilir:

"variables": {
  "<variable-name>": "<variable-value>",
  "<variable-name>": {
    <variable-complex-type-value>
  },
  "<variable-object-name>": {
    "copy": [
      {
        "name": "<name-of-array-property>",
        "count": <number-of-iterations>,
        "input": <object-or-value-to-repeat>
      }
    ]
  },
  "copy": [
    {
      "name": "<variable-array-name>",
      "count": <number-of-iterations>,
      "input": <object-or-value-to-repeat>
    }
  ]
}

bir değişken için çeşitli copy değerler oluşturmak için kullanma hakkında bilgi için bkz. Değişken yinelemesi.

Değişkenleri kullanma örnekleri için bkz. ARM şablonunda değişkenler.

İşlevler

Şablon içinde kendi işlevlerinizi oluşturabilirsiniz. Bu işlevler şablonda kullanılabilir. Genellikle, şablonunuz genelinde tekrarlamak istemeyebilirsiniz karmaşık ifadeler tanımlarsınız. Şablonlarda desteklenen ifadelerden ve işlevlerden kullanıcı tanımlı işlevler oluşturursanız.

Kullanıcı işlevi tanımlarken bazı kısıtlamalar vardır:

• İşlev değişkenlere erişe değildir.
• İşlev yalnızca işlevde tanımlanan parametreleri kullanabilir. Kullanıcı tanımlı bir işlevde parameters işlevini kullanırken, bu işlevin parametreleriyle sınırlandırılmış oluruz.
• İşlev, diğer kullanıcı tanımlı işlevleri çağıramaz.
• işlevi başvuru işlevini kullanamayr.
• İşlevin parametreleri varsayılan değerlere sahip değildir.

"functions": [
  {
    "namespace": "<namespace-for-functions>",
    "members": {
      "<function-name>": {
        "parameters": [
          {
            "name": "<parameter-name>",
            "type": "<type-of-parameter-value>"
          }
        ],
        "output": {
          "type": "<type-of-output-value>",
          "value": "<function-return-value>"
        }
      }
    }
  }
],

Özel işlevleri kullanma örnekleri için bkz. ARM şablonunda kullanıcı tanımlı işlevler.

Kaynaklar

bölümünde, resources dağıtılan veya güncelleştirilen kaynakları tanımlarsiniz.

Kaynakları aşağıdaki yapıyla tanımlarsiniz:

"resources": [
  {
      "condition": "<true-to-deploy-this-resource>",
      "type": "<resource-provider-namespace/resource-type-name>",
      "apiVersion": "<api-version-of-resource>",
      "name": "<name-of-the-resource>",
      "comments": "<your-reference-notes>",
      "location": "<location-of-resource>",
      "dependsOn": [
          "<array-of-related-resource-names>"
      ],
      "tags": {
          "<tag-name1>": "<tag-value1>",
          "<tag-name2>": "<tag-value2>"
      },
      "identity": {
        "type": "<system-assigned-or-user-assigned-identity>",
        "userAssignedIdentities": {
          "<resource-id-of-identity>": {}
        }
      },
      "sku": {
          "name": "<sku-name>",
          "tier": "<sku-tier>",
          "size": "<sku-size>",
          "family": "<sku-family>",
          "capacity": <sku-capacity>
      },
      "kind": "<type-of-resource>",
      "scope": "<target-scope-for-extension-resources>",
      "copy": {
          "name": "<name-of-copy-loop>",
          "count": <number-of-iterations>,
          "mode": "<serial-or-parallel>",
          "batchSize": <number-to-deploy-serially>
      },
      "plan": {
          "name": "<plan-name>",
          "promotionCode": "<plan-promotion-code>",
          "publisher": "<plan-publisher>",
          "product": "<plan-product>",
          "version": "<plan-version>"
      },
      "properties": {
          "<settings-for-the-resource>",
          "copy": [
              {
                  "name": ,
                  "count": ,
                  "input": {}
              }
          ]
      },
      "resources": [
          "<array-of-child-resources>"
      ]
  }
]

Çıkışlar

bölümünde, outputs dağıtımdan döndürülen değerleri belirtirsiniz. Genellikle, dağıtılan kaynaklardan değerler dönersiniz.

Aşağıdaki örnek, çıkış tanımının yapısını gösterir:

"outputs": {
  "<output-name>": {
    "condition": "<boolean-value-whether-to-output-value>",
    "type": "<type-of-output-value>",
    "value": "<output-value-expression>",
    "copy": {
      "count": <number-of-iterations>,
      "input": <values-for-the-variable>
    }
  }
}

Çıkışları kullanma örnekleri için bkz. ARM şablonunda çıkışlar.

Açıklamalar ve meta veriler

Şablonunuz için açıklama ve meta veri eklemeye yönelik birkaç seçenek vardır.

Yorumlar

Satır içi açıklamalar için veya // /* ... */ kullanabilirsiniz.

{
  "type": "Microsoft.Compute/virtualMachines",
  "apiVersion": "2018-10-01",
  "name": "[variables('vmName')]", // to customize name, change it in variables
  "location": "[parameters('location')]", //defaults to resource group location
  "dependsOn": [ /* storage account and network interface must be deployed first */
    "[resourceId('Microsoft.Storage/storageAccounts/', variables('storageAccountName'))]",
    "[resourceId('Microsoft.Network/networkInterfaces/', variables('nicName'))]"
  ],

Bu Visual Studio Code, Azure Resource Manager Araçları uzantısı bir ARM şablonunu otomatik olarak algılar ve dil modunu değiştirebilir. Uygulama şablonunun Azure Resource Manager sağ alt köşesinde bir Şablon Visual Studio Code satır içi yorumları kullanabilirsiniz. Satır içi açıklamalar artık geçersiz olarak işaretlenir.

Meta veri

Şablonda neredeyse metadata herhangi bir yere nesne eklemek için kullanabilirsiniz. Resource Manager nesnesini yoksayıyor, ancak JSON düzenleyiciniz özelliğin geçerli olmadığını konusunda sizi uyarıyor olabilir. nesnesinde, ihtiyacınız olan özellikleri tanımlayın.

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "metadata": {
    "comments": "This template was developed for demonstration purposes.",
    "author": "Example Name"
  },

için, parameters metadata özelliğine sahip bir nesnesi description ekleyin.

"parameters": {
  "adminUsername": {
    "type": "string",
    "metadata": {
      "description": "User name for the Virtual Machine."
    }
  },

Şablonu portal üzerinden dağıtırken, açıklamaya sağ istediğiniz metin otomatik olarak bu parametrenin ipucu olarak kullanılır.

için resources bir öğe veya nesne comments metadata ekleyin. Aşağıdaki örnekte hem bir öğesi comments hem de nesnesi metadata gösterir.

"resources": [
  {
    "type": "Microsoft.Storage/storageAccounts",
    "apiVersion": "2018-07-01",
    "name": "[concat('storage', uniqueString(resourceGroup().id))]",
    "comments": "Storage account used to store VM disks",
    "location": "[parameters('location')]",
    "metadata": {
      "comments": "These tags are needed for policy compliance."
    },
    "tags": {
      "Dept": "[parameters('deptName')]",
      "Environment": "[parameters('environment')]"
    },
    "sku": {
      "name": "Standard_LRS"
    },
    "kind": "Storage",
    "properties": {}
  }
]

için outputs çıkış metadata değerine bir nesnesi ekleyin.

"outputs": {
  "hostname": {
    "type": "string",
    "value": "[reference(variables('publicIPAddressName')).dnsSettings.fqdn]",
    "metadata": {
      "comments": "Return the fully qualified domain name"
    }
  },

Kullanıcı tanımlı işlevlere metadata nesne ekleriz.

Çok satırlı dizeler

Bir dizeyi birden çok satıra kesebilirsiniz. Örneğin, location AŞAĞıDAKI JSON örneğinde, özelliğine ve açıklamalardan birine bakın.

{
  "type": "Microsoft.Compute/virtualMachines",
  "apiVersion": "2018-10-01",
  "name": "[variables('vmName')]", // to customize name, change it in variables
  "location": "[
    parameters('location')
    ]", //defaults to resource group location
  /*
    storage account and network interface
    must be deployed first
  */
  "dependsOn": [
    "[resourceId('Microsoft.Storage/storageAccounts/', variables('storageAccountName'))]",
    "[resourceId('Microsoft.Network/networkInterfaces/', variables('nicName'))]"
  ],

Sonraki adımlar

• Farklı türlerde çözümler için tam şablonları görüntülemek üzere bkz. Azure Hızlı Başlangıç Şablonları.
• Bir şablon içinden kullanabileceğiniz işlevlerle ilgili ayrıntılar için bkz. ARM şablon işlevleri.
• Dağıtım sırasında birkaç şablonu birleştirmek için bkz. Azure kaynaklarını dağıttığınızda bağlı ve iç içe Şablonlar kullanma.
• Şablon oluşturma hakkında öneriler için bkz. ARM şablonu en iyi uygulamaları.
• Yaygın soruların yanıtları için bkz. ARM şablonları hakkında sık sorulan sorular.