Microsoft.VirtualMachineImages imageTemplates
Definicja zasobu Bicep
Typ zasobu imageTemplates można wdrożyć przy użyciu operacji docelowych:
- grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.
Format zasobu
Aby utworzyć zasób Microsoft.VirtualMachineImages/imageTemplates, dodaj następujący kod Bicep do szablonu.
resource symbolicname 'Microsoft.VirtualMachineImages/imageTemplates@2024-02-01' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
autoRun: {
state: 'string'
}
buildTimeoutInMinutes: int
customize: [
{
name: 'string'
type: 'string'
// For remaining properties, see ImageTemplateCustomizer objects
}
]
distribute: [
{
artifactTags: {
{customized property}: 'string'
}
runOutputName: 'string'
type: 'string'
// For remaining properties, see ImageTemplateDistributor objects
}
]
errorHandling: {
onCustomizerError: 'string'
onValidationError: 'string'
}
managedResourceTags: {
{customized property}: 'string'
}
optimize: {
vmBoot: {
state: 'string'
}
}
source: {
type: 'string'
// For remaining properties, see ImageTemplateSource objects
}
stagingResourceGroup: 'string'
validate: {
continueDistributeOnFailure: bool
inVMValidations: [
{
name: 'string'
type: 'string'
// For remaining properties, see ImageTemplateInVMValidator objects
}
]
sourceValidationOnly: bool
}
vmProfile: {
osDiskSizeGB: int
userAssignedIdentities: [
'string'
]
vmSize: 'string'
vnetConfig: {
containerInstanceSubnetId: 'string'
proxyVmSize: 'string'
subnetId: 'string'
}
}
}
tags: {
{customized property}: 'string'
}
}
Obiekty ImageTemplateDistributor
Ustaw właściwość , aby określić typ obiektu.
W przypadku ManagedImageużyj:
{
imageId: 'string'
location: 'string'
type: 'ManagedImage'
}
W przypadku SharedImageużyj:
{
excludeFromLatest: bool
galleryImageId: 'string'
replicationRegions: [
'string'
]
storageAccountType: 'string'
targetRegions: [
{
name: 'string'
replicaCount: int
storageAccountType: 'string'
}
]
type: 'SharedImage'
versioning: {
scheme: 'string'
// For remaining properties, see DistributeVersioner objects
}
}
W przypadkuwirtualnego dysku twardego
{
type: 'VHD'
uri: 'string'
}
Obiekty DistributeVersioner
Ustaw właściwość schematu, aby określić typ obiektu.
W przypadku najnowszejużyj:
{
major: int
scheme: 'Latest'
}
W przypadku source użyj:
{
scheme: 'Source'
}
Obiekty ImageTemplateCustomizer
Ustaw właściwość , aby określić typ obiektu.
W przypadkuplików
{
destination: 'string'
sha256Checksum: 'string'
sourceUri: 'string'
type: 'File'
}
W przypadku programu PowerShellużyj:
{
inline: [
'string'
]
runAsSystem: bool
runElevated: bool
scriptUri: 'string'
sha256Checksum: 'string'
type: 'PowerShell'
validExitCodes: [
int
]
}
W przypadku usługi Shellużyj:
{
inline: [
'string'
]
scriptUri: 'string'
sha256Checksum: 'string'
type: 'Shell'
}
W przypadku WindowsRestart użyj:
{
restartCheckCommand: 'string'
restartCommand: 'string'
restartTimeout: 'string'
type: 'WindowsRestart'
}
W przypadku windowsUpdateużyj:
{
filters: [
'string'
]
searchCriteria: 'string'
type: 'WindowsUpdate'
updateLimit: int
}
Obiekty ImageTemplateInVMValidator
Ustaw właściwość , aby określić typ obiektu.
W przypadkuplików
{
destination: 'string'
sha256Checksum: 'string'
sourceUri: 'string'
type: 'File'
}
W przypadku programu PowerShellużyj:
{
inline: [
'string'
]
runAsSystem: bool
runElevated: bool
scriptUri: 'string'
sha256Checksum: 'string'
type: 'PowerShell'
validExitCodes: [
int
]
}
W przypadku usługi Shellużyj:
{
inline: [
'string'
]
scriptUri: 'string'
sha256Checksum: 'string'
type: 'Shell'
}
Obiekty ImageTemplateSource
Ustaw właściwość , aby określić typ obiektu.
W przypadku ManagedImageużyj:
{
imageId: 'string'
type: 'ManagedImage'
}
W przypadku PlatformImageużyj:
{
offer: 'string'
planInfo: {
planName: 'string'
planProduct: 'string'
planPublisher: 'string'
}
publisher: 'string'
sku: 'string'
type: 'PlatformImage'
version: 'string'
}
W przypadku SharedImageVersionużyj:
{
imageVersionId: 'string'
type: 'SharedImageVersion'
}
Wartości właściwości
DistributeVersioner
Nazwa | Opis | Wartość |
---|---|---|
plan | Ustaw wartość "Latest" dla typu DistributeVersionerLatest. Ustaw wartość "Źródło" dla typu DistributeVersionerSource. | "Najnowsze" "Źródło" (wymagane) |
DistributeVersionerLatest
Nazwa | Opis | Wartość |
---|---|---|
major | 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. | Int Ograniczenia: Minimalna wartość = -1 |
plan | Schemat numerowania wersji do użycia. | "Latest" (wymagane) |
DistributeVersionerSource
Nazwa | Opis | Wartość |
---|---|---|
plan | Schemat numerowania wersji do użycia. | "Źródło" (wymagane) |
ImageTemplateAutoRun
Nazwa | Opis | Wartość |
---|---|---|
stan | Włączenie tego pola spowoduje wyzwolenie automatycznej kompilacji podczas tworzenia lub aktualizowania szablonu obrazu. | "Wyłączone" "Włączone" |
ImageTemplateCustomizer
Nazwa | Opis | Wartość |
---|---|---|
nazwa | Przyjazna nazwa, aby podać kontekst tego kroku dostosowywania | struna |
typ | Ustaw wartość "Plik" dla typu ImageTemplateFileCustomizer. Ustaw wartość "PowerShell" dla typu ImageTemplatePowerShellCustomizer. Ustaw wartość "Shell" dla typu ImageTemplateShellCustomizer. Ustaw wartość "WindowsRestart" dla typu ImageTemplateRestartCustomizer. Ustaw wartość "WindowsUpdate" dla typu ImageTemplateWindowsUpdateCustomizer. | "Plik" "PowerShell" "Powłoka" "WindowsRestart" "WindowsUpdate" (wymagane) |
ImageTemplateDistributor
Nazwa | Opis | Wartość |
---|---|---|
artifactTags | Tagi, które zostaną zastosowane do artefaktu po jego utworzeniu/zaktualizowaniu przez dystrybutora. | ImageTemplateDistributorArtifactTags |
runOutputName | Nazwa, która ma być używana dla skojarzonego elementu RunOutput. | struna Ograniczenia: Wzorzec = ^[A-Za-z0-9-_.]{1,64}$ (wymagane) |
typ | Ustaw wartość "ManagedImage" dla typu ImageTemplateManagedImageDistributor. Ustaw wartość "SharedImage" dla typu ImageTemplateSharedImageDistributor. Ustaw wartość "VHD" dla typu ImageTemplateVhdDistributor. | "ManagedImage" "SharedImage" "VHD" (wymagany) |
ImageTemplateDistributorArtifactTags
Nazwa | Opis | Wartość |
---|
ImageTemplateFileCustomizer
Nazwa | Opis | Wartość |
---|---|---|
cel | Ś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 | struna |
sha256Checksum | Sha256 suma kontrolna pliku podanego w polu sourceUri powyżej | struna |
sourceUri | 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. | struna |
typ | Typ narzędzia dostosowywania, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być konfiguratorem powłoki | "Plik" (wymagany) |
ImageTemplateFileValidator
Nazwa | Opis | Wartość |
---|---|---|
cel | Ś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 | struna |
sha256Checksum | Sha256 suma kontrolna pliku podanego w polu sourceUri powyżej | struna |
sourceUri | 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. | struna |
typ | Typ weryfikacji, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być walidacją powłoki | "Plik" (wymagany) |
ImageTemplateIdentity
Nazwa | Opis | Wartość |
---|---|---|
typ | Typ tożsamości używany dla szablonu obrazu. Typ "None" usunie wszystkie tożsamości z szablonu obrazu. | "Brak" "UserAssigned" |
userAssignedIdentities | 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. | UserAssignedIdentities |
ImageTemplateInVMValidator
Nazwa | Opis | Wartość |
---|---|---|
nazwa | Przyjazna nazwa, aby podać kontekst tego kroku weryfikacji | struna |
typ | Ustaw wartość "File" dla typu ImageTemplateFileValidator. Ustaw wartość "PowerShell" dla typu ImageTemplatePowerShellValidator. Ustaw wartość "Shell" dla typu ImageTemplateShellValidator. | "Plik" "PowerShell" "Shell" (wymagane) |
ImageTemplateManagedImageDistributor
Nazwa | Opis | Wartość |
---|---|---|
imageId | Identyfikator zasobu obrazu dysku zarządzanego | ciąg (wymagany) |
lokalizacja | Lokalizacja platformy Azure dla obrazu powinna być zgodna z tym, czy obraz już istnieje | ciąg (wymagany) |
typ | Typ rozkładu. | "ManagedImage" (wymagane) |
ImageTemplateManagedImageSource
Nazwa | Opis | Wartość |
---|---|---|
imageId | Identyfikator zasobu usługi ARM obrazu zarządzanego w subskrypcji klienta | ciąg (wymagany) |
typ | Określa typ obrazu źródłowego, z którym chcesz zacząć. | "ManagedImage" (wymagane) |
ImageTemplatePlatformImageSource
Nazwa | Opis | Wartość |
---|---|---|
oferta | Oferta obrazu z Azure Gallery Images. | struna |
planInfo | Opcjonalna konfiguracja planu zakupu dla obrazu platformy. | PlatformImagePurchasePlan |
wydawca | Program Image Publisher w usłudze Azure Gallery Images. | struna |
Numer jednostki magazynowej | Jednostka SKU obrazu z Obrazów z galerii platformy Azure. | struna |
typ | Określa typ obrazu źródłowego, z którym chcesz zacząć. | "PlatformImage" (wymagane) |
Wersja | 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. | struna |
ImageTemplatePowerShellCustomizer
Nazwa | Opis | Wartość |
---|---|---|
Wbudowany | Tablica poleceń programu PowerShell do wykonania | string[] |
runAsSystem | 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. | Bool |
runElevated | Jeśli zostanie określony, skrypt programu PowerShell zostanie uruchomiony z podwyższonym poziomem uprawnień | Bool |
scriptUri | 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. | struna |
sha256Checksum | Suma kontrolna SHA256 skryptu powłoki power shell podana w polu scriptUri powyżej | struna |
typ | Typ narzędzia dostosowywania, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być konfiguratorem powłoki | "PowerShell" (wymagany) |
validExitCodes | Prawidłowe kody zakończenia skryptu programu PowerShell. [Wartość domyślna: 0] | int[] |
ImageTemplatePowerShellValidator
Nazwa | Opis | Wartość |
---|---|---|
Wbudowany | Tablica poleceń programu PowerShell do wykonania | string[] |
runAsSystem | 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. | Bool |
runElevated | Jeśli zostanie określony, skrypt programu PowerShell zostanie uruchomiony z podwyższonym poziomem uprawnień | Bool |
scriptUri | 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. | struna |
sha256Checksum | Suma kontrolna SHA256 skryptu powłoki power shell podana w polu scriptUri powyżej | struna |
typ | Typ weryfikacji, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być walidacją powłoki | "PowerShell" (wymagany) |
validExitCodes | Prawidłowe kody zakończenia skryptu programu PowerShell. [Wartość domyślna: 0] | int[] |
ImageTemplateProperties
Nazwa | Opis | Wartość |
---|---|---|
autoUruchomienie | Wskazuje, czy szablon obrazu ma być uruchamiany automatycznie podczas tworzenia lub aktualizowania szablonu. | ImageTemplateAutoRun |
buildTimeoutInMinutes | 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). | Int Ograniczenia: Minimalna wartość = 0 Wartość maksymalna = 960 |
Dostosuj | Określa właściwości używane do opisywania kroków dostosowywania obrazu, takich jak źródło obrazu itp. | ImageTemplateCustomizer[] |
rozdzielać | Lokalizacja docelowa dystrybucji, do której należy przejść dane wyjściowe obrazu. | ImageTemplateDistributor[] (wymagane) |
errorHandling | Opcje obsługi błędów po niepowodzeniu kompilacji | ImageTemplatePropertiesErrorHandling |
managedResourceTags | Tagi, które zostaną zastosowane do grupy zasobów i/lub zasobów utworzonych przez usługę. | ImageTemplatePropertiesManagedResourceTags |
optymalizować | Określa optymalizację do wykonania na obrazie. | ImageTemplatePropertiesOptimize |
źródło | Określa właściwości używane do opisywania obrazu źródłowego. | ImageTemplateSource (wymagane) |
stagingResourceGroup | 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. | struna |
walidować | Opcje konfiguracji i lista weryfikacji, które mają zostać wykonane na obrazie wynikowym. | ImageTemplatePropertiesValidate |
vmProfile | Opisuje sposób konfigurowania maszyny wirtualnej do kompilowania obrazów | ImageTemplateVmProfile |
ImageTemplatePropertiesErrorHandling
Nazwa | Opis | Wartość |
---|---|---|
onCustomizerError | Jeśli wystąpi błąd konfiguratora i to pole jest ustawione na "oczyszczanie", skompilowana maszyna wirtualna i skojarzone zasoby sieciowe zostaną wyczyszczone. Jest to zachowanie domyślne. Jeśli wystąpi błąd konfiguratora i to pole jest ustawione na "przerwanie", maszyna wirtualna kompilacji zostanie zachowana. | "przerwij" "Oczyszczanie" |
onValidationError | Jeśli wystąpi błąd weryfikacji i to pole jest ustawione na "oczyszczanie", skompilowana maszyna wirtualna i skojarzone zasoby sieciowe zostaną wyczyszczone. Jest to zachowanie domyślne. Jeśli wystąpi błąd weryfikacji i to pole jest ustawione na "przerwanie", maszyna wirtualna kompilacji zostanie zachowana. | "przerwij" "Oczyszczanie" |
ImageTemplatePropertiesManagedResourceTags
Nazwa | Opis | Wartość |
---|
ImageTemplatePropertiesOptimize
Nazwa | Opis | Wartość |
---|---|---|
vmBoot | Optymalizacja jest stosowana na obrazie w celu szybszego rozruchu maszyny wirtualnej. | ImageTemplatePropertiesOptimizeVmBoot |
ImageTemplatePropertiesOptimizeVmBoot
Nazwa | Opis | Wartość |
---|---|---|
stan | Włączenie tego pola poprawi czas rozruchu maszyny wirtualnej, optymalizując ostateczne dostosowane dane wyjściowe obrazu. | "Wyłączone" "Włączone" |
ImageTemplatePropertiesValidate
Nazwa | Opis | Wartość |
---|---|---|
continueDistributeOnFailure | 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.] | Bool |
inVMValidations | Lista walidacji do wykonania. | ImageTemplateInVMValidator[] |
sourceValidationOnly | 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. | Bool |
ImageTemplateRestartCustomizer
Nazwa | Opis | Wartość |
---|---|---|
restartCheckCommand | Polecenie sprawdzania, czy ponowne uruchomienie zakończyło się pomyślnie [Ustawienie domyślne: ""] | struna |
restartCommand | Polecenie do wykonania ponownego uruchomienia [Domyślne: "shutdown /r /f /t 0 /c "packer restart"] | struna |
restartTimeout | 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"] | struna |
typ | Typ narzędzia dostosowywania, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być konfiguratorem powłoki | "WindowsRestart" (wymagany) |
ImageTemplateSharedImageDistributor
Nazwa | Opis | Wartość |
---|---|---|
excludeFromLatest | Flaga wskazująca, czy utworzona wersja obrazu powinna zostać wykluczona z najnowszej wersji. Pomiń użycie wartości domyślnej (false). | Bool |
galleryImageId | Identyfikator zasobu obrazu galerii obliczeniowej platformy Azure | ciąg (wymagany) |
replicationRegions | [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. | string[] |
storageAccountType | [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. | "Premium_LRS" "Standard_LRS" "Standard_ZRS" |
targetRegions | 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. | TargetRegion[] |
typ | Typ rozkładu. | "SharedImage" (wymagane) |
przechowywanie wersji | Opisuje sposób generowania nowego numeru wersji x.y.z dla dystrybucji. | |
ImageTemplateSharedImageVersionSource
Nazwa | Opis | Wartość |
---|---|---|
imageVersionId | Identyfikator zasobu usługi ARM wersji obrazu. Gdy nazwa wersji obrazu to "latest", wersja jest oceniana podczas kompilacji obrazu. | ciąg (wymagany) |
typ | Określa typ obrazu źródłowego, z którym chcesz zacząć. | "SharedImageVersion" (wymagane) |
ImageTemplateShellCustomizer
Nazwa | Opis | Wartość |
---|---|---|
Wbudowany | Tablica poleceń powłoki do wykonania | string[] |
scriptUri | 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. | struna |
sha256Checksum | Suma kontrolna SHA256 skryptu powłoki podana w polu scriptUri | struna |
typ | Typ narzędzia dostosowywania, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być konfiguratorem powłoki | "Shell" (wymagane) |
ImageTemplateShellValidator
Nazwa | Opis | Wartość |
---|---|---|
Wbudowany | Tablica poleceń powłoki do wykonania | string[] |
scriptUri | 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. | struna |
sha256Checksum | Suma kontrolna SHA256 skryptu powłoki podana w polu scriptUri | struna |
typ | Typ weryfikacji, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być walidacją powłoki | "Shell" (wymagane) |
ImageTemplateSource
Nazwa | Opis | Wartość |
---|---|---|
typ | Ustaw wartość "ManagedImage" dla typu ImageTemplateManagedImageSource. Ustaw wartość "PlatformImage" dla typu ImageTemplatePlatformImageSource. Ustaw wartość "SharedImageVersion" dla typu ImageTemplateSharedImageVersionSource. | "ManagedImage" "PlatformImage" "SharedImageVersion" (wymagane) |
ImageTemplateVhdDistributor
Nazwa | Opis | Wartość |
---|---|---|
typ | Typ rozkładu. | "VHD" (wymagany) |
Uri | 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. | struna |
ImageTemplateVmProfile
Nazwa | Opis | Wartość |
---|---|---|
osDiskSizeGB | Rozmiar dysku systemu operacyjnego w GB. Pomiń lub określ wartość 0, aby użyć domyślnego rozmiaru dysku systemu operacyjnego platformy Azure. | Int Ograniczenia: Minimalna wartość = 0 |
userAssignedIdentities | 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. | string[] |
vmSize | 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). | struna |
vnetConfig | 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. | VirtualNetworkConfig |
ImageTemplateWindowsUpdateCustomizer
Nazwa | Opis | Wartość |
---|---|---|
Filtry | 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. | string[] |
searchCriteria | 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. | struna |
typ | Typ narzędzia dostosowywania, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być konfiguratorem powłoki | "WindowsUpdate" (wymagane) |
updateLimit | Maksymalna liczba aktualizacji do zastosowania w danym momencie. Pomiń lub określ wartość 0, aby użyć wartości domyślnej (1000) | Int Ograniczenia: Minimalna wartość = 0 |
Microsoft.VirtualMachineImages/imageTemplates
Nazwa | Opis | Wartość |
---|---|---|
tożsamość | Tożsamość szablonu obrazu, jeśli jest skonfigurowana. | ImageTemplateIdentity (wymagane) |
lokalizacja | Lokalizacja geograficzna, w której znajduje się zasób | ciąg (wymagany) |
nazwa | Nazwa zasobu | struna Ograniczenia: Wzorzec = ^[A-Za-z0-9-_.]{1,64}$ (wymagane) |
Właściwości | Właściwości szablonu obrazu | ImageTemplateProperties |
Tagi | Tagi zasobów | Słownik nazw tagów i wartości. Zobacz tagi w szablonach |
PlatformImagePurchasePlan
Nazwa | Opis | Wartość |
---|---|---|
planName | Nazwa planu zakupu. | ciąg (wymagany) |
planProduct | Produkt planu zakupu. | ciąg (wymagany) |
planPublisher | Wydawca planu zakupu. | ciąg (wymagany) |
TargetRegion
Nazwa | Opis | Wartość |
---|---|---|
nazwa | Nazwa regionu. | ciąg (wymagany) |
replicaCount | Liczba replik wersji obrazu do utworzenia w tym regionie. Pomiń użycie wartości domyślnej (1). | Int Ograniczenia: Minimalna wartość = 1 |
storageAccountType | 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). | "Premium_LRS" "Standard_LRS" "Standard_ZRS" |
TrackedResourceTags
Nazwa | Opis | Wartość |
---|
UserAssignedIdentities
Nazwa | Opis | Wartość |
---|
UserAssignedIdentity
Nazwa | Opis | Wartość |
---|
VirtualNetworkConfig
Nazwa | Opis | Wartość |
---|---|---|
containerInstanceSubnetId | Identyfikator zasobu istniejącej podsieci, w której zostanie wdrożone wystąpienie kontenera platformy Azure dla izolowanych kompilacji. To pole może być określone tylko wtedy, gdy określono subnetId i musi znajdować się w tej samej sieci wirtualnej co podsieć określona w subnetId . |
struna |
proxyVmSize | Rozmiar maszyny wirtualnej serwera proxy używanej do przekazywania ruchu do maszyny wirtualnej kompilacji i maszyny wirtualnej weryfikacji. Nie można tego określić, jeśli określono containerInstanceSubnetId , ponieważ w takim przypadku nie wdrożono żadnej maszyny wirtualnej serwera proxy. Pomiń lub określ pusty ciąg, aby użyć wartości domyślnej (Standard_A1_v2). |
struna |
subnetId | Identyfikator zasobu istniejącej podsieci, w której zostanie wdrożona maszyna wirtualna kompilacji i maszyna wirtualna sprawdzania poprawności | struna |
Przykłady z przewodnika Szybki start
W poniższych przykładach szybkiego startu wdrożono ten typ zasobu.
Plik Bicep | Opis |
---|---|
Azure Image Builder z programem Azure Windows Baseline | Tworzy środowisko narzędzia Azure Image Builder i tworzy obraz systemu Windows Server z zastosowanymi najnowszymi aktualizacjami systemu Windows i punktem odniesienia platformy Azure. |
Konfigurowanie usługi Dev Box | Ten szablon umożliwia utworzenie wszystkich zasobów administracyjnych usługi Dev Box zgodnie z przewodnikiem Szybki start dotyczącym usługi Dev Box (/azure/dev-box/quickstart-create-dev-box). Możesz wyświetlić wszystkie utworzone zasoby lub bezpośrednio przejść do DevPortal.microsoft.com, aby utworzyć pierwsze rozwiązanie Dev Box. |
Definicja zasobu szablonu usługi ARM
Typ zasobu imageTemplates można wdrożyć przy użyciu operacji docelowych:
- grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.
Format zasobu
Aby utworzyć zasób Microsoft.VirtualMachineImages/imageTemplates, dodaj następujący kod JSON do szablonu.
{
"type": "Microsoft.VirtualMachineImages/imageTemplates",
"apiVersion": "2024-02-01",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"autoRun": {
"state": "string"
},
"buildTimeoutInMinutes": "int",
"customize": [ {
"name": "string",
"type": "string"
// For remaining properties, see ImageTemplateCustomizer objects
} ],
"distribute": [ {
"artifactTags": {
"{customized property}": "string"
},
"runOutputName": "string",
"type": "string"
// For remaining properties, see ImageTemplateDistributor objects
} ],
"errorHandling": {
"onCustomizerError": "string",
"onValidationError": "string"
},
"managedResourceTags": {
"{customized property}": "string"
},
"optimize": {
"vmBoot": {
"state": "string"
}
},
"source": {
"type": "string"
// For remaining properties, see ImageTemplateSource objects
},
"stagingResourceGroup": "string",
"validate": {
"continueDistributeOnFailure": "bool",
"inVMValidations": [ {
"name": "string",
"type": "string"
// For remaining properties, see ImageTemplateInVMValidator objects
} ],
"sourceValidationOnly": "bool"
},
"vmProfile": {
"osDiskSizeGB": "int",
"userAssignedIdentities": [ "string" ],
"vmSize": "string",
"vnetConfig": {
"containerInstanceSubnetId": "string",
"proxyVmSize": "string",
"subnetId": "string"
}
}
},
"tags": {
"{customized property}": "string"
}
}
Obiekty ImageTemplateDistributor
Ustaw właściwość , aby określić typ obiektu.
W przypadku ManagedImageużyj:
{
"imageId": "string",
"location": "string",
"type": "ManagedImage"
}
W przypadku SharedImageużyj:
{
"excludeFromLatest": "bool",
"galleryImageId": "string",
"replicationRegions": [ "string" ],
"storageAccountType": "string",
"targetRegions": [
{
"name": "string",
"replicaCount": "int",
"storageAccountType": "string"
}
],
"type": "SharedImage",
"versioning": {
"scheme": "string"
// For remaining properties, see DistributeVersioner objects
}
}
W przypadkuwirtualnego dysku twardego
{
"type": "VHD",
"uri": "string"
}
Obiekty DistributeVersioner
Ustaw właściwość schematu, aby określić typ obiektu.
W przypadku najnowszejużyj:
{
"major": "int",
"scheme": "Latest"
}
W przypadku source użyj:
{
"scheme": "Source"
}
Obiekty ImageTemplateCustomizer
Ustaw właściwość , aby określić typ obiektu.
W przypadkuplików
{
"destination": "string",
"sha256Checksum": "string",
"sourceUri": "string",
"type": "File"
}
W przypadku programu PowerShellużyj:
{
"inline": [ "string" ],
"runAsSystem": "bool",
"runElevated": "bool",
"scriptUri": "string",
"sha256Checksum": "string",
"type": "PowerShell",
"validExitCodes": [ "int" ]
}
W przypadku usługi Shellużyj:
{
"inline": [ "string" ],
"scriptUri": "string",
"sha256Checksum": "string",
"type": "Shell"
}
W przypadku WindowsRestart użyj:
{
"restartCheckCommand": "string",
"restartCommand": "string",
"restartTimeout": "string",
"type": "WindowsRestart"
}
W przypadku windowsUpdateużyj:
{
"filters": [ "string" ],
"searchCriteria": "string",
"type": "WindowsUpdate",
"updateLimit": "int"
}
Obiekty ImageTemplateInVMValidator
Ustaw właściwość , aby określić typ obiektu.
W przypadkuplików
{
"destination": "string",
"sha256Checksum": "string",
"sourceUri": "string",
"type": "File"
}
W przypadku programu PowerShellużyj:
{
"inline": [ "string" ],
"runAsSystem": "bool",
"runElevated": "bool",
"scriptUri": "string",
"sha256Checksum": "string",
"type": "PowerShell",
"validExitCodes": [ "int" ]
}
W przypadku usługi Shellużyj:
{
"inline": [ "string" ],
"scriptUri": "string",
"sha256Checksum": "string",
"type": "Shell"
}
Obiekty ImageTemplateSource
Ustaw właściwość , aby określić typ obiektu.
W przypadku ManagedImageużyj:
{
"imageId": "string",
"type": "ManagedImage"
}
W przypadku PlatformImageużyj:
{
"offer": "string",
"planInfo": {
"planName": "string",
"planProduct": "string",
"planPublisher": "string"
},
"publisher": "string",
"sku": "string",
"type": "PlatformImage",
"version": "string"
}
W przypadku SharedImageVersionużyj:
{
"imageVersionId": "string",
"type": "SharedImageVersion"
}
Wartości właściwości
DistributeVersioner
Nazwa | Opis | Wartość |
---|---|---|
plan | Ustaw wartość "Latest" dla typu DistributeVersionerLatest. Ustaw wartość "Źródło" dla typu DistributeVersionerSource. | "Najnowsze" "Źródło" (wymagane) |
DistributeVersionerLatest
Nazwa | Opis | Wartość |
---|---|---|
major | 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. | Int Ograniczenia: Minimalna wartość = -1 |
plan | Schemat numerowania wersji do użycia. | "Latest" (wymagane) |
DistributeVersionerSource
Nazwa | Opis | Wartość |
---|---|---|
plan | Schemat numerowania wersji do użycia. | "Źródło" (wymagane) |
ImageTemplateAutoRun
Nazwa | Opis | Wartość |
---|---|---|
stan | Włączenie tego pola spowoduje wyzwolenie automatycznej kompilacji podczas tworzenia lub aktualizowania szablonu obrazu. | "Wyłączone" "Włączone" |
ImageTemplateCustomizer
Nazwa | Opis | Wartość |
---|---|---|
nazwa | Przyjazna nazwa, aby podać kontekst tego kroku dostosowywania | struna |
typ | Ustaw wartość "Plik" dla typu ImageTemplateFileCustomizer. Ustaw wartość "PowerShell" dla typu ImageTemplatePowerShellCustomizer. Ustaw wartość "Shell" dla typu ImageTemplateShellCustomizer. Ustaw wartość "WindowsRestart" dla typu ImageTemplateRestartCustomizer. Ustaw wartość "WindowsUpdate" dla typu ImageTemplateWindowsUpdateCustomizer. | "Plik" "PowerShell" "Powłoka" "WindowsRestart" "WindowsUpdate" (wymagane) |
ImageTemplateDistributor
Nazwa | Opis | Wartość |
---|---|---|
artifactTags | Tagi, które zostaną zastosowane do artefaktu po jego utworzeniu/zaktualizowaniu przez dystrybutora. | ImageTemplateDistributorArtifactTags |
runOutputName | Nazwa, która ma być używana dla skojarzonego elementu RunOutput. | struna Ograniczenia: Wzorzec = ^[A-Za-z0-9-_.]{1,64}$ (wymagane) |
typ | Ustaw wartość "ManagedImage" dla typu ImageTemplateManagedImageDistributor. Ustaw wartość "SharedImage" dla typu ImageTemplateSharedImageDistributor. Ustaw wartość "VHD" dla typu ImageTemplateVhdDistributor. | "ManagedImage" "SharedImage" "VHD" (wymagany) |
ImageTemplateDistributorArtifactTags
Nazwa | Opis | Wartość |
---|
ImageTemplateFileCustomizer
Nazwa | Opis | Wartość |
---|---|---|
cel | Ś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 | struna |
sha256Checksum | Sha256 suma kontrolna pliku podanego w polu sourceUri powyżej | struna |
sourceUri | 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. | struna |
typ | Typ narzędzia dostosowywania, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być konfiguratorem powłoki | "Plik" (wymagany) |
ImageTemplateFileValidator
Nazwa | Opis | Wartość |
---|---|---|
cel | Ś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 | struna |
sha256Checksum | Sha256 suma kontrolna pliku podanego w polu sourceUri powyżej | struna |
sourceUri | 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. | struna |
typ | Typ weryfikacji, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być walidacją powłoki | "Plik" (wymagany) |
ImageTemplateIdentity
Nazwa | Opis | Wartość |
---|---|---|
typ | Typ tożsamości używany dla szablonu obrazu. Typ "None" usunie wszystkie tożsamości z szablonu obrazu. | "Brak" "UserAssigned" |
userAssignedIdentities | 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. | UserAssignedIdentities |
ImageTemplateInVMValidator
Nazwa | Opis | Wartość |
---|---|---|
nazwa | Przyjazna nazwa, aby podać kontekst tego kroku weryfikacji | struna |
typ | Ustaw wartość "File" dla typu ImageTemplateFileValidator. Ustaw wartość "PowerShell" dla typu ImageTemplatePowerShellValidator. Ustaw wartość "Shell" dla typu ImageTemplateShellValidator. | "Plik" "PowerShell" "Shell" (wymagane) |
ImageTemplateManagedImageDistributor
Nazwa | Opis | Wartość |
---|---|---|
imageId | Identyfikator zasobu obrazu dysku zarządzanego | ciąg (wymagany) |
lokalizacja | Lokalizacja platformy Azure dla obrazu powinna być zgodna z tym, czy obraz już istnieje | ciąg (wymagany) |
typ | Typ rozkładu. | "ManagedImage" (wymagane) |
ImageTemplateManagedImageSource
Nazwa | Opis | Wartość |
---|---|---|
imageId | Identyfikator zasobu usługi ARM obrazu zarządzanego w subskrypcji klienta | ciąg (wymagany) |
typ | Określa typ obrazu źródłowego, z którym chcesz zacząć. | "ManagedImage" (wymagane) |
ImageTemplatePlatformImageSource
Nazwa | Opis | Wartość |
---|---|---|
oferta | Oferta obrazu z Azure Gallery Images. | struna |
planInfo | Opcjonalna konfiguracja planu zakupu dla obrazu platformy. | PlatformImagePurchasePlan |
wydawca | Program Image Publisher w usłudze Azure Gallery Images. | struna |
Numer jednostki magazynowej | Jednostka SKU obrazu z Obrazów z galerii platformy Azure. | struna |
typ | Określa typ obrazu źródłowego, z którym chcesz zacząć. | "PlatformImage" (wymagane) |
Wersja | 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. | struna |
ImageTemplatePowerShellCustomizer
Nazwa | Opis | Wartość |
---|---|---|
Wbudowany | Tablica poleceń programu PowerShell do wykonania | string[] |
runAsSystem | 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. | Bool |
runElevated | Jeśli zostanie określony, skrypt programu PowerShell zostanie uruchomiony z podwyższonym poziomem uprawnień | Bool |
scriptUri | 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. | struna |
sha256Checksum | Suma kontrolna SHA256 skryptu powłoki power shell podana w polu scriptUri powyżej | struna |
typ | Typ narzędzia dostosowywania, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być konfiguratorem powłoki | "PowerShell" (wymagany) |
validExitCodes | Prawidłowe kody zakończenia skryptu programu PowerShell. [Wartość domyślna: 0] | int[] |
ImageTemplatePowerShellValidator
Nazwa | Opis | Wartość |
---|---|---|
Wbudowany | Tablica poleceń programu PowerShell do wykonania | string[] |
runAsSystem | 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. | Bool |
runElevated | Jeśli zostanie określony, skrypt programu PowerShell zostanie uruchomiony z podwyższonym poziomem uprawnień | Bool |
scriptUri | 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. | struna |
sha256Checksum | Suma kontrolna SHA256 skryptu powłoki power shell podana w polu scriptUri powyżej | struna |
typ | Typ weryfikacji, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być walidacją powłoki | "PowerShell" (wymagany) |
validExitCodes | Prawidłowe kody zakończenia skryptu programu PowerShell. [Wartość domyślna: 0] | int[] |
ImageTemplateProperties
Nazwa | Opis | Wartość |
---|---|---|
autoUruchomienie | Wskazuje, czy szablon obrazu ma być uruchamiany automatycznie podczas tworzenia lub aktualizowania szablonu. | ImageTemplateAutoRun |
buildTimeoutInMinutes | 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). | Int Ograniczenia: Minimalna wartość = 0 Wartość maksymalna = 960 |
Dostosuj | Określa właściwości używane do opisywania kroków dostosowywania obrazu, takich jak źródło obrazu itp. | ImageTemplateCustomizer[] |
rozdzielać | Lokalizacja docelowa dystrybucji, do której należy przejść dane wyjściowe obrazu. | ImageTemplateDistributor[] (wymagane) |
errorHandling | Opcje obsługi błędów po niepowodzeniu kompilacji | ImageTemplatePropertiesErrorHandling |
managedResourceTags | Tagi, które zostaną zastosowane do grupy zasobów i/lub zasobów utworzonych przez usługę. | ImageTemplatePropertiesManagedResourceTags |
optymalizować | Określa optymalizację do wykonania na obrazie. | ImageTemplatePropertiesOptimize |
źródło | Określa właściwości używane do opisywania obrazu źródłowego. | ImageTemplateSource (wymagane) |
stagingResourceGroup | 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. | struna |
walidować | Opcje konfiguracji i lista weryfikacji, które mają zostać wykonane na obrazie wynikowym. | ImageTemplatePropertiesValidate |
vmProfile | Opisuje sposób konfigurowania maszyny wirtualnej do kompilowania obrazów | ImageTemplateVmProfile |
ImageTemplatePropertiesErrorHandling
Nazwa | Opis | Wartość |
---|---|---|
onCustomizerError | Jeśli wystąpi błąd konfiguratora i to pole jest ustawione na "oczyszczanie", skompilowana maszyna wirtualna i skojarzone zasoby sieciowe zostaną wyczyszczone. Jest to zachowanie domyślne. Jeśli wystąpi błąd konfiguratora i to pole jest ustawione na "przerwanie", maszyna wirtualna kompilacji zostanie zachowana. | "przerwij" "Oczyszczanie" |
onValidationError | Jeśli wystąpi błąd weryfikacji i to pole jest ustawione na "oczyszczanie", skompilowana maszyna wirtualna i skojarzone zasoby sieciowe zostaną wyczyszczone. Jest to zachowanie domyślne. Jeśli wystąpi błąd weryfikacji i to pole jest ustawione na "przerwanie", maszyna wirtualna kompilacji zostanie zachowana. | "przerwij" "Oczyszczanie" |
ImageTemplatePropertiesManagedResourceTags
Nazwa | Opis | Wartość |
---|
ImageTemplatePropertiesOptimize
Nazwa | Opis | Wartość |
---|---|---|
vmBoot | Optymalizacja jest stosowana na obrazie w celu szybszego rozruchu maszyny wirtualnej. | ImageTemplatePropertiesOptimizeVmBoot |
ImageTemplatePropertiesOptimizeVmBoot
Nazwa | Opis | Wartość |
---|---|---|
stan | Włączenie tego pola poprawi czas rozruchu maszyny wirtualnej, optymalizując ostateczne dostosowane dane wyjściowe obrazu. | "Wyłączone" "Włączone" |
ImageTemplatePropertiesValidate
Nazwa | Opis | Wartość |
---|---|---|
continueDistributeOnFailure | 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.] | Bool |
inVMValidations | Lista walidacji do wykonania. | ImageTemplateInVMValidator[] |
sourceValidationOnly | 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. | Bool |
ImageTemplateRestartCustomizer
Nazwa | Opis | Wartość |
---|---|---|
restartCheckCommand | Polecenie sprawdzania, czy ponowne uruchomienie zakończyło się pomyślnie [Ustawienie domyślne: ""] | struna |
restartCommand | Polecenie do wykonania ponownego uruchomienia [Domyślne: "shutdown /r /f /t 0 /c "packer restart"] | struna |
restartTimeout | 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"] | struna |
typ | Typ narzędzia dostosowywania, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być konfiguratorem powłoki | "WindowsRestart" (wymagany) |
ImageTemplateSharedImageDistributor
Nazwa | Opis | Wartość |
---|---|---|
excludeFromLatest | Flaga wskazująca, czy utworzona wersja obrazu powinna zostać wykluczona z najnowszej wersji. Pomiń użycie wartości domyślnej (false). | Bool |
galleryImageId | Identyfikator zasobu obrazu galerii obliczeniowej platformy Azure | ciąg (wymagany) |
replicationRegions | [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. | string[] |
storageAccountType | [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. | "Premium_LRS" "Standard_LRS" "Standard_ZRS" |
targetRegions | 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. | TargetRegion[] |
typ | Typ rozkładu. | "SharedImage" (wymagane) |
przechowywanie wersji | Opisuje sposób generowania nowego numeru wersji x.y.z dla dystrybucji. | |
ImageTemplateSharedImageVersionSource
Nazwa | Opis | Wartość |
---|---|---|
imageVersionId | Identyfikator zasobu usługi ARM wersji obrazu. Gdy nazwa wersji obrazu to "latest", wersja jest oceniana podczas kompilacji obrazu. | ciąg (wymagany) |
typ | Określa typ obrazu źródłowego, z którym chcesz zacząć. | "SharedImageVersion" (wymagane) |
ImageTemplateShellCustomizer
Nazwa | Opis | Wartość |
---|---|---|
Wbudowany | Tablica poleceń powłoki do wykonania | string[] |
scriptUri | 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. | struna |
sha256Checksum | Suma kontrolna SHA256 skryptu powłoki podana w polu scriptUri | struna |
typ | Typ narzędzia dostosowywania, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być konfiguratorem powłoki | "Shell" (wymagane) |
ImageTemplateShellValidator
Nazwa | Opis | Wartość |
---|---|---|
Wbudowany | Tablica poleceń powłoki do wykonania | string[] |
scriptUri | 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. | struna |
sha256Checksum | Suma kontrolna SHA256 skryptu powłoki podana w polu scriptUri | struna |
typ | Typ weryfikacji, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być walidacją powłoki | "Shell" (wymagane) |
ImageTemplateSource
Nazwa | Opis | Wartość |
---|---|---|
typ | Ustaw wartość "ManagedImage" dla typu ImageTemplateManagedImageSource. Ustaw wartość "PlatformImage" dla typu ImageTemplatePlatformImageSource. Ustaw wartość "SharedImageVersion" dla typu ImageTemplateSharedImageVersionSource. | "ManagedImage" "PlatformImage" "SharedImageVersion" (wymagane) |
ImageTemplateVhdDistributor
Nazwa | Opis | Wartość |
---|---|---|
typ | Typ rozkładu. | "VHD" (wymagany) |
Uri | 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. | struna |
ImageTemplateVmProfile
Nazwa | Opis | Wartość |
---|---|---|
osDiskSizeGB | Rozmiar dysku systemu operacyjnego w GB. Pomiń lub określ wartość 0, aby użyć domyślnego rozmiaru dysku systemu operacyjnego platformy Azure. | Int Ograniczenia: Minimalna wartość = 0 |
userAssignedIdentities | 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. | string[] |
vmSize | 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). | struna |
vnetConfig | 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. | VirtualNetworkConfig |
ImageTemplateWindowsUpdateCustomizer
Nazwa | Opis | Wartość |
---|---|---|
Filtry | 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. | string[] |
searchCriteria | 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. | struna |
typ | Typ narzędzia dostosowywania, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być konfiguratorem powłoki | "WindowsUpdate" (wymagane) |
updateLimit | Maksymalna liczba aktualizacji do zastosowania w danym momencie. Pomiń lub określ wartość 0, aby użyć wartości domyślnej (1000) | Int Ograniczenia: Minimalna wartość = 0 |
Microsoft.VirtualMachineImages/imageTemplates
Nazwa | Opis | Wartość |
---|---|---|
apiVersion | Wersja interfejsu API | '2024-02-01' |
tożsamość | Tożsamość szablonu obrazu, jeśli jest skonfigurowana. | ImageTemplateIdentity (wymagane) |
lokalizacja | Lokalizacja geograficzna, w której znajduje się zasób | ciąg (wymagany) |
nazwa | Nazwa zasobu | struna Ograniczenia: Wzorzec = ^[A-Za-z0-9-_.]{1,64}$ (wymagane) |
Właściwości | Właściwości szablonu obrazu | ImageTemplateProperties |
Tagi | Tagi zasobów | Słownik nazw tagów i wartości. Zobacz tagi w szablonach |
typ | Typ zasobu | "Microsoft.VirtualMachineImages/imageTemplates" |
PlatformImagePurchasePlan
Nazwa | Opis | Wartość |
---|---|---|
planName | Nazwa planu zakupu. | ciąg (wymagany) |
planProduct | Produkt planu zakupu. | ciąg (wymagany) |
planPublisher | Wydawca planu zakupu. | ciąg (wymagany) |
TargetRegion
Nazwa | Opis | Wartość |
---|---|---|
nazwa | Nazwa regionu. | ciąg (wymagany) |
replicaCount | Liczba replik wersji obrazu do utworzenia w tym regionie. Pomiń użycie wartości domyślnej (1). | Int Ograniczenia: Minimalna wartość = 1 |
storageAccountType | 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). | "Premium_LRS" "Standard_LRS" "Standard_ZRS" |
TrackedResourceTags
Nazwa | Opis | Wartość |
---|
UserAssignedIdentities
Nazwa | Opis | Wartość |
---|
UserAssignedIdentity
Nazwa | Opis | Wartość |
---|
VirtualNetworkConfig
Nazwa | Opis | Wartość |
---|---|---|
containerInstanceSubnetId | Identyfikator zasobu istniejącej podsieci, w której zostanie wdrożone wystąpienie kontenera platformy Azure dla izolowanych kompilacji. To pole może być określone tylko wtedy, gdy określono subnetId i musi znajdować się w tej samej sieci wirtualnej co podsieć określona w subnetId . |
struna |
proxyVmSize | Rozmiar maszyny wirtualnej serwera proxy używanej do przekazywania ruchu do maszyny wirtualnej kompilacji i maszyny wirtualnej weryfikacji. Nie można tego określić, jeśli określono containerInstanceSubnetId , ponieważ w takim przypadku nie wdrożono żadnej maszyny wirtualnej serwera proxy. Pomiń lub określ pusty ciąg, aby użyć wartości domyślnej (Standard_A1_v2). |
struna |
subnetId | Identyfikator zasobu istniejącej podsieci, w której zostanie wdrożona maszyna wirtualna kompilacji i maszyna wirtualna sprawdzania poprawności | struna |
Szablony szybkiego startu
Następujące szablony szybkiego startu wdrażają ten typ zasobu.
Szablon | Opis |
---|---|
Azure Image Builder z programem Azure Windows Baseline wdrażanie |
Tworzy środowisko narzędzia Azure Image Builder i tworzy obraz systemu Windows Server z zastosowanymi najnowszymi aktualizacjami systemu Windows i punktem odniesienia platformy Azure. |
Konfigurowanie usługi Dev Box wdrażanie |
Ten szablon umożliwia utworzenie wszystkich zasobów administracyjnych usługi Dev Box zgodnie z przewodnikiem Szybki start dotyczącym usługi Dev Box (/azure/dev-box/quickstart-create-dev-box). Możesz wyświetlić wszystkie utworzone zasoby lub bezpośrednio przejść do DevPortal.microsoft.com, aby utworzyć pierwsze rozwiązanie Dev Box. |
Definicja zasobu narzędzia Terraform (dostawcy AzAPI)
Typ zasobu imageTemplates można wdrożyć przy użyciu operacji docelowych:
- grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.
Format zasobu
Aby utworzyć zasób Microsoft.VirtualMachineImages/imageTemplates, dodaj następujący program Terraform do szablonu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.VirtualMachineImages/imageTemplates@2024-02-01"
name = "string"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
autoRun = {
state = "string"
}
buildTimeoutInMinutes = int
customize = [
{
name = "string"
type = "string"
// For remaining properties, see ImageTemplateCustomizer objects
}
]
distribute = [
{
artifactTags = {
{customized property} = "string"
}
runOutputName = "string"
type = "string"
// For remaining properties, see ImageTemplateDistributor objects
}
]
errorHandling = {
onCustomizerError = "string"
onValidationError = "string"
}
managedResourceTags = {
{customized property} = "string"
}
optimize = {
vmBoot = {
state = "string"
}
}
source = {
type = "string"
// For remaining properties, see ImageTemplateSource objects
}
stagingResourceGroup = "string"
validate = {
continueDistributeOnFailure = bool
inVMValidations = [
{
name = "string"
type = "string"
// For remaining properties, see ImageTemplateInVMValidator objects
}
]
sourceValidationOnly = bool
}
vmProfile = {
osDiskSizeGB = int
userAssignedIdentities = [
"string"
]
vmSize = "string"
vnetConfig = {
containerInstanceSubnetId = "string"
proxyVmSize = "string"
subnetId = "string"
}
}
}
})
}
Obiekty ImageTemplateDistributor
Ustaw właściwość , aby określić typ obiektu.
W przypadku ManagedImageużyj:
{
imageId = "string"
location = "string"
type = "ManagedImage"
}
W przypadku SharedImageużyj:
{
excludeFromLatest = bool
galleryImageId = "string"
replicationRegions = [
"string"
]
storageAccountType = "string"
targetRegions = [
{
name = "string"
replicaCount = int
storageAccountType = "string"
}
]
type = "SharedImage"
versioning = {
scheme = "string"
// For remaining properties, see DistributeVersioner objects
}
}
W przypadkuwirtualnego dysku twardego
{
type = "VHD"
uri = "string"
}
Obiekty DistributeVersioner
Ustaw właściwość schematu, aby określić typ obiektu.
W przypadku najnowszejużyj:
{
major = int
scheme = "Latest"
}
W przypadku source użyj:
{
scheme = "Source"
}
Obiekty ImageTemplateCustomizer
Ustaw właściwość , aby określić typ obiektu.
W przypadkuplików
{
destination = "string"
sha256Checksum = "string"
sourceUri = "string"
type = "File"
}
W przypadku programu PowerShellużyj:
{
inline = [
"string"
]
runAsSystem = bool
runElevated = bool
scriptUri = "string"
sha256Checksum = "string"
type = "PowerShell"
validExitCodes = [
int
]
}
W przypadku usługi Shellużyj:
{
inline = [
"string"
]
scriptUri = "string"
sha256Checksum = "string"
type = "Shell"
}
W przypadku WindowsRestart użyj:
{
restartCheckCommand = "string"
restartCommand = "string"
restartTimeout = "string"
type = "WindowsRestart"
}
W przypadku windowsUpdateużyj:
{
filters = [
"string"
]
searchCriteria = "string"
type = "WindowsUpdate"
updateLimit = int
}
Obiekty ImageTemplateInVMValidator
Ustaw właściwość , aby określić typ obiektu.
W przypadkuplików
{
destination = "string"
sha256Checksum = "string"
sourceUri = "string"
type = "File"
}
W przypadku programu PowerShellużyj:
{
inline = [
"string"
]
runAsSystem = bool
runElevated = bool
scriptUri = "string"
sha256Checksum = "string"
type = "PowerShell"
validExitCodes = [
int
]
}
W przypadku usługi Shellużyj:
{
inline = [
"string"
]
scriptUri = "string"
sha256Checksum = "string"
type = "Shell"
}
Obiekty ImageTemplateSource
Ustaw właściwość , aby określić typ obiektu.
W przypadku ManagedImageużyj:
{
imageId = "string"
type = "ManagedImage"
}
W przypadku PlatformImageużyj:
{
offer = "string"
planInfo = {
planName = "string"
planProduct = "string"
planPublisher = "string"
}
publisher = "string"
sku = "string"
type = "PlatformImage"
version = "string"
}
W przypadku SharedImageVersionużyj:
{
imageVersionId = "string"
type = "SharedImageVersion"
}
Wartości właściwości
DistributeVersioner
Nazwa | Opis | Wartość |
---|---|---|
plan | Ustaw wartość "Latest" dla typu DistributeVersionerLatest. Ustaw wartość "Źródło" dla typu DistributeVersionerSource. | "Najnowsze" "Źródło" (wymagane) |
DistributeVersionerLatest
Nazwa | Opis | Wartość |
---|---|---|
major | 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. | Int Ograniczenia: Minimalna wartość = -1 |
plan | Schemat numerowania wersji do użycia. | "Latest" (wymagane) |
DistributeVersionerSource
Nazwa | Opis | Wartość |
---|---|---|
plan | Schemat numerowania wersji do użycia. | "Źródło" (wymagane) |
ImageTemplateAutoRun
Nazwa | Opis | Wartość |
---|---|---|
stan | Włączenie tego pola spowoduje wyzwolenie automatycznej kompilacji podczas tworzenia lub aktualizowania szablonu obrazu. | "Wyłączone" "Włączone" |
ImageTemplateCustomizer
Nazwa | Opis | Wartość |
---|---|---|
nazwa | Przyjazna nazwa, aby podać kontekst tego kroku dostosowywania | struna |
typ | Ustaw wartość "Plik" dla typu ImageTemplateFileCustomizer. Ustaw wartość "PowerShell" dla typu ImageTemplatePowerShellCustomizer. Ustaw wartość "Shell" dla typu ImageTemplateShellCustomizer. Ustaw wartość "WindowsRestart" dla typu ImageTemplateRestartCustomizer. Ustaw wartość "WindowsUpdate" dla typu ImageTemplateWindowsUpdateCustomizer. | "Plik" "PowerShell" "Powłoka" "WindowsRestart" "WindowsUpdate" (wymagane) |
ImageTemplateDistributor
Nazwa | Opis | Wartość |
---|---|---|
artifactTags | Tagi, które zostaną zastosowane do artefaktu po jego utworzeniu/zaktualizowaniu przez dystrybutora. | ImageTemplateDistributorArtifactTags |
runOutputName | Nazwa, która ma być używana dla skojarzonego elementu RunOutput. | struna Ograniczenia: Wzorzec = ^[A-Za-z0-9-_.]{1,64}$ (wymagane) |
typ | Ustaw wartość "ManagedImage" dla typu ImageTemplateManagedImageDistributor. Ustaw wartość "SharedImage" dla typu ImageTemplateSharedImageDistributor. Ustaw wartość "VHD" dla typu ImageTemplateVhdDistributor. | "ManagedImage" "SharedImage" "VHD" (wymagany) |
ImageTemplateDistributorArtifactTags
Nazwa | Opis | Wartość |
---|
ImageTemplateFileCustomizer
Nazwa | Opis | Wartość |
---|---|---|
cel | Ś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 | struna |
sha256Checksum | Sha256 suma kontrolna pliku podanego w polu sourceUri powyżej | struna |
sourceUri | 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. | struna |
typ | Typ narzędzia dostosowywania, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być konfiguratorem powłoki | "Plik" (wymagany) |
ImageTemplateFileValidator
Nazwa | Opis | Wartość |
---|---|---|
cel | Ś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 | struna |
sha256Checksum | Sha256 suma kontrolna pliku podanego w polu sourceUri powyżej | struna |
sourceUri | 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. | struna |
typ | Typ weryfikacji, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być walidacją powłoki | "Plik" (wymagany) |
ImageTemplateIdentity
Nazwa | Opis | Wartość |
---|---|---|
typ | Typ tożsamości używany dla szablonu obrazu. Typ "None" usunie wszystkie tożsamości z szablonu obrazu. | "Brak" "UserAssigned" |
userAssignedIdentities | 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. | UserAssignedIdentities |
ImageTemplateInVMValidator
Nazwa | Opis | Wartość |
---|---|---|
nazwa | Przyjazna nazwa, aby podać kontekst tego kroku weryfikacji | struna |
typ | Ustaw wartość "File" dla typu ImageTemplateFileValidator. Ustaw wartość "PowerShell" dla typu ImageTemplatePowerShellValidator. Ustaw wartość "Shell" dla typu ImageTemplateShellValidator. | "Plik" "PowerShell" "Shell" (wymagane) |
ImageTemplateManagedImageDistributor
Nazwa | Opis | Wartość |
---|---|---|
imageId | Identyfikator zasobu obrazu dysku zarządzanego | ciąg (wymagany) |
lokalizacja | Lokalizacja platformy Azure dla obrazu powinna być zgodna z tym, czy obraz już istnieje | ciąg (wymagany) |
typ | Typ rozkładu. | "ManagedImage" (wymagane) |
ImageTemplateManagedImageSource
Nazwa | Opis | Wartość |
---|---|---|
imageId | Identyfikator zasobu usługi ARM obrazu zarządzanego w subskrypcji klienta | ciąg (wymagany) |
typ | Określa typ obrazu źródłowego, z którym chcesz zacząć. | "ManagedImage" (wymagane) |
ImageTemplatePlatformImageSource
Nazwa | Opis | Wartość |
---|---|---|
oferta | Oferta obrazu z Azure Gallery Images. | struna |
planInfo | Opcjonalna konfiguracja planu zakupu dla obrazu platformy. | PlatformImagePurchasePlan |
wydawca | Program Image Publisher w usłudze Azure Gallery Images. | struna |
Numer jednostki magazynowej | Jednostka SKU obrazu z Obrazów z galerii platformy Azure. | struna |
typ | Określa typ obrazu źródłowego, z którym chcesz zacząć. | "PlatformImage" (wymagane) |
Wersja | 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. | struna |
ImageTemplatePowerShellCustomizer
Nazwa | Opis | Wartość |
---|---|---|
Wbudowany | Tablica poleceń programu PowerShell do wykonania | string[] |
runAsSystem | 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. | Bool |
runElevated | Jeśli zostanie określony, skrypt programu PowerShell zostanie uruchomiony z podwyższonym poziomem uprawnień | Bool |
scriptUri | 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. | struna |
sha256Checksum | Suma kontrolna SHA256 skryptu powłoki power shell podana w polu scriptUri powyżej | struna |
typ | Typ narzędzia dostosowywania, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być konfiguratorem powłoki | "PowerShell" (wymagany) |
validExitCodes | Prawidłowe kody zakończenia skryptu programu PowerShell. [Wartość domyślna: 0] | int[] |
ImageTemplatePowerShellValidator
Nazwa | Opis | Wartość |
---|---|---|
Wbudowany | Tablica poleceń programu PowerShell do wykonania | string[] |
runAsSystem | 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. | Bool |
runElevated | Jeśli zostanie określony, skrypt programu PowerShell zostanie uruchomiony z podwyższonym poziomem uprawnień | Bool |
scriptUri | 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. | struna |
sha256Checksum | Suma kontrolna SHA256 skryptu powłoki power shell podana w polu scriptUri powyżej | struna |
typ | Typ weryfikacji, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być walidacją powłoki | "PowerShell" (wymagany) |
validExitCodes | Prawidłowe kody zakończenia skryptu programu PowerShell. [Wartość domyślna: 0] | int[] |
ImageTemplateProperties
Nazwa | Opis | Wartość |
---|---|---|
autoUruchomienie | Wskazuje, czy szablon obrazu ma być uruchamiany automatycznie podczas tworzenia lub aktualizowania szablonu. | ImageTemplateAutoRun |
buildTimeoutInMinutes | 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). | Int Ograniczenia: Minimalna wartość = 0 Wartość maksymalna = 960 |
Dostosuj | Określa właściwości używane do opisywania kroków dostosowywania obrazu, takich jak źródło obrazu itp. | ImageTemplateCustomizer[] |
rozdzielać | Lokalizacja docelowa dystrybucji, do której należy przejść dane wyjściowe obrazu. | ImageTemplateDistributor[] (wymagane) |
errorHandling | Opcje obsługi błędów po niepowodzeniu kompilacji | ImageTemplatePropertiesErrorHandling |
managedResourceTags | Tagi, które zostaną zastosowane do grupy zasobów i/lub zasobów utworzonych przez usługę. | ImageTemplatePropertiesManagedResourceTags |
optymalizować | Określa optymalizację do wykonania na obrazie. | ImageTemplatePropertiesOptimize |
źródło | Określa właściwości używane do opisywania obrazu źródłowego. | ImageTemplateSource (wymagane) |
stagingResourceGroup | 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. | struna |
walidować | Opcje konfiguracji i lista weryfikacji, które mają zostać wykonane na obrazie wynikowym. | ImageTemplatePropertiesValidate |
vmProfile | Opisuje sposób konfigurowania maszyny wirtualnej do kompilowania obrazów | ImageTemplateVmProfile |
ImageTemplatePropertiesErrorHandling
Nazwa | Opis | Wartość |
---|---|---|
onCustomizerError | Jeśli wystąpi błąd konfiguratora i to pole jest ustawione na "oczyszczanie", skompilowana maszyna wirtualna i skojarzone zasoby sieciowe zostaną wyczyszczone. Jest to zachowanie domyślne. Jeśli wystąpi błąd konfiguratora i to pole jest ustawione na "przerwanie", maszyna wirtualna kompilacji zostanie zachowana. | "przerwij" "Oczyszczanie" |
onValidationError | Jeśli wystąpi błąd weryfikacji i to pole jest ustawione na "oczyszczanie", skompilowana maszyna wirtualna i skojarzone zasoby sieciowe zostaną wyczyszczone. Jest to zachowanie domyślne. Jeśli wystąpi błąd weryfikacji i to pole jest ustawione na "przerwanie", maszyna wirtualna kompilacji zostanie zachowana. | "przerwij" "Oczyszczanie" |
ImageTemplatePropertiesManagedResourceTags
Nazwa | Opis | Wartość |
---|
ImageTemplatePropertiesOptimize
Nazwa | Opis | Wartość |
---|---|---|
vmBoot | Optymalizacja jest stosowana na obrazie w celu szybszego rozruchu maszyny wirtualnej. | ImageTemplatePropertiesOptimizeVmBoot |
ImageTemplatePropertiesOptimizeVmBoot
Nazwa | Opis | Wartość |
---|---|---|
stan | Włączenie tego pola poprawi czas rozruchu maszyny wirtualnej, optymalizując ostateczne dostosowane dane wyjściowe obrazu. | "Wyłączone" "Włączone" |
ImageTemplatePropertiesValidate
Nazwa | Opis | Wartość |
---|---|---|
continueDistributeOnFailure | 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.] | Bool |
inVMValidations | Lista walidacji do wykonania. | ImageTemplateInVMValidator[] |
sourceValidationOnly | 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. | Bool |
ImageTemplateRestartCustomizer
Nazwa | Opis | Wartość |
---|---|---|
restartCheckCommand | Polecenie sprawdzania, czy ponowne uruchomienie zakończyło się pomyślnie [Ustawienie domyślne: ""] | struna |
restartCommand | Polecenie do wykonania ponownego uruchomienia [Domyślne: "shutdown /r /f /t 0 /c "packer restart"] | struna |
restartTimeout | 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"] | struna |
typ | Typ narzędzia dostosowywania, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być konfiguratorem powłoki | "WindowsRestart" (wymagany) |
ImageTemplateSharedImageDistributor
Nazwa | Opis | Wartość |
---|---|---|
excludeFromLatest | Flaga wskazująca, czy utworzona wersja obrazu powinna zostać wykluczona z najnowszej wersji. Pomiń użycie wartości domyślnej (false). | Bool |
galleryImageId | Identyfikator zasobu obrazu galerii obliczeniowej platformy Azure | ciąg (wymagany) |
replicationRegions | [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. | string[] |
storageAccountType | [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. | "Premium_LRS" "Standard_LRS" "Standard_ZRS" |
targetRegions | 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. | TargetRegion[] |
typ | Typ rozkładu. | "SharedImage" (wymagane) |
przechowywanie wersji | Opisuje sposób generowania nowego numeru wersji x.y.z dla dystrybucji. | |
ImageTemplateSharedImageVersionSource
Nazwa | Opis | Wartość |
---|---|---|
imageVersionId | Identyfikator zasobu usługi ARM wersji obrazu. Gdy nazwa wersji obrazu to "latest", wersja jest oceniana podczas kompilacji obrazu. | ciąg (wymagany) |
typ | Określa typ obrazu źródłowego, z którym chcesz zacząć. | "SharedImageVersion" (wymagane) |
ImageTemplateShellCustomizer
Nazwa | Opis | Wartość |
---|---|---|
Wbudowany | Tablica poleceń powłoki do wykonania | string[] |
scriptUri | 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. | struna |
sha256Checksum | Suma kontrolna SHA256 skryptu powłoki podana w polu scriptUri | struna |
typ | Typ narzędzia dostosowywania, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być konfiguratorem powłoki | "Shell" (wymagane) |
ImageTemplateShellValidator
Nazwa | Opis | Wartość |
---|---|---|
Wbudowany | Tablica poleceń powłoki do wykonania | string[] |
scriptUri | 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. | struna |
sha256Checksum | Suma kontrolna SHA256 skryptu powłoki podana w polu scriptUri | struna |
typ | Typ weryfikacji, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być walidacją powłoki | "Shell" (wymagane) |
ImageTemplateSource
Nazwa | Opis | Wartość |
---|---|---|
typ | Ustaw wartość "ManagedImage" dla typu ImageTemplateManagedImageSource. Ustaw wartość "PlatformImage" dla typu ImageTemplatePlatformImageSource. Ustaw wartość "SharedImageVersion" dla typu ImageTemplateSharedImageVersionSource. | "ManagedImage" "PlatformImage" "SharedImageVersion" (wymagane) |
ImageTemplateVhdDistributor
Nazwa | Opis | Wartość |
---|---|---|
typ | Typ rozkładu. | "VHD" (wymagany) |
Uri | 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. | struna |
ImageTemplateVmProfile
Nazwa | Opis | Wartość |
---|---|---|
osDiskSizeGB | Rozmiar dysku systemu operacyjnego w GB. Pomiń lub określ wartość 0, aby użyć domyślnego rozmiaru dysku systemu operacyjnego platformy Azure. | Int Ograniczenia: Minimalna wartość = 0 |
userAssignedIdentities | 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. | string[] |
vmSize | 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). | struna |
vnetConfig | 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. | VirtualNetworkConfig |
ImageTemplateWindowsUpdateCustomizer
Nazwa | Opis | Wartość |
---|---|---|
Filtry | 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. | string[] |
searchCriteria | 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. | struna |
typ | Typ narzędzia dostosowywania, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być konfiguratorem powłoki | "WindowsUpdate" (wymagane) |
updateLimit | Maksymalna liczba aktualizacji do zastosowania w danym momencie. Pomiń lub określ wartość 0, aby użyć wartości domyślnej (1000) | Int Ograniczenia: Minimalna wartość = 0 |
Microsoft.VirtualMachineImages/imageTemplates
Nazwa | Opis | Wartość |
---|---|---|
tożsamość | Tożsamość szablonu obrazu, jeśli jest skonfigurowana. | ImageTemplateIdentity (wymagane) |
lokalizacja | Lokalizacja geograficzna, w której znajduje się zasób | ciąg (wymagany) |
nazwa | Nazwa zasobu | struna Ograniczenia: Wzorzec = ^[A-Za-z0-9-_.]{1,64}$ (wymagane) |
Właściwości | Właściwości szablonu obrazu | ImageTemplateProperties |
Tagi | Tagi zasobów | Słownik nazw tagów i wartości. |
typ | Typ zasobu | "Microsoft.VirtualMachineImages/imageTemplates@2024-02-01" |
PlatformImagePurchasePlan
Nazwa | Opis | Wartość |
---|---|---|
planName | Nazwa planu zakupu. | ciąg (wymagany) |
planProduct | Produkt planu zakupu. | ciąg (wymagany) |
planPublisher | Wydawca planu zakupu. | ciąg (wymagany) |
TargetRegion
Nazwa | Opis | Wartość |
---|---|---|
nazwa | Nazwa regionu. | ciąg (wymagany) |
replicaCount | Liczba replik wersji obrazu do utworzenia w tym regionie. Pomiń użycie wartości domyślnej (1). | Int Ograniczenia: Minimalna wartość = 1 |
storageAccountType | 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). | "Premium_LRS" "Standard_LRS" "Standard_ZRS" |
TrackedResourceTags
Nazwa | Opis | Wartość |
---|
UserAssignedIdentities
Nazwa | Opis | Wartość |
---|
UserAssignedIdentity
Nazwa | Opis | Wartość |
---|
VirtualNetworkConfig
Nazwa | Opis | Wartość |
---|---|---|
containerInstanceSubnetId | Identyfikator zasobu istniejącej podsieci, w której zostanie wdrożone wystąpienie kontenera platformy Azure dla izolowanych kompilacji. To pole może być określone tylko wtedy, gdy określono subnetId i musi znajdować się w tej samej sieci wirtualnej co podsieć określona w subnetId . |
struna |
proxyVmSize | Rozmiar maszyny wirtualnej serwera proxy używanej do przekazywania ruchu do maszyny wirtualnej kompilacji i maszyny wirtualnej weryfikacji. Nie można tego określić, jeśli określono containerInstanceSubnetId , ponieważ w takim przypadku nie wdrożono żadnej maszyny wirtualnej serwera proxy. Pomiń lub określ pusty ciąg, aby użyć wartości domyślnej (Standard_A1_v2). |
struna |
subnetId | Identyfikator zasobu istniejącej podsieci, w której zostanie wdrożona maszyna wirtualna kompilacji i maszyna wirtualna sprawdzania poprawności | struna |