Freigeben über


Microsoft.VirtualMachineImages imageTemplates 2018-02-01-preview

Bicep-Ressourcendefinition

Der imageTemplates-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.VirtualMachineImages/imageTemplates-Ressource zu erstellen, fügen Sie der Vorlage die folgende Bicep hinzu.

resource symbolicname 'Microsoft.VirtualMachineImages/imageTemplates@2018-02-01-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    customize: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see ImageTemplateCustomizer objects
      }
    ]
    distribute: [
      {
        artifactTags: {
          {customized property}: 'string'
        }
        runOutputName: 'string'
        type: 'string'
        // For remaining properties, see ImageTemplateDistributor objects
      }
    ]
    source: {
      type: 'string'
      // For remaining properties, see ImageTemplateSource objects
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

ImageTemplateSource-Objekte

Legen Sie den Typ Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für ISO-:

{
  sha256Checksum: 'string'
  sourceURI: 'string'
  type: 'ISO'
}

Verwenden Sie für PlatformImage-:

{
  offer: 'string'
  publisher: 'string'
  sku: 'string'
  type: 'PlatformImage'
  version: 'string'
}

ImageTemplateCustomizer-Objekte

Legen Sie den Typ Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für Shell-:

{
  script: 'string'
  type: 'shell'
}

ImageTemplateDistributor-Objekte

Legen Sie den Typ Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für managedImage-:

{
  imageId: 'string'
  location: 'string'
  type: 'managedImage'
}

Verwenden Sie für sharedImage-:

{
  galleryImageId: 'string'
  replicationRegions: [
    'string'
  ]
  type: 'sharedImage'
}

Eigenschaftswerte

ImageTemplateCustomizer

Name Beschreibung Wert
Name Anzeigename zum Bereitstellen des Kontexts, der in diesem Anpassungsschritt ausgeführt wird Schnur
Art Legen Sie für den Typ ImageTemplateShellCustomizer-auf "shell" fest. 'shell' (erforderlich)

ImageTemplateDistributor

Name Beschreibung Wert
artifactTags Tags, die auf das Artefakt angewendet werden, nachdem es vom Verteiler erstellt/aktualisiert wurde. ImageTemplateDistributorArtifactTags
runOutputName Der Name, der für den zugeordneten RunOutput verwendet werden soll. Schnur

Zwänge:
Pattern = ^[A-Za-z0-9-_]{1,64}$ (erforderlich)
Art Set to 'managedImage' for type ImageTemplateManagedImageDistributor. Set to 'sharedImage' for type ImageTemplateSharedImageDistributor. "managedImage"
"sharedImage" (erforderlich)

ImageTemplateDistributorArtifactTags

Name Beschreibung Wert

ImageTemplateIsoSource

Name Beschreibung Wert
sha256Checksum SHA256-Prüfsumme des ISO-Images. Zeichenfolge (erforderlich)
sourceURI URL zum Abrufen des ISO-Images. Auf diese URL muss zum Zeitpunkt der ImageTemplate-Erstellung auf den Ressourcenanbieter zugegriffen werden. Zeichenfolge (erforderlich)
Art Gibt den Typ des Quellbilds an, mit dem Sie beginnen möchten. "ISO" (erforderlich)

ImageTemplateManagedImageDistributor

Name Beschreibung Wert
imageId Ressourcen-ID des Image des verwalteten Datenträgers Zeichenfolge (erforderlich)
Ort Azure-Speicherort für das Image sollte übereinstimmen, wenn das Bild bereits vorhanden ist Zeichenfolge (erforderlich)
Art Typ der Verteilung. "managedImage" (erforderlich)

ImageTemplatePlatformImageSource

Name Beschreibung Wert
Angebot Bildangebot aus dem Azure Gallery Images. Schnur
Verlag Image Publisher in Azure Gallery Images. Schnur
Sku Bildsku aus der Azure Gallery Images. Schnur
Art Gibt den Typ des Quellbilds an, mit dem Sie beginnen möchten. "PlatformImage" (erforderlich)
Version Bildversion aus der Azure Gallery Images. Schnur

ImageTemplateProperties

Name Beschreibung Wert
Anpassen Gibt die Eigenschaften an, die zum Beschreiben der Anpassungsschritte des Bilds verwendet werden, z. B. Bildquelle usw. ImageTemplateCustomizer[]
verteilen Die Verteilungsziele, zu denen die Bildausgabe wechseln muss. ImageTemplateDistributor[] (erforderlich)
Quelle Gibt die Eigenschaften an, die zum Beschreiben des Quellbilds verwendet werden. ImageTemplateSource- (erforderlich)

ImageTemplateSharedImageDistributor

Name Beschreibung Wert
galleryImageId Ressourcen-ID des Bilds "Freigegebene Bildergalerie" Zeichenfolge (erforderlich)
replicationRegions string[] (erforderlich)
Art Typ der Verteilung. "sharedImage" (erforderlich)

ImageTemplateShellCustomizer

Name Beschreibung Wert
Skript Das Shellskript, das zum Anpassen ausgeführt werden soll. Es kann sich um einen GitHub-Link, SAS-URI für Azure Storage usw. handeln. Schnur
Art Der Typ des Anpassungstools, das Sie für das Bild verwenden möchten. Beispielsweise kann "shell" shellCustomizer sein. 'shell' (erforderlich)

ImageTemplateSource

Name Beschreibung Wert
Art Legen Sie für den Typ ImageTemplateIsoSourceauf "ISO" fest. Set to 'PlatformImage' for type ImageTemplatePlatformImageSource. "ISO"
"PlatformImage" (erforderlich)

Microsoft.VirtualMachineImages/imageTemplates

Name Beschreibung Wert
Ort Ressourcenspeicherort Zeichenfolge (erforderlich)
Name Der Ressourcenname Schnur

Zwänge:
Pattern = ^[A-Za-z0-9-_]{1,64}$ (erforderlich)
Eigenschaften ImageTemplateProperties-
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen

ResourceTags

Name Beschreibung Wert

Schnellstartbeispiele

Die folgenden Schnellstartbeispiele stellen diesen Ressourcentyp bereit.

Bicep-Datei Beschreibung
Azure Image Builder mit Azure Windows Baseline Erstellt eine Azure Image Builder-Umgebung und erstellt ein Windows Server-Image mit den neuesten Angewendeten Windows-Updates und Azure Windows Baseline.
Konfigurieren des Dev Box-Diensts Diese Vorlage würde alle Dev Box-Administratorressourcen gemäß dev Box-Schnellstarthandbuch (/azure/dev-box/quickstart-create-dev-box) erstellen. Sie können alle erstellten Ressourcen anzeigen oder direkt zu DevPortal.microsoft.com wechseln, um Ihr erstes Dev Box zu erstellen.

ARM-Vorlagenressourcendefinition

Der imageTemplates-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Ä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",
  "properties": {
    "customize": [ {
      "name": "string",
      "type": "string"
      // For remaining properties, see ImageTemplateCustomizer objects
    } ],
    "distribute": [ {
      "artifactTags": {
        "{customized property}": "string"
      },
      "runOutputName": "string",
      "type": "string"
      // For remaining properties, see ImageTemplateDistributor objects
    } ],
    "source": {
      "type": "string"
      // For remaining properties, see ImageTemplateSource objects
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

ImageTemplateSource-Objekte

Legen Sie den Typ Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für ISO-:

{
  "sha256Checksum": "string",
  "sourceURI": "string",
  "type": "ISO"
}

Verwenden Sie für PlatformImage-:

{
  "offer": "string",
  "publisher": "string",
  "sku": "string",
  "type": "PlatformImage",
  "version": "string"
}

ImageTemplateCustomizer-Objekte

Legen Sie den Typ Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für Shell-:

{
  "script": "string",
  "type": "shell"
}

ImageTemplateDistributor-Objekte

Legen Sie den Typ Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für managedImage-:

{
  "imageId": "string",
  "location": "string",
  "type": "managedImage"
}

Verwenden Sie für sharedImage-:

{
  "galleryImageId": "string",
  "replicationRegions": [ "string" ],
  "type": "sharedImage"
}

Eigenschaftswerte

ImageTemplateCustomizer

Name Beschreibung Wert
Name Anzeigename zum Bereitstellen des Kontexts, der in diesem Anpassungsschritt ausgeführt wird Schnur
Art Legen Sie für den Typ ImageTemplateShellCustomizer-auf "shell" fest. 'shell' (erforderlich)

ImageTemplateDistributor

Name Beschreibung Wert
artifactTags Tags, die auf das Artefakt angewendet werden, nachdem es vom Verteiler erstellt/aktualisiert wurde. ImageTemplateDistributorArtifactTags
runOutputName Der Name, der für den zugeordneten RunOutput verwendet werden soll. Schnur

Zwänge:
Pattern = ^[A-Za-z0-9-_]{1,64}$ (erforderlich)
Art Set to 'managedImage' for type ImageTemplateManagedImageDistributor. Set to 'sharedImage' for type ImageTemplateSharedImageDistributor. "managedImage"
"sharedImage" (erforderlich)

ImageTemplateDistributorArtifactTags

Name Beschreibung Wert

ImageTemplateIsoSource

Name Beschreibung Wert
sha256Checksum SHA256-Prüfsumme des ISO-Images. Zeichenfolge (erforderlich)
sourceURI URL zum Abrufen des ISO-Images. Auf diese URL muss zum Zeitpunkt der ImageTemplate-Erstellung auf den Ressourcenanbieter zugegriffen werden. Zeichenfolge (erforderlich)
Art Gibt den Typ des Quellbilds an, mit dem Sie beginnen möchten. "ISO" (erforderlich)

ImageTemplateManagedImageDistributor

Name Beschreibung Wert
imageId Ressourcen-ID des Image des verwalteten Datenträgers Zeichenfolge (erforderlich)
Ort Azure-Speicherort für das Image sollte übereinstimmen, wenn das Bild bereits vorhanden ist Zeichenfolge (erforderlich)
Art Typ der Verteilung. "managedImage" (erforderlich)

ImageTemplatePlatformImageSource

Name Beschreibung Wert
Angebot Bildangebot aus dem Azure Gallery Images. Schnur
Verlag Image Publisher in Azure Gallery Images. Schnur
Sku Bildsku aus der Azure Gallery Images. Schnur
Art Gibt den Typ des Quellbilds an, mit dem Sie beginnen möchten. "PlatformImage" (erforderlich)
Version Bildversion aus der Azure Gallery Images. Schnur

ImageTemplateProperties

Name Beschreibung Wert
Anpassen Gibt die Eigenschaften an, die zum Beschreiben der Anpassungsschritte des Bilds verwendet werden, z. B. Bildquelle usw. ImageTemplateCustomizer[]
verteilen Die Verteilungsziele, zu denen die Bildausgabe wechseln muss. ImageTemplateDistributor[] (erforderlich)
Quelle Gibt die Eigenschaften an, die zum Beschreiben des Quellbilds verwendet werden. ImageTemplateSource- (erforderlich)

ImageTemplateSharedImageDistributor

Name Beschreibung Wert
galleryImageId Ressourcen-ID des Bilds "Freigegebene Bildergalerie" Zeichenfolge (erforderlich)
replicationRegions string[] (erforderlich)
Art Typ der Verteilung. "sharedImage" (erforderlich)

ImageTemplateShellCustomizer

Name Beschreibung Wert
Skript Das Shellskript, das zum Anpassen ausgeführt werden soll. Es kann sich um einen GitHub-Link, SAS-URI für Azure Storage usw. handeln. Schnur
Art Der Typ des Anpassungstools, das Sie für das Bild verwenden möchten. Beispielsweise kann "shell" shellCustomizer sein. 'shell' (erforderlich)

ImageTemplateSource

Name Beschreibung Wert
Art Legen Sie für den Typ ImageTemplateIsoSourceauf "ISO" fest. Set to 'PlatformImage' for type ImageTemplatePlatformImageSource. "ISO"
"PlatformImage" (erforderlich)

Microsoft.VirtualMachineImages/imageTemplates

Name Beschreibung Wert
apiVersion Die API-Version "2018-02-01-preview"
Ort Ressourcenspeicherort Zeichenfolge (erforderlich)
Name Der Ressourcenname Schnur

Zwänge:
Pattern = ^[A-Za-z0-9-_]{1,64}$ (erforderlich)
Eigenschaften ImageTemplateProperties-
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
Art Der Ressourcentyp 'Microsoft.VirtualMachineImages/imageTemplates'

ResourceTags

Name Beschreibung Wert

Schnellstartvorlagen

Die folgenden Schnellstartvorlagen stellen diesen Ressourcentyp bereit.

Schablone Beschreibung
Azure Image Builder mit Azure Windows Baseline

Bereitstellen in Azure
Erstellt eine Azure Image Builder-Umgebung und erstellt ein Windows Server-Image mit den neuesten Angewendeten Windows-Updates und Azure Windows Baseline.
Konfigurieren des Dev Box-Diensts

Bereitstellen in Azure
Diese Vorlage würde alle Dev Box-Administratorressourcen gemäß dev Box-Schnellstarthandbuch (/azure/dev-box/quickstart-create-dev-box) erstellen. Sie können alle erstellten Ressourcen anzeigen oder direkt zu DevPortal.microsoft.com wechseln, um Ihr erstes Dev Box zu erstellen.

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der imageTemplates-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

  • Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.VirtualMachineImages/imageTemplates-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.VirtualMachineImages/imageTemplates@2018-02-01-preview"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      customize = [
        {
          name = "string"
          type = "string"
          // For remaining properties, see ImageTemplateCustomizer objects
        }
      ]
      distribute = [
        {
          artifactTags = {
            {customized property} = "string"
          }
          runOutputName = "string"
          type = "string"
          // For remaining properties, see ImageTemplateDistributor objects
        }
      ]
      source = {
        type = "string"
        // For remaining properties, see ImageTemplateSource objects
      }
    }
  })
}

ImageTemplateSource-Objekte

Legen Sie den Typ Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für ISO-:

{
  sha256Checksum = "string"
  sourceURI = "string"
  type = "ISO"
}

Verwenden Sie für PlatformImage-:

{
  offer = "string"
  publisher = "string"
  sku = "string"
  type = "PlatformImage"
  version = "string"
}

ImageTemplateCustomizer-Objekte

Legen Sie den Typ Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für Shell-:

{
  script = "string"
  type = "shell"
}

ImageTemplateDistributor-Objekte

Legen Sie den Typ Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für managedImage-:

{
  imageId = "string"
  location = "string"
  type = "managedImage"
}

Verwenden Sie für sharedImage-:

{
  galleryImageId = "string"
  replicationRegions = [
    "string"
  ]
  type = "sharedImage"
}

Eigenschaftswerte

ImageTemplateCustomizer

Name Beschreibung Wert
Name Anzeigename zum Bereitstellen des Kontexts, der in diesem Anpassungsschritt ausgeführt wird Schnur
Art Legen Sie für den Typ ImageTemplateShellCustomizer-auf "shell" fest. 'shell' (erforderlich)

ImageTemplateDistributor

Name Beschreibung Wert
artifactTags Tags, die auf das Artefakt angewendet werden, nachdem es vom Verteiler erstellt/aktualisiert wurde. ImageTemplateDistributorArtifactTags
runOutputName Der Name, der für den zugeordneten RunOutput verwendet werden soll. Schnur

Zwänge:
Pattern = ^[A-Za-z0-9-_]{1,64}$ (erforderlich)
Art Set to 'managedImage' for type ImageTemplateManagedImageDistributor. Set to 'sharedImage' for type ImageTemplateSharedImageDistributor. "managedImage"
"sharedImage" (erforderlich)

ImageTemplateDistributorArtifactTags

Name Beschreibung Wert

ImageTemplateIsoSource

Name Beschreibung Wert
sha256Checksum SHA256-Prüfsumme des ISO-Images. Zeichenfolge (erforderlich)
sourceURI URL zum Abrufen des ISO-Images. Auf diese URL muss zum Zeitpunkt der ImageTemplate-Erstellung auf den Ressourcenanbieter zugegriffen werden. Zeichenfolge (erforderlich)
Art Gibt den Typ des Quellbilds an, mit dem Sie beginnen möchten. "ISO" (erforderlich)

ImageTemplateManagedImageDistributor

Name Beschreibung Wert
imageId Ressourcen-ID des Image des verwalteten Datenträgers Zeichenfolge (erforderlich)
Ort Azure-Speicherort für das Image sollte übereinstimmen, wenn das Bild bereits vorhanden ist Zeichenfolge (erforderlich)
Art Typ der Verteilung. "managedImage" (erforderlich)

ImageTemplatePlatformImageSource

Name Beschreibung Wert
Angebot Bildangebot aus dem Azure Gallery Images. Schnur
Verlag Image Publisher in Azure Gallery Images. Schnur
Sku Bildsku aus der Azure Gallery Images. Schnur
Art Gibt den Typ des Quellbilds an, mit dem Sie beginnen möchten. "PlatformImage" (erforderlich)
Version Bildversion aus der Azure Gallery Images. Schnur

ImageTemplateProperties

Name Beschreibung Wert
Anpassen Gibt die Eigenschaften an, die zum Beschreiben der Anpassungsschritte des Bilds verwendet werden, z. B. Bildquelle usw. ImageTemplateCustomizer[]
verteilen Die Verteilungsziele, zu denen die Bildausgabe wechseln muss. ImageTemplateDistributor[] (erforderlich)
Quelle Gibt die Eigenschaften an, die zum Beschreiben des Quellbilds verwendet werden. ImageTemplateSource- (erforderlich)

ImageTemplateSharedImageDistributor

Name Beschreibung Wert
galleryImageId Ressourcen-ID des Bilds "Freigegebene Bildergalerie" Zeichenfolge (erforderlich)
replicationRegions string[] (erforderlich)
Art Typ der Verteilung. "sharedImage" (erforderlich)

ImageTemplateShellCustomizer

Name Beschreibung Wert
Skript Das Shellskript, das zum Anpassen ausgeführt werden soll. Es kann sich um einen GitHub-Link, SAS-URI für Azure Storage usw. handeln. Schnur
Art Der Typ des Anpassungstools, das Sie für das Bild verwenden möchten. Beispielsweise kann "shell" shellCustomizer sein. 'shell' (erforderlich)

ImageTemplateSource

Name Beschreibung Wert
Art Legen Sie für den Typ ImageTemplateIsoSourceauf "ISO" fest. Set to 'PlatformImage' for type ImageTemplatePlatformImageSource. "ISO"
"PlatformImage" (erforderlich)

Microsoft.VirtualMachineImages/imageTemplates

Name Beschreibung Wert
Ort Ressourcenspeicherort Zeichenfolge (erforderlich)
Name Der Ressourcenname Schnur

Zwänge:
Pattern = ^[A-Za-z0-9-_]{1,64}$ (erforderlich)
Eigenschaften ImageTemplateProperties-
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte.
Art Der Ressourcentyp "Microsoft.VirtualMachineImages/imageTemplates@2018-02-01-preview"

ResourceTags

Name Beschreibung Wert