模板参数
本文介绍了传递给与 Azure 部署连接器关联的所有模板的对象。该对象作为 al 参数传递,可以通过 ARM 模板函数 parameters 访问,例如 [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"
}
}
}
}
<!--NeedCopy-->
AlParam
作为 al 参数传递给每个部署的数据集。可以通过将 al 传递给
parameters
ARM 模板函数,从 ARM 模板内部访问此数据,例如 parameters('al')。
| 名称 | 描述 | 值 |
|---|---|---|
| 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 位整数) |
| uploadSize | 将上传到所创建磁盘的源磁盘大小,单位为字节。 | number(64 位整数) |
LayeredImageInput
特定于 LayeredImage 部署类型的输入数据。
| 名称 | 描述 | 值 |
|---|---|---|
| type | 此输入适用的部署类型。 | ‘LayeredImage’ |
| diskName | 磁盘名称,如当前正在发布的映像的 App Layering 映像模板中指定。 | string |
| source | 映像的源。这是一个对象,其中包含与 Machine 部署关联的 ARM 模板中指定的每个输出的属性。 | any |
MachineInput
特定于 Machine 部署类型的输入数据。
| 名称 | 描述 | 值 |
|---|---|---|
| type | 此输入适用的部署类型。 | ‘Machine’ |
| disk | 适用于计算机操作系统磁盘的输入数据。 | DiskInput |
| vm | 适用于 VM 本身的输入数据。 | VmInput |
DiskInput
适用于计算机操作系统磁盘的输入数据。
| 名称 | 描述 | 值 |
|---|---|---|
| image | 磁盘的源。这是一个对象,其中包含与 Boot Image 部署关联的 ARM 模板中指定的每个输出的属性(如果连接器配置中指定了 Boot Image 部署)。如果未指定 Boot Image 部署,则使用与 Cache Disk 部署关联的 ARM 模板的输出。 | any |
| size | 要创建的磁盘大小,单位为 GiB。 | number(64 位整数) |
| name | 磁盘名称,如当前正在发布的映像的 App Layering 映像模板中指定。如果这不是映像发布操作,则此项未定义。 | string |
VmInput
适用于 VM 的输入数据。
| 名称 | 描述 | 值 |
|---|---|---|
| userData | 必须应用于与部署关联的 ARM 模板中指定的 virtualMachine 的 VirtualMachineProperties 的 userData 属性的值。 |
string |
DeploymentContext
提供当前部署操作的上下文。
| 名称 | 描述 | 值 |
|---|---|---|
| taskId | 导致部署的 ELM 任务 ID。 | number(64 位整数) |
| type | 当前部署的类型。 | ‘CacheDisk’、’BootImage’、’Machine’、’LayeredImage’ |
| user | 启动导致此部署的 ELM 任务的用户的用户名。 | string |
| comment | 用户在启动导致此部署的 ELM 任务时输入的注释。 | string |
| config | 与此部署关联的平台连接器配置。 | Config |
| item | 与导致此部署的 ELM 任务关联的 App Layering 实体。此实体将引用层、分层映像模板或启动映像。 | Item |
Config
包含与当前操作关联的平台连接器配置的属性。
| 名称 | 描述 | 值 |
|---|---|---|
| id | 平台连接器配置的 ID。这是一个 GUID,格式为 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx。 | string |
| name | 平台连接器配置的名称。 | string |
| custom | 平台连接器配置中指定的自定义数据。此对象的类型和属性取决于用户为当前部署类型指定的 JSON。 | any |
Item
与导致部署的 ELM 任务关联的 App Layering 实体。
此实体可以是层、分层映像模板或启动映像。
| 名称 | 描述 | 值 |
|---|---|---|
| type | App Layering 实体的项目类型。 | ‘Image’、’AppLayer’、’OsLayer’、’PlatformLayer’、’ConnectorCachedCeBootImage’ |
| id | 项目 ID。 | number(64 位整数) |
| name | 项目名称。 | string |
| description | 项目描述。 | string |
| created | 项目最初创建的日期和时间。 | string(ISO 8601 日期时间) |
| modified | 项目上次更改的日期和时间。 | string(ISO 8601 日期时间) |
| version | 有关此特定项目版本的信息。 | Version |
Version
与导致部署的 ELM 任务关联的 App Layering 实体版本。此实体可以是层版本、分层映像模板版本或启动映像版本。
| 名称 | 描述 | 值 |
|---|---|---|
| number | 表示版本的整数。对于层,这是尝试打包的次数。对于分层映像模板,这是模板成功发布的次数。对于启动映像,这是映像文件的时间戳。 | number(32 位整数) |
| name | 版本名称。对于层,这是用户指定的版本名称。对于分层映像模板,这是 Publish{Number}_。对于启动映像,这是创建部署的 App Layering 版本 (x.y.z)。 | string |
| description | 版本描述。对于层,这是用户指定的版本描述。对于分层映像模板,这是一个空字符串。对于启动映像,这是一个通用描述,其中包含设备版本号。 | string |
| created | 版本创建的日期和时间。对于层,这是版本创建的时间。对于分层映像模板,这是模板上次编辑的时间。对于启动映像,这是映像文件的时间戳。 | string(ISO 8601 日期时间) |
已复制!
失败!