Microsoft.VirtualMachineImages imageTemplates 2018-02-01-preview
Bicep-Ressourcendefinition
Der ImageTemplates-Ressourcentyp kann für Folgendes bereitgestellt werden:
- Ressourcengruppen – Siehe Bereitstellungsbefehle für Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.VirtualMachineImages/imageTemplates-Ressource zu erstellen, fügen Sie der Vorlage den folgenden Bicep hinzu.
resource symbolicname 'Microsoft.VirtualMachineImages/imageTemplates@2018-02-01-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
properties: {
customize: [
{
name: 'string'
type: 'string'
// For remaining properties, see ImageTemplateCustomizer objects
}
]
distribute: [
{
artifactTags: {}
runOutputName: 'string'
type: 'string'
// For remaining properties, see ImageTemplateDistributor objects
}
]
source: {
type: 'string'
// For remaining properties, see ImageTemplateSource objects
}
}
}
ImageTemplateCustomizer-Objekte
Legen Sie die type-Eigenschaft fest, um den Typ des Objekts anzugeben.
Verwenden Sie für die Shell Folgendes:
type: 'shell'
script: 'string'
ImageTemplateDistributor-Objekte
Legen Sie die type-Eigenschaft fest, um den Typ des Objekts anzugeben.
Verwenden Sie für managedImage Folgendes:
type: 'managedImage'
imageId: 'string'
location: 'string'
Verwenden Sie für sharedImage Folgendes:
type: 'sharedImage'
galleryImageId: 'string'
replicationRegions: [
'string'
]
ImageTemplateSource-Objekte
Legen Sie die type-Eigenschaft fest, um den Typ des Objekts anzugeben.
Verwenden Sie für ISO Folgendes:
type: 'ISO'
sha256Checksum: 'string'
sourceURI: 'string'
Verwenden Sie für PlatformImage Folgendes:
type: 'PlatformImage'
offer: 'string'
publisher: 'string'
sku: 'string'
version: 'string'
Eigenschaftswerte
imageTemplates
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| name | Der Ressourcenname | Zeichenfolge (erforderlich) |
| location | Ressourcenspeicherort | Zeichenfolge (erforderlich) |
| tags | Ressourcentags | Wörterbuch der Tagnamen und -werte. Weitere Informationen finden Sie unter Tags in Vorlagen. |
| properties | ImageTemplateProperties |
ImageTemplateProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Anpassen | Gibt die Eigenschaften an, die verwendet werden, um die Anpassungsschritte des Bilds zu beschreiben, z. B. Bildquelle usw. | ImageTemplateCustomizer[] |
| Verteilen (distribute) | Die Verteilungsziele, an die die Bildausgabe gehen muss. | ImageTemplateDistributor[] (erforderlich) |
| source | Gibt die Eigenschaften an, die zum Beschreiben des Quellimages verwendet werden. | ImageTemplateSource (erforderlich) |
ImageTemplateCustomizer
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| name | Anzeigename, um Kontext für die Funktionsweise dieses Anpassungsschritts bereitzustellen | Zeichenfolge |
| type | Festlegen des Objekttyps | Shell (erforderlich) |
ImageTemplateShellCustomizer
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Typ des Anpassungstools, das Sie für das Image verwenden möchten. Beispielsweise kann "shell" shellCustomizer sein. | "Shell" (erforderlich) |
| script | Das Shellskript, das zum Anpassen ausgeführt werden soll. Es kann sich um einen GitHub-Link, einen SAS-URI für Azure Storage usw. handeln. | Zeichenfolge |
ImageTemplateDistributor
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| artifactTags | Tags, die auf das Artefakt angewendet werden, nachdem es vom Verteiler erstellt/aktualisiert wurde. | Objekt (object) |
| runOutputName | Der Name, der für den zugeordneten RunOutput verwendet werden soll. | Zeichenfolge (erforderlich) |
| Typ | Festlegen des Objekttyps | managedImage sharedImage (erforderlich) |
ImageTemplateManagedImageDistributor
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Typ der Verteilung. | "managedImage" (erforderlich) |
| imageId | Ressourcen-ID des Images für verwaltete Datenträger | Zeichenfolge (erforderlich) |
| location | Der Azure-Speicherort für das Image sollte übereinstimmen, wenn das Image bereits vorhanden ist. | Zeichenfolge (erforderlich) |
ImageTemplateSharedImageDistributor
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Typ der Verteilung. | "sharedImage" (erforderlich) |
| galleryImageId | Ressourcen-ID des Shared Image Gallery-Images | Zeichenfolge (erforderlich) |
| replicationRegions | string[] (erforderlich) |
ImageTemplateSource
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Festlegen des Objekttyps | ISO PlatformImage (erforderlich) |
ImageTemplateIsoSource
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Gibt den Typ des Quellimages an, mit dem Sie beginnen möchten. | "ISO" (erforderlich) |
| sha256Checksum | SHA256-Prüfsumme des ISO-Images. | Zeichenfolge (erforderlich) |
| Sourceuri | URL zum Abrufen des ISO-Images. Diese URL muss für den Ressourcenanbieter zum Zeitpunkt der imageTemplate-Erstellung zugänglich sein. | Zeichenfolge (erforderlich) |
ImageTemplatePlatformImageSource
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Gibt den Typ des Quellimages an, mit dem Sie beginnen möchten. | "PlatformImage" (erforderlich) |
| offer | Imageangebot aus dem Azure-Katalog Images. | Zeichenfolge |
| publisher | Bildherausgeber in Azure-Katalogimages. | Zeichenfolge |
| sku | Bild-SKU aus dem Azure-Katalog Images. | Zeichenfolge |
| version | Imageversion aus den Azure-Katalogimages. | Zeichenfolge |
Schnellstartvorlagen
In den folgenden Schnellstartvorlagen wird dieser Ressourcentyp bereitgestellt.
| Vorlage | BESCHREIBUNG |
|---|---|
Azure Image Builder mit Azure Windows Baseline |
Erstellt eine Azure Image Builder-Umgebung und erstellt ein Windows Server-Image mit dem neuesten Windows Updates und angewendeter Azure Windows-Baseline. |
| Konfigurieren des Dev Box-Diensts |
Mit dieser Vorlage würden alle Dev Box-Administratorressourcen gemäß der Dev Box-Schnellstartanleitung erstellt. Sie können alle erstellten Ressourcen anzeigen oder direkt zu DevPortal.microsoft.com wechseln, um Ihre erste Dev Box zu erstellen. |
Ressourcendefinition mit einer ARM-Vorlage
Der ImageTemplates-Ressourcentyp kann für Folgendes bereitgestellt werden:
- Ressourcengruppen – Siehe Bereitstellungsbefehle für Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.VirtualMachineImages/imageTemplates-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.
{
"type": "Microsoft.VirtualMachineImages/imageTemplates",
"apiVersion": "2018-02-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"customize": [
{
"name": "string",
"type": "string"
// For remaining properties, see ImageTemplateCustomizer objects
}
],
"distribute": [
{
"artifactTags": {},
"runOutputName": "string",
"type": "string"
// For remaining properties, see ImageTemplateDistributor objects
}
],
"source": {
"type": "string"
// For remaining properties, see ImageTemplateSource objects
}
}
}
ImageTemplateCustomizer-Objekte
Legen Sie die type-Eigenschaft fest, um den Typ des Objekts anzugeben.
Verwenden Sie für die Shell Folgendes:
"type": "shell",
"script": "string"
ImageTemplateDistributor-Objekte
Legen Sie die type-Eigenschaft fest, um den Typ des Objekts anzugeben.
Verwenden Sie für managedImage Folgendes:
"type": "managedImage",
"imageId": "string",
"location": "string"
Verwenden Sie für sharedImage Folgendes:
"type": "sharedImage",
"galleryImageId": "string",
"replicationRegions": [ "string" ]
ImageTemplateSource-Objekte
Legen Sie die type-Eigenschaft fest, um den Typ des Objekts anzugeben.
Verwenden Sie für ISO Folgendes:
"type": "ISO",
"sha256Checksum": "string",
"sourceURI": "string"
Verwenden Sie für PlatformImage Folgendes:
"type": "PlatformImage",
"offer": "string",
"publisher": "string",
"sku": "string",
"version": "string"
Eigenschaftswerte
imageTemplates
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Ressourcentyp | "Microsoft.VirtualMachineImages/imageTemplates" |
| apiVersion | Die Version der Ressourcen-API | "2018-02-01-preview" |
| name | Der Ressourcenname | Zeichenfolge (erforderlich) |
| location | Ressourcenspeicherort | Zeichenfolge (erforderlich) |
| tags | Ressourcentags | Wörterbuch der Tagnamen und -werte. Weitere Informationen finden Sie unter Tags in Vorlagen. |
| properties | ImageTemplateProperties |
ImageTemplateProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Anpassen | Gibt die Eigenschaften an, die verwendet werden, um die Anpassungsschritte des Bilds zu beschreiben, z. B. Bildquelle usw. | ImageTemplateCustomizer[] |
| Verteilen (distribute) | Die Verteilungsziele, an die die Bildausgabe gehen muss. | ImageTemplateDistributor[] (erforderlich) |
| source | Gibt die Eigenschaften an, die zum Beschreiben des Quellimages verwendet werden. | ImageTemplateSource (erforderlich) |
ImageTemplateCustomizer
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| name | Anzeigename, um Kontext für die Funktionsweise dieses Anpassungsschritts bereitzustellen | Zeichenfolge |
| type | Festlegen des Objekttyps | Shell (erforderlich) |
ImageTemplateShellCustomizer
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Typ des Anpassungstools, das Sie für das Image verwenden möchten. Beispielsweise kann "shell" shellCustomizer sein. | "Shell" (erforderlich) |
| script | Das Shellskript, das zum Anpassen ausgeführt werden soll. Es kann sich um einen GitHub-Link, einen SAS-URI für Azure Storage usw. handeln. | Zeichenfolge |
ImageTemplateDistributor
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| artifactTags | Tags, die auf das Artefakt angewendet werden, nachdem es vom Verteiler erstellt/aktualisiert wurde. | Objekt (object) |
| runOutputName | Der Name, der für den zugeordneten RunOutput verwendet werden soll. | Zeichenfolge (erforderlich) |
| Typ | Festlegen des Objekttyps | managedImage sharedImage (erforderlich) |
ImageTemplateManagedImageDistributor
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Typ der Verteilung. | "managedImage" (erforderlich) |
| imageId | Ressourcen-ID des Images für verwaltete Datenträger | Zeichenfolge (erforderlich) |
| location | Der Azure-Speicherort für das Image sollte übereinstimmen, wenn das Image bereits vorhanden ist. | Zeichenfolge (erforderlich) |
ImageTemplateSharedImageDistributor
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Typ der Verteilung. | "sharedImage" (erforderlich) |
| galleryImageId | Ressourcen-ID des Shared Image Gallery-Images | Zeichenfolge (erforderlich) |
| replicationRegions | string[] (erforderlich) |
ImageTemplateSource
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Festlegen des Objekttyps | ISO PlatformImage (erforderlich) |
ImageTemplateIsoSource
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Gibt den Typ des Quellimages an, mit dem Sie beginnen möchten. | "ISO" (erforderlich) |
| sha256Checksum | SHA256-Prüfsumme des ISO-Images. | Zeichenfolge (erforderlich) |
| Sourceuri | URL zum Abrufen des ISO-Images. Diese URL muss für den Ressourcenanbieter zum Zeitpunkt der imageTemplate-Erstellung zugänglich sein. | Zeichenfolge (erforderlich) |
ImageTemplatePlatformImageSource
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Gibt den Typ des Quellimages an, mit dem Sie beginnen möchten. | "PlatformImage" (erforderlich) |
| offer | Imageangebot aus dem Azure-Katalog Images. | Zeichenfolge |
| publisher | Bildherausgeber in Azure-Katalogimages. | Zeichenfolge |
| sku | Bild-SKU aus dem Azure-Katalog Images. | Zeichenfolge |
| version | Imageversion aus den Azure-Katalogimages. | Zeichenfolge |
Schnellstartvorlagen
In den folgenden Schnellstartvorlagen wird dieser Ressourcentyp bereitgestellt.
| Vorlage | BESCHREIBUNG |
|---|---|
| Azure Image Builder mit Azure Windows Baseline |
Erstellt eine Azure Image Builder-Umgebung und erstellt ein Windows Server-Image mit dem neuesten Windows Updates und angewendeter Azure Windows-Baseline. |
| Konfigurieren des Dev Box-Diensts |
Mit dieser Vorlage würden alle Dev Box-Administratorressourcen gemäß der Dev Box-Schnellstartanleitung erstellt. Sie können alle erstellten Ressourcen anzeigen oder direkt zu DevPortal.microsoft.com wechseln, um Ihre erste Dev Box zu erstellen. |
Terraform-Ressourcendefinition (AzAPI-Anbieter)
Der ImageTemplates-Ressourcentyp kann für Folgendes bereitgestellt werden:
- Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.VirtualMachineImages/imageTemplates-Ressource zu erstellen, fügen Sie der Vorlage den folgenden Terraform hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.VirtualMachineImages/imageTemplates@2018-02-01-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
customize = [
{
name = "string"
type = "string"
// For remaining properties, see ImageTemplateCustomizer objects
}
]
distribute = [
{
artifactTags = {}
runOutputName = "string"
type = "string"
// For remaining properties, see ImageTemplateDistributor objects
}
]
source = {
type = "string"
// For remaining properties, see ImageTemplateSource objects
}
}
})
}
ImageTemplateCustomizer-Objekte
Legen Sie die type-Eigenschaft fest, um den Typ des Objekts anzugeben.
Verwenden Sie für die Shell Folgendes:
type = "shell"
script = "string"
ImageTemplateDistributor-Objekte
Legen Sie die type-Eigenschaft fest, um den Typ des Objekts anzugeben.
Verwenden Sie für managedImage Folgendes:
type = "managedImage"
imageId = "string"
location = "string"
Verwenden Sie für sharedImage Folgendes:
type = "sharedImage"
galleryImageId = "string"
replicationRegions = [
"string"
]
ImageTemplateSource-Objekte
Legen Sie die type-Eigenschaft fest, um den Typ des Objekts anzugeben.
Verwenden Sie für ISO Folgendes:
type = "ISO"
sha256Checksum = "string"
sourceURI = "string"
Verwenden Sie für PlatformImage Folgendes:
type = "PlatformImage"
offer = "string"
publisher = "string"
sku = "string"
version = "string"
Eigenschaftswerte
imageTemplates
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Ressourcentyp | "Microsoft.VirtualMachineImages/imageTemplates@2018-02-01-preview" |
| name | Der Ressourcenname | Zeichenfolge (erforderlich) |
| location | Ressourcenspeicherort | Zeichenfolge (erforderlich) |
| parent_id | Verwenden Sie zum Bereitstellen in einer Ressourcengruppe die ID dieser Ressourcengruppe. | Zeichenfolge (erforderlich) |
| tags | Ressourcentags | Wörterbuch der Tagnamen und -werte. |
| properties | ImageTemplateProperties |
ImageTemplateProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Anpassen | Gibt die Eigenschaften an, die verwendet werden, um die Anpassungsschritte des Bilds zu beschreiben, z. B. Bildquelle usw. | ImageTemplateCustomizer[] |
| Verteilen (distribute) | Die Verteilungsziele, an die die Bildausgabe gehen muss. | ImageTemplateDistributor[] (erforderlich) |
| source | Gibt die Eigenschaften an, die zum Beschreiben des Quellimages verwendet werden. | ImageTemplateSource (erforderlich) |
ImageTemplateCustomizer
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| name | Anzeigename, um Kontext für die Funktionsweise dieses Anpassungsschritts bereitzustellen | Zeichenfolge |
| type | Festlegen des Objekttyps | Shell (erforderlich) |
ImageTemplateShellCustomizer
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Typ des Anpassungstools, das Sie für das Image verwenden möchten. "shell" kann beispielsweise shellCustomizer sein. | "Shell" (erforderlich) |
| script | Das Shellskript, das zum Anpassen ausgeführt werden soll. Es kann sich um einen Github-Link, einen SAS-URI für Azure Storage usw. handeln. | Zeichenfolge |
ImageTemplateDistributor
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| artifactTags | Tags, die auf das Artefakt angewendet werden, nachdem es vom Verteiler erstellt/aktualisiert wurde. | Objekt (object) |
| runOutputName | Der Name, der für den zugeordneten RunOutput verwendet werden soll. | Zeichenfolge (erforderlich) |
| Typ | Festlegen des Objekttyps | managedImage sharedImage (erforderlich) |
ImageTemplateManagedImageDistributor
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Verteilungstyp. | "managedImage" (erforderlich) |
| imageId | Ressourcen-ID des Verwalteten Datenträgerimages | Zeichenfolge (erforderlich) |
| location | Azure-Speicherort für das Image sollte übereinstimmen, wenn das Image bereits vorhanden ist | Zeichenfolge (erforderlich) |
ImageTemplateSharedImageDistributor
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Verteilungstyp. | "sharedImage" (erforderlich) |
| galleryImageId | Ressourcen-ID des Shared Image Gallery-Images | Zeichenfolge (erforderlich) |
| replicationRegions | string[] (erforderlich) |
ImageTemplateSource
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Festlegen des Objekttyps | ISO PlatformImage (erforderlich) |
ImageTemplateIsoSource
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Gibt den Typ des Quellimages an, mit dem Sie beginnen möchten. | "ISO" (erforderlich) |
| sha256Checksum | SHA256-Prüfsumme des ISO-Images. | Zeichenfolge (erforderlich) |
| Sourceuri | URL zum Abrufen des ISO-Images. Auf diese URL muss für den Ressourcenanbieter zum Zeitpunkt der imageTemplate-Erstellung zugegriffen werden. | Zeichenfolge (erforderlich) |
ImageTemplatePlatformImageSource
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Gibt den Typ des Quellimages an, mit dem Sie beginnen möchten. | "PlatformImage" (erforderlich) |
| offer | Imageangebot aus dem Azure-Katalog images. | Zeichenfolge |
| publisher | Image Publisher in Azure Gallery Images. | Zeichenfolge |
| sku | Image-SKU aus den Azure-Katalogimages. | Zeichenfolge |
| version | Imageversion aus den Azure-Katalogimages. | Zeichenfolge |
Feedback
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unter https://aka.ms/ContentUserFeedback.
Feedback senden und anzeigen für