テンプレートパラメーター
この記事では、Azure Deploymentsコネクターに関連付けられているすべてのテンプレートに渡されるオブジェクトについて説明します。このオブジェクトはalパラメーターとして渡され、[parameters('al').context.user]のように、ARMテンプレート関数parametersを介してアクセスできます。
{
"input":
{
"type": "BootImage",
"source": "any"
},
// OR
{
"type": "CacheDisk",
"size": "number",
"uploadSize": "number"
},
// OR
{
"type": "LayeredImage",
"diskName": "string",
"source": "any"
},
// OR
{
"type": "Machine",
"disk": {
"image": "any",
"size": "number",
"name": "string"
},
"vm": {
"userData": "string"
}
},
"context": {
"taskId": "number",
"type": "string",
"user": "string",
"comment": "string",
"config": {
"id": "string",
"name": "string",
"custom": "any"
},
"item": {
"type": "string",
"id": "number",
"name": "string",
"description": "string",
"created": "string",
"modified": "string",
"version": {
"number": "number",
"name": "string",
"description": "string",
"created": "string"
}
}
}
}
<!--NeedCopy-->
AlParam
すべてのデプロイに_al_パラメーターとして渡されるデータセットです。これは、parameters('al')のように、_al_をparameters ARMテンプレート関数に渡すことで、ARMテンプレート内からアクセスできます。
| 名前 | 説明 | 値 |
|---|---|---|
| input | 特定のデプロイタイプにのみ適用されるデータセット。このプロパティのタイプは、context.typeで指定されたデプロイタイプによって異なります。 |
BootImageInput, CacheDiskInput, LayeredImageInput, MachineInput |
| context | すべてのデプロイタイプに適用されるデータセット。 | DeploymentContext |
BootImageInput
BootImageデプロイタイプに固有の入力データ。
| 名前 | 説明 | 値 |
|---|---|---|
| type | この入力が適用されるデプロイのタイプ。 | ‘BootImage’ |
| source | イメージのソース。これは、Cache Diskデプロイに関連付けられたARMテンプレートで指定された各出力のプロパティを持つオブジェクトです。 | any |
CacheDiskInput
CacheDiskデプロイタイプに固有の入力データ。
| 名前 | 説明 | 値 |
|---|---|---|
| type | この入力が適用されるデプロイのタイプ。 | ‘CacheDisk’ |
| size | 作成されるマネージドディスクのサイズ (GiB単位)。 | number (32-bit integer) |
| uploadSize | 作成されるディスクにアップロードされるソースディスクのサイズ (バイト単位)。 | number (64-bit integer) |
LayeredImageInput
LayeredImageデプロイタイプに固有の入力データ。
| 名前 | 説明 | 値 |
|---|---|---|
| type | この入力が適用されるデプロイのタイプ。 | ‘LayeredImage’ |
| diskName | 現在公開されているイメージのApp Layeringイメージテンプレートで指定されているディスクの名前。 | string |
| source | イメージのソース。これは、Machineデプロイに関連付けられたARMテンプレートで指定された各出力のプロパティを持つオブジェクトです。 | any |
MachineInput
Machineデプロイタイプに固有の入力データ。
| 名前 | 説明 | 値 |
|---|---|---|
| type | この入力が適用されるデプロイのタイプ。 | ‘Machine’ |
| disk | マシンのOSディスクに適用される入力データ。 | DiskInput |
| vm | VM自体に適用される入力データ。 | VmInput |
DiskInput
マシンのOSディスクに適用される入力データ。
| 名前 | 説明 | 値 |
|---|---|---|
| image | ディスクのソース。これは、Boot Imageデプロイがコネクター構成で指定されている場合、そのデプロイに関連付けられたARMテンプレートで指定された各出力のプロパティを持つオブジェクトです。Boot Imageデプロイが指定されていない場合は、Cache Diskデプロイに関連付けられたARMテンプレートの出力が使用されます。 | any |
| size | 作成されるディスクのサイズ (GiB単位)。 | number (64-bit integer) |
| name | 現在公開されているイメージのApp Layeringイメージテンプレートで指定されているディスクの名前。これがイメージ公開操作でない場合、これは未定義です。 | string |
VmInput
VMに適用される入力データ。
| 名前 | 説明 | 値 |
|---|---|---|
| userData | デプロイに関連付けられたARMテンプレートで指定されたvirtualMachineのVirtualMachinePropertiesのuserDataプロパティに適用する必要がある値。 |
string |
DeploymentContext
現在のデプロイ操作のコンテキストを提供します。
| 名前 | 説明 | 値 |
|---|---|---|
| taskId | デプロイを引き起こしたELMタスクのID。 | number (64-bit integer) |
| type | 現在のデプロイのタイプ。 | ‘CacheDisk’, ‘BootImage’, ‘Machine’, ‘LayeredImage’ |
| user | このデプロイを引き起こしたELMタスクを開始したユーザーのユーザー名。 | string |
| comment | このデプロイを引き起こしたELMタスクを開始したときにユーザーが入力したコメント。 | string |
| config | このデプロイに関連付けられているプラットフォームコネクター構成。 | Config |
| item | このデプロイを引き起こしたELMタスクに関連付けられているApp Layeringエンティティ。これは、レイヤー、レイヤードイメージテンプレート、またはブートイメージを参照します。 | Item |
Config
現在の操作に関連付けられているプラットフォームコネクター構成のプロパティが含まれます。
| 名前 | 説明 | 値 |
|---|---|---|
| id | プラットフォームコネクター構成のID。これは_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx_形式のGUIDです。 |
string |
| name | プラットフォームコネクター構成の名前。 | string |
| custom | プラットフォームコネクター構成で指定されたカスタムデータ。このオブジェクトのタイプとプロパティは、ユーザーによって現在のデプロイタイプに指定されたJSONによって異なります。 | any |
Item
デプロイを引き起こしたELMタスクに関連付けられているApp Layeringエンティティ。
これは、レイヤー、レイヤードイメージテンプレート、またはブートイメージのいずれかです。
| 名前 | 説明 | 値 |
|---|---|---|
| type | App Layeringエンティティのアイテムタイプ。 | ‘Image’, ‘AppLayer’, ‘OsLayer’, ‘PlatformLayer’, ‘ConnectorCachedCeBootImage’ |
| id | アイテムのID。 | number (64-bit integer) |
| name | アイテムの名前。 | string |
| description | アイテムの説明。 | string |
| created | アイテムが最初に作成された日時。 | string (ISO 8601 datetime) |
| modified | アイテムが最後に変更された日時。 | string (ISO 8601 datetime) |
| version | この特定のアイテムバージョンに関する情報。 | Version |
Version
デプロイを引き起こしたELMタスクに関連付けられているApp Layeringエンティティのバージョン。これは、レイヤーバージョン、レイヤードイメージテンプレートバージョン、またはブートイメージバージョンのいずれかです。
| 名前 | 説明 | 値 |
|---|---|---|
| number | バージョンを表す整数。レイヤーの場合、これは試行されたパッケージングの数です。レイヤードイメージテンプレートの場合、これはテンプレートの公開成功数です。ブートイメージの場合、これはイメージファイルのタイムスタンプです。 | number (32-bit integer) |
| name | バージョンの名前。レイヤーの場合、これはユーザーが指定したバージョン名です。レイヤードイメージテンプレートの場合、これは_Publish\_{Number}_です。ブートイメージの場合、これはデプロイを作成するApp Layeringのバージョン (x.y.z) です。 |
string |
| description | バージョンの説明。レイヤーの場合、これはユーザーが指定したバージョン説明です。レイヤードイメージテンプレートの場合、これは空の文字列です。ブートイメージの場合、これはアプライアンスのバージョン番号を含む一般的な説明です。 | string |
| created | バージョンが作成された日時。レイヤーの場合、これはバージョンが作成されたときです。レイヤードイメージテンプレートの場合、これはテンプレートが最後に編集されたときです。ブートイメージの場合、これはイメージファイルのタイムスタンプです。 | string (ISO 8601 datetime) |