Azure Blueprints で使用する関数

[アーティクル]
09/07/2023

重要

2026 年 7 月 11 日に、Blueprints (プレビュー) は非推奨になります。既存のブループリントの定義と割り当てを Template Specs とデプロイスタックに移行します。ブループリントアーティファクトは、デプロイスタックの定義に使用される ARM JSON テンプレートまたは Bicep ファイルに変換されます。アーティファクトを ARM リソースとして作成する方法については、次を参照してください。

Azure Blueprints では、ブループリントの定義をより動的にする関数が提供されます。これらの関数は、ブループリントの定義とブループリントアーティファクトで使用するためのものです。 Azure Resource Manager テンプレート (ARM テンプレート) のアーティファクトでは、ブループリントのパラメーターによって動的な値を取得するだけでなく、Resource Manager の関数の使用も完全にサポートされています。

次の関数がサポートされています。

artifacts
concat
parameters
resourceGroup
resourceGroups
subscription

artifacts

artifacts(artifactName)

そのブループリントアーティファクトの出力が設定されたプロパティのオブジェクトが返されます。

注意

artifacts() 関数は、ARM テンプレート内からは使用できません。 Azure PowerShell または REST API によってブループリントを Blueprints-as-code の一部として管理する場合、関数は、ブループリント定義の JSON 内またはアーティファクト JSON 内のみで使用できます。

パラメーター

パラメーター	必須	種類	説明
artifactName	はい	string	ブループリントアーティファクトの名前。

戻り値

出力プロパティのオブジェクト。 outputs のプロパティは、参照されているブループリントアーティファクトの種類に依存します。すべての種類は次の形式に従います。

{
  "outputs": {collectionOfOutputProperties}
}

ポリシー割り当てアーティファクト

{
    "outputs": {
        "policyAssignmentId": "{resourceId-of-policy-assignment}",
        "policyAssignmentName": "{name-of-policy-assignment}",
        "policyDefinitionId": "{resourceId-of-policy-definition}",
    }
}

ARM テンプレートのアーティファクト

返されるオブジェクトの outputs のプロパティは、ARM テンプレート内で定義されており、デプロイによって返されます。

ロールの割り当てアーティファクト

{
    "outputs": {
        "roleAssignmentId": "{resourceId-of-role-assignment}",
        "roleDefinitionId": "{resourceId-of-role-definition}",
        "principalId": "{principalId-role-is-being-assigned-to}",
    }
}

例

次のサンプル出力プロパティを含む ID が myTemplateArtifact の ARM テンプレートアーティファクト:

{
    "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
    ...
    "outputs": {
        "myArray": {
            "type": "array",
            "value": ["first", "second"]
        },
        "myString": {
            "type": "string",
            "value": "my string value"
        },
        "myObject": {
            "type": "object",
            "value": {
                "myProperty": "my value",
                "anotherProperty": true
            }
        }
    }
}

myTemplateArtifact サンプルからデータを取得する例を次にいくつか示します。

式	Type	値
`[artifacts("myTemplateArtifact").outputs.myArray]`	Array	["first", "second"]
`[artifacts("myTemplateArtifact").outputs.myArray[0]]`	String	"first"
`[artifacts("myTemplateArtifact").outputs.myString]`	String	"my string value"
`[artifacts("myTemplateArtifact").outputs.myObject]`	Object	{ "myproperty": "my value", "anotherProperty": true }
`[artifacts("myTemplateArtifact").outputs.myObject.myProperty]`	String	"my value"
`[artifacts("myTemplateArtifact").outputs.myObject.anotherProperty]`	Bool	True

concat

concat(string1, string2, string3, ...)

複数の文字列値を結合し、連結された文字列を返します。

パラメーター

パラメーター	必須	種類	説明
string1	はい	string	連結の最初の値。
残りの引数	いいえ	string	連結する順番での追加の値

戻り値

連結された値の文字列。

解説

Azure Blueprints 関数は、文字列でのみ動作する点が、ARM テンプレート関数と異なります。

例

concat(parameters('organizationName'), '-vm')

parameters

parameters(parameterName)

ブループリントパラメーターの値が返されます。指定するパラメーター名が、ブループリント定義またはブループリントアーティファクトで定義されている必要があります。

パラメーター

パラメーター	必須	種類	説明
parameterName	はい	string	返されるパラメーターの名前。

戻り値

指定したブループリントパラメーターまたはブループリントアーティファクトパラメーターの値。

解説

Azure Blueprints 関数は、ブループリントパラメーターでのみ動作する点が、ARM テンプレート関数と異なります。

例

ブループリント定義でパラメーター principalIds を定義します。

{
    "type": "Microsoft.Blueprint/blueprints",
    "properties": {
        ...
        "parameters": {
            "principalIds": {
                "type": "array",
                "metadata": {
                    "displayName": "Principal IDs",
                    "description": "This is a blueprint parameter that any artifact can reference. We'll display these descriptions for you in the info bubble. Supply principal IDs for the users,groups, or service principals for the Azure role assignment.",
                    "strongType": "PrincipalId"
                }
            }
        },
        ...
    }
}

次に、ブループリントアーティファクトの parameters() に対する引数として principalIds を使います。

{
    "type": "Microsoft.Blueprint/blueprints/artifacts",
    "kind": "roleAssignment",
    ...
    "properties": {
        "roleDefinitionId": "/providers/Microsoft.Authorization/roleDefinitions/8e3af657-a8ff-443c-a75c-2fe8c4bcb635",
        "principalIds": "[parameters('principalIds')]",
        ...
    }
}

resourceGroup

resourceGroup()

現在のリソースグループを表すオブジェクトを返します。

戻り値

返されるオブジェクトの形式は次のとおりです。

{
  "name": "{resourceGroupName}",
  "location": "{resourceGroupLocation}",
}

解説

Azure Blueprints 関数は、ARM テンプレート関数と異なります。 resourceGroup() 関数は、サブスクリプションレベルのアーティファクトまたはブループリント定義では使用できません。リソースグループアーティファクトの一部であるブループリントアーティファクトでのみ使用できます。

resourceGroup() 関数の一般的な使用方法は、リソースグループアーティファクトと同じ場所にリソースを作成することです。

例

リソースグループの場所を使用するには、ブループリント定義または割り当て中のいずれかで、別のアーティファクトに対する場所として設定し、ブループリント定義でリソースグループのプレースホルダーオブジェクトを宣言します。次の例では、NetworkingPlaceholder がリソースグループプレースホルダーの名前です。

{
    "type": "Microsoft.Blueprint/blueprints",
    "properties": {
        ...
        "resourceGroups": {
            "NetworkingPlaceholder": {
                "location": "eastus"
            }
        }
    }
}

その後、リソースグループのプレースホルダーオブジェクトを対象とするブループリントアーティファクトのコンテキストで、resourceGroup() 関数を使います。この例では、テンプレートアーティファクトは NetworkingPlaceholder リソースグループにデプロイされ、NetworkingPlaceholder リソースグループの場所が動的に設定されたパラメーター resourceLocation がテンプレートに提供されます。 NetworkingPlaceholder リソースグループの場所は、ブループリント定義で静的に定義されているか、または割り当ての間に動的に定義されています。いずれの場合も、テンプレートアーティファクトでは、パラメーターとしてその情報が提供され、正しい場所にリソースをデプロイするために使用されます。

{
  "type": "Microsoft.Blueprint/blueprints/artifacts",
  "kind": "template",
  "properties": {
      "template": {
        ...
      },
      "resourceGroup": "NetworkingPlaceholder",
      ...
      "parameters": {
        "resourceLocation": {
          "value": "[resourceGroup().location]"
        }
      }
  }
}

resourceGroups

resourceGroups(placeholderName)

指定したリソースグループアーティファクトを表すオブジェクトが返されます。アーティファクトのコンテキストが必要な resourceGroup() とは異なり、この関数は、特定のリソースグループプレースホルダーのプロパティを、そのリソースグループのコンテキスト内にないときに取得するために使用されます。

パラメーター

パラメーター	必須	種類	説明
placeholderName	はい	string	取得するリソースグループアーティファクトのプレースホルダーの名前。

戻り値

返されるオブジェクトの形式は次のとおりです。

{
  "name": "{resourceGroupName}",
  "location": "{resourceGroupLocation}",
}

例

{
    "type": "Microsoft.Blueprint/blueprints",
    "properties": {
        ...
        "resourceGroups": {
            "NetworkingPlaceholder": {
                "location": "eastus"
            }
        }
    }
}

その後、任意のブループリントアーティファクトのコンテキストから resourceGroups() 関数を使って、そのリソースグループプレースホルダーオブジェクトへの参照を取得します。この例では、テンプレートアーティファクトは NetworkingPlaceholder リソースグループの外側にデプロイされ、NetworkingPlaceholder リソースグループの場所が動的に設定されたパラメーター artifactLocation がテンプレートに提供されます。 NetworkingPlaceholder リソースグループの場所は、ブループリント定義で静的に定義されているか、または割り当ての間に動的に定義されています。いずれの場合も、テンプレートアーティファクトでは、パラメーターとしてその情報が提供され、正しい場所にリソースをデプロイするために使用されます。

{
  "kind": "template",
  "properties": {
      "template": {
          ...
      },
      ...
      "parameters": {
        "artifactLocation": {
          "value": "[resourceGroups('NetworkingPlaceholder').location]"
        }
      }
  },
  "type": "Microsoft.Blueprint/blueprints/artifacts",
  "name": "myTemplate"
}

subscription

subscription()

現在のブループリント割り当てのサブスクリプションの詳細が返されます。

戻り値

返されるオブジェクトの形式は次のとおりです。

{
    "id": "/subscriptions/{subscriptionId}",
    "subscriptionId": "{subscriptionId}",
    "tenantId": "{tenantId}",
    "displayName": "{name-of-subscription}"
}

例

サブスクリプションの表示名と concat() 関数を使って、テンプレートアーティファクトにパラメーター resourceName として渡される名前付け規則を作成します。

{
  "kind": "template",
  "properties": {
      "template": {
          ...
      },
      ...
      "parameters": {
        "resourceName": {
          "value": "[concat(subscription().displayName, '-vm')]"
        }
      }
  },
  "type": "Microsoft.Blueprint/blueprints/artifacts",
  "name": "myTemplate"
}

次のステップ

ブループリントのライフサイクルを参照する。
静的および動的パラメーターの使用方法を理解する。
ブループリントの優先順位のカスタマイズを参照する。
ブループリントのリソースロックの使用方法を調べる。
既存の割り当ての更新方法を参照する。
ブループリントの割り当て時の問題を一般的なトラブルシューティングで解決する。

次の方法で共有

Azure Blueprints で使用する関数

artifacts

パラメーター

戻り値

ポリシー割り当てアーティファクト

ARM テンプレートのアーティファクト

ロールの割り当てアーティファクト

例

concat

パラメーター

戻り値

解説

例

parameters

パラメーター

戻り値

解説

例

resourceGroup

戻り値

解説

例

resourceGroups

パラメーター

戻り値

例

subscription

戻り値

例

次のステップ

フィードバック

その他のリソース