ARM 模板的比较函数

项目
10/13/2023

资源管理器提供了多个用于在 Azure 资源管理器模板（ARM 模板）中进行比较的函数：

coalesce
equals
greater
greaterOrEquals
less
lessOrEquals

提示

建议使用 Bicep，因为它提供与 ARM 模板相同的功能，并且该语法更易于使用。若要了解详细信息，请参阅合并逻辑运算符和比较运算符。

coalesce

coalesce(arg1, arg2, arg3, ...)

从参数中返回第一个非 null 值。空字符串、空数组和空对象不为 null。

在 Bicep 中，改用 ?? 运算符。请参阅联合 ??。

parameters

参数	必选	Type	说明
arg1	是	int、string、array 或 object	要测试是否为 null 的第一个值。
其他参数	否	int、string、array 或 object	要测试是否为 null 的其他值。

返回值

第一个非 null 参数的值，可以是字符串、整数、数组或对象。如果所有参数都为 null，则为 null。

示例

以下示例模板显示 coalesce 不同用法的输出。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "objectToTest": {
      "type": "object",
      "defaultValue": {
        "null1": null,
        "null2": null,
        "string": "default",
        "int": 1,
        "object": { "first": "default" },
        "array": [ 1 ]
      }
    }
  },
  "resources": [
  ],
  "outputs": {
    "stringOutput": {
      "type": "string",
      "value": "[coalesce(parameters('objectToTest').null1, parameters('objectToTest').null2, parameters('objectToTest').string)]"
    },
    "intOutput": {
      "type": "int",
      "value": "[coalesce(parameters('objectToTest').null1, parameters('objectToTest').null2, parameters('objectToTest').int)]"
    },
    "objectOutput": {
      "type": "object",
      "value": "[coalesce(parameters('objectToTest').null1, parameters('objectToTest').null2, parameters('objectToTest').object)]"
    },
    "arrayOutput": {
      "type": "array",
      "value": "[coalesce(parameters('objectToTest').null1, parameters('objectToTest').null2, parameters('objectToTest').array)]"
    },
    "emptyOutput": {
      "type": "bool",
      "value": "[empty(coalesce(parameters('objectToTest').null1, parameters('objectToTest').null2))]"
    }
  }
}

上述示例中使用默认值的输出为：

名称	类型	值
stringOutput	String	默认值
intOutput	int	1
objectOutput	Object	{"first": "default"}
arrayOutput	Array	[1]
emptyOutput	Bool	True

equals

equals(arg1, arg2)

检查两个值是否相等。

在 Bicep 中，改用 == 运算符。请参阅等于 = =。

parameters

参数	必选	Type	说明
arg1	是	int、string、array 或 object	要检查是否相等的第一个值。
arg2	是	int、string、array 或 object	要检查是否相等的第二个值。

返回值

如果值相等，返回 True；否则返回 False。

备注

equals 函数通常与 condition 元素一起使用来测试资源是否已部署。

{
  "condition": "[equals(parameters('newOrExisting'),'new')]",
  "type": "Microsoft.Storage/storageAccounts",
  "name": "[variables('storageAccountName')]",
  "apiVersion": "2017-06-01",
  "location": "[resourceGroup().location]",
  "sku": {
    "name": "[variables('storageAccountType')]"
  },
  "kind": "Storage",
  "properties": {}
}

示例

以下示例检查不同类型的值是否相等。所有默认值都返回 True。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "firstInt": {
      "type": "int",
      "defaultValue": 1
    },
    "secondInt": {
      "type": "int",
      "defaultValue": 1
    },
    "firstString": {
      "type": "string",
      "defaultValue": "a"
    },
    "secondString": {
      "type": "string",
      "defaultValue": "a"
    },
    "firstArray": {
      "type": "array",
      "defaultValue": [ "a", "b" ]
    },
    "secondArray": {
      "type": "array",
      "defaultValue": [ "a", "b" ]
    },
    "firstObject": {
      "type": "object",
      "defaultValue": { "a": "b" }
    },
    "secondObject": {
      "type": "object",
      "defaultValue": { "a": "b" }
    }
  },
  "resources": [
  ],
  "outputs": {
    "checkInts": {
      "type": "bool",
      "value": "[equals(parameters('firstInt'), parameters('secondInt') )]"
    },
    "checkStrings": {
      "type": "bool",
      "value": "[equals(parameters('firstString'), parameters('secondString'))]"
    },
    "checkArrays": {
      "type": "bool",
      "value": "[equals(parameters('firstArray'), parameters('secondArray'))]"
    },
    "checkObjects": {
      "type": "bool",
      "value": "[equals(parameters('firstObject'), parameters('secondObject'))]"
    }
  }
}

上述示例中使用默认值的输出为：

名称	类型	Value
checkInts	Bool	True
checkStrings	Bool	True
checkArrays	Bool	True
checkObjects	Bool	True

以下示例模板结合使用 not 和 equals。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "resources": [
  ],
  "outputs": {
    "checkNotEquals": {
      "type": "bool",
      "value": "[not(equals(1, 2))]"
    }
  }
}

前述示例的输出为：

名称	类型	Value
checkNotEquals	Bool	True

greater

greater(arg1, arg2)

检查第一个值是否大于第二个值。

在 Bicep 中，改用 > 运算符。请参阅大于 >。

参数

参数	必选	Type	说明
arg1	是	int 或 string	用于大于比较的第一个值。
arg2	是	int 或 string	用于大于比较的第二个值。

返回值

如果第一个值大于第二个值，返回 True；否则返回 False。

示例

以下示例检查一个值是否大于另一个值。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "firstInt": {
      "type": "int",
      "defaultValue": 1
    },
    "secondInt": {
      "type": "int",
      "defaultValue": 2
    },
    "firstString": {
      "type": "string",
      "defaultValue": "A"
    },
    "secondString": {
      "type": "string",
      "defaultValue": "a"
    }
  },
  "resources": [
  ],
  "outputs": {
    "checkInts": {
      "type": "bool",
      "value": "[greater(parameters('firstInt'), parameters('secondInt') )]"
    },
    "checkStrings": {
      "type": "bool",
      "value": "[greater(parameters('firstString'), parameters('secondString'))]"
    }
  }
}

上述示例中使用默认值的输出为：

名称	类型	Value
checkInts	Bool	False
checkStrings	Bool	True

greaterOrEquals

greaterOrEquals(arg1, arg2)

检查第一个值是否大于或等于第二个值。

在 Bicep 中，改用 >= 运算符。请参阅大于或等于 >=。

参数

参数	必选	Type	说明
arg1	是	int 或 string	用于大于或等于比较的第一个值。
arg2	是	int 或 string	用于大于或等于比较的第二个值。

返回值

如果第一个值大于或等于第二个值，返回 True；否则返回 False。

示例

以下示例检查一个值是否大于等于另一个值。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "firstInt": {
      "type": "int",
      "defaultValue": 1
    },
    "secondInt": {
      "type": "int",
      "defaultValue": 2
    },
    "firstString": {
      "type": "string",
      "defaultValue": "A"
    },
    "secondString": {
      "type": "string",
      "defaultValue": "a"
    }
  },
  "resources": [
  ],
  "outputs": {
    "checkInts": {
      "type": "bool",
      "value": "[greaterOrEquals(parameters('firstInt'), parameters('secondInt') )]"
    },
    "checkStrings": {
      "type": "bool",
      "value": "[greaterOrEquals(parameters('firstString'), parameters('secondString'))]"
    }
  }
}

上述示例中使用默认值的输出为：

名称	类型	Value
checkInts	Bool	False
checkStrings	Bool	True

less

less(arg1, arg2)

检查第一个值是否小于第二个值。

在 Bicep 中，改用 < 运算符。请参阅小于 <。

参数

参数	必选	Type	说明
arg1	是	int 或 string	用于小于比较的第一个值。
arg2	是	int 或 string	用于小于比较的第二个值。

返回值

如果第一个值小于第二个值，返回 True；否则返回 False。

示例

以下示例检查一个值是否小于另一个值。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "firstInt": {
      "type": "int",
      "defaultValue": 1
    },
    "secondInt": {
      "type": "int",
      "defaultValue": 2
    },
    "firstString": {
      "type": "string",
      "defaultValue": "A"
    },
    "secondString": {
      "type": "string",
      "defaultValue": "a"
    }
  },
  "resources": [
  ],
  "outputs": {
    "checkInts": {
      "type": "bool",
      "value": "[less(parameters('firstInt'), parameters('secondInt') )]"
    },
    "checkStrings": {
      "type": "bool",
      "value": "[less(parameters('firstString'), parameters('secondString'))]"
    }
  }
}

上述示例中使用默认值的输出为：

名称	类型	Value
checkInts	Bool	True
checkStrings	Bool	False

lessOrEquals

lessOrEquals(arg1, arg2)

检查第一个值是否小于或等于第二个值。

在 Bicep 中，改用 <= 运算符。请参阅小于或等于 <=。

参数

参数	必选	Type	说明
arg1	是	int 或 string	用于小于或等于比较的第一个值。
arg2	是	int 或 string	用于小于或等于比较的第二个值。

返回值

如果第一个值小于或等于第二个值，返回 True；否则返回 False。

示例

以下示例检查一个值是否小于等于另一个值。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "firstInt": {
      "type": "int",
      "defaultValue": 1
    },
    "secondInt": {
      "type": "int",
      "defaultValue": 2
    },
    "firstString": {
      "type": "string",
      "defaultValue": "A"
    },
    "secondString": {
      "type": "string",
      "defaultValue": "a"
    }
  },
  "resources": [
  ],
  "outputs": {
    "checkInts": {
      "type": "bool",
      "value": "[lessOrEquals(parameters('firstInt'), parameters('secondInt') )]"
    },
    "checkStrings": {
      "type": "bool",
      "value": "[lessOrEquals(parameters('firstString'), parameters('secondString'))]"
    }
  }
}

上述示例中使用默认值的输出为：

名称	类型	Value
checkInts	Bool	True
checkStrings	Bool	False

后续步骤

有关 ARM 模板中各部分的说明，请参阅了解 ARM 模板的结构和语法。

通过

ARM 模板的比较函数

coalesce

parameters

返回值

示例

equals

parameters

返回值

备注

示例

greater

参数

返回值

示例

greaterOrEquals

参数

返回值

示例

less

参数

返回值

示例

lessOrEquals

参数

返回值

示例

后续步骤

其他资源