ARM テンプレートのデプロイ関数

[アーティクル]
08/22/2023

Resource Manager には、Azure Resource Manager テンプレート (ARM テンプレート) の現在のデプロイに関連する値を取得する次の関数が用意されています。

デプロイ
environment
parameters
variables

リソース、リソースグループ、サブスクリプションから値を取得する方法については、「リソース関数」を参照してください。

ヒント

ARM テンプレートと同じ機能を提供し、構文も使いやすいので、Bicep をお勧めします。詳細については、「デプロイ関数」を参照してください。

deployment

deployment()

現在のデプロイ操作に関する情報を返します。

Bicep で、デプロイ関数を使用します。

戻り値

この関数は、デプロイ中に渡されたオブジェクトを返します。返されたオブジェクトのプロパティは、以下に該当するかどうかによって異なります。

テンプレートまたはテンプレートスペックをデプロイする。
ローカルファイルであるテンプレートをデプロイするか、URI を使用してアクセスされるリモートファイルであるテンプレートをデプロイする。
リソースグループにデプロイするか、他のいずれかのスコープ (Azure サブスクリプション、管理グループ、またはテナント) にデプロイする。

ローカルテンプレートをリソースグループにデプロイする場合は、関数から次の形式が返されます。

{
  "name": "",
  "properties": {
    "template": {
      "$schema": "",
      "contentVersion": "",
      "parameters": {},
      "variables": {},
      "resources": [],
      "outputs": {}
    },
    "templateHash": "",
    "parameters": {},
    "mode": "",
    "provisioningState": ""
  }
}

リモートテンプレートをリソースグループにデプロイする場合は、関数から次の形式が返されます。

{
  "name": "",
  "properties": {
    "templateLink": {
      "uri": ""
    },
    "template": {
      "$schema": "",
      "contentVersion": "",
      "parameters": {},
      "variables": {},
      "resources": [],
      "outputs": {}
    },
    "templateHash": "",
    "parameters": {},
    "mode": "",
    "provisioningState": ""
  }
}

テンプレートスペックをリソースグループにデプロイする場合は、関数から次の形式が返されます。

{
  "name": "",
  "properties": {
    "templateLink": {
      "id": ""
    },
    "template": {
      "$schema": "",
      "contentVersion": "",
      "parameters": {},
      "variables": {},
      "resources": [],
      "outputs": {}
    },
    "templateHash": "",
    "parameters": {},
    "mode": "",
    "provisioningState": ""
  }
}

Azure サブスクリプション、管理グループ、またはテナントにデプロイする場合は、返されるオブジェクトに location プロパティが含まれています。ローカルテンプレートまたは外部テンプレートのいずれかをデプロイする場合は、場所プロパティが含まれています。形式は次のようになります:

{
  "name": "",
  "location": "",
  "properties": {
    "template": {
      "$schema": "",
      "contentVersion": "",
      "resources": [],
      "outputs": {}
    },
    "templateHash": "",
    "parameters": {},
    "mode": "",
    "provisioningState": ""
  }
}

languageVersion 2.0 テンプレートをデプロイすると、この deployment 関数はプロパティの限られたサブセットを返します:

{
  "name": "",
  "location": "",
  "properties": {
    "template": {
      "contentVersion": ""
    },
    "templateLink": {
      "id": "",
      "uri": ""
    }
  }
}

解説

deployment() を使い、親テンプレートの URI に基づいて、別のテンプレートにリンクできます。

"variables": {
  "sharedTemplateUrl": "[uri(deployment().properties.templateLink.uri, 'shared-resources.json')]"
}

ポータル内のデプロイ履歴からテンプレートを再デプロイすると、テンプレートがローカルファイルとしてデプロイされます。デプロイ関数の中では、templateLink プロパティは返されません。お使いのテンプレートが templateLink に依存して別のテンプレートへのリンクを構成している場合は、ポータルを使用して再デプロイしないでください。代わりに、最初にテンプレートのデプロイに利用したコマンドを使用してください。

例

次の例では、デプロイオブジェクトが返されます。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "resources": [],
  "outputs": {
    "deploymentOutput": {
      "type": "object",
      "value": "[deployment()]"
    }
  }
}

前の例では、次のオブジェクトが返されます。

{
  "name": "deployment",
  "properties": {
    "template": {
      "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
      "contentVersion": "1.0.0.0",
      "resources": [],
      "outputs": {
        "deploymentOutput": {
          "type": "Object",
          "value": "[deployment()]"
        }
      }
    },
    "templateHash": "13135986259522608210",
    "parameters": {},
    "mode": "Incremental",
    "provisioningState": "Accepted"
  }
}

サブスクリプションのデプロイの場合、次の例ではデプロイオブジェクトが返されます。

{
  "$schema": "https://schema.management.azure.com/schemas/2018-05-01/subscriptionDeploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {},
  "variables": {},
  "resources": [],
  "outputs": {
    "exampleOutput": {
      "type": "object",
      "value": "[deployment()]"
    }
  }
}

環境

environment()

デプロイに使用される Azure 環境に関する情報を返します。

Bicep で、環境関数を使用します。

解説

アカウントの登録済み環境の一覧を表示するには、az cloud list または Get-AzEnvironment を使用します。

戻り値

この関数では、現在の Azure 環境のプロパティが返されます。次の例では、グローバル Azure のプロパティを示しています。ソブリンクラウドでは、少し異なるプロパティが返される場合があります。

{
  "name": "",
  "gallery": "",
  "graph": "",
  "portal": "",
  "graphAudience": "",
  "activeDirectoryDataLake": "",
  "batch": "",
  "media": "",
  "sqlManagement": "",
  "vmImageAliasDoc": "",
  "resourceManager": "",
  "authentication": {
    "loginEndpoint": "",
    "audiences": [
      "",
      ""
    ],
    "tenant": "",
    "identityProvider": ""
  },
  "suffixes": {
    "acrLoginServer": "",
    "azureDatalakeAnalyticsCatalogAndJob": "",
    "azureDatalakeStoreFileSystem": "",
    "azureFrontDoorEndpointSuffix": "",
    "keyvaultDns": "",
    "sqlServerHostname": "",
    "storage": ""
  }
}

例

次のテンプレート例では、環境オブジェクトが返されます。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "resources": [],
  "outputs": {
    "environmentOutput": {
      "type": "object",
      "value": "[environment()]"
    }
  }
}

前の例では、グローバル Azure にデプロイされる場合は、次のオブジェクトが返されます。

{
  "name": "AzureCloud",
  "gallery": "https://gallery.azure.com/",
  "graph": "https://graph.windows.net/",
  "portal": "https://portal.azure.com",
  "graphAudience": "https://graph.windows.net/",
  "activeDirectoryDataLake": "https://datalake.azure.net/",
  "batch": "https://batch.core.windows.net/",
  "media": "https://rest.media.azure.net",
  "sqlManagement": "https://management.core.windows.net:8443/",
  "vmImageAliasDoc": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/arm-compute/quickstart-templates/aliases.json",
  "resourceManager": "https://management.azure.com/",
  "authentication": {
    "loginEndpoint": "https://login.microsoftonline.com/",
    "audiences": [
      "https://management.core.windows.net/",
      "https://management.azure.com/"
    ],
    "tenant": "common",
    "identityProvider": "AAD"
  },
  "suffixes": {
    "acrLoginServer": ".azurecr.io",
    "azureDatalakeAnalyticsCatalogAndJob": "azuredatalakeanalytics.net",
    "azureDatalakeStoreFileSystem": "azuredatalakestore.net",
    "azureFrontDoorEndpointSuffix": "azurefd.net",
    "keyvaultDns": ".vault.azure.net",
    "sqlServerHostname": ".database.windows.net",
    "storage": "core.windows.net"
  }
}

parameters

parameters(parameterName)

パラメーター値を返します。指定したパラメーター名は、テンプレートのパラメーターセクションで定義されている必要があります。

Bicep では、シンボリック名を使用してパラメーターを直接参照します。

パラメーター

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

戻り値

指定したパラメーターの値。

注釈

通常、パラメーターを使ってリソースの値を設定します。次の例では、Web サイトの名前を、デプロイ時に渡されるパラメーターの値に設定します。

"parameters": {
  "siteName": {
    "type": "string"
  }
}, "resources": [
  {
    "type": "Microsoft.Web/Sites",
    "apiVersion": "2016-08-01",
    "name": "[parameters('siteName')]",
    ...
  }
]

例

次の例では、parameters 関数の簡単な使用方法を示しています。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "stringParameter": {
      "type": "string",
      "defaultValue": "option 1"
    },
    "intParameter": {
      "type": "int",
      "defaultValue": 1
    },
    "objectParameter": {
      "type": "object",
      "defaultValue": {
        "one": "a",
        "two": "b"
      }
    },
    "arrayParameter": {
      "type": "array",
      "defaultValue": [ 1, 2, 3 ]
    },
    "crossParameter": {
      "type": "string",
      "defaultValue": "[parameters('stringParameter')]"
    }
  },
  "variables": {},
  "resources": [],
  "outputs": {
    "stringOutput": {
      "type": "string",
      "value": "[parameters('stringParameter')]"
    },
    "intOutput": {
      "type": "int",
      "value": "[parameters('intParameter')]"
    },
    "objectOutput": {
      "type": "object",
      "value": "[parameters('objectParameter')]"
    },
    "arrayOutput": {
      "type": "array",
      "value": "[parameters('arrayParameter')]"
    },
    "crossOutput": {
      "type": "string",
      "value": "[parameters('crossParameter')]"
    }
  }
}

既定値を使用した場合の前の例の出力は次のようになります。

名前	Type	値
stringOutput	String	option 1
intOutput	int	1
objectOutput	Object	{"one": "a", "two": "b"}
arrayOutput	Array	[1, 2, 3]
crossOutput	String	option 1

パラメーターの使用方法の詳細については、「ARM テンプレートのパラメーター」を参照してください。

variables

variables(variableName)

変数の値を返します。指定した変数名は、テンプレートの変数セクションで定義されている必要があります。

Bicep では、シンボリック名を使用して変数を直接参照します。

パラメーター

パラメーター	必須	Type	説明
variableName	はい	String	返す変数の名前。

戻り値

指定した変数の値。

注釈

通常、変数を使って、複雑な値を 1 回だけ作成することによりテンプレートを簡略化します。次の例では、ストレージアカウントの一意の名前を作成します。

"variables": {
  "storageName": "[concat('storage', uniqueString(resourceGroup().id))]"
},
"resources": [
  {
    "type": "Microsoft.Storage/storageAccounts",
    "name": "[variables('storageName')]",
    ...
  },
  {
    "type": "Microsoft.Compute/virtualMachines",
    "dependsOn": [
      "[variables('storageName')]"
    ],
    ...
  }
],

例

次の例は異なる変数値を返します。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {},
  "variables": {
    "var1": "myVariable",
    "var2": [ 1, 2, 3, 4 ],
    "var3": "[ variables('var1') ]",
    "var4": {
      "property1": "value1",
      "property2": "value2"
    }
  },
  "resources": [],
  "outputs": {
    "exampleOutput1": {
      "type": "string",
      "value": "[variables('var1')]"
    },
    "exampleOutput2": {
      "type": "array",
      "value": "[variables('var2')]"
    },
    "exampleOutput3": {
      "type": "string",
      "value": "[variables('var3')]"
    },
    "exampleOutput4": {
      "type": "object",
      "value": "[variables('var4')]"
    }
  }
}

既定値を使用した場合の前の例の出力は次のようになります。

名前	Type	値
exampleOutput1	String	myVariable
exampleOutput2	Array	[1, 2, 3, 4]
exampleOutput3	String	myVariable
exampleOutput4	Object	{"property1": "value1", "property2": "value2"}

変数の使用方法の詳細については、「ARM テンプレートでの変数」を参照してください。

次のステップ

ARM テンプレートのセクションの説明については、「ARM テンプレートの構造と構文について」を参照してください。

ARM テンプレートのデプロイ関数

deployment

戻り値

解説

例

環境

解説

戻り値

例

parameters

パラメーター

戻り値

注釈

例

variables

パラメーター

戻り値

注釈

例

次のステップ

その他のリソース