Udostępnij za pośrednictwem


Virtual Machine Image Templates - Get

Uzyskiwanie informacji o szablonie obrazu maszyny wirtualnej

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}?api-version=2022-07-01

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
imageTemplateName
path True

string

Nazwa szablonu obrazu

Wzorzec wyrażenia regularnego: ^[A-Za-z0-9-_.]{1,64}$

resourceGroupName
path True

string

Nazwa grupy zasobów.

subscriptionId
path True

string

Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.

api-version
query True

string

Wersja interfejsu API klienta.

Odpowiedzi

Nazwa Typ Opis
200 OK

ImageTemplate

OK

Other Status Codes

CloudError

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

Retrieve an Image Template.

Przykładowe żądanie

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate?api-version=2022-07-01

Przykładowa odpowiedź

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate",
  "name": "myImageTemplate",
  "location": "westus",
  "type": "Microsoft.VirtualMachineImages/imageTemplates",
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity_1": {
        "clientId": "00000000-0000-0000-0000-000000000000",
        "principalId": "00000000-0000-0000-0000-000000000000"
      }
    }
  },
  "properties": {
    "source": {
      "type": "ManagedImage",
      "imageId": "/subscriptions/{subscription-id}/resourceGroups/source_rg/providers/Microsoft.Compute/images/source_image"
    },
    "customize": [
      {
        "type": "Shell",
        "name": "Shell Customizer Example",
        "scriptUri": "https://example.com/path/to/script.sh"
      }
    ],
    "distribute": [
      {
        "type": "ManagedImage",
        "location": "1_location",
        "runOutputName": "image_it_pir_1",
        "imageId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/images/image_it_1",
        "artifactTags": {
          "tagName": "value"
        }
      }
    ],
    "vmProfile": {
      "vmSize": "Standard_D2s_v3",
      "osDiskSizeGB": 64
    }
  }
}

Definicje

Nazwa Opis
CloudError

Odpowiedź na błąd z usługi Azure VM Image Builder.

CloudErrorBody

Odpowiedź na błąd z usługi Azure VM Image Builder.

createdByType

Typ tożsamości, która utworzyła zasób.

DistributeVersionerLatest

Generuje numer wersji, który będzie najnowszy na podstawie istniejących numerów wersji.

DistributeVersionerSource

Generuje numer wersji na podstawie numeru wersji obrazu źródłowego

ImageTemplate

Szablon obrazu to zasób usługi ARM zarządzany przez dostawcę Microsoft.VirtualMachineImages

ImageTemplateFileCustomizer

Przekazuje pliki do maszyn wirtualnych (Linux, Windows). Odpowiada aprowizatorowi plików programu Packer

ImageTemplateFileValidator

Przekazuje pliki wymagane do weryfikacji maszyn wirtualnych (Linux, Windows). Odpowiada aprowizatorowi plików packer

ImageTemplateIdentity

Tożsamość szablonu obrazu.

ImageTemplateLastRunStatus

Opisuje najnowszy stan uruchamiania szablonu obrazu

ImageTemplateManagedImageDistributor

Dystrybuuj jako obraz dysku zarządzanego.

ImageTemplateManagedImageSource

Opisuje źródło obrazu, które jest obrazem zarządzanym w subskrypcji klienta. Ten obraz musi znajdować się w tej samej subskrypcji i regionie co szablon konstruktora obrazów.

ImageTemplatePlatformImageSource

Opisuje źródło obrazu z obrazów galerii platformy Azure.

ImageTemplatePowerShellCustomizer

Uruchamia określony program PowerShell na maszynie wirtualnej (Windows). Odpowiada aprowizatorowi programu PowerShell packer. Można określić dokładnie jedną z wartości "scriptUri" lub "wbudowanych".

ImageTemplatePowerShellValidator

Uruchamia określony skrypt programu PowerShell w fazie walidacji (Windows). Odpowiada aprowizatorowi programu PowerShell Packer. Można określić dokładnie jedną z wartości "scriptUri" lub "inline".

ImageTemplateRestartCustomizer

Uruchamia ponownie maszynę wirtualną i czeka na powrót do trybu online (Windows). Odpowiada aprowizatorowi ponownego uruchamiania systemu Windows Packer

ImageTemplateSharedImageDistributor

Dystrybucja za pośrednictwem usługi Azure Compute Gallery.

ImageTemplateSharedImageVersionSource

Opisuje źródło obrazu, które jest wersją obrazu w galerii obliczeniowej platformy Azure lub bezpośredniej galerii udostępnionej.

ImageTemplateShellCustomizer

Uruchamia skrypt powłoki w fazie dostosowywania (Linux). Odpowiada aprowizatorowi powłoki Packer. Można określić dokładnie jedną z wartości "scriptUri" lub "wbudowanych".

ImageTemplateShellValidator

Uruchamia określony skrypt powłoki w fazie walidacji (Linux). Odpowiada aprowizatorowi powłoki Packer. Można określić dokładnie jedną z wartości "scriptUri" lub "inline".

ImageTemplateVhdDistributor

Dystrybuowanie za pośrednictwem wirtualnego dysku twardego na koncie magazynu.

ImageTemplateVmProfile

Opisuje maszyny wirtualne używane do kompilowania i weryfikowania obrazów

ImageTemplateWindowsUpdateCustomizer

Instaluje Aktualizacje systemu Windows. Odpowiada usłudze Packer Windows Update Provisioner (https://github.com/rgl/packer-provisioner-windows-update)

Optimize

Określa optymalizację do wykonania na obrazie.

PlatformImagePurchasePlan

Konfiguracja planu zakupu dla obrazu platformy.

ProvisioningError

Opisuje błąd występujący podczas tworzenia lub aktualizowania szablonu obrazu

ProvisioningErrorCode

Kod błędu niepowodzenia aprowizacji

ProvisioningState

Stan aprowizacji zasobu

ResourceIdentityType

Typ tożsamości używany dla szablonu obrazu. Typ "Brak" spowoduje usunięcie tożsamości z szablonu obrazu.

RunState

Stan ostatniego uruchomienia

RunSubState

Stan podrzędny ostatniego uruchomienia

SharedImageStorageAccountType

Określa typ konta magazynu, który ma być używany do przechowywania wersji obrazu z galerii obliczeniowej platformy Azure.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

TargetRegion

Opisuje informacje o regionie docelowym.

UserAssignedIdentity

Właściwości tożsamości przypisanej przez użytkownika

Validate

Opcje konfiguracji i lista walidacji do wykonania na obrazie wynikowym.

VirtualNetworkConfig

Virtual Network konfiguracji.

VmBoot

Optymalizacja jest stosowana na obrazie w celu szybszego rozruchu maszyny wirtualnej.

VMBootOptimizationState

Włączenie tego pola poprawi czas rozruchu maszyny wirtualnej, optymalizując końcowe dostosowane dane wyjściowe obrazu.

CloudError

Odpowiedź na błąd z usługi Azure VM Image Builder.

Nazwa Typ Opis
error

CloudErrorBody

Szczegóły dotyczące błędu.

CloudErrorBody

Odpowiedź na błąd z usługi Azure VM Image Builder.

Nazwa Typ Opis
code

string

Identyfikator błędu. Kody są niezmienne i mają być używane programowo.

details

CloudErrorBody[]

Lista dodatkowych szczegółów dotyczących błędu.

message

string

Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.

target

string

Element docelowy określonego błędu. Na przykład nazwa właściwości w błędzie.

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa Typ Opis
Application

string

Key

string

ManagedIdentity

string

User

string

DistributeVersionerLatest

Generuje numer wersji, który będzie najnowszy na podstawie istniejących numerów wersji.

Nazwa Typ Domyślna wartość Opis
major

integer

-1

Wersja główna wygenerowanego numeru wersji. Określ, co to jest "najnowsze" na podstawie wersji z tą wartością jako wersji głównej. -1 jest odpowiednikiem pozostawienia go nieustawionego.

scheme string:

Latest

Schemat numerowania wersji do użycia.

DistributeVersionerSource

Generuje numer wersji na podstawie numeru wersji obrazu źródłowego

Nazwa Typ Opis
scheme string:

Source

Schemat numerowania wersji do użycia.

ImageTemplate

Szablon obrazu to zasób usługi ARM zarządzany przez dostawcę Microsoft.VirtualMachineImages

Nazwa Typ Domyślna wartość Opis
id

string

W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex — /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

ImageTemplateIdentity

Tożsamość szablonu obrazu, jeśli została skonfigurowana.

location

string

Lokalizacja geograficzna, w której znajduje się zasób

name

string

Nazwa zasobu

properties.buildTimeoutInMinutes

integer

0

Maksymalny czas oczekiwania podczas tworzenia szablonu obrazu (obejmuje wszystkie dostosowania, optymalizację, walidacje i dystrybucje). Pomiń lub określ 0, aby użyć wartości domyślnej (4 godziny).

properties.customize ImageTemplateCustomizer[]:

Określa właściwości używane do opisywania kroków dostosowywania obrazu, takich jak źródło obrazu itp.

properties.distribute ImageTemplateDistributor[]:

Cele dystrybucji, w których dane wyjściowe obrazu muszą przejść do.

properties.exactStagingResourceGroup

string

Identyfikator przejściowej grupy zasobów w tej samej subskrypcji co szablon obrazu, który będzie używany do kompilowania obrazu. To pole tylko do odczytu różni się od wartości "stagingResourceGroup" tylko wtedy, gdy wartość określona w polu "stagingResourceGroup" jest pusta.

properties.lastRunStatus

ImageTemplateLastRunStatus

Stan "uruchom", który jest obecnie wykonywany lub został ostatnio wykonany.

properties.optimize

Optimize

Określa optymalizację do wykonania na obrazie.

properties.provisioningError

ProvisioningError

Błąd aprowizacji, jeśli istnieje

properties.provisioningState

ProvisioningState

Stan aprowizacji zasobu

properties.source ImageTemplateSource:

Określa właściwości używane do opisywania obrazu źródłowego.

properties.stagingResourceGroup

string

Identyfikator przejściowej grupy zasobów w tej samej subskrypcji co szablon obrazu, który będzie używany do kompilowania obrazu. Jeśli to pole jest puste, zostanie utworzona grupa zasobów o losowej nazwie. Jeśli grupa zasobów określona w tym polu nie istnieje, zostanie utworzona o tej samej nazwie. Jeśli określona grupa zasobów istnieje, musi być pusta i w tym samym regionie co szablon obrazu. Utworzona grupa zasobów zostanie usunięta podczas usuwania szablonu, jeśli to pole jest puste lub określona grupa zasobów nie istnieje, ale jeśli określona grupa zasobów istnieje, zasoby utworzone w grupie zasobów zostaną usunięte podczas usuwania szablonu, a sama grupa zasobów pozostanie.

properties.validate

Validate

Opcje konfiguracji i lista walidacji do wykonania na obrazie wynikowym.

properties.vmProfile

ImageTemplateVmProfile

Opisuje sposób konfigurowania maszyny wirtualnej do kompilowania obrazów

systemData

systemData

Metadane usługi Azure Resource Manager zawierające informacje createdBy i modifiedBy.

tags

object

Tagi zasobów.

type

string

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

ImageTemplateFileCustomizer

Przekazuje pliki do maszyn wirtualnych (Linux, Windows). Odpowiada aprowizatorowi plików programu Packer

Nazwa Typ Opis
destination

string

Ścieżka bezwzględna do pliku (z już utworzonymi zagnieżdżonym strukturami katalogów), do którego zostanie przekazany plik (z identyfikatora sourceUri) na maszynie wirtualnej

name

string

Przyjazna nazwa w celu zapewnienia kontekstu tego kroku dostosowywania

sha256Checksum

string

Sha256 sumę kontrolną pliku podanego w polu sourceUri powyżej

sourceUri

string

Identyfikator URI pliku, który ma zostać przekazany do dostosowywania maszyny wirtualnej. Może to być link github, identyfikator URI sygnatury dostępu współdzielonego dla usługi Azure Storage itp.

type string:

File

Typ narzędzia dostosowywania, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być konfiguratorem powłoki

ImageTemplateFileValidator

Przekazuje pliki wymagane do weryfikacji maszyn wirtualnych (Linux, Windows). Odpowiada aprowizatorowi plików packer

Nazwa Typ Opis
destination

string

Ścieżka bezwzględna do pliku (z utworzonymi już zagnieżdżonym strukturami katalogów), do którego zostanie przekazany plik (z identyfikatora sourceUri) na maszynie wirtualnej

name

string

Przyjazna nazwa w celu zapewnienia kontekstu tego kroku weryfikacji

sha256Checksum

string

Sha256 sum kontrolnych pliku podanego w polu sourceUri powyżej

sourceUri

string

Identyfikator URI pliku, który ma zostać przekazany do maszyny wirtualnej w celu weryfikacji. Może to być link usługi GitHub, identyfikator URI usługi Azure Storage (autoryzowany lub sas) itp.

type string:

File

Typ weryfikacji, którego chcesz użyć na obrazie. Na przykład "Shell" może być walidacja powłoki

ImageTemplateIdentity

Tożsamość szablonu obrazu.

Nazwa Typ Opis
type

ResourceIdentityType

Typ tożsamości używany dla szablonu obrazu. Typ "Brak" spowoduje usunięcie tożsamości z szablonu obrazu.

userAssignedIdentities

<string,  UserAssignedIdentity>

tożsamości User-Assigned
Zestaw tożsamości przypisanych przez użytkownika skojarzonych z zasobem. Klucze słownika userAssignedIdentities będą identyfikatorami zasobów usługi ARM w postaci: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Wartości słownika mogą być pustymi obiektami ({}) w żądaniach.

ImageTemplateLastRunStatus

Opisuje najnowszy stan uruchamiania szablonu obrazu

Nazwa Typ Opis
endTime

string

Godzina zakończenia ostatniego uruchomienia (UTC)

message

string

Pełne informacje o stanie ostatniego uruchomienia

runState

RunState

Stan ostatniego uruchomienia

runSubState

RunSubState

Podstan ostatniego uruchomienia

startTime

string

Godzina rozpoczęcia ostatniego uruchomienia (UTC)

ImageTemplateManagedImageDistributor

Dystrybuuj jako obraz dysku zarządzanego.

Nazwa Typ Opis
artifactTags

object

Tagi, które zostaną zastosowane do artefaktu po jego utworzeniu/zaktualizowaniu przez dystrybutora.

imageId

string

Identyfikator zasobu obrazu dysku zarządzanego

location

string

Lokalizacja platformy Azure dla obrazu powinna być zgodna z tym, czy obraz już istnieje

runOutputName

string

Nazwa, która ma być używana dla skojarzonego elementu RunOutput.

type string:

ManagedImage

Typ rozkładu.

ImageTemplateManagedImageSource

Opisuje źródło obrazu, które jest obrazem zarządzanym w subskrypcji klienta. Ten obraz musi znajdować się w tej samej subskrypcji i regionie co szablon konstruktora obrazów.

Nazwa Typ Opis
imageId

string

Identyfikator zasobu usługi ARM obrazu zarządzanego w subskrypcji klienta

type string:

ManagedImage

Określa typ obrazu źródłowego, z którym chcesz zacząć.

ImageTemplatePlatformImageSource

Opisuje źródło obrazu z obrazów galerii platformy Azure.

Nazwa Typ Opis
exactVersion

string

Wersja obrazu z obrazów galerii platformy Azure. To pole readonly różni się od "wersji", tylko wtedy, gdy wartość określona w polu "version" to "latest".

offer

string

Oferta obrazów z obrazów galerii platformy Azure.

planInfo

PlatformImagePurchasePlan

Opcjonalna konfiguracja planu zakupu dla obrazu platformy.

publisher

string

Wydawca obrazów w obrazach galerii platformy Azure.

sku

string

Jednostka SKU obrazów z obrazów galerii platformy Azure.

type string:

PlatformImage

Określa typ obrazu źródłowego, z którym chcesz zacząć.

version

string

Wersja obrazu z obrazów galerii platformy Azure. Jeśli w tym miejscu określono wartość "latest", wersja jest oceniana po zakończeniu kompilacji obrazu, a nie podczas przesyłania szablonu.

ImageTemplatePowerShellCustomizer

Uruchamia określony program PowerShell na maszynie wirtualnej (Windows). Odpowiada aprowizatorowi programu PowerShell packer. Można określić dokładnie jedną z wartości "scriptUri" lub "wbudowanych".

Nazwa Typ Domyślna wartość Opis
inline

string[]

Tablica poleceń programu PowerShell do wykonania

name

string

Przyjazna nazwa w celu zapewnienia kontekstu tego kroku dostosowywania

runAsSystem

boolean

False

Jeśli zostanie określony, skrypt programu PowerShell zostanie uruchomiony z podwyższonym poziomem uprawnień przy użyciu użytkownika systemu lokalnego. Może mieć wartość true tylko wtedy, gdy powyższe pole runElevated ma wartość true.

runElevated

boolean

False

Jeśli zostanie określony, skrypt programu PowerShell zostanie uruchomiony z podwyższonym poziomem uprawnień

scriptUri

string

Identyfikator URI skryptu programu PowerShell do uruchomienia w celu dostosowania. Może to być link github, identyfikator URI sygnatury dostępu współdzielonego dla usługi Azure Storage itp.

sha256Checksum

string

Sha256 suma kontrolna skryptu powłoki Power Shell podana w polu scriptUri powyżej

type string:

PowerShell

Typ narzędzia dostosowywania, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być konfiguratorem powłoki

validExitCodes

integer[]

Prawidłowe kody zakończenia skryptu programu PowerShell. [Ustawienie domyślne: 0]

ImageTemplatePowerShellValidator

Uruchamia określony skrypt programu PowerShell w fazie walidacji (Windows). Odpowiada aprowizatorowi programu PowerShell Packer. Można określić dokładnie jedną z wartości "scriptUri" lub "inline".

Nazwa Typ Domyślna wartość Opis
inline

string[]

Tablica poleceń programu PowerShell do wykonania

name

string

Przyjazna nazwa w celu zapewnienia kontekstu tego kroku weryfikacji

runAsSystem

boolean

False

Jeśli zostanie określony, skrypt programu PowerShell zostanie uruchomiony z podwyższonym poziomem uprawnień przy użyciu użytkownika systemu lokalnego. Może mieć wartość true tylko wtedy, gdy powyższe pole runElevated ma wartość true.

runElevated

boolean

False

Jeśli zostanie określony, skrypt programu PowerShell zostanie uruchomiony z podwyższonym poziomem uprawnień

scriptUri

string

Identyfikator URI skryptu programu PowerShell do uruchomienia na potrzeby walidacji. Może to być link usługi GitHub, identyfikator URI usługi Azure Storage itp.

sha256Checksum

string

Suma kontrolna SHA256 skryptu powłoki power shell podana w polu scriptUri powyżej

type string:

PowerShell

Typ weryfikacji, którego chcesz użyć na obrazie. Na przykład "Shell" może być walidacja powłoki

validExitCodes

integer[]

Prawidłowe kody zakończenia skryptu programu PowerShell. [Wartość domyślna: 0]

ImageTemplateRestartCustomizer

Uruchamia ponownie maszynę wirtualną i czeka na powrót do trybu online (Windows). Odpowiada aprowizatorowi ponownego uruchamiania systemu Windows Packer

Nazwa Typ Opis
name

string

Przyjazna nazwa w celu zapewnienia kontekstu tego kroku dostosowywania

restartCheckCommand

string

Polecenie sprawdzania, czy ponowne uruchomienie zakończyło się pomyślnie [Ustawienie domyślne: '']

restartCommand

string

Polecenie do wykonania ponownego uruchomienia [Domyślne: 'shutdown /r /f /t 0 /c "packer restart"]

restartTimeout

string

Limit czasu ponownego uruchomienia określony jako ciąg wielkości i jednostki, np. "5m" (5 minut) lub "2h" (2 godziny) [Wartość domyślna: "5m"]

type string:

WindowsRestart

Typ narzędzia dostosowywania, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być konfiguratorem powłoki

ImageTemplateSharedImageDistributor

Dystrybucja za pośrednictwem usługi Azure Compute Gallery.

Nazwa Typ Domyślna wartość Opis
artifactTags

object

Tagi, które zostaną zastosowane do artefaktu po jego utworzeniu/zaktualizowaniu przez dystrybutora.

excludeFromLatest

boolean

False

Flaga wskazująca, czy utworzona wersja obrazu powinna być wykluczona z najnowszej wersji. Pomiń użycie wartości domyślnej (false).

galleryImageId

string

Identyfikator zasobu obrazu galerii obliczeniowej platformy Azure

replicationRegions

string[]

[Przestarzałe] Lista regionów, do których zostanie zreplikowany obraz. Tę listę można określić tylko wtedy, gdy nie określono wartości targetRegions. To pole jest przestarzałe — zamiast tego użyj targetRegions.

runOutputName

string

Nazwa, która ma być używana dla skojarzonego elementu RunOutput.

storageAccountType

SharedImageStorageAccountType

[Przestarzałe] Typ konta magazynu, który ma być używany do przechowywania obrazu udostępnionego. Pomiń użycie wartości domyślnej (Standard_LRS). To pole można określić tylko wtedy, gdy określono wartość replicationRegions. To pole jest przestarzałe — zamiast tego użyj targetRegions.

targetRegions

TargetRegion[]

Regiony docelowe, w których będzie replikowana rozproszona wersja obrazu. Ten obiekt zastępuje replikacjęRegiony i można go określić tylko wtedy, gdy nie określono regionów replikacji.

type string:

SharedImage

Typ rozkładu.

versioning DistributeVersioner:

Opisuje sposób generowania nowego numeru wersji x.y.z dla dystrybucji.

ImageTemplateSharedImageVersionSource

Opisuje źródło obrazu, które jest wersją obrazu w galerii obliczeniowej platformy Azure lub bezpośredniej galerii udostępnionej.

Nazwa Typ Opis
exactVersion

string

Dokładny identyfikator zasobu usługi ARM wersji obrazu. To pole tylko do odczytu różni się od identyfikatora wersji obrazu w identyfikatorze "imageVersionId" tylko wtedy, gdy nazwa wersji określona w polu "imageVersionId" ma wartość "latest".

imageVersionId

string

Identyfikator zasobu usługi ARM wersji obrazu. Gdy nazwa wersji obrazu to "latest", wersja jest oceniana podczas kompilacji obrazu.

type string:

SharedImageVersion

Określa typ obrazu źródłowego, z którym chcesz zacząć.

ImageTemplateShellCustomizer

Uruchamia skrypt powłoki w fazie dostosowywania (Linux). Odpowiada aprowizatorowi powłoki Packer. Można określić dokładnie jedną z wartości "scriptUri" lub "wbudowanych".

Nazwa Typ Opis
inline

string[]

Tablica poleceń powłoki do wykonania

name

string

Przyjazna nazwa w celu zapewnienia kontekstu tego kroku dostosowywania

scriptUri

string

Identyfikator URI skryptu powłoki do uruchomienia w celu dostosowania. Może to być link github, identyfikator URI sygnatury dostępu współdzielonego dla usługi Azure Storage itp.

sha256Checksum

string

Suma kontrolna SHA256 skryptu powłoki podana w polu scriptUri

type string:

Shell

Typ narzędzia dostosowywania, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być konfiguratorem powłoki

ImageTemplateShellValidator

Uruchamia określony skrypt powłoki w fazie walidacji (Linux). Odpowiada aprowizatorowi powłoki Packer. Można określić dokładnie jedną z wartości "scriptUri" lub "inline".

Nazwa Typ Opis
inline

string[]

Tablica poleceń powłoki do wykonania

name

string

Przyjazna nazwa w celu zapewnienia kontekstu tego kroku weryfikacji

scriptUri

string

Identyfikator URI skryptu powłoki do uruchomienia na potrzeby walidacji. Może to być link usługi GitHub, identyfikator URI usługi Azure Storage itp.

sha256Checksum

string

Suma kontrolna SHA256 skryptu powłoki podana w polu scriptUri

type string:

Shell

Typ weryfikacji, którego chcesz użyć na obrazie. Na przykład "Shell" może być walidacja powłoki

ImageTemplateVhdDistributor

Dystrybuowanie za pośrednictwem wirtualnego dysku twardego na koncie magazynu.

Nazwa Typ Opis
artifactTags

object

Tagi, które zostaną zastosowane do artefaktu po jego utworzeniu/zaktualizowaniu przez dystrybutora.

runOutputName

string

Nazwa, która ma być używana dla skojarzonego elementu RunOutput.

type string:

VHD

Typ rozkładu.

uri

string

Opcjonalny identyfikator URI usługi Azure Storage dla rozproszonego obiektu blob wirtualnego dysku twardego. Pomiń użycie domyślnego (pustego ciągu), w którym przypadku wirtualny dysk twardy zostanie opublikowany na koncie magazynu w przejściowej grupie zasobów.

ImageTemplateVmProfile

Opisuje maszyny wirtualne używane do kompilowania i weryfikowania obrazów

Nazwa Typ Domyślna wartość Opis
osDiskSizeGB

integer

0

Rozmiar dysku systemu operacyjnego w GB. Pomiń lub określ wartość 0, aby użyć domyślnego rozmiaru dysku systemu operacyjnego platformy Azure.

userAssignedIdentities

string[]

Opcjonalna tablica identyfikatorów zasobów tożsamości zarządzanych przypisanych przez użytkownika do skonfigurowania na maszynie wirtualnej kompilacji i na maszynie wirtualnej weryfikacji. Może to obejmować tożsamość szablonu obrazu.

vmSize

string

Rozmiar maszyny wirtualnej używanej do kompilowania, dostosowywania i przechwytywania obrazów. Pomiń lub określ pusty ciąg, aby użyć wartości domyślnej (Standard_D1_v2 dla obrazów gen1 i Standard_D2ds_v4 dla obrazów gen2).

vnetConfig

VirtualNetworkConfig

Opcjonalna konfiguracja sieci wirtualnej do użycia w celu wdrożenia maszyny wirtualnej kompilacji i maszyny wirtualnej weryfikacji w programie. Pomiń, jeśli nie trzeba używać określonej sieci wirtualnej.

ImageTemplateWindowsUpdateCustomizer

Instaluje Aktualizacje systemu Windows. Odpowiada usłudze Packer Windows Update Provisioner (https://github.com/rgl/packer-provisioner-windows-update)

Nazwa Typ Domyślna wartość Opis
filters

string[]

Tablica filtrów do wybrania aktualizacji do zastosowania. Pomiń lub określ pustą tablicę, aby użyć wartości domyślnej (bez filtru). Zapoznaj się z powyższym linkiem, aby zapoznać się z przykładami i szczegółowym opisem tego pola.

name

string

Przyjazna nazwa w celu zapewnienia kontekstu tego kroku dostosowywania

searchCriteria

string

Kryteria wyszukiwania aktualizacji. Pomiń lub określ pusty ciąg, aby użyć wartości domyślnej (przeszukaj wszystko). Zapoznaj się z powyższym linkiem, aby zapoznać się z przykładami i szczegółowym opisem tego pola.

type string:

WindowsUpdate

Typ narzędzia dostosowywania, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być konfiguratorem powłoki

updateLimit

integer

0

Maksymalna liczba aktualizacji do zastosowania w danym momencie. Pomiń lub określ wartość 0, aby użyć wartości domyślnej (1000)

Optimize

Określa optymalizację do wykonania na obrazie.

Nazwa Typ Opis
vmBoot

VmBoot

Optymalizacja jest stosowana na obrazie w celu szybszego rozruchu maszyny wirtualnej.

PlatformImagePurchasePlan

Konfiguracja planu zakupu dla obrazu platformy.

Nazwa Typ Opis
planName

string

Nazwa planu zakupu.

planProduct

string

Produkt planu zakupu.

planPublisher

string

Wydawca planu zakupu.

ProvisioningError

Opisuje błąd występujący podczas tworzenia lub aktualizowania szablonu obrazu

Nazwa Typ Opis
message

string

Pełny komunikat o błędzie dotyczący niepowodzenia aprowizacji

provisioningErrorCode

ProvisioningErrorCode

Kod błędu niepowodzenia aprowizacji

ProvisioningErrorCode

Kod błędu niepowodzenia aprowizacji

Nazwa Typ Opis
BadCustomizerType

string

BadDistributeType

string

BadManagedImageSource

string

BadPIRSource

string

BadSharedImageDistribute

string

BadSharedImageVersionSource

string

BadSourceType

string

BadStagingResourceGroup

string

BadValidatorType

string

NoCustomizerScript

string

NoValidatorScript

string

Other

string

ServerError

string

UnsupportedCustomizerType

string

UnsupportedValidatorType

string

ProvisioningState

Stan aprowizacji zasobu

Nazwa Typ Opis
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

ResourceIdentityType

Typ tożsamości używany dla szablonu obrazu. Typ "Brak" spowoduje usunięcie tożsamości z szablonu obrazu.

Nazwa Typ Opis
None

string

UserAssigned

string

RunState

Stan ostatniego uruchomienia

Nazwa Typ Opis
Canceled

string

Canceling

string

Failed

string

PartiallySucceeded

string

Running

string

Succeeded

string

RunSubState

Stan podrzędny ostatniego uruchomienia

Nazwa Typ Opis
Building

string

Customizing

string

Distributing

string

Optimizing

string

Queued

string

Validating

string

SharedImageStorageAccountType

Określa typ konta magazynu, który ma być używany do przechowywania wersji obrazu z galerii obliczeniowej platformy Azure.

Nazwa Typ Opis
Premium_LRS

string

Standard_LRS

string

Standard_ZRS

string

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa Typ Opis
createdAt

string

Sygnatura czasowa tworzenia zasobu (UTC).

createdBy

string

Tożsamość, która utworzyła zasób.

createdByType

createdByType

Typ tożsamości, która utworzyła zasób.

lastModifiedAt

string

Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)

lastModifiedBy

string

Tożsamość, która ostatnio zmodyfikowała zasób.

lastModifiedByType

createdByType

Typ tożsamości, która ostatnio zmodyfikowała zasób.

TargetRegion

Opisuje informacje o regionie docelowym.

Nazwa Typ Domyślna wartość Opis
name

string

Nazwa regionu.

replicaCount

integer

1

Liczba replik wersji obrazu do utworzenia w tym regionie. Pomiń użycie wartości domyślnej (1).

storageAccountType

SharedImageStorageAccountType

Określa typ konta magazynu, który ma być używany do przechowywania obrazu w tym regionie. Pomiń użycie wartości domyślnej (Standard_LRS).

UserAssignedIdentity

Właściwości tożsamości przypisanej przez użytkownika

Nazwa Typ Opis
clientId

string

Identyfikator klienta przypisanej tożsamości.

principalId

string

Identyfikator podmiotu zabezpieczeń przypisanej tożsamości.

Validate

Opcje konfiguracji i lista walidacji do wykonania na obrazie wynikowym.

Nazwa Typ Domyślna wartość Opis
continueDistributeOnFailure

boolean

False

Jeśli walidacja nie powiedzie się i to pole ma wartość false, obrazy wyjściowe nie zostaną rozproszone. Jest to zachowanie domyślne. Jeśli walidacja nie powiedzie się i to pole jest ustawione na wartość true, obrazy wyjściowe będą nadal dystrybuowane. Użyj tej opcji ostrożnie, ponieważ może to spowodować rozpowszechnianie nieprawidłowych obrazów do użycia. W obu przypadkach (prawda lub fałsz) uruchomienie obrazu końcowego zostanie zgłoszone jako zakończone niepowodzeniem w przypadku niepowodzenia weryfikacji. [Uwaga: to pole nie ma wpływu, jeśli walidacja zakończy się pomyślnie.

inVMValidations ImageTemplateInVMValidator[]:

Lista walidacji do wykonania.

sourceValidationOnly

boolean

False

Jeśli to pole ma wartość true, obraz określony w sekcji "źródło" zostanie bezpośrednio zweryfikowany. W celu wygenerowania nie zostanie uruchomiona żadna oddzielna kompilacja, a następnie zweryfikuj dostosowany obraz.

VirtualNetworkConfig

Virtual Network konfiguracji.

Nazwa Typ Opis
proxyVmSize

string

Rozmiar maszyny wirtualnej serwera proxy używanej do przekazywania ruchu do maszyny wirtualnej kompilacji i maszyny wirtualnej weryfikacji. Pomiń lub określ pusty ciąg, aby użyć wartości domyślnej (Standard_A1_v2).

subnetId

string

Identyfikator zasobu istniejącej podsieci.

VmBoot

Optymalizacja jest stosowana na obrazie w celu szybszego rozruchu maszyny wirtualnej.

Nazwa Typ Opis
state

VMBootOptimizationState

Włączenie tego pola poprawi czas rozruchu maszyny wirtualnej, optymalizując końcowe dostosowane dane wyjściowe obrazu.

VMBootOptimizationState

Włączenie tego pola poprawi czas rozruchu maszyny wirtualnej, optymalizując końcowe dostosowane dane wyjściowe obrazu.

Nazwa Typ Opis
Disabled

string

Enabled

string