Итерация выходных данных в шаблонах ARM
В этой статье показано, как создать более одного значения для выходных данных в шаблоне Azure Resource Manager (шаблоне ARM). Добавив цикл копирования в раздел outputs шаблона, можно динамически возвращать число элементов во время развертывания.
Можно также использовать цикл копирования для ресурсов, свойств в ресурсе и переменных.
Совет
Мы рекомендуем использовать Bicep, так как он предоставляет те же возможности, что и шаблоны ARM, и имеет более простой синтаксис. Дополнительные сведения см. в статье о циклах.
Синтаксис
Добавьте элемент copy
в раздел outputs шаблона, чтобы вернуть число элементов. Элемент копирования имеет следующий общий формат.
"copy": {
"count": <number-of-iterations>,
"input": <values-for-the-output>
}
Свойство count
определяет количество итераций, которое требуется выполнить для выходного значения.
Свойство input
задает те свойства, которые необходимо повторить. Вы создадите массив элементов на основе значения в свойстве input
. Это может быть одно свойство (например, строка) или объект с несколькими свойствами.
Ограничения копирования
Количество не может превышать 800.
Количество не может быть отрицательным. Оно может быть равно нулю, если вы развертываете шаблон с помощью последней версии Azure CLI, PowerShell или REST API. В частности, необходимо использовать:
- Azure PowerShell версии 2.6 или более поздней;
- Azure CLI версии 2.0.74 или более поздней;
- REST API версии 2019-05-10 или более поздней.
- Связанные развертывания должны использовать API версии 2019-05-10 или более поздней для типа ресурса развертывания
Более ранние версии PowerShell, CLI и REST API не поддерживают нулевое значение.
Итерация выходных данных
В следующем примере создается переменное число учетных записей хранения и возвращается конечная точка для каждой учетной записи хранения.
{
"$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
"contentVersion": "1.0.0.0",
"parameters": {
"storageCount": {
"type": "int",
"defaultValue": 2
},
"location": {
"type": "string",
"defaultValue": "[resourceGroup().location]"
}
},
"variables": {
"baseName": "[format('storage{0}', uniqueString(resourceGroup().id))]"
},
"resources": [
{
"copy": {
"name": "storagecopy",
"count": "[parameters('storageCount')]"
},
"type": "Microsoft.Storage/storageAccounts",
"apiVersion": "2022-09-01",
"name": "[format('{0}{1}', copyIndex(), variables('baseName'))]",
"location": "[parameters('location')]",
"sku": {
"name": "Standard_LRS"
},
"kind": "Storage",
"properties": {}
}
],
"outputs": {
"storageEndpoints": {
"type": "array",
"copy": {
"count": "[parameters('storageCount')]",
"input": "[reference(format('{0}{1}', copyIndex(), variables('baseName'))).primaryEndpoints.blob]"
}
}
}
}
Приведенный выше шаблон возвращает массив со следующими значениями:
[
"https://0storagecfrbqnnmpeudi.blob.core.windows.net/",
"https://1storagecfrbqnnmpeudi.blob.core.windows.net/"
]
Следующий пример возвращает три свойства из новых учетных записей хранения.
{
"$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
"contentVersion": "1.0.0.0",
"parameters": {
"storageCount": {
"type": "int",
"defaultValue": 2
},
"location": {
"type": "string",
"defaultValue": "[resourceGroup().location]"
}
},
"variables": {
"baseName": "[format('storage{0}', uniqueString(resourceGroup().id))]"
},
"resources": [
{
"copy": {
"name": "storagecopy",
"count": "[length(range(0, parameters('storageCount')))]"
},
"type": "Microsoft.Storage/storageAccounts",
"apiVersion": "2022-09-01",
"name": "[format('{0}{1}', range(0, parameters('storageCount'))[copyIndex()], variables('baseName'))]",
"location": "[parameters('location')]",
"sku": {
"name": "Standard_LRS"
},
"kind": "Storage",
"properties": {}
}
],
"outputs": {
"storageInfo": {
"type": "array",
"copy": {
"count": "[length(range(0, parameters('storageCount')))]",
"input": {
"id": "[resourceId('Microsoft.Storage/storageAccounts', format('{0}{1}', copyIndex(), variables('baseName')))]",
"blobEndpoint": "[reference(format('{0}{1}', copyIndex(), variables('baseName'))).primaryEndpoints.blob]",
"status": "[reference(format('{0}{1}', copyIndex(), variables('baseName'))).statusOfPrimary]"
}
}
}
}
}
В представленном выше примере возвращается массив со следующими значениями:
[
{
"id": "/subscriptions/00000000/resourceGroups/demoGroup/providers/Microsoft.Storage/storageAccounts/0storagecfrbqnnmpeudi",
"blobEndpoint": "https://0storagecfrbqnnmpeudi.blob.core.windows.net/",
"status": "available"
},
{
"id": "/subscriptions/00000000/resourceGroups/demoGroup/providers/Microsoft.Storage/storageAccounts/1storagecfrbqnnmpeudi",
"blobEndpoint": "https://1storagecfrbqnnmpeudi.blob.core.windows.net/",
"status": "available"
}
]
Следующие шаги
- Ознакомьтесь с учебником Руководство по созданию нескольких экземпляров ресурса с помощью шаблонов ARM.
- Дополнительные сведения об использовании цикла копирования см. в следующих статье:
- Если вы хотите изучить разделы шаблона, ознакомьтесь с разделом Описание структуры и синтаксиса шаблонов ARM.
- Чтобы узнать, как развернуть шаблон, ознакомьтесь с разделом Развертывание ресурсов с помощью шаблонов ARM и Azure PowerShell.