Virtual Machine Image Templates - Get

Služba:: Image Builder

Verze rozhraní API:: 2022-07-01

Získání informací o šabloně image virtuálního počítače

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
imageTemplateName	path	True	string pattern: ^[A-Za-z0-9-_.]{1,64}$	Název šablony obrázku
resourceGroupName	path	True	string	Název skupiny prostředků.
subscriptionId	path	True	string	Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného je součástí identifikátoru URI pro každé volání služby.
api-version	query	True	string	Verze rozhraní API klienta.

Odpovědi

Name	Typ	Description
200 OK	ImageTemplate	OK
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Retrieve an Image Template.

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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
    }
  }
}

Definice

Name	Description
CloudError	Odpověď na chybu ze služby Azure VM Image Builder
CloudErrorBody	Odpověď na chybu ze služby Azure VM Image Builder
createdByType	Typ identity, která prostředek vytvořila.
DistributeVersionerLatest	Vygeneruje číslo verze, které bude nejnovější na základě existujících čísel verzí.
DistributeVersionerSource	Vygeneruje číslo verze na základě čísla verze zdrojové image.
ImageTemplate	Šablona image je prostředek ARM spravovaný poskytovatelem Microsoft.VirtualMachineImages.
ImageTemplateFileCustomizer	Nahraje soubory do virtuálních počítačů (Linux, Windows). Odpovídá zřizovacímu modulu souborů packeru.
ImageTemplateFileValidator	Nahraje soubory potřebné k ověření do virtuálních počítačů (Linux, Windows). Odpovídá zřizovacímu modulu souborů packeru.
ImageTemplateIdentity	Identita šablony obrázku
ImageTemplateLastRunStatus	Popisuje nejnovější stav spuštění šablony image.
ImageTemplateManagedImageDistributor	Distribuujte jako image spravovaného disku.
ImageTemplateManagedImageSource	Popisuje zdroj image, který je spravovanou imagí v předplatném zákazníka. Tato image se musí nacházet ve stejném předplatném a oblasti jako šablona Image Builderu.
ImageTemplatePlatformImageSource	Popisuje zdroj image z image galerie Azure.
ImageTemplatePowerShellCustomizer	Spustí zadaný PowerShell na virtuálním počítači (Windows). Odpovídá zřizovacímu modulu PowerShellu Packer. Je možné zadat přesně jeden z "scriptUri" nebo "inline".
ImageTemplatePowerShellValidator	Spustí zadaný skript PowerShellu během ověřovací fáze (Windows). Odpovídá zřizovacímu modulu PowerShellu Packer. Je možné zadat přesně jeden z "scriptUri" nebo "inline".
ImageTemplateRestartCustomizer	Restartuje virtuální počítač a počká, až se vrátí do online režimu (Windows). Odpovídá zřizovacímu programu Packer windows-restart
ImageTemplateSharedImageDistributor	Distribuujte prostřednictvím galerie výpočetních prostředků Azure.
ImageTemplateSharedImageVersionSource	Popisuje zdroj image, který je verzí image v Galerii výpočetních prostředků Azure nebo v přímé sdílené galerii.
ImageTemplateShellCustomizer	Spustí skript prostředí během fáze přizpůsobení (Linux). Odpovídá zřizovacímu modulu prostředí Packer. Je možné zadat přesně jeden z "scriptUri" nebo "inline".
ImageTemplateShellValidator	Spustí zadaný skript prostředí během ověřovací fáze (Linux). Odpovídá zřizovacímu modulu prostředí Packer. Je možné zadat přesně jeden z "scriptUri" nebo "inline".
ImageTemplateVhdDistributor	Distribuce prostřednictvím virtuálního pevného disku v účtu úložiště
ImageTemplateVmProfile	Popisuje virtuální počítače používané k vytváření a ověřování imagí.
ImageTemplateWindowsUpdateCustomizer	Nainstaluje aktualizace Systému Windows. Odpovídá zřizovacímu programu Windows Update Packer (https://github.com/rgl/packer-provisioner-windows-update)
Optimize	Určuje optimalizaci, která se má provést na imagi.
PlatformImagePurchasePlan	Konfigurace plánu nákupu pro image platformy
ProvisioningError	Popisuje chybu, ke které došlo při vytváření nebo aktualizaci šablony obrázku.
ProvisioningErrorCode	Kód chyby selhání zřizování
ProvisioningState	Stav zřizování prostředku
ResourceIdentityType	Typ identity používané pro šablonu obrázku. Typ None odebere ze šablony obrázku všechny identity.
RunState	Stav posledního spuštění
RunSubState	Dílčí stav posledního spuštění
SharedImageStorageAccountType	Určuje typ účtu úložiště, který se má použít k uložení verze image Galerie výpočetních prostředků Azure.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.
TargetRegion	Popisuje informace o cílové oblasti.
UserAssignedIdentity	Vlastnosti identity přiřazené uživatelem
Validate	Možnosti konfigurace a seznam ověření, která se mají provést na výsledné imagi.
VirtualNetworkConfig	Konfigurace virtuální sítě
VmBoot	Optimalizace se použije na imagi pro rychlejší spuštění virtuálního počítače.
VMBootOptimizationState	Povolením tohoto pole se zlepší doba spouštění virtuálního počítače optimalizací konečného přizpůsobeného výstupu image.

CloudError

Objekt

Odpověď na chybu ze služby Azure VM Image Builder

Name	Typ	Description
error	CloudErrorBody	Podrobnosti o chybě

CloudErrorBody

Objekt

Odpověď na chybu ze služby Azure VM Image Builder

Name	Typ	Description
code	string	Identifikátor chyby. Kódy jsou invariantní a mají být využity programově.
details	CloudErrorBody[]	Seznam dalších podrobností o chybě
message	string	Zpráva popisující chybu, která má být vhodná pro zobrazení v uživatelském rozhraní.
target	string	Cíl konkrétní chyby. Například název vlastnosti v chybě.

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

DistributeVersionerLatest

Objekt

Vygeneruje číslo verze, které bude nejnovější na základě existujících čísel verzí.

Name	Typ	Default value	Description
major	integer (int32) minimum: -1	-1	Hlavní verze pro vygenerované číslo verze Zjistěte, co je nejnovější na základě verzí s touto hodnotou jako hlavní verze. -1 je ekvivalentem ponechání nenasazené sady.
scheme	string: Latest		Schéma číslování verzí, které se má použít.

DistributeVersionerSource

Objekt

Vygeneruje číslo verze na základě čísla verze zdrojové image.

Name	Typ	Description
scheme	string: Source	Schéma číslování verzí, které se má použít.

ImageTemplate

Objekt

Šablona image je prostředek ARM spravovaný poskytovatelem Microsoft.VirtualMachineImages.

Name	Typ	Default value	Description
id	string		Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ImageTemplateIdentity		Identita šablony obrázku, pokud je nakonfigurovaná.
location	string		Geografické umístění, ve kterém se nachází zdroj
name	string		Název prostředku
properties.buildTimeoutInMinutes	integer (int32) minimum: 0 maximum: 960	0	Maximální doba čekání při sestavování šablony image (zahrnuje všechna přizpůsobení, optimalizaci, ověřování a distribuce). Vynecháte nebo zadejte hodnotu 0, která se má použít jako výchozí (4 hodiny).
properties.customize	ImageTemplateCustomizer[]: ImageTemplateFileCustomizer[] ImageTemplatePowerShellCustomizer[] ImageTemplateRestartCustomizer[] ImageTemplateShellCustomizer[] ImageTemplateWindowsUpdateCustomizer[]		Určuje vlastnosti použité k popisu kroků přizpůsobení obrázku, jako je zdroj image atd.
properties.distribute	ImageTemplateDistributor[]: ImageTemplateManagedImageDistributor[] ImageTemplateSharedImageDistributor[] ImageTemplateVhdDistributor[]		Distribuční cíle, kam je potřeba výstup obrázku přejít.
properties.exactStagingResourceGroup	string		ID pracovní skupiny prostředků ve stejném předplatném jako šablona image, která se použije k sestavení image. Toto pole jen pro čtení se liší od "stagingResourceGroup" pouze v případě, že hodnota zadaná v poli "stagingResourceGroup" je prázdná.
properties.lastRunStatus	ImageTemplateLastRunStatus		Stav "run", který se právě spouští nebo byl naposledy proveden.
properties.optimize	Optimize		Určuje optimalizaci, která se má provést na imagi.
properties.provisioningError	ProvisioningError		Chyba zřizování, pokud existuje
properties.provisioningState	ProvisioningState		Stav zřizování prostředku
properties.source	ImageTemplateSource: ImageTemplateManagedImageSource ImageTemplatePlatformImageSource ImageTemplateSharedImageVersionSource		Určuje vlastnosti použité k popisu zdrojové image.
properties.stagingResourceGroup	string		ID pracovní skupiny prostředků ve stejném předplatném jako šablona image, která se použije k sestavení image. Pokud je toto pole prázdné, vytvoří se skupina prostředků s náhodným názvem. Pokud skupina prostředků zadaná v tomto poli neexistuje, vytvoří se se stejným názvem. Pokud zadaná skupina prostředků existuje, musí být prázdná a ve stejné oblasti jako šablona obrázku. Vytvořená skupina prostředků se odstraní během odstraňování šablony, pokud je toto pole prázdné nebo zadaná skupina prostředků neexistuje, ale pokud zadaná skupina prostředků existuje, odstraní se prostředky vytvořené ve skupině prostředků během odstranění šablony a skupina prostředků zůstane sama.
properties.validate	Validate		Možnosti konfigurace a seznam ověření, která se mají provést na výsledné imagi.
properties.vmProfile	ImageTemplateVmProfile		Popisuje, jak je virtuální počítač nastavený tak, aby se sestavily image.
systemData	systemData		Metadata Azure Resource Manageru obsahující informace createdBy a modifiedBy
tags	object		Značky prostředků
type	string		Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

ImageTemplateFileCustomizer

Objekt

Nahraje soubory do virtuálních počítačů (Linux, Windows). Odpovídá zřizovacímu modulu souborů packeru.

Name	Typ	Description
destination	string	Absolutní cesta k souboru (s již vytvořenými vnořenými adresářovými strukturami), do kterého se soubor (ze zdrojového identifikátoruURI) nahraje do virtuálního počítače.
name	string	Popisný název, který poskytuje kontext k tomu, co tento krok přizpůsobení dělá
sha256Checksum	string	Kontrolní součet souboru SHA256 uvedený v poli sourceUri výše
sourceUri	string	Identifikátor URI souboru, který se má nahrát pro přizpůsobení virtuálního počítače. Může to být odkaz githubu, identifikátor URI SAS pro Azure Storage atd.
type	string: File	Typ nástroje pro přizpůsobení, který chcete použít na obrázku. Například "Shell" může být úpravce prostředí.

ImageTemplateFileValidator

Objekt

Nahraje soubory potřebné k ověření do virtuálních počítačů (Linux, Windows). Odpovídá zřizovacímu modulu souborů packeru.

Name	Typ	Description
destination	string	Absolutní cesta k souboru (s již vytvořenými vnořenými adresářovými strukturami), do kterého se soubor (ze zdrojového identifikátoruURI) nahraje do virtuálního počítače.
name	string	Popisný název, který poskytuje kontext k tomu, co tento krok ověření dělá
sha256Checksum	string	Kontrolní součet souboru SHA256 uvedený v poli sourceUri výše
sourceUri	string	Identifikátor URI souboru, který se má nahrát do virtuálního počítače pro ověření. Může to být odkaz githubu, identifikátor URI služby Azure Storage (autorizovaný nebo SAS) atd.
type	string: File	Typ ověření, který chcete použít na obrázku. Například "Shell" může být ověření prostředí.

ImageTemplateIdentity

Objekt

Identita šablony obrázku

Name	Typ	Description
type	ResourceIdentityType	Typ identity používané pro šablonu obrázku. Typ None odebere ze šablony obrázku všechny identity.
userAssignedIdentities	<string, UserAssignedIdentity>	identity User-Assigned Sada identit přiřazených uživatelem přidružená k prostředku. Klíče slovníku userAssignedIdentities budou ID prostředků ARM ve formuláři: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Hodnoty slovníku můžou být prázdné objekty ({}) v požadavcích.

ImageTemplateLastRunStatus

Objekt

Popisuje nejnovější stav spuštění šablony image.

Name	Typ	Description
endTime	string (date-time)	Čas ukončení posledního spuštění (UTC)
message	string	Podrobné informace o posledním stavu spuštění
runState	RunState	Stav posledního spuštění
runSubState	RunSubState	Dílčí stav posledního spuštění
startTime	string (date-time)	Čas zahájení posledního spuštění (UTC)

ImageTemplateManagedImageDistributor

Objekt

Distribuujte jako image spravovaného disku.

Name	Typ	Description
artifactTags	object	Značky, které se po vytvoření nebo aktualizaci distributora použijí na artefakt.
imageId	string	ID prostředku image spravovaného disku
location	string	Umístění Azure pro image by se mělo shodovat, pokud image již existuje.
runOutputName	string pattern: ^[A-Za-z0-9-_.]{1,64}$	Název, který se má použít pro přidružený RunOutput.
type	string: ManagedImage	Typ distribuce.

ImageTemplateManagedImageSource

Objekt

Popisuje zdroj image, který je spravovanou imagí v předplatném zákazníka. Tato image se musí nacházet ve stejném předplatném a oblasti jako šablona Image Builderu.

Name	Typ	Description
imageId	string	ID prostředku ARM spravované image v předplatném zákazníka
type	string: ManagedImage	Určuje typ zdrojové image, se kterou chcete začít.

ImageTemplatePlatformImageSource

Objekt

Popisuje zdroj image z image galerie Azure.

Name	Typ	Description
exactVersion	string	Verze image z image galerie Azure. Toto pole jen pro čtení se liší od "verze", pouze pokud je hodnota zadaná v poli verze "latest".
offer	string	Nabídka image z imagí galerie Azure
planInfo	PlatformImagePurchasePlan	Volitelná konfigurace nákupního plánu pro image platformy
publisher	string	Image Publisher v imagích galerie Azure.
sku	string	SKU obrázku zimagí galerie Azure .
type	string: PlatformImage	Určuje typ zdrojové image, se kterou chcete začít.
version	string	Verze image z image galerie Azure. Pokud je zde zadána hodnota latest, vyhodnotí se verze, když se sestavení image provede, ne při odeslání šablony.

ImageTemplatePowerShellCustomizer

Objekt

Spustí zadaný PowerShell na virtuálním počítači (Windows). Odpovídá zřizovacímu modulu PowerShellu Packer. Je možné zadat přesně jeden z "scriptUri" nebo "inline".

Name	Typ	Default value	Description
inline	string[]		Pole příkazů PowerShellu pro spuštění
name	string		Popisný název, který poskytuje kontext k tomu, co tento krok přizpůsobení dělá
runAsSystem	boolean	False	Pokud je zadáno, skript PowerShellu se spustí se zvýšenými oprávněními pomocí uživatele místního systému. Může být true pouze v případech, kdy je výše uvedené pole runElevated nastaveno na hodnotu true.
runElevated	boolean	False	Pokud je zadáno, skript PowerShellu se spustí se zvýšenými oprávněními.
scriptUri	string		Identifikátor URI skriptu PowerShellu, který se má spustit pro přizpůsobení. Může to být odkaz githubu, identifikátor URI SAS pro Azure Storage atd.
sha256Checksum	string		Kontrolní součet SHA256 skriptu power shellu uvedený v poli scriptUri výše
type	string: PowerShell		Typ nástroje pro přizpůsobení, který chcete použít na obrázku. Například "Shell" může být úpravce prostředí.
validExitCodes	integer[] (int32)		Platné ukončovací kódy pro skript PowerShellu [Výchozí: 0]

ImageTemplatePowerShellValidator

Objekt

Spustí zadaný skript PowerShellu během ověřovací fáze (Windows). Odpovídá zřizovacímu modulu PowerShellu Packer. Je možné zadat přesně jeden z "scriptUri" nebo "inline".

Name	Typ	Default value	Description
inline	string[]		Pole příkazů PowerShellu pro spuštění
name	string		Popisný název, který poskytuje kontext k tomu, co tento krok ověření dělá
runAsSystem	boolean	False	Pokud je zadáno, skript PowerShellu se spustí se zvýšenými oprávněními pomocí uživatele místního systému. Může být true pouze v případech, kdy je výše uvedené pole runElevated nastaveno na hodnotu true.
runElevated	boolean	False	Pokud je zadáno, skript PowerShellu se spustí se zvýšenými oprávněními.
scriptUri	string		Identifikátor URI skriptu PowerShellu, který se má spustit pro ověření. Může to být odkaz githubu, identifikátor URI služby Azure Storage atd.
sha256Checksum	string		Kontrolní součet SHA256 skriptu power shellu uvedený v poli scriptUri výše
type	string: PowerShell		Typ ověření, který chcete použít na obrázku. Například "Shell" může být ověření prostředí.
validExitCodes	integer[] (int32)		Platné ukončovací kódy pro skript PowerShellu [Výchozí: 0]

ImageTemplateRestartCustomizer

Objekt

Restartuje virtuální počítač a počká, až se vrátí do online režimu (Windows). Odpovídá zřizovacímu programu Packer windows-restart

Name	Typ	Description
name	string	Popisný název, který poskytuje kontext k tomu, co tento krok přizpůsobení dělá
restartCheckCommand	string	Příkaz, který zkontroluje, jestli restartování proběhlo úspěšně [Výchozí: '']
restartCommand	string	Příkaz pro spuštění restartování [Výchozí: "shutdown /r /f /t 0 /c "packer restart"']
restartTimeout	string	Časový limit restartování zadaný jako řetězec velikosti a jednotky, například 5 min (5 minut) nebo 2h (2 hodiny) [Výchozí hodnota: 5 min]
type	string: WindowsRestart	Typ nástroje pro přizpůsobení, který chcete použít na obrázku. Například "Shell" může být úpravce prostředí.

ImageTemplateSharedImageDistributor

Objekt

Distribuujte prostřednictvím galerie výpočetních prostředků Azure.

Name	Typ	Default value	Description
artifactTags	object		Značky, které se po vytvoření nebo aktualizaci distributora použijí na artefakt.
excludeFromLatest	boolean	False	Příznak označující, jestli má být vytvořená verze image vyloučena z nejnovější verze. Vynecháte použití výchozí hodnoty (false).
galleryImageId	string		ID prostředku image Galerie výpočetních prostředků Azure
replicationRegions	string[]		[Zastaralé] Seznam oblastí, do kterých se image bude replikovat. Tento seznam lze zadat pouze v případě, že cílové oblasti nejsou zadány. Toto pole je zastaralé – místo toho použijte cílové oblasti.
runOutputName	string pattern: ^[A-Za-z0-9-_.]{1,64}$		Název, který se má použít pro přidružený RunOutput.
storageAccountType	SharedImageStorageAccountType		[Zastaralé] Typ účtu úložiště, který se má použít k uložení sdílené image. Vynecháte použití výchozího nastavení (Standard_LRS). Toto pole lze zadat pouze v případě, že je zadána oblast replikace. Toto pole je zastaralé – místo toho použijte cílové oblasti.
targetRegions	TargetRegion[]		Cílové oblasti, do kterých se distribuovaná verze image bude replikovat. Tento objekt nahrazuje oblasti replikace a lze jej zadat pouze v případě, že není zadána oblast replikace.
type	string: SharedImage		Typ distribuce.
versioning	DistributeVersioner: DistributeVersionerLatest DistributeVersionerSource		Popisuje, jak vygenerovat nové číslo verze x.y.z pro distribuci.

ImageTemplateSharedImageVersionSource

Objekt

Popisuje zdroj image, který je verzí image v Galerii výpočetních prostředků Azure nebo v přímé sdílené galerii.

Name	Typ	Description
exactVersion	string	Přesné ID prostředku ARM verze image Toto pole jen pro čtení se liší od ID verze image v imageVersionId pouze v případě, že název verze zadaný v poli imageVersionId je "latest".
imageVersionId	string	ID prostředku ARM verze image. Pokud je název verze image "latest", vyhodnotí se verze při sestavení image.
type	string: SharedImageVersion	Určuje typ zdrojové image, se kterou chcete začít.

ImageTemplateShellCustomizer

Objekt

Spustí skript prostředí během fáze přizpůsobení (Linux). Odpovídá zřizovacímu modulu prostředí Packer. Je možné zadat přesně jeden z "scriptUri" nebo "inline".

Name	Typ	Description
inline	string[]	Pole příkazů prostředí ke spuštění
name	string	Popisný název, který poskytuje kontext k tomu, co tento krok přizpůsobení dělá
scriptUri	string	Identifikátor URI skriptu prostředí, který se má spustit pro přizpůsobení. Může to být odkaz githubu, identifikátor URI SAS pro Azure Storage atd.
sha256Checksum	string	Kontrolní součet sha256 skriptu prostředí zadaného v poli scriptUri
type	string: Shell	Typ nástroje pro přizpůsobení, který chcete použít na obrázku. Například "Shell" může být úpravce prostředí.

ImageTemplateShellValidator

Objekt

Spustí zadaný skript prostředí během ověřovací fáze (Linux). Odpovídá zřizovacímu modulu prostředí Packer. Je možné zadat přesně jeden z "scriptUri" nebo "inline".

Name	Typ	Description
inline	string[]	Pole příkazů prostředí ke spuštění
name	string	Popisný název, který poskytuje kontext k tomu, co tento krok ověření dělá
scriptUri	string	Identifikátor URI skriptu prostředí, který se má spustit pro ověření. Může to být odkaz githubu, identifikátor URI služby Azure Storage atd.
sha256Checksum	string	Kontrolní součet sha256 skriptu prostředí zadaného v poli scriptUri
type	string: Shell	Typ ověření, který chcete použít na obrázku. Například "Shell" může být ověření prostředí.

ImageTemplateVhdDistributor

Objekt

Distribuce prostřednictvím virtuálního pevného disku v účtu úložiště

Name	Typ	Description
artifactTags	object	Značky, které se po vytvoření nebo aktualizaci distributora použijí na artefakt.
runOutputName	string pattern: ^[A-Za-z0-9-_.]{1,64}$	Název, který se má použít pro přidružený RunOutput.
type	string: VHD	Typ distribuce.
uri	string	Volitelný identifikátor URI služby Azure Storage pro distribuovaný objekt blob virtuálního pevného disku Vynecháte použití výchozího (prázdného řetězce), v takovém případě se virtuální pevný disk publikuje do účtu úložiště v pracovní skupině prostředků.

ImageTemplateVmProfile

Objekt

Popisuje virtuální počítače používané k vytváření a ověřování imagí.

Name	Typ	Default value	Description
osDiskSizeGB	integer (int32) minimum: 0	0	Velikost disku s operačním systémem v GB Vynecháte nebo zadejte hodnotu 0 pro použití výchozí velikosti disku s operačním systémem Azure.
userAssignedIdentities	string[]		Volitelné pole ID prostředků spravovaných identit přiřazených uživatelem, které se mají nakonfigurovat na virtuálním počítači sestavení a ověření. Může to zahrnovat identitu šablony obrázku.
vmSize	string		Velikost virtuálního počítače použitého k sestavení, přizpůsobení a zachycení imagí Vynecháte nebo zadejte prázdný řetězec, který se má použít jako výchozí (Standard_D1_v2 pro image Gen1 a Standard_D2ds_v4 pro image Gen2).
vnetConfig	VirtualNetworkConfig		Volitelná konfigurace virtuální sítě, která se má použít k nasazení virtuálního počítače sestavení a ověření virtuálního počítače. Vynecháte, pokud není potřeba použít žádnou konkrétní virtuální síť.

ImageTemplateWindowsUpdateCustomizer

Objekt

Nainstaluje aktualizace Systému Windows. Odpovídá zřizovacímu programu Windows Update Packer (https://github.com/rgl/packer-provisioner-windows-update)

Name	Typ	Default value	Description
filters	string[]		Polefiltrůch Vynechání nebo zadání prázdného pole pro použití výchozího pole (bez filtru) Příklady a podrobný popis tohoto pole najdete na výše uvedeném odkazu.
name	string		Popisný název, který poskytuje kontext k tomu, co tento krok přizpůsobení dělá
searchCriteria	string		Kritéria pro vyhledávání aktualizací Vynecháte nebo zadejte prázdný řetězec, který se má použít jako výchozí (prohledávat vše). Příklady a podrobný popis tohoto pole najdete na výše uvedeném odkazu.
type	string: WindowsUpdate		Typ nástroje pro přizpůsobení, který chcete použít na obrázku. Například "Shell" může být úpravce prostředí.
updateLimit	integer (int32) minimum: 0	0	Maximální početaktualizacích Vynechání nebo zadání hodnoty 0 pro použití výchozího nastavení (1000)

Optimize

Objekt

Určuje optimalizaci, která se má provést na imagi.

Name	Typ	Description
vmBoot	VmBoot	Optimalizace se použije na imagi pro rychlejší spuštění virtuálního počítače.

PlatformImagePurchasePlan

Objekt

Konfigurace plánu nákupu pro image platformy

Name	Typ	Description
planName	string	Název nákupního plánu.
planProduct	string	Produkt nákupního plánu.
planPublisher	string	Vydavatel nákupního plánu.

ProvisioningError

Objekt

Popisuje chybu, ke které došlo při vytváření nebo aktualizaci šablony obrázku.

Name	Typ	Description
message	string	Podrobná chybová zpráva o selhání zřizování
provisioningErrorCode	ProvisioningErrorCode	Kód chyby selhání zřizování

ProvisioningErrorCode

Výčet

Kód chyby selhání zřizování

Hodnota	Description
BadSourceType
BadPIRSource
BadManagedImageSource
BadSharedImageVersionSource
BadCustomizerType
UnsupportedCustomizerType
NoCustomizerScript
BadValidatorType
UnsupportedValidatorType
NoValidatorScript
BadDistributeType
BadSharedImageDistribute
BadStagingResourceGroup
ServerError
Other

ProvisioningState

Výčet

Stav zřizování prostředku

Hodnota	Description
Creating
Updating
Succeeded
Failed
Deleting
Canceled

ResourceIdentityType

Výčet

Typ identity používané pro šablonu obrázku. Typ None odebere ze šablony obrázku všechny identity.

Hodnota	Description
UserAssigned
None

RunState

Výčet

Stav posledního spuštění

Hodnota	Description
Running
Canceling
Succeeded
PartiallySucceeded
Failed
Canceled

RunSubState

Výčet

Dílčí stav posledního spuštění

Hodnota	Description
Queued
Building
Customizing
Optimizing
Validating
Distributing

SharedImageStorageAccountType

Výčet

Určuje typ účtu úložiště, který se má použít k uložení verze image Galerie výpočetních prostředků Azure.

Hodnota	Description
Standard_LRS
Standard_ZRS
Premium_LRS

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

TargetRegion

Objekt

Popisuje informace o cílové oblasti.

Name	Typ	Default value	Description
name	string		Název oblasti.
replicaCount	integer (int32) minimum: 1	1	Počet replik verze image, které se mají v této oblasti vytvořit. Vynecháte použití výchozího nastavení (1).
storageAccountType	SharedImageStorageAccountType		Určuje typ účtu úložiště, který se má použít k uložení image v této oblasti. Vynecháte použití výchozího nastavení (Standard_LRS).

UserAssignedIdentity

Objekt

Vlastnosti identity přiřazené uživatelem

Name	Typ	Description
clientId	string	ID klienta přiřazené identity.
principalId	string	ID objektu zabezpečení přiřazené identity.

Validate

Objekt

Možnosti konfigurace a seznam ověření, která se mají provést na výsledné imagi.

Name	Typ	Default value	Description
continueDistributeOnFailure	boolean	False	Pokud se ověření nezdaří a toto pole je nastavené na false, výstupní image nebudou distribuovány. Toto je výchozí chování. Pokud se ověření nezdaří a toto pole je nastavené na true, výstupní image se budou dál distribuovat. Tuto možnost použijte s opatrností, protože může vést k distribuci špatných obrázků pro použití. V oboupřípadechch kódech se zobrazí v obou případech [Poznámka: Toto pole nemá žádný vliv, pokud bude ověření úspěšné.]
inVMValidations	ImageTemplateInVMValidator[]: ImageTemplateFileValidator[] ImageTemplatePowerShellValidator[] ImageTemplateShellValidator[]		Seznam ověření, která se mají provést.
sourceValidationOnly	boolean	False	Pokud je toto pole nastaveno na true, obrázek zadaný ve zdrojové části se ověří přímo. K vygenerování a ověření přizpůsobené image se nespustí žádné samostatné sestavení.

VirtualNetworkConfig

Objekt

Konfigurace virtuální sítě

Name	Typ	Description
proxyVmSize	string	Velikost virtuálního počítače proxy serveru sloužícího k předání provozu do virtuálního počítače sestavení a ověření virtuálního počítače Vynecháte nebo zadejte prázdný řetězec, který se má použít jako výchozí (Standard_A1_v2).
subnetId	string	ID prostředku před existující podsítě.

VmBoot

Objekt

Optimalizace se použije na imagi pro rychlejší spuštění virtuálního počítače.

Name	Typ	Description
state	VMBootOptimizationState	Povolením tohoto pole se zlepší doba spouštění virtuálního počítače optimalizací konečného přizpůsobeného výstupu image.

VMBootOptimizationState

Výčet

Povolením tohoto pole se zlepší doba spouštění virtuálního počítače optimalizací konečného přizpůsobeného výstupu image.

Hodnota	Description
Enabled
Disabled

Sdílet prostřednictvím

Virtual Machine Image Templates - Get

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

Retrieve an Image Template.

Ukázkový požadavek

Ukázková odpověď

Definice

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