Virtual Machine Image Templates - Get

Usługa:: Image Builder

Wersja interfejsu API:: 2022-07-01

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 pattern: ^[A-Za-z0-9-_.]{1,64}$	Nazwa szablonu obrazu
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 protokołu 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

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 200

{
  "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 arm zarządzany przez dostawcę Microsoft.VirtualMachineImages
ImageTemplateFileCustomizer	Przekazuje pliki do maszyn wirtualnych (Linux, Windows). Odpowiada aprowizatorowi plików 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 usługi Azure Gallery Images.
ImageTemplatePowerShellCustomizer	Uruchamia określony program PowerShell na maszynie wirtualnej (Windows). Odpowiada aprowizatorowi programu PowerShell Packer. Można określić dokładnie jeden z parametrów "scriptUri" lub "inline".
ImageTemplatePowerShellValidator	Uruchamia określony skrypt programu PowerShell w fazie walidacji (Windows). Odpowiada aprowizatorowi programu PowerShell Packer. Można określić dokładnie jeden z parametrów "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 galerii usługi Azure Compute.
ImageTemplateSharedImageVersionSource	Opisuje źródło obrazu, które jest wersją obrazu w galerii obliczeniowej platformy Azure lub w 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 jeden z parametrów "scriptUri" lub "inline".
ImageTemplateShellValidator	Uruchamia określony skrypt powłoki w fazie walidacji (Linux). Odpowiada aprowizatorowi powłoki Packer. Można określić dokładnie jeden z parametrów "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 "None" usunie wszystkie 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 weryfikacji, które mają zostać wykonane na obrazie wynikowym.
VirtualNetworkConfig	Konfiguracja sieci wirtualnej.
VmBoot	Optymalizacja jest stosowana na obrazie w celu szybszego rozruchu maszyny wirtualnej.
VMBootOptimizationState	Włączenie tego pola poprawi czas rozruchu maszyny wirtualnej, optymalizując ostateczne dostosowane dane wyjściowe obrazu.

CloudError

Objekt

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

Nazwa	Typ	Opis
error	CloudErrorBody	Szczegółowe informacje o błędzie.

CloudErrorBody

Objekt

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

Wyliczanie

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

Wartość	Opis
User
Application
ManagedIdentity
Key

DistributeVersionerLatest

Objekt

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

Nazwa	Typ	Domyślna wartość	Opis
major	integer (int32) minimum: -1	-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 równoważne pozostawieniu go bez ustawienia.
scheme	string: Latest		Schemat numerowania wersji do użycia.

DistributeVersionerSource

Objekt

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

Nazwa	Typ	Opis
scheme	string: Source	Schemat numerowania wersji do użycia.

ImageTemplate

Objekt

Szablon obrazu to zasób arm zarządzany przez dostawcę Microsoft.VirtualMachineImages

Nazwa	Typ	Domyślna wartość	Opis
id	string		W pełni kwalifikowany identyfikator zasobu dla zasobu. Przykład - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ImageTemplateIdentity		Tożsamość szablonu obrazu, jeśli jest skonfigurowana.
location	string		Lokalizacja geograficzna, w której znajduje się zasób
name	string		Nazwa zasobu
properties.buildTimeoutInMinutes	integer (int32) minimum: 0 maximum: 960	0	Maksymalny czas trwania oczekiwania podczas kompilowania szablonu obrazu (obejmuje wszystkie dostosowania, optymalizację, walidacje i dystrybucje). Pomiń lub określ wartość 0, aby użyć wartości domyślnej (4 godziny).
properties.customize	ImageTemplateCustomizer[]: ImageTemplateFileCustomizer[] ImageTemplatePowerShellCustomizer[] ImageTemplateRestartCustomizer[] ImageTemplateShellCustomizer[] ImageTemplateWindowsUpdateCustomizer[]		Określa właściwości używane do opisywania kroków dostosowywania obrazu, takich jak źródło obrazu itp.
properties.distribute	ImageTemplateDistributor[]: ImageTemplateManagedImageDistributor[] ImageTemplateSharedImageDistributor[] ImageTemplateVhdDistributor[]		Lokalizacja docelowa dystrybucji, do której należy przejść dane wyjściowe obrazu.
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 aktualnie 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: ImageTemplateManagedImageSource ImageTemplatePlatformImageSource ImageTemplateSharedImageVersionSource		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 weryfikacji, które mają zostać wykonane 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

Objekt

Przekazuje pliki do maszyn wirtualnych (Linux, Windows). Odpowiada aprowizatorowi plików 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, aby podać kontekst tego kroku dostosowywania
sha256Checksum	string	Sha256 suma kontrolna 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

Objekt

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 już utworzonymi zagnieżdżonym strukturami katalogów), do którego zostanie przekazany plik (z identyfikatora sourceUri) na maszynie wirtualnej
name	string	Przyjazna nazwa, aby podać kontekst tego kroku weryfikacji
sha256Checksum	string	Sha256 suma kontrolna 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 "Powłoka" może być walidacją powłoki

ImageTemplateIdentity

Objekt

Tożsamość szablonu obrazu.

Nazwa	Typ	Opis
type	ResourceIdentityType	Typ tożsamości używany dla szablonu obrazu. Typ "None" usunie wszystkie 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

Objekt

Opisuje najnowszy stan uruchamiania szablonu obrazu

Nazwa	Typ	Opis
endTime	string (date-time)	Godzina zakończenia ostatniego uruchomienia (UTC)
message	string	Pełne informacje o stanie ostatniego uruchomienia
runState	RunState	Stan ostatniego uruchomienia
runSubState	RunSubState	Stan podrzędny ostatniego uruchomienia
startTime	string (date-time)	Godzina rozpoczęcia ostatniego uruchomienia (UTC)

ImageTemplateManagedImageDistributor

Objekt

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 pattern: ^[A-Za-z0-9-_.]{1,64}$	Nazwa, która ma być używana dla skojarzonego elementu RunOutput.
type	string: ManagedImage	Typ rozkładu.

ImageTemplateManagedImageSource

Objekt

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

Objekt

Opisuje źródło obrazu z usługi Azure Gallery Images.

Nazwa	Typ	Opis
exactVersion	string	Wersja obrazu z Obrazów z galerii platformy Azure. To pole tylko do odczytu różni się od "wersji", tylko wtedy, gdy wartość określona w polu "version" to "latest".
offer	string	Oferta obrazu z Azure Gallery Images.
planInfo	PlatformImagePurchasePlan	Opcjonalna konfiguracja planu zakupu dla obrazu platformy.
publisher	string	Program Image Publisher w usłudze Azure Gallery Images.
sku	string	Jednostka SKU obrazu z Obrazów z 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 z galerii platformy Azure. Jeśli w tym miejscu określono wartość "latest", wersja jest oceniana podczas kompilacji obrazu, a nie podczas przesyłania szablonu.

ImageTemplatePowerShellCustomizer

Objekt

Uruchamia określony program PowerShell na maszynie wirtualnej (Windows). Odpowiada aprowizatorowi programu PowerShell Packer. Można określić dokładnie jeden z parametrów "scriptUri" lub "inline".

Nazwa	Typ	Domyślna wartość	Opis
inline	string[]		Tablica poleceń programu PowerShell do wykonania
name	string		Przyjazna nazwa, aby podać kontekst 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 na potrzeby dostosowywania. 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 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[] (int32)		Prawidłowe kody zakończenia skryptu programu PowerShell. [Wartość domyślna: 0]

ImageTemplatePowerShellValidator

Objekt

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

Nazwa	Typ	Domyślna wartość	Opis
inline	string[]		Tablica poleceń programu PowerShell do wykonania
name	string		Przyjazna nazwa, aby podać kontekst 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 w celu weryfikacji. 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 "Powłoka" może być walidacją powłoki
validExitCodes	integer[] (int32)		Prawidłowe kody zakończenia skryptu programu PowerShell. [Wartość domyślna: 0]

ImageTemplateRestartCustomizer

Objekt

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, aby podać kontekst 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 uruchamiania 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

Objekt

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

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 zostać 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 obraz zostanie zreplikowany. Tę listę można określić tylko wtedy, gdy nie określono elementów targetRegions. To pole jest przestarzałe — zamiast tego użyj targetRegions.
runOutputName	string pattern: ^[A-Za-z0-9-_.]{1,64}$		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 udostępnionego obrazu. 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 określić tylko wtedy, gdy nie określono regionów replikacji.
type	string: SharedImage		Typ rozkładu.
versioning	DistributeVersioner: DistributeVersionerLatest DistributeVersionerSource		Opisuje sposób generowania nowego numeru wersji x.y.z dla dystrybucji.

ImageTemplateSharedImageVersionSource

Objekt

Opisuje źródło obrazu, które jest wersją obrazu w galerii obliczeniowej platformy Azure lub w 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 parametrze "imageVersionId" tylko wtedy, gdy nazwa wersji określona w polu "imageVersionId" to "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

Objekt

Uruchamia skrypt powłoki w fazie dostosowywania (Linux). Odpowiada aprowizatorowi powłoki Packer. Można określić dokładnie jeden z parametrów "scriptUri" lub "inline".

Nazwa	Typ	Opis
inline	string[]	Tablica poleceń powłoki do wykonania
name	string	Przyjazna nazwa, aby podać kontekst tego kroku dostosowywania
scriptUri	string	Identyfikator URI skryptu powłoki do uruchomienia na potrzeby dostosowywania. 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

Objekt

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

Nazwa	Typ	Opis
inline	string[]	Tablica poleceń powłoki do wykonania
name	string	Przyjazna nazwa, aby podać kontekst tego kroku weryfikacji
scriptUri	string	Identyfikator URI skryptu powłoki do uruchomienia w celu weryfikacji. 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 "Powłoka" może być walidacją powłoki

ImageTemplateVhdDistributor

Objekt

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 pattern: ^[A-Za-z0-9-_.]{1,64}$	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 dysk VHD zostanie opublikowany na koncie magazynu w przejściowej grupie zasobów.

ImageTemplateVmProfile

Objekt

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

Nazwa	Typ	Domyślna wartość	Opis
osDiskSizeGB	integer (int32) minimum: 0	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 obrazów gen2).
vnetConfig	VirtualNetworkConfig		Opcjonalna konfiguracja sieci wirtualnej, która ma być używana do wdrażania maszyny wirtualnej kompilacji i sprawdzania poprawności maszyny wirtualnej w programie. Pomiń, jeśli nie trzeba używać określonej sieci wirtualnej.

ImageTemplateWindowsUpdateCustomizer

Objekt

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, aby podać kontekst tego kroku dostosowywania
searchCriteria	string		Kryteria wyszukiwania aktualizacji. Pomiń lub określ pusty ciąg, aby użyć wartości domyślnej (wyszukaj 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 (int32) minimum: 0	0	Maksymalna liczba aktualizacji do zastosowania w danym momencie. Pomiń lub określ wartość 0, aby użyć wartości domyślnej (1000)

Optimize

Objekt

Określa optymalizację do wykonania na obrazie.

Nazwa	Typ	Opis
vmBoot	VmBoot	Optymalizacja jest stosowana na obrazie w celu szybszego rozruchu maszyny wirtualnej.

PlatformImagePurchasePlan

Objekt

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

Objekt

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

Wyliczanie

Kod błędu niepowodzenia aprowizacji

Wartość	Opis
BadSourceType
BadPIRSource
BadManagedImageSource
BadSharedImageVersionSource
BadCustomizerType
UnsupportedCustomizerType
NoCustomizerScript
BadValidatorType
UnsupportedValidatorType
NoValidatorScript
BadDistributeType
BadSharedImageDistribute
BadStagingResourceGroup
ServerError
Other

ProvisioningState

Wyliczanie

Stan aprowizacji zasobu

Wartość	Opis
Creating
Updating
Succeeded
Failed
Deleting
Canceled

ResourceIdentityType

Wyliczanie

Typ tożsamości używany dla szablonu obrazu. Typ "None" usunie wszystkie tożsamości z szablonu obrazu.

Wartość	Opis
UserAssigned
None

RunState

Wyliczanie

Stan ostatniego uruchomienia

Wartość	Opis
Running
Canceling
Succeeded
PartiallySucceeded
Failed
Canceled

RunSubState

Wyliczanie

Stan podrzędny ostatniego uruchomienia

Wartość	Opis
Queued
Building
Customizing
Optimizing
Validating
Distributing

SharedImageStorageAccountType

Wyliczanie

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

Wartość	Opis
Standard_LRS
Standard_ZRS
Premium_LRS

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	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 (date-time)	Znacznik czasu 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

Objekt

Opisuje informacje o regionie docelowym.

Nazwa	Typ	Domyślna wartość	Opis
name	string		Nazwa regionu.
replicaCount	integer (int32) minimum: 1	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

Objekt

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

Objekt

Opcje konfiguracji i lista weryfikacji, które mają zostać wykonane na obrazie wynikowym.

Nazwa	Typ	Domyślna wartość	Opis
continueDistributeOnFailure	boolean	False	Jeśli walidacja nie powiedzie się, a to pole ma wartość false, obrazy wyjściowe nie będą dystrybuowane. Jest to zachowanie domyślne. Jeśli walidacja nie powiedzie się, a to pole ma wartość true, obrazy wyjściowe będą nadal dystrybuowane. Użyj tej opcji z ostrożnością, ponieważ może to spowodować rozpowszechnianie nieprawidłowych obrazów do użytku. 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[]: ImageTemplateFileValidator[] ImageTemplatePowerShellValidator[] ImageTemplateShellValidator[]		Lista walidacji do wykonania.
sourceValidationOnly	boolean	False	Jeśli to pole ma wartość true, obraz określony w sekcji "źródło" zostanie zweryfikowany bezpośrednio. W celu wygenerowania nie zostanie uruchomiona żadna oddzielna kompilacja, a następnie zweryfikuj dostosowany obraz.

VirtualNetworkConfig

Objekt

Konfiguracja sieci wirtualnej.

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

Objekt

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 ostateczne dostosowane dane wyjściowe obrazu.

VMBootOptimizationState

Wyliczanie

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

Wartość	Opis
Enabled
Disabled

Udostępnij za pośrednictwem

Virtual Machine Image Templates - Get

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

Retrieve an Image Template.

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

CloudError

CloudErrorBody

createdByType

DistributeVersionerLatest

DistributeVersionerSource

ImageTemplate

ImageTemplateFileCustomizer

ImageTemplateFileValidator

ImageTemplateIdentity

ImageTemplateLastRunStatus

ImageTemplateManagedImageDistributor

ImageTemplateManagedImageSource

ImageTemplatePlatformImageSource

ImageTemplatePowerShellCustomizer

ImageTemplatePowerShellValidator

ImageTemplateRestartCustomizer

ImageTemplateSharedImageDistributor

ImageTemplateSharedImageVersionSource

ImageTemplateShellCustomizer

ImageTemplateShellValidator

ImageTemplateVhdDistributor

ImageTemplateVmProfile

ImageTemplateWindowsUpdateCustomizer

Optimize

PlatformImagePurchasePlan

ProvisioningError

ProvisioningErrorCode

ProvisioningState

ResourceIdentityType

RunState

RunSubState

SharedImageStorageAccountType

systemData

TargetRegion

UserAssignedIdentity

Validate

VirtualNetworkConfig

VmBoot

VMBootOptimizationState