Bicep 函式概觀
本文說明您可以在 Bicep 檔案中使用的所有函式。 若要定義自定義函式,請參閱 使用者定義函式。 如需 Bicep 檔案中各節的描述,請參閱 Bicep 檔案結構和語法。
大多數函式在部署至資源群組、訂用帳戶、管理群組或租用戶時都會以相同方式運作。 有些函式不能在所有範圍中使用。 這類函式如下所列。
函式的命名空間
兩個命名空間 az
和 sys
包含了所有 Bicep 函式。 使用函式時,通常無須指定命名空間。 只有當函式名稱與您在 Bicep 檔案中定義的另一個項目相同時,才需要指定命名空間。 例如,若要建立名稱為 range
的參數,則須新增 sys
命名空間以區分 range
函式。
// Parameter contains the same name as a function
param range int
// Must use sys namespace to call the function.
// The second use of range refers to the parameter.
output result array = sys.range(1, range)
az
命名空間包含 Azure 部署專屬的函式。 sys
命名空間包含用於建構值的函式。 sys
命名空間也包含參數和資源迴圈的裝飾項目。 本文會列出這類命名空間。
任何函式
Bicep 中可使用 any 函式,協助解決與資料類型警告相關的問題。 此函式位於 sys
命名空間。
陣列函數
您可使用下列函式來處理陣列。 這些函式全都位於 sys
命名空間。
- array
- concat
- contains
- empty
- indexOf
- first
- flatten
- intersection
- last
- lastIndexOf
- length
- min
- max
- range
- skip
- take
- union
無類別網域間函式 (CIDR) 函式
您可使用下列函式來處理 CIDR。 所有這些函式都在命名空間中 sys
:
日期函式
您可使用下列函式來處理日期。 所有這些函式都在命名空間中 sys
:
部署值函式
您可使用下列函式來取得與部署相關的值。 所有這些函式都在命名空間中 az
:
檔案函式
您可使用下列函式,將外部檔案內容載入 Bicep 檔案。 所有這些函式都在命名空間中 sys
:
Lambda 函數
您可以使用下列函數來處理 Lambda 運算式。 所有這些函式都在命名空間中 sys
:
邏輯函式
下列函式可用於處理邏輯條件。 此函式位於 命名空間中 sys
:
數值函數
您可使用下列函式來處理整數。 所有這些函式都在命名空間中 sys
:
物件函式
您可使用下列函式來處理物件。 所有這些函式都在命名空間中 sys
:
參數檔案函式
下列函式可用於 Bicep 參數檔案。 所有這些函式都在命名空間中 sys
:
資源函式
您可使用下列函式來取得資源值。 這些函式大多位於 az
命名空間。 和 getSecret
函list
式沒有命名空間限定符,因為它們會直接在資源類型中命名:
- extensionResourceId
- getSecret
- listAccountSas
- listKeys
- listSecrets
- list*
- managementGroupResourceId
- pickZones
- providers (已取代)
- reference
- resourceId - 這可用於任何範圍,但有效的參數會根據範圍而變更。
- subscriptionResourceId
- tenantResourceId
範圍函式
您可使用下列函式來取得範圍值。 所有這些函式都在命名空間中 az
:
- managementGroup (部分機器翻譯)
- resourceGroup - 這隻能在部署至資源群組時使用。
- 訂 用帳戶 - 這隻能在部署至資源群組或訂用帳戶時使用。
- tenant
字串函數
Bicep 提供下列函式來處理字串。 所有這些函式都在命名空間中 sys
:
- base64
- base64ToJson
- base64ToString
- concat
- contains
- dataUri
- dataUriToString
- empty
- endsWith
- first
- format
- guid
- indexOf
- join
- last
- lastIndexOf
- length
- newGuid
- padLeft
- replace
- skip
- split
- startsWith
- string
- substring
- take
- toLower
- toUpper
- 修剪
- uniqueString
- uri
- uriComponent
- uriComponentToString
下一步
- 若要在建立資源類型時逐一查看特定次數,請參閱 Bicep 中的反覆迴圈。
- 若要瞭解如何部署您已建立的 Bicep 檔案,請參閱 使用 Azure CLI 和 Azure PowerShell 部署 Bicep 檔案。