ARM 템플릿의 구문 및 식
ARM 템플릿(Azure Resource Manager 템플릿)의 기본 구문은 JSON(JavaScript Object Notation)입니다. 그러나 식을 사용하여 템플릿에서 사용할 수 있는 JSON 값을 확장할 수 있습니다. 식은 [ 및 ] 대괄호로 각각 시작 및 종료됩니다. 식의 값은 템플릿을 배포할 때 평가됩니다. 식은 문자열, 정수, 부울, 배열 또는 개체를 반환할 수 있습니다.
템플릿 식은 24,576자를 초과할 수 없습니다.
함수 사용
Azure Resource Manager에서는 템플릿에서 사용할 수 있는 함수를 제공합니다. 다음 예에서는 매개 변수의 기본값에서 함수를 사용하는 식을 보여 줍니다.
"parameters": {
"location": {
"type": "string",
"defaultValue": "[resourceGroup().location]"
}
},
식 내에서 resourceGroup() 구문은 템플릿 내에서 사용하기 위해 Resource Manager가 제공하는 함수 중 하나를 호출합니다. 이 경우 resourceGroup 함수입니다. JavaScript에서와 마찬가지로 함수 호출은 functionName(arg1,arg2,arg3)과 같이 형식이 지정됩니다. 구문 .location은 해당 함수에서 반환된 개체에서 하나의 속성을 검색합니다.
템플릿 함수 및 해당 매개 변수는 대/소문자를 구분하지 않습니다. 예를 들어 Resource Manager는 variables('var1') 및 VARIABLES('VAR1')를 동일하게 해결합니다. 계산될 때 함수는 대/소문자를 명시적으로 수정하지 않는 한(toUpper 또는 toLower 등) 대/소문자를 보존합니다. 특정 리소스 유형에는 함수가 계산되는 방식에 관계없이 대/소문자 요구 사항이 있을 수 있습니다.
문자열 값을 매개 변수로 함수에 전달하려면 작은따옴표를 사용합니다.
"name": "[concat('storage', uniqueString(resourceGroup().id))]"
대부분의 함수는 리소스 그룹, 구독, 관리 그룹 또는 테넌트에 배포되었는지 여부와 상관없이 동일하게 작동합니다. 다음 함수는 범위에 따라 제한이 있습니다.
- resourceGroup - 리소스 그룹에 대한 배포에서만 사용할 수 있습니다.
- resourceId - 모든 범위에서 사용할 수 있지만 유효한 매개 변수는 범위에 따라 변경됩니다.
- 구독 - 리소스 그룹 또는 구독에 대한 배포에서만 사용할 수 있습니다.
이스케이프 문자
리터럴 문자열을 왼쪽 대괄호 [로 시작하여 오른쪽 대괄호 ]로 끝나되, 식으로 해석되지 않게 하려면 문자 [[로 시작하도록 추가 대괄호를 추가합니다. 예를 들어 변수는 다음과 같습니다.
"demoVar1": "[[test value]"
[test value]로 확인됩니다.
그러나 리터럴 문자열이 대괄호로 끝나지 않는 경우에는 첫 번째 대괄호를 이스케이프하지 않습니다. 예를 들어 변수는 다음과 같습니다.
"demoVar2": "[test] value"
[test] value로 확인됩니다.
템플릿에서 JSON 개체를 추가하는 것과 같이 식에서 큰따옴표를 이스케이프하려면 백슬래시를 사용합니다.
"tags": {
"CostCenter": "{\"Dept\":\"Finance\",\"Environment\":\"Production\"}"
},
ARM 식 출력에서 작은따옴표를 이스케이프하려면 작은따옴표를 두 배로 둡니다. 다음 템플릿의 출력은 JSON 값 {"abc":"'quoted'"}을(를) 생성합니다.
{
"$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
"contentVersion": "1.0.0.0",
"parameters": {},
"resources": [],
"outputs": {
"foo": {
"type": "object",
"value": "[createObject('abc', '''quoted''')]"
}
}
}
리소스 정의에서 식 내의 이중 이스케이프 값입니다. 다음 템플릿의 scriptOutput은 de'f입니다.
{
"$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
"contentVersion": "1.0.0.0",
"parameters": {
"forceUpdateTag": {
"type": "string",
"defaultValue": "[newGuid()]"
}
},
"variables": {
"deploymentScriptSharedProperties": {
"forceUpdateTag": "[parameters('forceUpdateTag')]",
"azPowerShellVersion": "10.1",
"retentionInterval": "P1D"
}
},
"resources": [
{
"type": "Microsoft.Resources/deploymentScripts",
"apiVersion": "2020-10-01",
"name": "escapingTest",
"location": "[resourceGroup().location]",
"kind": "AzurePowerShell",
"properties": "[union(variables('deploymentScriptSharedProperties'), createObject('scriptContent', '$DeploymentScriptOutputs = @{}; $DeploymentScriptOutputs.escaped = \"de''''f\";'))]"
}
],
"outputs": {
"scriptOutput": {
"type": "string",
"value": "[reference('escapingTest').outputs.escaped]"
}
}
}
languageVersion 2.0을 사용하면 이중 이스케이프가 더 이상 필요하지 않습니다. 위의 예제는 동일한 결과 de'f을(를) 가져오기 위해 다음 JSON으로 작성할 수 있습니다.
{
"$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
"languageVersion": "2.0",
"contentVersion": "1.0.0.0",
"parameters": {
"forceUpdateTag": {
"type": "string",
"defaultValue": "[newGuid()]"
}
},
"variables": {
"deploymentScriptSharedProperties": {
"forceUpdateTag": "[parameters('forceUpdateTag')]",
"azPowerShellVersion": "10.1",
"retentionInterval": "P1D"
}
},
"resources": {
"escapingTest": {
"type": "Microsoft.Resources/deploymentScripts",
"apiVersion": "2020-10-01",
"name": "escapingTest",
"location": "[resourceGroup().location]",
"kind": "AzurePowerShell",
"properties": "[union(variables('deploymentScriptSharedProperties'), createObject('scriptContent', '$DeploymentScriptOutputs = @{}; $DeploymentScriptOutputs.escaped = \"de''f\";'))]"
}
},
"outputs": {
"scriptOutput": {
"type": "string",
"value": "[reference('escapingTest').outputs.escaped]"
}
}
}
매개 변수 값을 전달할 때 이스케이프 문자의 사용은 매개 변수 값이 지정된 위치에 따라 달라집니다. 템플릿에서 기본값을 설정하는 경우 추가적인 왼쪽 괄호를 만들어야 합니다.
{
"$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
"contentVersion": "1.0.0.0",
"parameters": {
"demoParam1": {
"type": "string",
"defaultValue": "[[test value]"
}
},
"resources": [],
"outputs": {
"exampleOutput": {
"type": "string",
"value": "[parameters('demoParam1')]"
}
}
}
기본값을 사용하는 경우 템플릿은 [test value]를 반환합니다.
그러나 명령줄을 통해 매개 변수 값을 전달하는 경우 문자는 문자 그대로 해석됩니다. 다음을 사용하여 이전 템플릿 배포:
New-AzResourceGroupDeployment -ResourceGroupName demoGroup -TemplateFile azuredeploy.json -demoParam1 "[[test value]"
[[test value]을(를) 반환합니다. 대신 다음을 사용합니다.
New-AzResourceGroupDeployment -ResourceGroupName demoGroup -TemplateFile azuredeploy.json -demoParam1 "[test value]"
매개 변수 파일에서 값을 전달할 때 동일한 형식이 적용됩니다. 문자는 문자 그대로 해석됩니다. 위의 템플릿과 함께 사용하는 경우 다음 매개 변수 파일은 [test value]을 반환합니다.
{
"$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
"contentVersion": "1.0.0.0",
"parameters": {
"demoParam1": {
"value": "[test value]"
}
}
}
Null 값
속성을 null로 설정하려면 null 또는 [json('null')]을 사용할 수 있습니다. null을 매개 변수로 제공하면 JSON 함수는 빈 개체를 반환합니다. 두 경우 모두 Resource Manager 템플릿은 이를 속성이 없는 것처럼 처리합니다.
"stringValue": null,
"objectValue": "[json('null')]"
요소를 완전히 제거하려면 filter() 함수를 사용할 수 있습니다. 예시:
{
"$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
"contentVersion": "1.0.0.0",
"parameters": {
"deployCaboodle": {
"type": "bool",
"defaultValue": false
}
},
"variables": {
"op": [
{
"name": "ODB"
},
{
"name": "ODBRPT"
},
{
"name": "Caboodle"
}
]
},
"resources": [],
"outputs": {
"backendAddressPools": {
"type": "array",
"value": "[if(parameters('deployCaboodle'), variables('op'), filter(variables('op'), lambda('on', not(equals(lambdaVariables('on').name, 'Caboodle')))))]"
}
}
}
다음 단계
- 템플릿에서 사용할 수 있는 함수 전체 목록은 ARM 템플릿 함수를 참조하세요.
- 템플릿 파일에 대한 자세한 내용은 ARM 템플릿의 구조 및 구문 이해를 참조하세요.