テンプレートパラメータ
この記事では、Azure Deploymentsコネクタに関連付けられているすべてのテンプレートに渡されるオブジェクトについて説明します。オブジェクトは
alパラメータとして渡され、parametersなどのARMテンプレート関数[parameters('al').context.user]を介してアクセスできます。
{
"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"
}
}
}
}
AlParam
al パラメータとしてすべてのデプロイに渡されるデータセットです。これは、ARMテンプレート内で al を parameters ARM テンプレート関数（
parameters('al')など）に渡すことでアクセスできます。
| 名前 | 説明 | 値 |
|---|---|---|
| 入力 | 特定のデプロイタイプにのみ適用されるデータセット。このプロパティのタイプは、context.typeで指定されたデプロイタイプによって異なります。 |
BootImageInput, CacheDiskInput, LayeredImageInput, MachineInput |
| コンテキスト | すべてのデプロイタイプに適用されるデータセット。 | DeploymentContext |
BootImageInput
BootImageデプロイタイプに固有の入力データ。
| 名前 | 説明 | 値 |
|---|---|---|
| タイプ | この入力が適用されるデプロイの種類。 | 'BootImage' |
| ソース | イメージのソース。これは、Cache Disk デプロイに関連付けられた ARM テンプレートで指定された各出力のプロパティを持つオブジェクトです。 | 任意 |
CacheDiskInput
CacheDisk デプロイタイプに固有の入力データ。
| 名前 | 説明 | 値 |
|---|---|---|
| タイプ | この入力が適用されるデプロイの種類。 | 'CacheDisk' |
| サイズ | 作成されるマネージドディスクのサイズ (GiB単位)。 | 数値 (32ビット整数) |
| uploadSize | 作成されたディスクにアップロードされるソースディスクのサイズ (バイト単位)。 | 数値 (64ビット整数) |
LayeredImageInput
LayeredImageデプロイタイプに固有の入力データ。
| 名前 | 説明 | 値 |
|---|---|---|
| タイプ | この入力が適用されるデプロイの種類。 | 'LayeredImage' |
| diskName | 現在公開されているイメージのApp Layeringイメージテンプレートで指定されたディスク名。 | 文字列 |
| ソース | イメージのソース。これは、Machineデプロイメントに関連付けられたARMテンプレートで指定された各出力のプロパティを持つオブジェクトです。 | 任意 |
MachineInput
Machineデプロイメントタイプに固有の入力データ。
DiskInput
マシンのOSディスクに適用される入力データ。
| 名前 | 説明 | 値 |
|---|---|---|
| イメージ | ディスクのソースです。これは、コネクタ構成でブートイメージ展開が指定されている場合、ブートイメージ展開に関連付けられたARMテンプレートで指定された各出力のプロパティを持つオブジェクトです。ブートイメージ展開が指定されていない場合、キャッシュディスク展開に関連付けられたARMテンプレートの出力が使用されます。 | 任意 |
| サイズ | 作成するディスクのサイズ (GiB単位)。 | 数値 (64ビット整数) |
| 名前 | 現在公開されているイメージのApp Layeringイメージテンプレートで指定されているディスクの名前。イメージ公開操作でない場合、これは未定義です。 | 文字列 |
VmInput
VMに適用される入力データ。
| 名前 | 説明 | 値 |
|---|---|---|
| userData | デプロイに関連付けられたARMテンプレートで指定されているvirtualMachineのVirtualMachinePropertiesのuserDataプロパティに適用する必要がある値。 |
文字列 |
DeploymentContext
現在のデプロイ操作のコンテキストを提供します。
| 名前 | 説明 | 値 |
|---|---|---|
| taskId | デプロイメントの原因となったELMタスクのID。 | 数値 (64ビット整数) |
| タイプ | 現在のデプロイメントのタイプ。 | 'キャッシュディスク'、'ブートイメージ'、'マシン'、'レイヤードイメージ' |
| ユーザー | このデプロイメントの原因となったELMタスクを開始したユーザーのユーザー名。 | 文字列 |
| コメント | このデプロイメントの原因となったELMタスクを開始したときにユーザーが入力したコメント。 | 文字列 |
| 構成 | このデプロイに関連付けられているプラットフォームコネクタ構成。 | 構成 |
| 項目 | このデプロイを引き起こしたELMタスクに関連付けられているApp Layeringエンティティ。これは、レイヤー、レイヤードイメージテンプレート、またはブートイメージを指します。 | 項目 |
構成
現在の操作に関連付けられているプラットフォームコネクタ構成のプロパティが含まれています。
| 名前 | 説明 | 値 |
|---|---|---|
| ID | プラットフォームコネクタ構成のID。これは、xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx の形式のGUIDです。 | 文字列 |
| 名前 | プラットフォームコネクタ構成の名前。 | 文字列 |
| カスタム | プラットフォームコネクタ構成で指定されたカスタムデータ。このオブジェクトのタイプとプロパティは、ユーザーが現在の展開タイプに指定したJSONによって異なります。 | 任意 |
項目
展開を引き起こしたELMタスクに関連付けられたApp Layeringエンティティ。
これは、レイヤー、レイヤードイメージテンプレート、またはブートイメージのいずれかです。
| 名前 | 説明 | 値 |
|---|---|---|
| タイプ | App Layeringエンティティの項目タイプ。 | 'イメージ'、'アップレイヤー'、'OSレイヤー'、'プラットフォームレイヤー'、'ConnectorCachedCeBootImage' |
| id | アイテムのID。 | 数値 (64ビット整数) |
| 名前 | アイテムの名前。 | 文字列 |
| 説明 | アイテムの説明。 | 文字列 |
| 作成日時 | アイテムが最初に作成された日時。 | 文字列 (ISO 8601 日時) |
| 変更日時 | アイテムが最後に変更された日時。 | 文字列 (ISO 8601 日時) |
| バージョン | このアイテムの特定のバージョンに関する情報。 | バージョン |
バージョン
デプロイメントを引き起こしたELMタスクに関連付けられたApp Layeringエンティティのバージョン。これは、レイヤーバージョン、レイヤードイメージテンプレートバージョン、またはブートイメージバージョンである場合があります。
| 名前 | 説明 | 値 |
|---|---|---|
| 数値 | バージョンを表す整数。レイヤーの場合、これは試行されたパッケージングの数です。レイヤードイメージテンプレートの場合、これはテンプレートの公開に成功した回数です。ブートイメージの場合、これはイメージファイルのタイムスタンプです。 | 数値 (32ビット整数) |
| 名前 | バージョンの名前。レイヤーの場合、これはユーザーが指定したバージョン名です。レイヤードイメージテンプレートの場合、これは Publish_{Number} です。ブートイメージの場合、これはデプロイメントを作成するApp Layeringのバージョン (x.y.z) です。 | 文字列 |
| 説明 | バージョンの説明。レイヤーの場合、これはユーザーが指定したバージョン説明です。レイヤードイメージテンプレートの場合、これは空の文字列です。ブートイメージの場合、これはアプライアンスのバージョン番号を含む一般的な説明です。 | 文字列 |
| 作成日時 | バージョンが作成された日時。レイヤーの場合、これはバージョンが作成された日時です。レイヤードイメージテンプレートの場合、これはテンプレートが最後に編集された日時です。ブートイメージの場合、これはイメージファイルのタイムスタンプです。 | 文字列 (ISO 8601 日時) |