Uwaga
Dostęp do tej strony wymaga autoryzacji. Może spróbować zalogować się lub zmienić katalogi.
Dostęp do tej strony wymaga autoryzacji. Możesz spróbować zmienić katalogi.
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 dziennik zmian.
Format zasobu
Aby utworzyć zasób Microsoft.VirtualMachineImages/imageTemplates, dodaj następujący kod Bicep do szablonu.
resource symbolicname 'Microsoft.VirtualMachineImages/imageTemplates@2022-07-01' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
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
}
]
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: {
proxyVmSize: 'string'
subnetId: 'string'
}
}
}
tags: {
{customized property}: 'string'
}
}
Obiekty ImageTemplateSource
Ustaw właściwość , aby określić typ obiektu.
W przypadku funkcji ManagedImage użyj:
{
imageId: 'string'
type: 'ManagedImage'
}
W przypadku platformy PlatformImage użyj:
{
offer: 'string'
planInfo: {
planName: 'string'
planProduct: 'string'
planPublisher: 'string'
}
publisher: 'string'
sku: 'string'
type: 'PlatformImage'
version: 'string'
}
W przypadku elementu SharedImageVersion użyj:
{
imageVersionId: 'string'
type: 'SharedImageVersion'
}
Obiekty DistributeVersioner
Ustaw właściwość schematu , aby określić typ obiektu.
W przypadku najnowszej wersji użyj:
{
major: int
scheme: 'Latest'
}
W przypadku źródła 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 PowerShell użyj:
{
inline: [
'string'
]
runAsSystem: bool
runElevated: bool
scriptUri: 'string'
sha256Checksum: 'string'
type: 'PowerShell'
validExitCodes: [
int
]
}
W przypadku powłoki użyj:
{
inline: [
'string'
]
scriptUri: 'string'
sha256Checksum: 'string'
type: 'Shell'
}
W przypadku WindowsRestart użyj:
{
restartCheckCommand: 'string'
restartCommand: 'string'
restartTimeout: 'string'
type: 'WindowsRestart'
}
W przypadku programu WindowsUpdate uż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 PowerShell użyj:
{
inline: [
'string'
]
runAsSystem: bool
runElevated: bool
scriptUri: 'string'
sha256Checksum: 'string'
type: 'PowerShell'
validExitCodes: [
int
]
}
W przypadku powłoki użyj:
{
inline: [
'string'
]
scriptUri: 'string'
sha256Checksum: 'string'
type: 'Shell'
}
Obiekty ImageTemplateDistributor
Ustaw właściwość , aby określić typ obiektu.
W przypadku funkcji ManagedImage użyj:
{
imageId: 'string'
location: 'string'
type: 'ManagedImage'
}
W przypadku funkcji SharedImage uż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'
}
Wartości właściwości
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 | Właściwości ImageTemplateProperties |
Etykiety | Tagi zasobów | Słownik nazw tagów i wartości. Zobacz Tagi w szablonach |
DistributeVersioner (Dystrybucja wersji)
Nazwa | Opis | Wartość |
---|---|---|
schemat | Ustaw wartość "Latest" dla typu DistributeVersionerLatest. Ustaw wartość "Źródło" dla typu DistributeVersionerSource. | "Najnowsze" "Źródło" (wymagane) |
DistributeVersionerLatest
Nazwa | Opis | Wartość |
---|---|---|
główny | 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 |
schemat | Schemat numerowania wersji do użycia. | "Latest" (wymagane) |
DistributeVersionerSource (Źródło Dystrybucji)
Nazwa | Opis | Wartość |
---|---|---|
schemat | Schemat numerowania wersji do użycia. | "Źródło" (wymagane) |
Konfigurator szablonu obrazu
Nazwa | Opis | Wartość |
---|---|---|
nazwa | Przyjazna nazwa, aby podać kontekst tego kroku dostosowywania | ciąg |
typ | Dla typu ImageTemplateFileCustomizer ustaw wartość "Plik". 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) |
Dystrybutor szablonów obrazów
Nazwa | Opis | Wartość |
---|---|---|
artifactTags (Znaczniki artefaktu) | Tagi, które zostaną zastosowane do artefaktu po jego utworzeniu/zaktualizowaniu przez dystrybutora. | ImageTemplateDistributorArtifactTags |
runOutputName (nazwa_wyjścia) | Nazwa, która ma być używana dla skojarzonego elementu RunOutput. | struna Ograniczenia: Wzorzec = ^[A-Za-z0-9-_.]{1,64}$ (wymagane) |
typ | Dla typu ImageTemplateManagedImageDistributor ustaw wartość "ManagedImage". Dla typu ImageTemplateSharedImageDistributor ustaw wartość "SharedImage". Dla typu ImageTemplateVhdDistributor ustaw wartość "VHD". | "ManagedImage" "SharedImage" "VHD" (wymagany) |
ImageTemplateDistributorArtifactTags
Nazwa | Opis | Wartość |
---|
ImageTemplateFileCustomizer (Konfigurator Obrazu)
Nazwa | Opis | Wartość |
---|---|---|
docelowy | Ś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 | ciąg |
sha256Suma kontrolna | Sha256 suma kontrolna pliku podanego w polu sourceUri powyżej | ciąg |
sourceUri (identyfikator źródłowy) | 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. | ciąg |
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) |
Walidator plików ImageTemplateFileValidator
Nazwa | Opis | Wartość |
---|---|---|
docelowy | Ś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 | ciąg |
sha256Suma kontrolna | Sha256 suma kontrolna pliku podanego w polu sourceUri powyżej | ciąg |
sourceUri (identyfikator źródłowy) | 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. | ciąg |
typ | Typ weryfikacji, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być walidacją powłoki | "Plik" (wymagany) |
ImageTemplateIdentity (Tożsamość szablonu obrazu)
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" |
tożsamości przypisane użytkownikom | 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 | ciąg |
typ | Dla typu ImageTemplateFileValidator ustaw wartość "Plik". Ustaw wartość "PowerShell" dla typu ImageTemplatePowerShellValidator. Dla typu ImageTemplateShellValidator ustaw wartość "Shell". | "Plik" "PowerShell" "Shell" (wymagane) |
ImageTemplateManagedImageDistributor (Szablon obrazuZarządzanyDystrybutor obrazów)
Nazwa | Opis | Wartość |
---|---|---|
imageId (identyfikator obrazu) | 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 obrazu) | 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 obrazów galerii platformy Azure. | ciąg |
planInfo (informacje o planie) | Opcjonalna konfiguracja planu zakupu dla obrazu platformy. | PlatformaImagePurchasePlan |
wydawca | Program Image Publisher w usłudze Azure Gallery Images. | ciąg |
Jednostka magazynowa (SKU) | Jednostka SKU obrazu z obrazów galerii platformy Azure. | ciąg |
typ | Określa typ obrazu źródłowego, z którym chcesz zacząć. | "PlatformImage" (wymagane) |
wersja | Wersja obrazu z obrazów galerii platformy Azure. Jeśli w tym miejscu określono wartość "latest", wersja jest oceniana podczas kompilacji obrazu, a nie podczas przesyłania szablonu. | ciąg |
ImageTemplatePowerShellCustomizer
Nazwa | Opis | Wartość |
---|---|---|
śródwierszowy | Tablica poleceń programu PowerShell do wykonania | ciąg znakowy[] |
runAsSystem (Bieg Systemowy) | 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 (Podwyższony) | Jeśli zostanie określony, skrypt programu PowerShell zostanie uruchomiony z podwyższonym poziomem uprawnień | Bool |
scriptUri (identyfikator 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. | ciąg |
sha256Suma kontrolna | Suma kontrolna SHA256 skryptu powłoki power shell podana w polu scriptUri powyżej | ciąg |
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 (validKody wyjścia) | Prawidłowe kody zakończenia skryptu programu PowerShell. [Wartość domyślna: 0] | int[] |
ImageTemplatePowerShellValidator
Nazwa | Opis | Wartość |
---|---|---|
śródwierszowy | Tablica poleceń programu PowerShell do wykonania | ciąg znakowy[] |
runAsSystem (Bieg Systemowy) | 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 (Podwyższony) | Jeśli zostanie określony, skrypt programu PowerShell zostanie uruchomiony z podwyższonym poziomem uprawnień | Bool |
scriptUri (identyfikator 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. | ciąg |
sha256Suma kontrolna | Suma kontrolna SHA256 skryptu powłoki power shell podana w polu scriptUri powyżej | ciąg |
typ | Typ weryfikacji, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być walidacją powłoki | "PowerShell" (wymagany) |
validExitCodes (validKody wyjścia) | Prawidłowe kody zakończenia skryptu programu PowerShell. [Wartość domyślna: 0] | int[] |
Właściwości ImageTemplateProperties
Nazwa | Opis | Wartość |
---|---|---|
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 |
dostosowywać | Określa właściwości używane do opisywania kroków dostosowywania obrazu, takich jak źródło obrazu itp. | ImageTemplateCustomizer[] |
rozproszony | Lokalizacja docelowa dystrybucji, do której należy przejść dane wyjściowe obrazu. | ImageTemplateDistributor[] (wymagane) |
optymalizować | Określa optymalizację do wykonania na obrazie. | ImageTemplatePropertiesOptymalizuj |
przesłać ź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. | ciąg |
sprawdzać poprawność | Opcje konfiguracji i lista weryfikacji, które mają zostać wykonane na obrazie wynikowym. | ImageTemplatePropertiesValidate (Walidacja obrazu)ImageTemplatePropertiesValidate (Walidacja szablon |
Profil wirtualny | Opisuje sposób konfigurowania maszyny wirtualnej do kompilowania obrazów | ImageTemplateVmProfile |
ImageTemplatePropertiesOptymalizuj
Nazwa | Opis | Wartość |
---|---|---|
Maszyna wirtualna (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 (Walidacja obrazu)ImageTemplatePropertiesValidate (Walidacja szablon
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 (tylko źródło) | 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 (ponowne uruchomienie) | Polecenie sprawdzania, czy ponowne uruchomienie zakończyło się pomyślnie [Ustawienie domyślne: ""] | ciąg |
restartPolecenie | Polecenie do wykonania ponownego uruchomienia [Domyślne: "shutdown /r /f /t 0 /c "packer restart"] | ciąg |
restartLimit czasu | 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"] | ciąg |
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ść |
---|---|---|
wykluczZNajświeższych | Flaga wskazująca, czy utworzona wersja obrazu powinna zostać wykluczona z najnowszej wersji. Pomiń użycie wartości domyślnej (false). | Bool |
galleryImageId (identyfikator obrazu) | Identyfikator zasobu obrazu galerii obliczeniowej platformy Azure | ciąg (wymagany) |
Regiony replikacji | [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. | ciąg znakowy[] |
storageAccountType (typ konta) | [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) | 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. | Region docelowy[] |
typ | Typ rozkładu. | "SharedImage" (wymagane) |
przechowywanie wersji | Opisuje sposób generowania nowego numeru wersji x.y.z dla dystrybucji. | DistributeVersioner (Dystrybucja wersji) |
ImageTemplateSharedImageVersionSource
Nazwa | Opis | Wartość |
---|---|---|
imageVersionId (identyfikator obrazu) | 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ść |
---|---|---|
śródwierszowy | Tablica poleceń powłoki do wykonania | ciąg znakowy[] |
scriptUri (identyfikator 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. | ciąg |
sha256Suma kontrolna | Suma kontrolna SHA256 skryptu powłoki podana w polu scriptUri | ciąg |
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ść |
---|---|---|
śródwierszowy | Tablica poleceń powłoki do wykonania | ciąg znakowy[] |
scriptUri (identyfikator 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. | ciąg |
sha256Suma kontrolna | Suma kontrolna SHA256 skryptu powłoki podana w polu scriptUri | ciąg |
typ | Typ weryfikacji, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być walidacją powłoki | "Shell" (wymagane) |
ImageTemplateSource (Źródło szablonu obrazu)
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) |
ImageTemplateVhdDystrybutor
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. | ciąg |
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 |
tożsamości przypisane użytkownikom | 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. | ciąg znakowy[] |
Rozmiar maszyny wirtualnej | 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). | ciąg |
vnetConfig (konfiguracja sieci vnet) | 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. | Konfiguracja sieci wirtualnej |
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. | ciąg znakowy[] |
Kryteria wyszukiwania | 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. | ciąg |
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) |
Limit aktualizacji | 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 |
PlatformaImagePurchasePlan
Nazwa | Opis | Wartość |
---|---|---|
nazwa planu | Nazwa planu zakupu. | ciąg (wymagany) |
planProdukt | Produkt planu zakupu. | ciąg (wymagany) |
planPublisher (Wydawca planu) | Wydawca planu zakupu. | ciąg (wymagany) |
Region docelowy
Nazwa | Opis | Wartość |
---|---|---|
nazwa | Nazwa regionu. | ciąg (wymagany) |
Liczba replik | Liczba replik wersji obrazu do utworzenia w tym regionie. Pomiń użycie wartości domyślnej (1). | Int Ograniczenia: Minimalna wartość = 1 |
storageAccountType (typ konta) | 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" |
Śledzone tagi zasobów
Nazwa | Opis | Wartość |
---|
UserAssignedIdentities
Nazwa | Opis | Wartość |
---|
Tożsamość przypisana przez użytkownika
Nazwa | Opis | Wartość |
---|
Konfiguracja sieci wirtualnej
Nazwa | Opis | Wartość |
---|---|---|
proxyVmSize (rozmiar serwera) | Rozmiar maszyny wirtualnej serwera proxy używanej do przekazywania ruchu do maszyny wirtualnej kompilacji i maszyny wirtualnej weryfikacji. Pomiń lub określ pusty ciąg, aby użyć wartości domyślnej (Standard_A1_v2). | ciąg |
subnetId (identyfikator podsieci) | Identyfikator zasobu istniejącej podsieci. | ciąg |
Przykłady użycia
Moduły zweryfikowane na platformie Azure
Następujące moduły zweryfikowane platformy Azure mogą służyć do wdrażania tego typu zasobu.
Moduł | Opis |
---|---|
szablon obrazu maszyny wirtualnej | Moduł zasobów AVM dla szablonu obrazu maszyny wirtualnej |
Przykłady szybkiego startu platformy Azure
Następujące szablony szybkiego startu platformy Azure zawierają przykłady Bicep na potrzeby wdrażania tego typu 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 dziennik zmian.
Format zasobu
Aby utworzyć zasób Microsoft.VirtualMachineImages/imageTemplates, dodaj następujący kod JSON do szablonu.
{
"type": "Microsoft.VirtualMachineImages/imageTemplates",
"apiVersion": "2022-07-01",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"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
} ],
"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": {
"proxyVmSize": "string",
"subnetId": "string"
}
}
},
"tags": {
"{customized property}": "string"
}
}
Obiekty ImageTemplateSource
Ustaw właściwość , aby określić typ obiektu.
W przypadku funkcji ManagedImage użyj:
{
"imageId": "string",
"type": "ManagedImage"
}
W przypadku platformy PlatformImage użyj:
{
"offer": "string",
"planInfo": {
"planName": "string",
"planProduct": "string",
"planPublisher": "string"
},
"publisher": "string",
"sku": "string",
"type": "PlatformImage",
"version": "string"
}
W przypadku elementu SharedImageVersion użyj:
{
"imageVersionId": "string",
"type": "SharedImageVersion"
}
Obiekty DistributeVersioner
Ustaw właściwość schematu , aby określić typ obiektu.
W przypadku najnowszej wersji użyj:
{
"major": "int",
"scheme": "Latest"
}
W przypadku źródła 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 PowerShell użyj:
{
"inline": [ "string" ],
"runAsSystem": "bool",
"runElevated": "bool",
"scriptUri": "string",
"sha256Checksum": "string",
"type": "PowerShell",
"validExitCodes": [ "int" ]
}
W przypadku powłoki użyj:
{
"inline": [ "string" ],
"scriptUri": "string",
"sha256Checksum": "string",
"type": "Shell"
}
W przypadku WindowsRestart użyj:
{
"restartCheckCommand": "string",
"restartCommand": "string",
"restartTimeout": "string",
"type": "WindowsRestart"
}
W przypadku programu WindowsUpdate uż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 PowerShell użyj:
{
"inline": [ "string" ],
"runAsSystem": "bool",
"runElevated": "bool",
"scriptUri": "string",
"sha256Checksum": "string",
"type": "PowerShell",
"validExitCodes": [ "int" ]
}
W przypadku powłoki użyj:
{
"inline": [ "string" ],
"scriptUri": "string",
"sha256Checksum": "string",
"type": "Shell"
}
Obiekty ImageTemplateDistributor
Ustaw właściwość , aby określić typ obiektu.
W przypadku funkcji ManagedImage użyj:
{
"imageId": "string",
"location": "string",
"type": "ManagedImage"
}
W przypadku funkcji SharedImage uż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"
}
Wartości właściwości
Microsoft.VirtualMachineImages/imageTemplates
Nazwa | Opis | Wartość |
---|---|---|
apiVersion (wersja interfejsu api) | Wersja interfejsu API | '2022-07-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 | Właściwości ImageTemplateProperties |
Etykiety | Tagi zasobów | Słownik nazw tagów i wartości. Zobacz Tagi w szablonach |
typ | Typ zasobu | "Microsoft.VirtualMachineImages/imageTemplates" |
DistributeVersioner (Dystrybucja wersji)
Nazwa | Opis | Wartość |
---|---|---|
schemat | Ustaw wartość "Latest" dla typu DistributeVersionerLatest. Ustaw wartość "Źródło" dla typu DistributeVersionerSource. | "Najnowsze" "Źródło" (wymagane) |
DistributeVersionerLatest
Nazwa | Opis | Wartość |
---|---|---|
główny | 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 |
schemat | Schemat numerowania wersji do użycia. | "Latest" (wymagane) |
DistributeVersionerSource (Źródło Dystrybucji)
Nazwa | Opis | Wartość |
---|---|---|
schemat | Schemat numerowania wersji do użycia. | "Źródło" (wymagane) |
Konfigurator szablonu obrazu
Nazwa | Opis | Wartość |
---|---|---|
nazwa | Przyjazna nazwa, aby podać kontekst tego kroku dostosowywania | ciąg |
typ | Dla typu ImageTemplateFileCustomizer ustaw wartość "Plik". 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) |
Dystrybutor szablonów obrazów
Nazwa | Opis | Wartość |
---|---|---|
artifactTags (Znaczniki artefaktu) | Tagi, które zostaną zastosowane do artefaktu po jego utworzeniu/zaktualizowaniu przez dystrybutora. | ImageTemplateDistributorArtifactTags |
runOutputName (nazwa_wyjścia) | Nazwa, która ma być używana dla skojarzonego elementu RunOutput. | struna Ograniczenia: Wzorzec = ^[A-Za-z0-9-_.]{1,64}$ (wymagane) |
typ | Dla typu ImageTemplateManagedImageDistributor ustaw wartość "ManagedImage". Dla typu ImageTemplateSharedImageDistributor ustaw wartość "SharedImage". Dla typu ImageTemplateVhdDistributor ustaw wartość "VHD". | "ManagedImage" "SharedImage" "VHD" (wymagany) |
ImageTemplateDistributorArtifactTags
Nazwa | Opis | Wartość |
---|
ImageTemplateFileCustomizer (Konfigurator Obrazu)
Nazwa | Opis | Wartość |
---|---|---|
docelowy | Ś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 | ciąg |
sha256Suma kontrolna | Sha256 suma kontrolna pliku podanego w polu sourceUri powyżej | ciąg |
sourceUri (identyfikator źródłowy) | 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. | ciąg |
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) |
Walidator plików ImageTemplateFileValidator
Nazwa | Opis | Wartość |
---|---|---|
docelowy | Ś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 | ciąg |
sha256Suma kontrolna | Sha256 suma kontrolna pliku podanego w polu sourceUri powyżej | ciąg |
sourceUri (identyfikator źródłowy) | 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. | ciąg |
typ | Typ weryfikacji, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być walidacją powłoki | "Plik" (wymagany) |
ImageTemplateIdentity (Tożsamość szablonu obrazu)
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" |
tożsamości przypisane użytkownikom | 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 | ciąg |
typ | Dla typu ImageTemplateFileValidator ustaw wartość "Plik". Ustaw wartość "PowerShell" dla typu ImageTemplatePowerShellValidator. Dla typu ImageTemplateShellValidator ustaw wartość "Shell". | "Plik" "PowerShell" "Shell" (wymagane) |
ImageTemplateManagedImageDistributor (Szablon obrazuZarządzanyDystrybutor obrazów)
Nazwa | Opis | Wartość |
---|---|---|
imageId (identyfikator obrazu) | 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 obrazu) | 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 obrazów galerii platformy Azure. | ciąg |
planInfo (informacje o planie) | Opcjonalna konfiguracja planu zakupu dla obrazu platformy. | PlatformaImagePurchasePlan |
wydawca | Program Image Publisher w usłudze Azure Gallery Images. | ciąg |
Jednostka magazynowa (SKU) | Jednostka SKU obrazu z obrazów galerii platformy Azure. | ciąg |
typ | Określa typ obrazu źródłowego, z którym chcesz zacząć. | "PlatformImage" (wymagane) |
wersja | Wersja obrazu z obrazów galerii platformy Azure. Jeśli w tym miejscu określono wartość "latest", wersja jest oceniana podczas kompilacji obrazu, a nie podczas przesyłania szablonu. | ciąg |
ImageTemplatePowerShellCustomizer
Nazwa | Opis | Wartość |
---|---|---|
śródwierszowy | Tablica poleceń programu PowerShell do wykonania | ciąg znakowy[] |
runAsSystem (Bieg Systemowy) | 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 (Podwyższony) | Jeśli zostanie określony, skrypt programu PowerShell zostanie uruchomiony z podwyższonym poziomem uprawnień | Bool |
scriptUri (identyfikator 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. | ciąg |
sha256Suma kontrolna | Suma kontrolna SHA256 skryptu powłoki power shell podana w polu scriptUri powyżej | ciąg |
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 (validKody wyjścia) | Prawidłowe kody zakończenia skryptu programu PowerShell. [Wartość domyślna: 0] | int[] |
ImageTemplatePowerShellValidator
Nazwa | Opis | Wartość |
---|---|---|
śródwierszowy | Tablica poleceń programu PowerShell do wykonania | ciąg znakowy[] |
runAsSystem (Bieg Systemowy) | 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 (Podwyższony) | Jeśli zostanie określony, skrypt programu PowerShell zostanie uruchomiony z podwyższonym poziomem uprawnień | Bool |
scriptUri (identyfikator 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. | ciąg |
sha256Suma kontrolna | Suma kontrolna SHA256 skryptu powłoki power shell podana w polu scriptUri powyżej | ciąg |
typ | Typ weryfikacji, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być walidacją powłoki | "PowerShell" (wymagany) |
validExitCodes (validKody wyjścia) | Prawidłowe kody zakończenia skryptu programu PowerShell. [Wartość domyślna: 0] | int[] |
Właściwości ImageTemplateProperties
Nazwa | Opis | Wartość |
---|---|---|
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 |
dostosowywać | Określa właściwości używane do opisywania kroków dostosowywania obrazu, takich jak źródło obrazu itp. | ImageTemplateCustomizer[] |
rozproszony | Lokalizacja docelowa dystrybucji, do której należy przejść dane wyjściowe obrazu. | ImageTemplateDistributor[] (wymagane) |
optymalizować | Określa optymalizację do wykonania na obrazie. | ImageTemplatePropertiesOptymalizuj |
przesłać ź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. | ciąg |
sprawdzać poprawność | Opcje konfiguracji i lista weryfikacji, które mają zostać wykonane na obrazie wynikowym. | ImageTemplatePropertiesValidate (Walidacja obrazu)ImageTemplatePropertiesValidate (Walidacja szablon |
Profil wirtualny | Opisuje sposób konfigurowania maszyny wirtualnej do kompilowania obrazów | ImageTemplateVmProfile |
ImageTemplatePropertiesOptymalizuj
Nazwa | Opis | Wartość |
---|---|---|
Maszyna wirtualna (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 (Walidacja obrazu)ImageTemplatePropertiesValidate (Walidacja szablon
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 (tylko źródło) | 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 (ponowne uruchomienie) | Polecenie sprawdzania, czy ponowne uruchomienie zakończyło się pomyślnie [Ustawienie domyślne: ""] | ciąg |
restartPolecenie | Polecenie do wykonania ponownego uruchomienia [Domyślne: "shutdown /r /f /t 0 /c "packer restart"] | ciąg |
restartLimit czasu | 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"] | ciąg |
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ść |
---|---|---|
wykluczZNajświeższych | Flaga wskazująca, czy utworzona wersja obrazu powinna zostać wykluczona z najnowszej wersji. Pomiń użycie wartości domyślnej (false). | Bool |
galleryImageId (identyfikator obrazu) | Identyfikator zasobu obrazu galerii obliczeniowej platformy Azure | ciąg (wymagany) |
Regiony replikacji | [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. | ciąg znakowy[] |
storageAccountType (typ konta) | [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) | 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. | Region docelowy[] |
typ | Typ rozkładu. | "SharedImage" (wymagane) |
przechowywanie wersji | Opisuje sposób generowania nowego numeru wersji x.y.z dla dystrybucji. | DistributeVersioner (Dystrybucja wersji) |
ImageTemplateSharedImageVersionSource
Nazwa | Opis | Wartość |
---|---|---|
imageVersionId (identyfikator obrazu) | 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ść |
---|---|---|
śródwierszowy | Tablica poleceń powłoki do wykonania | ciąg znakowy[] |
scriptUri (identyfikator 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. | ciąg |
sha256Suma kontrolna | Suma kontrolna SHA256 skryptu powłoki podana w polu scriptUri | ciąg |
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ść |
---|---|---|
śródwierszowy | Tablica poleceń powłoki do wykonania | ciąg znakowy[] |
scriptUri (identyfikator 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. | ciąg |
sha256Suma kontrolna | Suma kontrolna SHA256 skryptu powłoki podana w polu scriptUri | ciąg |
typ | Typ weryfikacji, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być walidacją powłoki | "Shell" (wymagane) |
ImageTemplateSource (Źródło szablonu obrazu)
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) |
ImageTemplateVhdDystrybutor
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. | ciąg |
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 |
tożsamości przypisane użytkownikom | 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. | ciąg znakowy[] |
Rozmiar maszyny wirtualnej | 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). | ciąg |
vnetConfig (konfiguracja sieci vnet) | 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. | Konfiguracja sieci wirtualnej |
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. | ciąg znakowy[] |
Kryteria wyszukiwania | 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. | ciąg |
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) |
Limit aktualizacji | 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 |
PlatformaImagePurchasePlan
Nazwa | Opis | Wartość |
---|---|---|
nazwa planu | Nazwa planu zakupu. | ciąg (wymagany) |
planProdukt | Produkt planu zakupu. | ciąg (wymagany) |
planPublisher (Wydawca planu) | Wydawca planu zakupu. | ciąg (wymagany) |
Region docelowy
Nazwa | Opis | Wartość |
---|---|---|
nazwa | Nazwa regionu. | ciąg (wymagany) |
Liczba replik | Liczba replik wersji obrazu do utworzenia w tym regionie. Pomiń użycie wartości domyślnej (1). | Int Ograniczenia: Minimalna wartość = 1 |
storageAccountType (typ konta) | 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" |
Śledzone tagi zasobów
Nazwa | Opis | Wartość |
---|
UserAssignedIdentities
Nazwa | Opis | Wartość |
---|
Tożsamość przypisana przez użytkownika
Nazwa | Opis | Wartość |
---|
Konfiguracja sieci wirtualnej
Nazwa | Opis | Wartość |
---|---|---|
proxyVmSize (rozmiar serwera) | Rozmiar maszyny wirtualnej serwera proxy używanej do przekazywania ruchu do maszyny wirtualnej kompilacji i maszyny wirtualnej weryfikacji. Pomiń lub określ pusty ciąg, aby użyć wartości domyślnej (Standard_A1_v2). | ciąg |
subnetId (identyfikator podsieci) | Identyfikator zasobu istniejącej podsieci. | ciąg |
Przykłady użycia
Szablony szybkiego startu platformy Azure
Następujące szablony szybkiego startu platformy Azure wdrażają ten typ zasobu.
Szablon | 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 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 dziennik 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@2022-07-01"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
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
}
]
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 = {
proxyVmSize = "string"
subnetId = "string"
}
}
}
}
}
Obiekty ImageTemplateSource
Ustaw właściwość , aby określić typ obiektu.
W przypadku funkcji ManagedImage użyj:
{
imageId = "string"
type = "ManagedImage"
}
W przypadku platformy PlatformImage użyj:
{
offer = "string"
planInfo = {
planName = "string"
planProduct = "string"
planPublisher = "string"
}
publisher = "string"
sku = "string"
type = "PlatformImage"
version = "string"
}
W przypadku elementu SharedImageVersion użyj:
{
imageVersionId = "string"
type = "SharedImageVersion"
}
Obiekty DistributeVersioner
Ustaw właściwość schematu , aby określić typ obiektu.
W przypadku najnowszej wersji użyj:
{
major = int
scheme = "Latest"
}
W przypadku źródła 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 PowerShell użyj:
{
inline = [
"string"
]
runAsSystem = bool
runElevated = bool
scriptUri = "string"
sha256Checksum = "string"
type = "PowerShell"
validExitCodes = [
int
]
}
W przypadku powłoki użyj:
{
inline = [
"string"
]
scriptUri = "string"
sha256Checksum = "string"
type = "Shell"
}
W przypadku WindowsRestart użyj:
{
restartCheckCommand = "string"
restartCommand = "string"
restartTimeout = "string"
type = "WindowsRestart"
}
W przypadku programu WindowsUpdate uż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 PowerShell użyj:
{
inline = [
"string"
]
runAsSystem = bool
runElevated = bool
scriptUri = "string"
sha256Checksum = "string"
type = "PowerShell"
validExitCodes = [
int
]
}
W przypadku powłoki użyj:
{
inline = [
"string"
]
scriptUri = "string"
sha256Checksum = "string"
type = "Shell"
}
Obiekty ImageTemplateDistributor
Ustaw właściwość , aby określić typ obiektu.
W przypadku funkcji ManagedImage użyj:
{
imageId = "string"
location = "string"
type = "ManagedImage"
}
W przypadku funkcji SharedImage uż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"
}
Wartości właściwości
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 | Właściwości ImageTemplateProperties |
Etykiety | Tagi zasobów | Słownik nazw tagów i wartości. |
typ | Typ zasobu | "Microsoft.VirtualMachineImages/imageTemplates@2022-07-01" |
DistributeVersioner (Dystrybucja wersji)
Nazwa | Opis | Wartość |
---|---|---|
schemat | Ustaw wartość "Latest" dla typu DistributeVersionerLatest. Ustaw wartość "Źródło" dla typu DistributeVersionerSource. | "Najnowsze" "Źródło" (wymagane) |
DistributeVersionerLatest
Nazwa | Opis | Wartość |
---|---|---|
główny | 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 |
schemat | Schemat numerowania wersji do użycia. | "Latest" (wymagane) |
DistributeVersionerSource (Źródło Dystrybucji)
Nazwa | Opis | Wartość |
---|---|---|
schemat | Schemat numerowania wersji do użycia. | "Źródło" (wymagane) |
Konfigurator szablonu obrazu
Nazwa | Opis | Wartość |
---|---|---|
nazwa | Przyjazna nazwa, aby podać kontekst tego kroku dostosowywania | ciąg |
typ | Dla typu ImageTemplateFileCustomizer ustaw wartość "Plik". 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) |
Dystrybutor szablonów obrazów
Nazwa | Opis | Wartość |
---|---|---|
artifactTags (Znaczniki artefaktu) | Tagi, które zostaną zastosowane do artefaktu po jego utworzeniu/zaktualizowaniu przez dystrybutora. | ImageTemplateDistributorArtifactTags |
runOutputName (nazwa_wyjścia) | Nazwa, która ma być używana dla skojarzonego elementu RunOutput. | struna Ograniczenia: Wzorzec = ^[A-Za-z0-9-_.]{1,64}$ (wymagane) |
typ | Dla typu ImageTemplateManagedImageDistributor ustaw wartość "ManagedImage". Dla typu ImageTemplateSharedImageDistributor ustaw wartość "SharedImage". Dla typu ImageTemplateVhdDistributor ustaw wartość "VHD". | "ManagedImage" "SharedImage" "VHD" (wymagany) |
ImageTemplateDistributorArtifactTags
Nazwa | Opis | Wartość |
---|
ImageTemplateFileCustomizer (Konfigurator Obrazu)
Nazwa | Opis | Wartość |
---|---|---|
docelowy | Ś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 | ciąg |
sha256Suma kontrolna | Sha256 suma kontrolna pliku podanego w polu sourceUri powyżej | ciąg |
sourceUri (identyfikator źródłowy) | 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. | ciąg |
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) |
Walidator plików ImageTemplateFileValidator
Nazwa | Opis | Wartość |
---|---|---|
docelowy | Ś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 | ciąg |
sha256Suma kontrolna | Sha256 suma kontrolna pliku podanego w polu sourceUri powyżej | ciąg |
sourceUri (identyfikator źródłowy) | 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. | ciąg |
typ | Typ weryfikacji, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być walidacją powłoki | "Plik" (wymagany) |
ImageTemplateIdentity (Tożsamość szablonu obrazu)
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" |
tożsamości przypisane użytkownikom | 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 | ciąg |
typ | Dla typu ImageTemplateFileValidator ustaw wartość "Plik". Ustaw wartość "PowerShell" dla typu ImageTemplatePowerShellValidator. Dla typu ImageTemplateShellValidator ustaw wartość "Shell". | "Plik" "PowerShell" "Shell" (wymagane) |
ImageTemplateManagedImageDistributor (Szablon obrazuZarządzanyDystrybutor obrazów)
Nazwa | Opis | Wartość |
---|---|---|
imageId (identyfikator obrazu) | 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 obrazu) | 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 obrazów galerii platformy Azure. | ciąg |
planInfo (informacje o planie) | Opcjonalna konfiguracja planu zakupu dla obrazu platformy. | PlatformaImagePurchasePlan |
wydawca | Program Image Publisher w usłudze Azure Gallery Images. | ciąg |
Jednostka magazynowa (SKU) | Jednostka SKU obrazu z obrazów galerii platformy Azure. | ciąg |
typ | Określa typ obrazu źródłowego, z którym chcesz zacząć. | "PlatformImage" (wymagane) |
wersja | Wersja obrazu z obrazów galerii platformy Azure. Jeśli w tym miejscu określono wartość "latest", wersja jest oceniana podczas kompilacji obrazu, a nie podczas przesyłania szablonu. | ciąg |
ImageTemplatePowerShellCustomizer
Nazwa | Opis | Wartość |
---|---|---|
śródwierszowy | Tablica poleceń programu PowerShell do wykonania | ciąg znakowy[] |
runAsSystem (Bieg Systemowy) | 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 (Podwyższony) | Jeśli zostanie określony, skrypt programu PowerShell zostanie uruchomiony z podwyższonym poziomem uprawnień | Bool |
scriptUri (identyfikator 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. | ciąg |
sha256Suma kontrolna | Suma kontrolna SHA256 skryptu powłoki power shell podana w polu scriptUri powyżej | ciąg |
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 (validKody wyjścia) | Prawidłowe kody zakończenia skryptu programu PowerShell. [Wartość domyślna: 0] | int[] |
ImageTemplatePowerShellValidator
Nazwa | Opis | Wartość |
---|---|---|
śródwierszowy | Tablica poleceń programu PowerShell do wykonania | ciąg znakowy[] |
runAsSystem (Bieg Systemowy) | 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 (Podwyższony) | Jeśli zostanie określony, skrypt programu PowerShell zostanie uruchomiony z podwyższonym poziomem uprawnień | Bool |
scriptUri (identyfikator 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. | ciąg |
sha256Suma kontrolna | Suma kontrolna SHA256 skryptu powłoki power shell podana w polu scriptUri powyżej | ciąg |
typ | Typ weryfikacji, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być walidacją powłoki | "PowerShell" (wymagany) |
validExitCodes (validKody wyjścia) | Prawidłowe kody zakończenia skryptu programu PowerShell. [Wartość domyślna: 0] | int[] |
Właściwości ImageTemplateProperties
Nazwa | Opis | Wartość |
---|---|---|
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 |
dostosowywać | Określa właściwości używane do opisywania kroków dostosowywania obrazu, takich jak źródło obrazu itp. | ImageTemplateCustomizer[] |
rozproszony | Lokalizacja docelowa dystrybucji, do której należy przejść dane wyjściowe obrazu. | ImageTemplateDistributor[] (wymagane) |
optymalizować | Określa optymalizację do wykonania na obrazie. | ImageTemplatePropertiesOptymalizuj |
przesłać ź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. | ciąg |
sprawdzać poprawność | Opcje konfiguracji i lista weryfikacji, które mają zostać wykonane na obrazie wynikowym. | ImageTemplatePropertiesValidate (Walidacja obrazu)ImageTemplatePropertiesValidate (Walidacja szablon |
Profil wirtualny | Opisuje sposób konfigurowania maszyny wirtualnej do kompilowania obrazów | ImageTemplateVmProfile |
ImageTemplatePropertiesOptymalizuj
Nazwa | Opis | Wartość |
---|---|---|
Maszyna wirtualna (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 (Walidacja obrazu)ImageTemplatePropertiesValidate (Walidacja szablon
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 (tylko źródło) | 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 (ponowne uruchomienie) | Polecenie sprawdzania, czy ponowne uruchomienie zakończyło się pomyślnie [Ustawienie domyślne: ""] | ciąg |
restartPolecenie | Polecenie do wykonania ponownego uruchomienia [Domyślne: "shutdown /r /f /t 0 /c "packer restart"] | ciąg |
restartLimit czasu | 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"] | ciąg |
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ść |
---|---|---|
wykluczZNajświeższych | Flaga wskazująca, czy utworzona wersja obrazu powinna zostać wykluczona z najnowszej wersji. Pomiń użycie wartości domyślnej (false). | Bool |
galleryImageId (identyfikator obrazu) | Identyfikator zasobu obrazu galerii obliczeniowej platformy Azure | ciąg (wymagany) |
Regiony replikacji | [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. | ciąg znakowy[] |
storageAccountType (typ konta) | [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) | 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. | Region docelowy[] |
typ | Typ rozkładu. | "SharedImage" (wymagane) |
przechowywanie wersji | Opisuje sposób generowania nowego numeru wersji x.y.z dla dystrybucji. | DistributeVersioner (Dystrybucja wersji) |
ImageTemplateSharedImageVersionSource
Nazwa | Opis | Wartość |
---|---|---|
imageVersionId (identyfikator obrazu) | 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ść |
---|---|---|
śródwierszowy | Tablica poleceń powłoki do wykonania | ciąg znakowy[] |
scriptUri (identyfikator 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. | ciąg |
sha256Suma kontrolna | Suma kontrolna SHA256 skryptu powłoki podana w polu scriptUri | ciąg |
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ść |
---|---|---|
śródwierszowy | Tablica poleceń powłoki do wykonania | ciąg znakowy[] |
scriptUri (identyfikator 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. | ciąg |
sha256Suma kontrolna | Suma kontrolna SHA256 skryptu powłoki podana w polu scriptUri | ciąg |
typ | Typ weryfikacji, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być walidacją powłoki | "Shell" (wymagane) |
ImageTemplateSource (Źródło szablonu obrazu)
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) |
ImageTemplateVhdDystrybutor
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. | ciąg |
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 |
tożsamości przypisane użytkownikom | 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. | ciąg znakowy[] |
Rozmiar maszyny wirtualnej | 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). | ciąg |
vnetConfig (konfiguracja sieci vnet) | 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. | Konfiguracja sieci wirtualnej |
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. | ciąg znakowy[] |
Kryteria wyszukiwania | 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. | ciąg |
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) |
Limit aktualizacji | 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 |
PlatformaImagePurchasePlan
Nazwa | Opis | Wartość |
---|---|---|
nazwa planu | Nazwa planu zakupu. | ciąg (wymagany) |
planProdukt | Produkt planu zakupu. | ciąg (wymagany) |
planPublisher (Wydawca planu) | Wydawca planu zakupu. | ciąg (wymagany) |
Region docelowy
Nazwa | Opis | Wartość |
---|---|---|
nazwa | Nazwa regionu. | ciąg (wymagany) |
Liczba replik | Liczba replik wersji obrazu do utworzenia w tym regionie. Pomiń użycie wartości domyślnej (1). | Int Ograniczenia: Minimalna wartość = 1 |
storageAccountType (typ konta) | 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" |
Śledzone tagi zasobów
Nazwa | Opis | Wartość |
---|
UserAssignedIdentities
Nazwa | Opis | Wartość |
---|
Tożsamość przypisana przez użytkownika
Nazwa | Opis | Wartość |
---|
Konfiguracja sieci wirtualnej
Nazwa | Opis | Wartość |
---|---|---|
proxyVmSize (rozmiar serwera) | Rozmiar maszyny wirtualnej serwera proxy używanej do przekazywania ruchu do maszyny wirtualnej kompilacji i maszyny wirtualnej weryfikacji. Pomiń lub określ pusty ciąg, aby użyć wartości domyślnej (Standard_A1_v2). | ciąg |
subnetId (identyfikator podsieci) | Identyfikator zasobu istniejącej podsieci. | ciąg |