Vorlagenparameter
Dieser Artikel beschreibt Objekte, die an alle Vorlagen übergeben werden, die einem Azure Deployments Connector zugeordnet sind. Das Objekt wird als Parameter al übergeben und kann über die ARM-Vorlagenfunktion parameters aufgerufen werden, z. B. [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
Der Datensatz, der bei jeder Bereitstellung als Parameter al übergeben wird. Dieser kann innerhalb der ARM-Vorlage aufgerufen werden, indem al an die
parameters
ARM-Vorlagenfunktion übergeben wird, z. B. parameters('al').
| Name | Beschreibung | Wert |
|---|---|---|
| input | Ein Datensatz, der nur für einen bestimmten Bereitstellungstyp gilt. Der Typ dieser Eigenschaft hängt vom Bereitstellungstyp ab, der durch context.type angegeben wird. |
BootImageInput, CacheDiskInput, LayeredImageInput, MachineInput |
| context | Ein Datensatz, der für jeden Bereitstellungstyp gilt. | DeploymentContext |
BootImageInput
Eingabedaten, die spezifisch für den Bereitstellungstyp BootImage sind.
| Name | Beschreibung | Wert |
|---|---|---|
| type | Der Bereitstellungstyp, für den diese Eingabe gilt. | ‘BootImage’ |
| source | Die Quelle für das Image. Dies ist ein Objekt mit einer Eigenschaft für jede Ausgabe, die in der ARM-Vorlage angegeben ist, die der Cache-Datenträger-Bereitstellung zugeordnet ist. | any |
CacheDiskInput
Eingabedaten, die spezifisch für den Bereitstellungstyp CacheDisk sind.
| Name | Beschreibung | Wert |
|---|---|---|
| type | Der Bereitstellungstyp, für den diese Eingabe gilt. | ‘CacheDisk’ |
| size | Die Größe des zu erstellenden verwalteten Datenträgers in GiB. | Zahl (32-Bit-Ganzzahl) |
| uploadSize | Die Größe des Quelldatenträgers, der auf den erstellten Datenträger hochgeladen wird, in Byte. | Zahl (64-Bit-Ganzzahl) |
LayeredImageInput
Eingabedaten, die spezifisch für den Bereitstellungstyp LayeredImage sind.
| Name | Beschreibung | Wert |
|---|---|---|
| type | Der Bereitstellungstyp, für den diese Eingabe gilt. | ‘LayeredImage’ |
| diskName | Der Name des Datenträgers, wie in der App Layering-Image-Vorlage des aktuell veröffentlichten Images angegeben. | Zeichenfolge |
| source | Die Quelle für das Image. Dies ist ein Objekt mit einer Eigenschaft für jede Ausgabe, die in der ARM-Vorlage angegeben ist, die der Maschinen-Bereitstellung zugeordnet ist. | any |
MachineInput
Eingabedaten, die spezifisch für den Bereitstellungstyp Machine sind.
| Name | Beschreibung | Wert |
|---|---|---|
| type | Der Bereitstellungstyp, für den diese Eingabe gilt. | ‘Machine’ |
| disk | Eingabedaten, die für den Betriebssystemdatenträger der Maschine gelten. | DiskInput |
| vm | Eingabedaten, die für die VM selbst gelten. | VmInput |
DiskInput
Eingabedaten, die für den Betriebssystemdatenträger einer Maschine gelten.
| Name | Beschreibung | Wert |
|---|---|---|
| image | Die Quelle für den Datenträger. Dies ist ein Objekt mit einer Eigenschaft für jede Ausgabe, die in der ARM-Vorlage angegeben ist, die der Boot-Image-Bereitstellung zugeordnet ist, falls die Boot-Image-Bereitstellung in der Connector-Konfiguration angegeben ist. Wenn die Boot-Image-Bereitstellung nicht angegeben ist, wird die Ausgabe der ARM-Vorlage verwendet, die der Cache-Datenträger-Bereitstellung zugeordnet ist. | any |
| size | Die Größe des zu erstellenden Datenträgers in GiB. | Zahl (64-Bit-Ganzzahl) |
| name | Der Name des Datenträgers, wie in der App Layering-Image-Vorlage des aktuell veröffentlichten Images angegeben. Wenn dies keine Image-Veröffentlichungsoperation ist, dann ist dieser undefiniert. | Zeichenfolge |
VmInput
Eingabedaten, die für eine VM gelten.
| Name | Beschreibung | Wert |
|---|---|---|
| userData | Der Wert, der auf die Eigenschaft userData der VirtualMachineProperties der virtualMachine angewendet werden muss, die in der ARM-Vorlage angegeben ist, die der Bereitstellung zugeordnet ist. |
Zeichenfolge |
DeploymentContext
Stellt den Kontext des aktuellen Bereitstellungsvorgangs bereit.
| Name | Beschreibung | Wert |
|---|---|---|
| taskId | Die ID des ELM-Tasks, der die Bereitstellung verursacht hat. | Zahl (64-Bit-Ganzzahl) |
| type | Der Typ der aktuellen Bereitstellung. | ‘CacheDisk’, ‘BootImage’, ‘Machine’, ‘LayeredImage’ |
| user | Der Benutzername des Benutzers, der den ELM-Task gestartet hat, der diese Bereitstellung verursacht hat. | Zeichenfolge |
| comment | Der Kommentar, den der Benutzer beim Starten des ELM-Tasks eingegeben hat, der diese Bereitstellung verursacht hat. | Zeichenfolge |
| config | Die Plattform-Connector-Konfiguration, die dieser Bereitstellung zugeordnet ist. | Config |
| item | Die App Layering-Entität, die dem ELM-Task zugeordnet ist, der diese Bereitstellung verursacht hat. Dies bezieht sich auf eine Ebene, eine Vorlage für geschichtete Images oder ein Boot-Image. | Item |
Config
Enthält die Eigenschaften der Plattform-Connector-Konfiguration, die dem aktuellen Vorgang zugeordnet ist.
| Name | Beschreibung | Wert |
|---|---|---|
| id | Die ID der Plattform-Connector-Konfiguration. Dies ist eine GUID in der Form xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx. | Zeichenfolge |
| name | Der Name der Plattform-Connector-Konfiguration. | Zeichenfolge |
| custom | Die benutzerdefinierten Daten, die in der Plattform-Connector-Konfiguration angegeben sind. Der Typ und die Eigenschaften dieses Objekts hängen vom JSON ab, das der Benutzer für den aktuellen Bereitstellungstyp angegeben hat. | any |
Item
Die App Layering-Entität, die einem ELM-Task zugeordnet ist, der eine Bereitstellung verursacht hat.
Dies kann eine Ebene, eine Vorlage für geschichtete Images oder ein Boot-Image sein.
| Name | Beschreibung | Wert |
|---|---|---|
| type | Der Elementtyp der App Layering-Entität. | ‘Image’, ‘AppLayer’, ‘OsLayer’, ‘PlatformLayer’, ‘ConnectorCachedCeBootImage’ |
| id | Die ID des Elements. | Zahl (64-Bit-Ganzzahl) |
| name | Der Name des Elements. | Zeichenfolge |
| description | Die Beschreibung des Elements. | Zeichenfolge |
| created | Datum und Uhrzeit der ursprünglichen Erstellung des Elements. | Zeichenfolge (ISO 8601 Datums-/Zeitformat) |
| modified | Datum und Uhrzeit der letzten Änderung des Elements. | Zeichenfolge (ISO 8601 Datums-/Zeitformat) |
| version | Informationen zu dieser speziellen Version des Elements. | Version |
Version
Die Version einer App Layering-Entität, die einem ELM-Task zugeordnet ist, der eine Bereitstellung verursacht hat. Dies kann eine Ebenenversion, eine Vorlagenversion für geschichtete Images oder eine Boot-Image-Version sein.
| Name | Beschreibung | Wert |
|---|---|---|
| number | Eine Ganzzahl, die die Version darstellt. Bei Ebenen ist dies die Anzahl der versuchten Paketierungen. Bei Vorlagen für geschichtete Images ist dies die Anzahl der erfolgreichen Veröffentlichungen der Vorlage. Bei Boot-Images ist dies der Zeitstempel der Image-Datei. | Zahl (32-Bit-Ganzzahl) |
| name | Der Name der Version. Bei Ebenen ist dies der vom Benutzer angegebene Versionsname. Bei Vorlagen für geschichtete Images ist dies Publish{Number}_. Bei Boot-Images ist dies die Version (x.y.z) von App Layering, die die Bereitstellung erstellt. | Zeichenfolge |
| description | Die Beschreibung der Version. Bei Ebenen ist dies die vom Benutzer angegebene Versionsbeschreibung. Bei Vorlagen für geschichtete Images ist dies eine leere Zeichenfolge. Bei Boot-Images ist dies eine generische Beschreibung, die die Versionsnummer der Appliance enthält. | Zeichenfolge |
| created | Datum und Uhrzeit der Erstellung der Version. Bei Ebenen ist dies der Zeitpunkt der Erstellung der Version. Bei Vorlagen für geschichtete Images ist dies der Zeitpunkt der letzten Bearbeitung der Vorlage. Bei Boot-Images ist dies der Zeitstempel der Image-Datei. | Zeichenfolge (ISO 8601 Datums-/Zeitformat) |