az image builder

Verwalten und Erstellen von Image Builder-Vorlagen

Befehle

az image builder cancel

Abbrechen des Imagebuilds mit langer Ausführungsdauer basierend auf der Imagevorlage.

az image builder create

Erstellen Sie eine Image Builder-Vorlage.

az image builder customizer

Image Builder-Vorlagenanpassung verwalten.

az image builder customizer add

Fügen Sie einer Image Builder-Vorlage einen Image Builder-Customizer hinzu.

az image builder customizer clear

Entfernen Sie alle Image Builder-Anpasser aus einer Image Builder-Vorlage.

az image builder customizer remove

Entfernen Sie einen Image Builder-Customizer aus einer Image Builder-Vorlage.

az image builder delete

Löschen Sie die Image Builder-Vorlage.

az image builder list

Auflisten von Image Builder-Vorlagen.

az image builder output

Image Builder-Vorlagenausgabeverteiler verwalten.

az image builder output add

Fügen Sie einer Image Builder-Vorlage einen Image Builder-Ausgabeverteiler hinzu.

az image builder output clear

Entfernen Sie alle Image Builder-Ausgabeverteiler aus einer Image Builder-Vorlage.

az image builder output remove

Entfernen Sie einen Image Builder-Ausgabeverteiler aus einer Image Builder-Vorlage.

az image builder run

Erstellen Sie eine Image Builder-Vorlage.

az image builder show

Zeigen Sie eine Image Builder-Vorlage an.

az image builder show-runs

Zeigen Sie die Ausführungsausgaben einer Image Builder-Vorlage an.

az image builder update

Aktualisieren sie eine Image Builder-Vorlage.

az image builder validator

Verwalten der Image Builder-Vorlagenüberprüfung.

az image builder validator add

Hinzufügen von Validate zu einer vorhandenen Image Builder-Vorlage.

az image builder validator remove

Entfernen Sie validate aus einer vorhandenen Image Builder-Vorlage.

az image builder validator show

Überprüfen einer vorhandenen Image Builder-Vorlage anzeigen

az image builder wait

Versetzen Sie die CLI in einen Wartezustand, bis eine Bedingung der Vorlage erfüllt ist.

az image builder cancel

Abbrechen des Imagebuilds mit langer Ausführungsdauer basierend auf der Imagevorlage.

az image builder cancel [--ids]
                        [--name]
                        [--resource-group]
                        [--subscription]

Beispiele

Abbrechen eines Imagebuilds.

az image builder cancel -n mytemplate -g my-group

Optionale Parameter

--ids

Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Es sollte sich um eine vollständige Ressourcen-ID handeln, die alle Informationen der Argumente "Ressourcen-ID" enthält. Sie sollten entweder --ids oder andere "Ressourcen-ID"-Argumente angeben.

--name -n

Der Name der Bildvorlage.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

az image builder create

Erstellen Sie eine Image Builder-Vorlage.

az image builder create --name
                        --resource-group
                        [--build-timeout]
                        [--build-vm-identities]
                        [--checksum]
                        [--defer]
                        [--identity]
                        [--image-source]
                        [--image-template]
                        [--location]
                        [--managed-image-destinations]
                        [--no-wait]
                        [--os-disk-size]
                        [--proxy-vm-size]
                        [--scripts]
                        [--shared-image-destinations]
                        [--staging-resource-group]
                        [--subnet]
                        [--tags]
                        [--vm-size]
                        [--vnet]

Beispiele

Erstellen Sie eine Image Builder-Vorlage aus einem UbuntuLTS 18.04-Image. Verteilen Sie es als verwaltetes Image und als Shared Image Gallery-Imageversion. Geben Sie die Stagingressourcengruppen-ID als Imagevorlage an, die zum Erstellen des Images verwendet wird.

scripts="https://my-script-url.net/customize_script.sh"
imagesource="Canonical:UbuntuServer:18.04-LTS:18.04.201903060"

az image builder create --image-source $imagesource -n myTemplate -g myGroup \
    --scripts $scripts --managed-image-destinations image_1=westus \
    --shared-image-destinations my_shared_gallery/linux_image_def=westus,brazilsouth \
    --identity myIdentity --staging-resource-group myStagingResourceGroup

Erstellen Sie eine Image Builder-Vorlage mithilfe einer Imagevorlagendatei.

az image builder create -g my-group -n myTemplate --image-template filename

[Erweitert] Erstellen Sie eine Bildvorlage mit mehreren Anpassern und Verteilern mithilfe des Objektcaches der CLI über --defer. Unterstützt Features wie: Customizer- und Ausgabenamen, PowerShell-Exitcodes, Inlineskripts, Windows-Neustart, Dateianpasser, Artefakttags und Vhd-Ausgabeverteiler.

script="https://my-script-url.com/customize_script.ps1"
imagesource="MicrosoftWindowsServer:WindowsServer:2019-Datacenter:2019.0.20190214"

# create and update template object in local cli cache. Defers put request to ARM
# Cache object ttl set via az configure.
az image builder create --image-source $imagesource -n myTemplate \
    -g myGroup --scripts $script --identity myIdentity --defer

# add customizers
az image builder customizer add -n myTemplate -g myGroup  \
    --customizer-name myPwshScript --exit-codes 0 1 --inline-script \
    "mkdir c:\buildActions" "echo Azure-Image-Builder-Was-Here \
     > c:\buildActions\Output.txt" --type powershell --defer

az image builder customizer add -n myTemplate -g myGroup \
    --customizer-name myFileCustomizer --type file \
    --file-source "https://my-file-source.net/file.txt"  \
    --dest-path "c:\buildArtifacts\file.txt" --defer

# add distributors
az image builder output add -n myTemplate -g myGroup --is-vhd \
    --output-name myWinImageVhd --artifact-tags "is_vhd=True" --defer

az image builder output add -n myTemplate -g myGroup \
    --output-name myWinImageManaged --managed-image winImage \
    --managed-image-location eastus \
    --artifact-tags "is_vhd=False" --defer

# Stop deferring put request to ARM. Create the template from the object cache.
# Cache object will be deleted.
az image builder update -n myTemplate -g myGroup

Erforderliche Parameter

--name -n

Der Name der Bildvorlage.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

Optionale Parameter

--build-timeout

Die maximale Wartezeit beim Erstellen der Imagevorlage in Minuten. Der Standardwert ist 60.

--build-vm-identities

Optionale Konfiguration des virtuellen Netzwerks, das zum Bereitstellen des virtuellen Buildcomputers verwendet werden soll. Lassen Sie diese Angabe aus, wenn kein bestimmtes virtuelles Netzwerk verwendet werden muss.

--checksum

Die SHA256-Prüfsumme des Red Hat ISO-Images.

--defer

Speichert das Objekt temporär im lokalen Cache, anstatt es an Azure zu senden. Verwenden Sie az cache Befehle zum Anzeigen/Löschen.

--identity

Liste der vom Benutzer zugewiesenen Identitäten (Name oder ID, Leerzeichen getrennt) der Bildvorlage.

--image-source -i

Das anzupassende Basisimage. Muss ein gültiger Plattformimage-URN, Plattformimagealias, Red Hat ISO-Image-URI, Name/ID des verwalteten Images oder Versions-ID für freigegebene Images sein.

Wert aus: az vm image list, az vm image show
--image-template

Lokaler Pfad oder url zu einer Bildvorlagendatei. Bei Verwendung von --image-template werden alle anderen Parameter außer -g und -n ignoriert. Referenz: https://docs.microsoft.com/azure/virtual-machines/linux/image-builder-json.

--location -l

Der Standort. Werte aus: az account list-locations. Sie können den standardmäßig verwendeten Standort mit az configure --defaults location=<location> konfigurieren.

--managed-image-destinations

Informationen zum Ausgabeverteiler für verwaltete Images. Durch Leerzeichen getrennte Liste von Schlüssel-Wert-Paaren. Beispiel: "image_1=westus2 image_2=westus". Jeder Schlüssel ist der Name oder die Ressourcen-ID des zu erstellenden verwalteten Images. Jeder Wert ist die Position des Bilds.

--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

Standardwert: False
--os-disk-size

Größe des Betriebssystemdatenträgers in GB. Lassen Sie 0 aus, um die Standardgröße des Betriebssystemdatenträgers von Azure zu verwenden.

--proxy-vm-size

Größe des virtuellen Computers, der zum Erstellen, Anpassen und Erfassen von Images verwendet wird (Standard_D1_v2 für Gen1-Images und Standard_D2ds_v4 für Gen2-Images).

--scripts

Durch Leerzeichen getrennte Liste der Shell- oder PowerShell-Skripts, mit denen das Image angepasst werden soll. Jedes Skript muss eine öffentlich zugängliche URL sein. Leitet den Typ des Skripts aus der Dateierweiterung (".sh" oder ".ps1") oder vom Quelltyp ab. Weitere Anpassungsoptionen und Flexibilität finden Sie unter "az image template customizer add".

--shared-image-destinations

Ausgabeverteilerinformationen für shared image gallery (sig). Durch Leerzeichen getrennte Liste von Schlüssel-Wert-Paaren. Beispiel: "my_gallery_1/image_def_1=eastus,westus my_gallery_2/image_def_2=uksouth,canadaeast,francesouth." Jeder Schlüssel ist die SIG-Imagedefinitions-ID oder der Name des Sig-Katalogs und die Sig-Imagedefinition, die durch ein "/" getrennt ist. Jeder Wert ist eine durch Trennzeichen getrennte Liste von Replikatspeicherorten.

--staging-resource-group

Die Stagingressourcengruppen-ID im selben Abonnement wie die Imagevorlage, die zum Erstellen des Images verwendet wird.

--subnet

Name oder ID des Subnetzes, um den virtuellen Buildcomputer bereitzustellen.

--tags

Leerzeichentrennte Tags: key[=value] [key[=value] ...]. Verwenden Sie "", um vorhandene Tags zu löschen.

--vm-size

Größe des virtuellen Computers, der zum Erstellen, Anpassen und Erfassen von Images verwendet wird. Lassen Sie die leere Zeichenfolge aus, oder geben Sie sie an, um den Standard (Standard_D1_v2) zu verwenden.

--vnet

Name des VNET zum Bereitstellen des virtuellen Buildcomputers. Sie sollten es nur angeben, wenn das Subnetz ein Name ist.

az image builder delete

Löschen Sie die Image Builder-Vorlage.

az image builder delete [--ids]
                        [--name]
                        [--resource-group]
                        [--subscription]

Beispiele

Löschen Sie die Image Builder-Vorlage. (automatisch generiert)

az image builder delete --name MyImageTemplate --resource-group MyResourceGroup

Optionale Parameter

--ids

Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Es sollte sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" handelt. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

--name -n

Der Name der Bildvorlage.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

az image builder list

Image Builder-Vorlagen auflisten.

az image builder list [--resource-group]

Optionale Parameter

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

az image builder run

Erstellen Sie eine Image Builder-Vorlage.

az image builder run [--ids]
                     [--name]
                     [--no-wait]
                     [--resource-group]
                     [--subscription]

Beispiele

Starten Sie eine Vorlagenbuildausführung, und warten Sie dann, bis sie abgeschlossen ist.

az image builder run -n mytemplate -g my-group --no-wait

az image builder wait -n mytemplate -g aibmdi \
    --custom "lastRunStatus.runState!='Running'"

az image builder show -n mytemplate -g my-group

Optionale Parameter

--ids

Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Es sollte sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" handelt. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

--name -n

Der Name der Bildvorlage.

--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

Standardwert: False
--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

az image builder show

Zeigen Sie eine Image Builder-Vorlage an.

az image builder show [--ids]
                      [--name]
                      [--resource-group]
                      [--subscription]

Beispiele

Anzeigen einer Image Builder-Vorlage (automatisch generiert)

az image builder show --name mytemplate  --resource-group my-group

Optionale Parameter

--ids

Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Es sollte sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" handelt. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

--name -n

Der Name der Bildvorlage.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

az image builder show-runs

Zeigen Sie die Ausführungsausgaben einer Image Builder-Vorlage an.

az image builder show-runs [--ids]
                           [--name]
                           [--output-name]
                           [--resource-group]
                           [--subscription]

Beispiele

Führen Sie eine Vorlagenbuildausführung aus, und zeigen Sie dann die Ausführungsausgaben an.

az image builder run -n mytemplate -g my-group --no-wait

az image builder wait -n mytemplate -g aibmdi \
    --custom "lastRunStatus.runState!='Running'"

az image builder show-runs -n mytemplate -g my-group

Optionale Parameter

--ids

Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Es sollte sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" handelt. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

--name -n

Der Name der Bildvorlage.

--output-name

Name der Image Builder-Ausführungsausgabe.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

az image builder update

Aktualisieren Sie eine Image Builder-Vorlage.

Das Aktualisieren von Image Builder-Vorlagen wird derzeit nicht unterstützt. Dieser Befehl kann in Verbindung mit --defer verwendet werden, um ein Imagevorlagenobjekt im CLI-Cache zu aktualisieren. Ohne --defer wird die angegebene Imagevorlage aus dem Cache abgerufen und eine Anforderung an Azure gesendet, um die Imagevorlage zu erstellen.

az image builder update [--add]
                        [--defer]
                        [--force-string]
                        [--ids]
                        [--name]
                        [--remove]
                        [--resource-group]
                        [--set]
                        [--subscription]

Beispiele

Erstellen Sie eine Vorlagenressource aus einem Vorlagenobjekt im Cli-Cache. Weitere Informationen finden Sie unter "az image builder create /output add /customizer add --help" und "az cache -h".

# create and write template object to local cli cache
az image builder create --image-source {image_source} -n mytemplate -g my-group \
    --scripts {script} --managed-image-destinations image_1=westus --identity myidentity --defer

# add customizers and outputs to local cache template object via az image template output / customizer add
# one can also update cache object properties through generic update options, such as: --set
az image builder output add -n mytemplate -g my-group --output-name my-win-image-managed \
    --artifact-tags "is_vhd=False"  --managed-image winImage --managed-image-location eastus --defer

# send template create request to azure to create template resource
az image builder update -n mytemplate -g my-group

Optionale Parameter

--add

Fügen Sie einer Liste von Objekten ein Objekt hinzu, indem Sie ein Pfad- und Schlüsselwertpaar angeben. Beispiel: --add property.listProperty <key=value, string or JSON string>.

Standardwert: []
--defer

Speichert das Objekt temporär im lokalen Cache, anstatt es an Azure zu senden. Verwenden Sie az cache Befehle zum Anzeigen/Löschen.

--force-string

Wenn Sie "set" oder "add" verwenden, behalten Sie Zeichenfolgenliterale bei, anstatt zu versuchen, in JSON zu konvertieren.

Standardwert: False
--ids

Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Es sollte sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" handelt. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

--name -n

Der Name der Bildvorlage.

--remove

Entfernen Sie eine Eigenschaft oder ein Element aus einer Liste. Beispiel: --remove property.list OR --remove propertyToRemove.

Standardwert: []
--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--set

Aktualisieren Sie ein Objekt, indem Sie einen Eigenschaftenpfad und wert angeben, der festgelegt werden soll. Beispiel: --set property1.property2=.

Standardwert: []
--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

az image builder wait

Versetzen Sie die CLI in einen Wartezustand, bis eine Bedingung der Vorlage erfüllt ist.

az image builder wait [--created]
                      [--custom]
                      [--deleted]
                      [--exists]
                      [--ids]
                      [--interval]
                      [--name]
                      [--resource-group]
                      [--subscription]
                      [--timeout]
                      [--updated]

Beispiele

Starten Sie eine Vorlagenbuildausführung, und warten Sie dann, bis sie abgeschlossen ist.

az image builder run -n mytemplate -g my-group --no-wait

az image builder wait -n mytemplate -g aibmdi \
    --custom "lastRunStatus.runState!='Running'"

az image builder show -n mytemplate -g my-group

Optionale Parameter

--created

Warten Sie, bis sie mit "provisioningState" bei "Erfolgreich" erstellt wurde.

Standardwert: False
--custom

Warten Sie, bis die Bedingung eine benutzerdefinierte JMESPath-Abfrage erfüllt. Z.B. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Warten Sie, bis sie gelöscht wurde.

Standardwert: False
--exists

Warten Sie, bis die Ressource vorhanden ist.

Standardwert: False
--ids

Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Es sollte sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" handelt. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

--interval

Abfrageintervall in Sekunden.

Standardwert: 30
--name -n

Der Name der Bildvorlage.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--timeout

Maximale Wartezeit in Sekunden.

Standardwert: 3600
--updated

Warten Sie, bis sie mit provisioningState bei "Erfolgreich" aktualisiert wurde.

Standardwert: False