Microsoft.VirtualMachineImages imageTemplates
Definicja zasobu Bicep
Typ zasobu imageTemplates można wdrożyć w następujących elementach:
- 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-02-14' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
identity: {
type: 'string'
userAssignedIdentities: {}
}
properties: {
buildTimeoutInMinutes: int
customize: [
{
name: 'string'
type: 'string'
// For remaining properties, see ImageTemplateCustomizer objects
}
]
distribute: [
{
artifactTags: {}
runOutputName: 'string'
type: 'string'
// For remaining properties, see ImageTemplateDistributor objects
}
]
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 ImageTemplateCustomizer
Ustaw właściwość type , aby określić typ obiektu.
W przypadku pliku użyj:
type: 'File'
destination: 'string'
sha256Checksum: 'string'
sourceUri: 'string'
W przypadku programu PowerShell użyj:
type: 'PowerShell'
inline: [
'string'
]
runAsSystem: bool
runElevated: bool
scriptUri: 'string'
sha256Checksum: 'string'
validExitCodes: [
int
]
W przypadku powłoki użyj:
type: 'Shell'
inline: [
'string'
]
scriptUri: 'string'
sha256Checksum: 'string'
W przypadku systemu WindowsRestart użyj:
type: 'WindowsRestart'
restartCheckCommand: 'string'
restartCommand: 'string'
restartTimeout: 'string'
W przypadku programu WindowsUpdate użyj:
type: 'WindowsUpdate'
filters: [
'string'
]
searchCriteria: 'string'
updateLimit: int
Obiekty ImageTemplateDistributor
Ustaw właściwość type , aby określić typ obiektu.
W przypadku funkcji ManagedImage użyj:
type: 'ManagedImage'
imageId: 'string'
location: 'string'
W przypadku funkcji SharedImage użyj:
type: 'SharedImage'
excludeFromLatest: bool
galleryImageId: 'string'
replicationRegions: [
'string'
]
storageAccountType: 'string'
W przypadku wirtualnego dysku twardego użyj:
type: 'VHD'
Obiekty ImageTemplateSource
Ustaw właściwość type , aby określić typ obiektu.
W przypadku funkcji ManagedImage użyj:
type: 'ManagedImage'
imageId: 'string'
W przypadku platformyImage użyj:
type: 'PlatformImage'
offer: 'string'
planInfo: {
planName: 'string'
planProduct: 'string'
planPublisher: 'string'
}
publisher: 'string'
sku: 'string'
version: 'string'
W przypadku elementu SharedImageVersion użyj:
type: 'SharedImageVersion'
imageVersionId: 'string'
Obiekty ImageTemplateInVMValidator
Ustaw właściwość type , aby określić typ obiektu.
W przypadku programu PowerShell użyj:
type: 'PowerShell'
inline: [
'string'
]
runAsSystem: bool
runElevated: bool
scriptUri: 'string'
sha256Checksum: 'string'
validExitCodes: [
int
]
W przypadku powłoki użyj:
type: 'Shell'
inline: [
'string'
]
scriptUri: 'string'
sha256Checksum: 'string'
Wartości właściwości
imageTemplates
| Nazwa | Opis | Wartość |
|---|---|---|
| name | Nazwa zasobu | ciąg (wymagany) |
| location | Lokalizacja geograficzna, w której znajduje się zasób | ciąg (wymagany) |
| tags | Tagi zasobów. | Słownik nazw tagów i wartości. Zobacz Tagi w szablonach |
| identity | Tożsamość szablonu obrazu, jeśli została skonfigurowana. | ImageTemplateIdentity (wymagane) |
| properties | Właściwości szablonu obrazu | ImageTemplateProperties |
ImageTemplateIdentity
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ tożsamości używany dla szablonu obrazu. Typ "Brak" spowoduje usunięcie tożsamości z szablonu obrazu. | "Brak" "UserAssigned" |
| userAssignedIdentities | Lista tożsamości użytkowników skojarzonych z szablonem obrazu. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów usługi ARM w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | object |
ImageTemplateProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| buildTimeoutInMinutes | Maksymalny czas oczekiwania podczas tworzenia szablonu obrazu (obejmuje wszystkie dostosowania, walidacje i dystrybucje). Pomiń lub określ 0, aby użyć wartości domyślnej (4 godziny). | int |
| Dostosuj | Określa właściwości używane do opisywania kroków dostosowywania obrazu, takich jak źródło obrazu itp. | ImageTemplateCustomizer[] |
| Rozpowszechniać | Cele dystrybucji, w których dane wyjściowe obrazu muszą przejść do. | ImageTemplateDistributor[] (wymagane) |
| source | 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 |
| walidacja | Opcje konfiguracji i lista walidacji do wykonania na obrazie wynikowym. | ImageTemplatePropertiesValidate |
| vmProfile | Opisuje sposób konfigurowania maszyny wirtualnej do kompilowania obrazów | ImageTemplateVmProfile |
ImageTemplateCustomizer
| Nazwa | Opis | Wartość |
|---|---|---|
| name | Przyjazna nazwa w celu zapewnienia kontekstu tego kroku dostosowywania | ciąg |
| typ | Ustawianie typu obiektu | Plik Program PowerShell Powłoka WindowsRestart WindowsUpdate (wymagane) |
ImageTemplateFileCustomizer
| Nazwa | Opis | Wartość |
|---|---|---|
| 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) |
| destination | Ś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 |
| sha256Checksum | Sha256 sumę kontrolną pliku podanego w polu sourceUri powyżej | ciąg |
| 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. | ciąg |
ImageTemplatePowerShellCustomizer
| Nazwa | Opis | Wartość |
|---|---|---|
| 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) |
| inline | Tablica poleceń programu PowerShell do wykonania | ciąg[] |
| 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 dostosowania. Może to być link github, identyfikator URI sygnatury dostępu współdzielonego dla usługi Azure Storage itp. | ciąg |
| sha256Checksum | Sha256 suma kontrolna skryptu powłoki Power Shell podana w polu scriptUri powyżej | ciąg |
| validExitCodes | Prawidłowe kody zakończenia skryptu programu PowerShell. [Ustawienie domyślne: 0] | int[] |
ImageTemplateShellCustomizer
| Nazwa | Opis | Wartość |
|---|---|---|
| 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) |
| inline | Tablica poleceń powłoki do wykonania | ciąg[] |
| scriptUri | Identyfikator URI skryptu powłoki do uruchomienia w celu dostosowania. Może to być link github, identyfikator URI sygnatury dostępu współdzielonego dla usługi Azure Storage itp. | ciąg |
| sha256Checksum | Suma kontrolna SHA256 skryptu powłoki podana w polu scriptUri | ciąg |
ImageTemplateRestartCustomizer
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ narzędzia dostosowywania, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być konfiguratorem powłoki | "WindowsRestart" (wymagane) |
| restartCheckPolecenia | Polecenie sprawdzania, czy ponowne uruchomienie zakończyło się pomyślnie [Ustawienie domyślne: ''] | ciąg |
| restartCommand | Polecenie do wykonania ponownego uruchomienia [Domyślne: 'shutdown /r /f /t 0 /c "packer restart"] | ciąg |
| restartTimeout | Limit czasu ponownego uruchomienia określony jako ciąg wielkości i jednostki, np. "5m" (5 minut) lub "2h" (2 godziny) [Wartość domyślna: "5m"] | ciąg |
ImageTemplateWindowsUpdateCustomizer
| Nazwa | Opis | Wartość |
|---|---|---|
| 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) |
| 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[] |
| searchCriteria | Kryteria wyszukiwania aktualizacji. Pomiń lub określ pusty ciąg, aby użyć wartości domyślnej (przeszukaj wszystko). Zapoznaj się z powyższym linkiem, aby zapoznać się z przykładami i szczegółowym opisem tego pola. | ciąg |
| updateLimit | Maksymalna liczba aktualizacji do zastosowania w danym momencie. Pomiń lub określ wartość 0, aby użyć wartości domyślnej (1000) | int |
ImageTemplateDistributor
| Nazwa | Opis | Wartość |
|---|---|---|
| artifactTags | Tagi, które zostaną zastosowane do artefaktu po jego utworzeniu/zaktualizowaniu przez dystrybutora. | object |
| runOutputName | Nazwa, która ma być używana dla skojarzonego elementu RunOutput. | ciąg (wymagany) |
| typ | Ustawianie typu obiektu | ManagedImage SharedImage Wirtualny dysk twardy (wymagany) |
ImageTemplateManagedImageDistributor
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ rozkładu. | "ManagedImage" (wymagane) |
| imageId | Identyfikator zasobu obrazu dysku zarządzanego | ciąg (wymagany) |
| location | Lokalizacja platformy Azure dla obrazu powinna być zgodna z tym, czy obraz już istnieje | ciąg (wymagany) |
ImageTemplateSharedImageDistributor
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ rozkładu. | "SharedImage" (wymagane) |
| excludeFromLatest | Flaga wskazująca, czy utworzona wersja obrazu powinna być wykluczona z najnowszej wersji. Pomiń użycie wartości domyślnej (false). | bool |
| galleryImageId | Identyfikator zasobu obrazu Shared Image Gallery | ciąg (wymagany) |
| replicationRegions | Lista regionów, do których obraz zostanie zreplikowany | string[] (wymagane) |
| storageAccountType | Typ konta magazynu, który ma być używany do przechowywania obrazu udostępnionego. Pomiń użycie wartości domyślnej (Standard_LRS). | "Standard_LRS" "Standard_ZRS" |
ImageTemplateVhdDistributor
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ rozkładu. | "VHD" (wymagany) |
ImageTemplateSource
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Ustawianie typu obiektu | ManagedImage PlatformImage SharedImageVersion (wymagane) |
ImageTemplateManagedImageSource
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Określa typ obrazu źródłowego, z którym chcesz zacząć. | "ManagedImage" (wymagane) |
| imageId | Identyfikator zasobu usługi ARM obrazu zarządzanego w subskrypcji klienta | ciąg (wymagany) |
ImageTemplatePlatformImageSource
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Określa typ obrazu źródłowego, z którym chcesz zacząć. | "PlatformImage" (wymagane) |
| offer | Oferta obrazu z obrazów galerii platformy Azure. | ciąg |
| planInfo | Opcjonalna konfiguracja planu zakupu dla obrazu platformy. | PlatformImagePurchasePlan |
| publisher | Image Publisher w obrazach galerii platformy Azure. | ciąg |
| sku | Jednostka SKU obrazu z obrazów galerii platformy Azure. | ciąg |
| 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 |
PlatformImagePurchasePlan
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa planu | Nazwa planu zakupu. | ciąg (wymagany) |
| planProduct | Produkt planu zakupu. | ciąg (wymagany) |
| planPublisher | Wydawca planu zakupu. | ciąg (wymagany) |
ImageTemplateSharedImageVersionSource
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Określa typ obrazu źródłowego, z którym chcesz zacząć. | "SharedImageVersion" (wymagane) |
| imageVersionId | Identyfikator zasobu usługi ARM wersji obrazu w galerii obrazów udostępnionych | ciąg (wymagany) |
ImageTemplatePropertiesValidate
| Nazwa | Opis | Wartość |
|---|---|---|
| continueDistributeOnFailure | Jeśli walidacja nie powiedzie się i to pole ma wartość false, obrazy wyjściowe nie będą dystrybuowane. Jest to zachowanie domyślne. Jeśli walidacja nie powiedzie się i 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życia. W obu przypadkach (prawda lub fałsz) uruchomienie obrazu końcowego zostanie zgłoszone jako zakończone niepowodzeniem w przypadku niepowodzenia weryfikacji. [Uwaga: to pole nie ma wpływu, jeśli walidacja zakończy się pomyślnie.] | bool |
| inVMValidations | Lista walidacji do wykonania. | ImageTemplateInVMValidator[] |
| sourceValidationOnly | Jeśli to pole ma wartość true, obraz określony w sekcji "source" zostanie zweryfikowany bezpośrednio. W celu wygenerowania nie zostanie uruchomiona żadna oddzielna kompilacja, a następnie zweryfikuj dostosowany obraz. | bool |
ImageTemplateInVMValidator
| Nazwa | Opis | Wartość |
|---|---|---|
| name | Przyjazna nazwa, aby podać kontekst dotyczący tego, co robi ten krok weryfikacji | ciąg |
| typ | Ustawianie typu obiektu | Program PowerShell Powłoka (wymagana ) |
ImageTemplatePowerShellValidator
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ weryfikacji, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być walidacją powłoki | "PowerShell" (wymagany) |
| inline | Tablica poleceń programu PowerShell do wykonania | ciąg[] |
| 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. | ciąg |
| sha256Checksum | Sha256 suma kontrolna skryptu powłoki Power Shell podana w polu scriptUri powyżej | ciąg |
| validExitCodes | Prawidłowe kody zakończenia skryptu programu PowerShell. [Ustawienie domyślne: 0] | int[] |
ImageTemplateShellValidator
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ weryfikacji, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być walidacją powłoki | "Shell" (wymagane) |
| inline | Tablica poleceń powłoki do wykonania | ciąg[] |
| 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 |
| sha256Checksum | Suma kontrolna SHA256 skryptu powłoki podana w polu scriptUri | 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 |
| userAssignedIdentities | Opcjonalna tablica identyfikatorów zasobów tożsamości zarządzanych przypisanych przez użytkownika do skonfigurowania na maszynie wirtualnej kompilacji i maszynie wirtualnej weryfikacji. Może to obejmować tożsamość szablonu obrazu. | ciąg[] |
| vmSize | Rozmiar maszyny wirtualnej używanej do tworzenia, dostosowywania i przechwytywania obrazów. Pomiń lub określ pusty ciąg, aby użyć wartości domyślnej (Standard_D1_v2 dla obrazów gen1 i Standard_D2ds_v4 dla obrazów gen2). | ciąg |
| vnetConfig | Opcjonalna konfiguracja sieci wirtualnej do wdrożenia maszyny wirtualnej kompilacji i walidacji maszyny wirtualnej w programie . Pomiń, jeśli nie trzeba używać określonej sieci wirtualnej. | VirtualNetworkConfig |
VirtualNetworkConfig
| Nazwa | Opis | Wartość |
|---|---|---|
| proxyVmSize | 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 zasobu istniejącej podsieci. | ciąg |
Szablony szybkiego startu
Następujące szablony szybkiego startu wdrażają ten typ zasobu.
| Template | Opis |
|---|---|
Program Azure Image Builder z punktem odniesienia systemu Windows platformy Azure |
Tworzy środowisko narzędzia Azure Image Builder i tworzy obraz systemu Windows Server z zastosowanymi najnowszymi Aktualizacje 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. Możesz wyświetlić wszystkie utworzone zasoby lub bezpośrednio przejść do DevPortal.microsoft.com w celu utworzenia pierwszego urządzenia Dev Box. |
Definicja zasobu szablonu usługi ARM
Typ zasobu imageTemplates można wdrożyć w następujących elementach:
- 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-02-14",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"type": "string",
"userAssignedIdentities": {}
},
"properties": {
"buildTimeoutInMinutes": "int",
"customize": [
{
"name": "string",
"type": "string"
// For remaining properties, see ImageTemplateCustomizer objects
}
],
"distribute": [
{
"artifactTags": {},
"runOutputName": "string",
"type": "string"
// For remaining properties, see ImageTemplateDistributor objects
}
],
"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 ImageTemplateCustomizer
Ustaw właściwość type , aby określić typ obiektu.
W przypadku pliku użyj polecenia :
"type": "File",
"destination": "string",
"sha256Checksum": "string",
"sourceUri": "string"
W przypadku programu PowerShell użyj:
"type": "PowerShell",
"inline": [ "string" ],
"runAsSystem": "bool",
"runElevated": "bool",
"scriptUri": "string",
"sha256Checksum": "string",
"validExitCodes": [ "int" ]
W przypadku powłoki użyj:
"type": "Shell",
"inline": [ "string" ],
"scriptUri": "string",
"sha256Checksum": "string"
W przypadku systemu WindowsRestart użyj:
"type": "WindowsRestart",
"restartCheckCommand": "string",
"restartCommand": "string",
"restartTimeout": "string"
W przypadku programu WindowsUpdate użyj:
"type": "WindowsUpdate",
"filters": [ "string" ],
"searchCriteria": "string",
"updateLimit": "int"
Obiekty ImageTemplateDistributor
Ustaw właściwość type , aby określić typ obiektu.
W przypadku elementu ManagedImage użyj:
"type": "ManagedImage",
"imageId": "string",
"location": "string"
W przypadku elementu SharedImage użyj:
"type": "SharedImage",
"excludeFromLatest": "bool",
"galleryImageId": "string",
"replicationRegions": [ "string" ],
"storageAccountType": "string"
W przypadku wirtualnego dysku twardego użyj:
"type": "VHD"
Obiekty ImageTemplateSource
Ustaw właściwość type , aby określić typ obiektu.
W przypadku elementu ManagedImage użyj:
"type": "ManagedImage",
"imageId": "string"
W przypadku platformyImage użyj:
"type": "PlatformImage",
"offer": "string",
"planInfo": {
"planName": "string",
"planProduct": "string",
"planPublisher": "string"
},
"publisher": "string",
"sku": "string",
"version": "string"
W przypadku elementu SharedImageVersion użyj:
"type": "SharedImageVersion",
"imageVersionId": "string"
Obiekty ImageTemplateInVMValidator
Ustaw właściwość type , aby określić typ obiektu.
W przypadku programu PowerShell użyj:
"type": "PowerShell",
"inline": [ "string" ],
"runAsSystem": "bool",
"runElevated": "bool",
"scriptUri": "string",
"sha256Checksum": "string",
"validExitCodes": [ "int" ]
W przypadku powłoki użyj:
"type": "Shell",
"inline": [ "string" ],
"scriptUri": "string",
"sha256Checksum": "string"
Wartości właściwości
imageTemplates
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ zasobu | "Microsoft.VirtualMachineImages/imageTemplates" |
| apiVersion | Wersja interfejsu API zasobów | '2022-02-14' |
| name | Nazwa zasobu | ciąg (wymagany) |
| location | Lokalizacja geograficzna, w której znajduje się zasób | ciąg (wymagany) |
| tags | Tagi zasobów. | Słownik nazw tagów i wartości. Zobacz Tagi w szablonach |
| identity | Tożsamość szablonu obrazu, jeśli została skonfigurowana. | ImageTemplateIdentity (wymagane) |
| properties | Właściwości szablonu obrazu | ImageTemplateProperties |
ImageTemplateIdentity
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ tożsamości używany dla szablonu obrazu. Typ "Brak" spowoduje usunięcie tożsamości z szablonu obrazu. | "Brak" "UserAssigned" |
| userAssignedIdentities | Lista tożsamości użytkowników skojarzonych z szablonem obrazu. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów usługi ARM w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | object |
ImageTemplateProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| buildTimeoutInMinutes | Maksymalny czas oczekiwania podczas tworzenia szablonu obrazu (obejmuje wszystkie dostosowania, walidacje i dystrybucje). Pomiń lub określ 0, aby użyć wartości domyślnej (4 godziny). | int |
| Dostosuj | Określa właściwości używane do opisywania kroków dostosowywania obrazu, takich jak źródło obrazu itp. | ImageTemplateCustomizer[] |
| Rozpowszechniać | Cele dystrybucji, w których dane wyjściowe obrazu muszą przejść do. | ImageTemplateDistributor[] (wymagane) |
| source | 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 |
| walidacja | Opcje konfiguracji i lista walidacji do wykonania na obrazie wynikowym. | ImageTemplatePropertiesValidate |
| vmProfile | Opisuje sposób konfigurowania maszyny wirtualnej do kompilowania obrazów | ImageTemplateVmProfile |
ImageTemplateCustomizer
| Nazwa | Opis | Wartość |
|---|---|---|
| name | Przyjazna nazwa w celu zapewnienia kontekstu tego kroku dostosowywania | ciąg |
| typ | Ustawianie typu obiektu | Plik Program PowerShell Powłoka WindowsRestart WindowsUpdate (wymagane) |
ImageTemplateFileCustomizer
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ narzędzia dostosowywania, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być konfigurator powłoki | "Plik" (wymagany) |
| destination | Ścieżka bezwzględna do pliku (z utworzonymi już zagnieżdżonym strukturami katalogów), do którego zostanie przekazany plik (z identyfikatora sourceUri) na maszynie wirtualnej | ciąg |
| sha256Checksum | Sha256 sum kontrolnych pliku podanego w polu sourceUri powyżej | ciąg |
| Sourceuri | Identyfikator URI pliku, który ma zostać przekazany do dostosowywania maszyny wirtualnej. Może to być link usługi GitHub, identyfikator URI sygnatury dostępu współdzielonego dla usługi Azure Storage itp. | ciąg |
ImageTemplatePowerShellCustomizer
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ narzędzia dostosowywania, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być konfigurator powłoki | "PowerShell" (wymagany) |
| inline | Tablica poleceń programu PowerShell do wykonania | ciąg[] |
| 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 dostosowania. Może to być link github, identyfikator URI sygnatury dostępu współdzielonego dla usługi Azure Storage itp. | ciąg |
| sha256Checksum | Sha256 suma kontrolna skryptu powłoki Power Shell podana w polu scriptUri powyżej | ciąg |
| validExitCodes | Prawidłowe kody zakończenia skryptu programu PowerShell. [Ustawienie domyślne: 0] | int[] |
ImageTemplateShellCustomizer
| Nazwa | Opis | Wartość |
|---|---|---|
| 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) |
| inline | Tablica poleceń powłoki do wykonania | ciąg[] |
| scriptUri | Identyfikator URI skryptu powłoki do uruchomienia w celu dostosowania. Może to być link github, identyfikator URI sygnatury dostępu współdzielonego dla usługi Azure Storage itp. | ciąg |
| sha256Checksum | Suma kontrolna SHA256 skryptu powłoki podana w polu scriptUri | ciąg |
ImageTemplateRestartCustomizer
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ narzędzia dostosowywania, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być konfiguratorem powłoki | "WindowsRestart" (wymagane) |
| restartCheckPolecenia | Polecenie sprawdzania, czy ponowne uruchomienie zakończyło się pomyślnie [Ustawienie domyślne: ''] | ciąg |
| restartCommand | Polecenie do wykonania ponownego uruchomienia [Domyślne: 'shutdown /r /f /t 0 /c "packer restart"] | ciąg |
| restartTimeout | Limit czasu ponownego uruchomienia określony jako ciąg wielkości i jednostki, np. "5m" (5 minut) lub "2h" (2 godziny) [Wartość domyślna: "5m"] | ciąg |
ImageTemplateWindowsUpdateCustomizer
| Nazwa | Opis | Wartość |
|---|---|---|
| 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) |
| 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[] |
| searchCriteria | Kryteria wyszukiwania aktualizacji. Pomiń lub określ pusty ciąg, aby użyć wartości domyślnej (przeszukaj wszystko). Zapoznaj się z powyższym linkiem, aby zapoznać się z przykładami i szczegółowym opisem tego pola. | ciąg |
| updateLimit | Maksymalna liczba aktualizacji do zastosowania w danym momencie. Pomiń lub określ wartość 0, aby użyć wartości domyślnej (1000) | int |
ImageTemplateDistributor
| Nazwa | Opis | Wartość |
|---|---|---|
| artifactTags | Tagi, które zostaną zastosowane do artefaktu po jego utworzeniu/zaktualizowaniu przez dystrybutora. | object |
| runOutputName | Nazwa, która ma być używana dla skojarzonego elementu RunOutput. | ciąg (wymagany) |
| typ | Ustawianie typu obiektu | ManagedImage SharedImage Wirtualny dysk twardy (wymagany) |
ImageTemplateManagedImageDistributor
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ rozkładu. | "ManagedImage" (wymagane) |
| imageId | Identyfikator zasobu obrazu dysku zarządzanego | ciąg (wymagany) |
| location | Lokalizacja platformy Azure dla obrazu powinna być zgodna z tym, czy obraz już istnieje | ciąg (wymagany) |
ImageTemplateSharedImageDistributor
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ rozkładu. | "SharedImage" (wymagane) |
| excludeFromLatest | Flaga wskazująca, czy utworzona wersja obrazu powinna być wykluczona z najnowszej wersji. Pomiń użycie wartości domyślnej (false). | bool |
| galleryImageId | Identyfikator zasobu obrazu Shared Image Gallery | ciąg (wymagany) |
| replicationRegions | Lista regionów, do których obraz zostanie zreplikowany | string[] (wymagane) |
| storageAccountType | Typ konta magazynu, który ma być używany do przechowywania obrazu udostępnionego. Pomiń użycie wartości domyślnej (Standard_LRS). | "Standard_LRS" "Standard_ZRS" |
ImageTemplateVhdDistributor
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ rozkładu. | "VHD" (wymagany) |
ImageTemplateSource
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Ustawianie typu obiektu | ManagedImage PlatformImage SharedImageVersion (wymagane) |
ImageTemplateManagedImageSource
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Określa typ obrazu źródłowego, z którym chcesz zacząć. | "ManagedImage" (wymagane) |
| imageId | Identyfikator zasobu usługi ARM obrazu zarządzanego w subskrypcji klienta | ciąg (wymagany) |
ImageTemplatePlatformImageSource
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Określa typ obrazu źródłowego, z którym chcesz zacząć. | "PlatformImage" (wymagane) |
| offer | Oferta obrazu z obrazów galerii platformy Azure. | ciąg |
| planInfo | Opcjonalna konfiguracja planu zakupu dla obrazu platformy. | PlatformImagePurchasePlan |
| publisher | Image Publisher w obrazach galerii platformy Azure. | ciąg |
| sku | Jednostka SKU obrazu z obrazów galerii platformy Azure. | ciąg |
| 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 |
PlatformImagePurchasePlan
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa planu | Nazwa planu zakupu. | ciąg (wymagany) |
| planProduct | Produkt planu zakupu. | ciąg (wymagany) |
| planPublisher | Wydawca planu zakupu. | ciąg (wymagany) |
ImageTemplateSharedImageVersionSource
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Określa typ obrazu źródłowego, z którym chcesz zacząć. | "SharedImageVersion" (wymagane) |
| imageVersionId | Identyfikator zasobu usługi ARM wersji obrazu w galerii obrazów udostępnionych | ciąg (wymagany) |
ImageTemplatePropertiesValidate
| Nazwa | Opis | Wartość |
|---|---|---|
| continueDistributeOnFailure | Jeśli walidacja nie powiedzie się i to pole ma wartość false, obrazy wyjściowe nie zostaną rozproszone. Jest to zachowanie domyślne. Jeśli walidacja nie powiedzie się i to pole jest ustawione na wartość true, obrazy wyjściowe będą nadal dystrybuowane. Użyj tej opcji ostrożnie, ponieważ może to spowodować rozpowszechnianie nieprawidłowych obrazów do użycia. W obu przypadkach (prawda lub fałsz) uruchomienie obrazu końcowego zostanie zgłoszone jako zakończone niepowodzeniem w przypadku niepowodzenia weryfikacji. [Uwaga: to pole nie ma wpływu, jeśli walidacja zakończy się pomyślnie. | bool |
| inVMValidations | Lista walidacji do wykonania. | ImageTemplateInVMValidator[] |
| sourceValidationOnly | Jeśli to pole ma wartość true, obraz określony w sekcji "źródło" zostanie bezpośrednio zweryfikowany. W celu wygenerowania nie zostanie uruchomiona żadna oddzielna kompilacja, a następnie zweryfikuj dostosowany obraz. | bool |
ImageTemplateInVMValidator
| Nazwa | Opis | Wartość |
|---|---|---|
| name | Przyjazna nazwa w celu zapewnienia kontekstu tego kroku weryfikacji | ciąg |
| typ | Ustawianie typu obiektu | Program PowerShell Powłoka (wymagana ) |
ImageTemplatePowerShellValidator
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ weryfikacji, którego chcesz użyć na obrazie. Na przykład "Shell" może być walidacja powłoki | "PowerShell" (wymagany) |
| inline | Tablica poleceń programu PowerShell do wykonania | ciąg[] |
| 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 walidacji. Może to być link usługi GitHub, identyfikator URI usługi Azure Storage itp. | ciąg |
| sha256Checksum | Suma kontrolna SHA256 skryptu powłoki power shell podana w polu scriptUri powyżej | ciąg |
| validExitCodes | Prawidłowe kody zakończenia skryptu programu PowerShell. [Wartość domyślna: 0] | int[] |
ImageTemplateShellValidator
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ weryfikacji, którego chcesz użyć na obrazie. Na przykład "Shell" może być walidacja powłoki | "Shell" (wymagane) |
| inline | Tablica poleceń powłoki do wykonania | ciąg[] |
| scriptUri | Identyfikator URI skryptu powłoki do uruchomienia na potrzeby walidacji. Może to być link usługi GitHub, identyfikator URI usługi Azure Storage itp. | ciąg |
| sha256Checksum | Suma kontrolna SHA256 skryptu powłoki podana w polu scriptUri | 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 |
| 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. | ciąg[] |
| 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 dla obrazów gen2). | ciąg |
| vnetConfig | Opcjonalna konfiguracja sieci wirtualnej do użycia w celu wdrożenia maszyny wirtualnej kompilacji i maszyny wirtualnej weryfikacji w programie. Pomiń, jeśli nie trzeba używać określonej sieci wirtualnej. | VirtualNetworkConfig |
VirtualNetworkConfig
| Nazwa | Opis | Wartość |
|---|---|---|
| proxyVmSize | 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 zasobu istniejącej podsieci. | ciąg |
Szablony szybkiego startu
Następujące szablony szybkiego startu wdrażają ten typ zasobu.
| Template | Opis |
|---|---|
| Program Azure Image Builder z punktem odniesienia systemu Windows platformy Azure |
Tworzy środowisko narzędzia Azure Image Builder i tworzy obraz systemu Windows Server z zastosowanymi najnowszymi Aktualizacje 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. Możesz wyświetlić wszystkie utworzone zasoby lub bezpośrednio przejść do DevPortal.microsoft.com w celu utworzenia pierwszego urządzenia Dev Box. |
Definicja zasobu narzędzia Terraform (dostawcy AzAPI)
Typ zasobu imageTemplates można wdrożyć w następujących elementach:
- 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 element Terraform do szablonu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.VirtualMachineImages/imageTemplates@2022-02-14"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "UserAssigned"
identity_ids = []
}
body = jsonencode({
properties = {
buildTimeoutInMinutes = int
customize = [
{
name = "string"
type = "string"
// For remaining properties, see ImageTemplateCustomizer objects
}
]
distribute = [
{
artifactTags = {}
runOutputName = "string"
type = "string"
// For remaining properties, see ImageTemplateDistributor objects
}
]
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 ImageTemplateCustomizer
Ustaw właściwość type , aby określić typ obiektu.
W przypadku pliku użyj polecenia :
type = "File"
destination = "string"
sha256Checksum = "string"
sourceUri = "string"
W przypadku programu PowerShell użyj:
type = "PowerShell"
inline = [
"string"
]
runAsSystem = bool
runElevated = bool
scriptUri = "string"
sha256Checksum = "string"
validExitCodes = [
int
]
W przypadku powłoki użyj:
type = "Shell"
inline = [
"string"
]
scriptUri = "string"
sha256Checksum = "string"
W przypadku systemu WindowsRestart użyj:
type = "WindowsRestart"
restartCheckCommand = "string"
restartCommand = "string"
restartTimeout = "string"
W przypadku programu WindowsUpdate użyj:
type = "WindowsUpdate"
filters = [
"string"
]
searchCriteria = "string"
updateLimit = int
Obiekty ImageTemplateDistributor
Ustaw właściwość type , aby określić typ obiektu.
W przypadku elementu ManagedImage użyj:
type = "ManagedImage"
imageId = "string"
location = "string"
W przypadku elementu SharedImage użyj:
type = "SharedImage"
excludeFromLatest = bool
galleryImageId = "string"
replicationRegions = [
"string"
]
storageAccountType = "string"
W przypadku wirtualnego dysku twardego użyj:
type = "VHD"
Obiekty ImageTemplateSource
Ustaw właściwość type , aby określić typ obiektu.
W przypadku elementu ManagedImage użyj:
type = "ManagedImage"
imageId = "string"
W przypadku platformyImage użyj:
type = "PlatformImage"
offer = "string"
planInfo = {
planName = "string"
planProduct = "string"
planPublisher = "string"
}
publisher = "string"
sku = "string"
version = "string"
W przypadku elementu SharedImageVersion użyj:
type = "SharedImageVersion"
imageVersionId = "string"
Obiekty ImageTemplateInVMValidator
Ustaw właściwość type , aby określić typ obiektu.
W przypadku programu PowerShell użyj:
type = "PowerShell"
inline = [
"string"
]
runAsSystem = bool
runElevated = bool
scriptUri = "string"
sha256Checksum = "string"
validExitCodes = [
int
]
W przypadku powłoki użyj:
type = "Shell"
inline = [
"string"
]
scriptUri = "string"
sha256Checksum = "string"
Wartości właściwości
imageTemplates
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ zasobu | "Microsoft.VirtualMachineImages/imageTemplates@2022-02-14" |
| name | Nazwa zasobu | ciąg (wymagany) |
| location | Lokalizacja geograficzna, w której znajduje się zasób | ciąg (wymagany) |
| parent_id | Aby przeprowadzić wdrożenie w grupie zasobów, użyj identyfikatora tej grupy zasobów. | ciąg (wymagany) |
| tags | Tagi zasobów. | Słownik nazw tagów i wartości. |
| identity | Tożsamość szablonu obrazu, jeśli została skonfigurowana. | ImageTemplateIdentity (wymagane) |
| properties | Właściwości szablonu obrazu | Właściwości imageTemplateProperties |
ImageTemplateIdentity
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ tożsamości używanej dla szablonu obrazu. Typ "None" usunie wszystkie tożsamości z szablonu obrazu. | "UserAssigned" |
| identity_ids | Lista tożsamości użytkowników skojarzonych z szablonem obrazu. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów usługi ARM w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | Tablica identyfikatorów tożsamości użytkowników. |
Właściwości imageTemplateProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| buildTimeoutInMinutes | Maksymalny czas trwania oczekiwania podczas tworzenia szablonu obrazu (obejmuje wszystkie dostosowania, walidacje i dystrybucje). Pomiń lub określ wartość 0, aby użyć wartości domyślnej (4 godziny). | int |
| Dostosuj | Określa właściwości używane do opisywania kroków dostosowywania obrazu, takich jak źródło obrazu itp. | ImageTemplateCustomizer[] |
| Rozpowszechniać | Lokalizacja docelowa dystrybucji, do której należy przejść dane wyjściowe obrazu. | ImageTemplateDistributor[] (wymagane) |
| source | Określa właściwości używane do opisania 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 znajdować się 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 |
| walidacja | Opcje konfiguracji i lista walidacji do wykonania na obrazie wynikowym. | ImageTemplatePropertiesValidate |
| vmProfile | Opisuje sposób konfigurowania maszyny wirtualnej do kompilowania obrazów | ImageTemplateVmProfile |
ImageTemplateCustomizer
| Nazwa | Opis | Wartość |
|---|---|---|
| name | Przyjazna nazwa w celu zapewnienia kontekstu tego kroku dostosowywania | ciąg |
| typ | Ustawianie typu obiektu | Plik Program PowerShell Powłoka WindowsRestart WindowsUpdate (wymagane) |
ImageTemplateFileCustomizer
| Nazwa | Opis | Wartość |
|---|---|---|
| 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) |
| destination | Ś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 |
| sha256Checksum | Sha256 sumę kontrolną pliku podanego w polu sourceUri powyżej | ciąg |
| 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. | ciąg |
ImageTemplatePowerShellCustomizer
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ narzędzia dostosowywania, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być konfiguratorem powłoki | "PowerShell" (wymagane) |
| inline | Tablica poleceń programu PowerShell do wykonania | ciąg[] |
| 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 dostosowania. Może to być link github, identyfikator URI sygnatury dostępu współdzielonego dla usługi Azure Storage itp. | ciąg |
| sha256Checksum | Sha256 suma kontrolna skryptu powłoki Power Shell podana w polu scriptUri powyżej | ciąg |
| validExitCodes | Prawidłowe kody zakończenia skryptu programu PowerShell. [Ustawienie domyślne: 0] | int[] |
ImageTemplateShellCustomizer
| Nazwa | Opis | Wartość |
|---|---|---|
| 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) |
| inline | Tablica poleceń powłoki do wykonania | ciąg[] |
| scriptUri | Identyfikator URI skryptu powłoki do uruchomienia w celu dostosowania. Może to być link github, identyfikator URI sygnatury dostępu współdzielonego dla usługi Azure Storage itp. | ciąg |
| sha256Checksum | Suma kontrolna SHA256 skryptu powłoki podana w polu scriptUri | ciąg |
ImageTemplateRestartCustomizer
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ narzędzia dostosowywania, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być konfiguratorem powłoki | "WindowsRestart" (wymagane) |
| restartCheckPolecenia | Polecenie sprawdzania, czy ponowne uruchomienie zakończyło się pomyślnie [Ustawienie domyślne: ''] | ciąg |
| restartCommand | Polecenie do wykonania ponownego uruchomienia [Domyślne: 'shutdown /r /f /t 0 /c "packer restart"] | ciąg |
| restartTimeout | Limit czasu ponownego uruchomienia określony jako ciąg wielkości i jednostki, np. "5m" (5 minut) lub "2h" (2 godziny) [Wartość domyślna: "5m"] | ciąg |
ImageTemplateWindowsUpdateCustomizer
| Nazwa | Opis | Wartość |
|---|---|---|
| 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) |
| 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[] |
| searchCriteria | Kryteria wyszukiwania aktualizacji. Pomiń lub określ pusty ciąg, aby użyć wartości domyślnej (przeszukaj wszystko). Zapoznaj się z powyższym linkiem, aby zapoznać się z przykładami i szczegółowym opisem tego pola. | ciąg |
| updateLimit | Maksymalna liczba aktualizacji do zastosowania w danym momencie. Pomiń lub określ wartość 0, aby użyć wartości domyślnej (1000) | int |
ImageTemplateDistributor
| Nazwa | Opis | Wartość |
|---|---|---|
| artifactTags | Tagi, które zostaną zastosowane do artefaktu po jego utworzeniu/zaktualizowaniu przez dystrybutora. | object |
| runOutputName | Nazwa, która ma być używana dla skojarzonego elementu RunOutput. | ciąg (wymagany) |
| typ | Ustawianie typu obiektu | ManagedImage SharedImage Wirtualny dysk twardy (wymagany) |
ImageTemplateManagedImageDistributor
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ rozkładu. | "ManagedImage" (wymagane) |
| imageId | Identyfikator zasobu obrazu dysku zarządzanego | ciąg (wymagany) |
| location | Lokalizacja platformy Azure dla obrazu powinna być zgodna z tym, czy obraz już istnieje | ciąg (wymagany) |
ImageTemplateSharedImageDistributor
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ rozkładu. | "SharedImage" (wymagane) |
| excludeFromLatest | Flaga wskazująca, czy utworzona wersja obrazu powinna być wykluczona z najnowszej wersji. Pomiń użycie wartości domyślnej (false). | bool |
| galleryImageId | Identyfikator zasobu obrazu Shared Image Gallery | ciąg (wymagany) |
| replicationRegions | Lista regionów, do których obraz zostanie zreplikowany | string[] (wymagane) |
| storageAccountType | Typ konta magazynu, który ma być używany do przechowywania obrazu udostępnionego. Pomiń użycie wartości domyślnej (Standard_LRS). | "Standard_LRS" "Standard_ZRS" |
ImageTemplateVhdDistributor
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ rozkładu. | "VHD" (wymagany) |
ImageTemplateSource
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Ustawianie typu obiektu | ManagedImage PlatformImage SharedImageVersion (wymagane) |
ImageTemplateManagedImageSource
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Określa typ obrazu źródłowego, z którym chcesz zacząć. | "ManagedImage" (wymagane) |
| imageId | Identyfikator zasobu usługi ARM obrazu zarządzanego w subskrypcji klienta | ciąg (wymagany) |
ImageTemplatePlatformImageSource
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Określa typ obrazu źródłowego, z którym chcesz zacząć. | "PlatformImage" (wymagane) |
| offer | Oferta obrazu z obrazów galerii platformy Azure. | ciąg |
| planInfo | Opcjonalna konfiguracja planu zakupu dla obrazu platformy. | PlatformImagePurchasePlan |
| publisher | Image Publisher w obrazach galerii platformy Azure. | ciąg |
| sku | Jednostka SKU obrazu z obrazów galerii platformy Azure. | ciąg |
| 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 |
PlatformImagePurchasePlan
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa planu | Nazwa planu zakupu. | ciąg (wymagany) |
| planProduct | Produkt planu zakupu. | ciąg (wymagany) |
| planPublisher | Wydawca planu zakupu. | ciąg (wymagany) |
ImageTemplateSharedImageVersionSource
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Określa typ obrazu źródłowego, z którym chcesz zacząć. | "SharedImageVersion" (wymagane) |
| imageVersionId | Identyfikator zasobu usługi ARM wersji obrazu w galerii obrazów udostępnionych | ciąg (wymagany) |
ImageTemplatePropertiesValidate
| Nazwa | Opis | Wartość |
|---|---|---|
| continueDistributeOnFailure | Jeśli walidacja nie powiedzie się i to pole ma wartość false, obrazy wyjściowe nie będą dystrybuowane. Jest to zachowanie domyślne. Jeśli walidacja nie powiedzie się i 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życia. W obu przypadkach (prawda lub fałsz) uruchomienie obrazu końcowego zostanie zgłoszone jako zakończone niepowodzeniem w przypadku niepowodzenia weryfikacji. [Uwaga: to pole nie ma wpływu, jeśli walidacja zakończy się pomyślnie.] | bool |
| inVMValidations | Lista walidacji do wykonania. | ImageTemplateInVMValidator[] |
| sourceValidationOnly | Jeśli to pole ma wartość true, obraz określony w sekcji "source" zostanie zweryfikowany bezpośrednio. W celu wygenerowania nie zostanie uruchomiona żadna oddzielna kompilacja, a następnie zweryfikuj dostosowany obraz. | bool |
ImageTemplateInVMValidator
| Nazwa | Opis | Wartość |
|---|---|---|
| name | Przyjazna nazwa, aby podać kontekst dotyczący tego, co robi ten krok weryfikacji | ciąg |
| typ | Ustawianie typu obiektu | Program PowerShell Powłoka (wymagana ) |
ImageTemplatePowerShellValidator
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ weryfikacji, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być walidacją powłoki | "PowerShell" (wymagane) |
| inline | Tablica poleceń programu PowerShell do wykonania | ciąg[] |
| 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. | ciąg |
| sha256Checksum | Sha256 suma kontrolna skryptu powłoki Power Shell podana w polu scriptUri powyżej | ciąg |
| validExitCodes | Prawidłowe kody zakończenia skryptu programu PowerShell. [Ustawienie domyślne: 0] | int[] |
ImageTemplateShellValidator
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ weryfikacji, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być walidacją powłoki | "Shell" (wymagane) |
| inline | Tablica poleceń powłoki do wykonania | ciąg[] |
| 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 |
| sha256Checksum | Suma kontrolna SHA256 skryptu powłoki podana w polu scriptUri | 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 |
| userAssignedIdentities | Opcjonalna tablica identyfikatorów zasobów tożsamości zarządzanych przypisanych przez użytkownika do skonfigurowania na maszynie wirtualnej kompilacji i maszynie wirtualnej weryfikacji. Może to obejmować tożsamość szablonu obrazu. | ciąg[] |
| vmSize | Rozmiar maszyny wirtualnej używanej do tworzenia, dostosowywania i przechwytywania obrazów. Pomiń lub określ pusty ciąg, aby użyć wartości domyślnej (Standard_D1_v2 dla obrazów gen1 i Standard_D2ds_v4 dla obrazów gen2). | ciąg |
| vnetConfig | Opcjonalna konfiguracja sieci wirtualnej do wdrożenia maszyny wirtualnej kompilacji i walidacji maszyny wirtualnej w programie . Pomiń, jeśli nie trzeba używać określonej sieci wirtualnej. | VirtualNetworkConfig |
VirtualNetworkConfig
| Nazwa | Opis | Wartość |
|---|---|---|
| proxyVmSize | 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 zasobu istniejącej podsieci. | ciąg |
Opinia
Dostępne już wkrótce: W 2024 r. będziemy stopniowo wycofywać zgłoszenia z serwisu GitHub jako mechanizm przesyłania opinii na temat zawartości i zastępować go nowym systemem opinii. Aby uzyskać więcej informacji, sprawdź: https://aka.ms/ContentUserFeedback.
Prześlij i wyświetl opinię dla