ARM テンプレート関数
この記事では、Azure Resource Manager テンプレート (ARM テンプレート) で使用できるすべての関数について説明します。 ご自分のテンプレート内で関数を使用する方法の詳細については、テンプレートの構文に関するセクションを参照してください。
独自の関数を作成するには、ユーザー定義関数に関するページをご覧ください。
ほとんどの関数は、リソース グループ、サブスクリプション、管理グループ、またはテナントにデプロイされた場合に、同じように動作します。 いくつかの関数は、すべてのスコープでは使用できません。 これらは以下の一覧に記載されています。
すべての関数
Bicep では、データ型の警告に関する問題の解決に役立つ任意の関数を使用できます。
配列関数
Resource Manager には、配列を操作する関数が複数用意されています。
- array
- concat
- contains
- createArray
- empty
- first
- indexOf
- intersection
- last
- lastIndexOf
- length
- max
- min
- 範囲
- skip
- take
- union
Bicep のファイルの場合は、配列関数を使用します。
CIDR 関数
次の関数は、CIDR を操作するために使用できます。 これらの関数はすべて、sys
名前空間にあります。
比較関数
Resource Manager には、テンプレートで比較を行うための関数がいくつか用意されています。
Bicep のファイルの場合は、coalesce 論理演算子を使用します。 比較には、比較演算子を使用します。
データ関数
リソース マネージャーには、日付を操作する次の関数が用意されています。
Bicep のファイルの場合は、日付関数を使用します。
デプロイの値関数
リソース マネージャーには、テンプレートのセクションから値を取得し、デプロイに関連する値を取得する次の関数が用意されています。
Bicep のファイルの場合は、デプロイ関数を使用します。
ラムダ関数
リソース マネージャーには、ラムダ式を操作する次の関数が用意されています。
Bicep のファイルの場合は、ラムダ関数を使用します。
論理関数
リソース マネージャーには、論理の条件を操作する次の関数が用意されています。
Bicep のファイルの場合は、bool 論理関数を使用します。 その他の論理値には、論理演算子を使用します。
数値関数
リソース マネージャーには、整数を操作する次の関数が用意されています。
int
、min
、max
を使用している Bicep のファイルの場合は、数値関数を使用します。 その他の数値の場合は、数値演算子を使用します。
オブジェクト関数
Resource Manager には、オブジェクトを操作する関数が複数用意されています。
Bicep のファイルの場合は、オブジェクト関数を使用します。
リソース関数
リソース マネージャーには、リソース値を取得する次の関数が用意されています。
- extensionResourceId
- listAccountSas
- listKeys
- listSecrets
- list*
- pickZones
- providers (非推奨)
- reference
- 参照
- resourceId - 任意のスコープで使用できますが、有効なパラメーターはスコープに応じて変わります。
- subscriptionResourceId
- tenantResourceId
Bicep のファイルの場合は、リソース関数を使用します。
スコープ関数
Resource Manager には、デプロイのスコープ値を取得する次の関数が用意されています。
- managementGroup - 管理グループへのデプロイでのみ使用できます。
- resourceGroup - リソース グループへのデプロイでのみ使用できます。
- subscription - リソース グループまたはサブスクリプションへのデプロイでのみ使用できます。
- tenant - 任意のスコープでのデプロイに使用できます。
Bicep のファイルの場合は、スコープ関数を使用します。
文字列関数
リソース マネージャーには、文字列を操作する次の関数が用意されています。
- base64
- base64ToJson
- base64ToString
- concat
- contains
- dataUri
- dataUriToString
- empty
- endsWith
- first
- format
- guid
- indexOf
- join
- json
- last
- lastIndexOf
- length
- newGuid
- padLeft
- replace
- skip
- split
- startsWith
- string
- substring
- take
- toLower
- toUpper
- trim
- uniqueString
- uri
- uriComponent
- uriComponentToString
Bicep のファイルの場合は、文字列関数を使用します。
次のステップ
- ARM テンプレートのセクションの説明については、「ARM テンプレートの構造と構文について」を参照してください。
- 複数のテンプレートをマージする方法については、「Azure リソース デプロイ時のリンクされたテンプレートおよび入れ子になったテンプレートの使用」を参照してください。
- ある種類のリソースを作成するときに、指定した回数だけ反復する方法については、「ARM テンプレートでのリソースの反復処理」を参照してください。
- 作成したテンプレートをデプロイする方法については、「ARM テンプレートと Azure PowerShell を使用したリソースのデプロイ」を参照してください。