Microsoft.VirtualMachineImages imageTemplates 2022-02-14

Artykuł
12/17/2024

Definicja zasobu Bicep

Typ zasobu imageTemplates można wdrożyć przy użyciu operacji docelowych:

grupy zasobów — zobacz polecenia wdrażania grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.VirtualMachineImages/imageTemplates, dodaj następujący kod Bicep do szablonu.

resource symbolicname 'Microsoft.VirtualMachineImages/imageTemplates@2022-02-14' = {
  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
      }
    ]
    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 ImageTemplateInVMValidator

Ustaw właściwość , aby określić typ obiektu.

W przypadku programu PowerShellużyj:

{
  inline: [
    'string'
  ]
  runAsSystem: bool
  runElevated: bool
  scriptUri: 'string'
  sha256Checksum: 'string'
  type: 'PowerShell'
  validExitCodes: [
    int
  ]
}

W przypadku usługi Shellużyj:

{
  inline: [
    'string'
  ]
  scriptUri: 'string'
  sha256Checksum: 'string'
  type: 'Shell'
}

Obiekty ImageTemplateCustomizer

Ustaw właściwość , aby określić typ obiektu.

W przypadkuplików użyj:

{
  destination: 'string'
  sha256Checksum: 'string'
  sourceUri: 'string'
  type: 'File'
}

W przypadku programu PowerShellużyj:

{
  inline: [
    'string'
  ]
  runAsSystem: bool
  runElevated: bool
  scriptUri: 'string'
  sha256Checksum: 'string'
  type: 'PowerShell'
  validExitCodes: [
    int
  ]
}

W przypadku usługi Shellużyj:

{
  inline: [
    'string'
  ]
  scriptUri: 'string'
  sha256Checksum: 'string'
  type: 'Shell'
}

W przypadku WindowsRestart użyj:

{
  restartCheckCommand: 'string'
  restartCommand: 'string'
  restartTimeout: 'string'
  type: 'WindowsRestart'
}

W przypadku windowsUpdateużyj:

{
  filters: [
    'string'
  ]
  searchCriteria: 'string'
  type: 'WindowsUpdate'
  updateLimit: int
}

Obiekty ImageTemplateSource

Ustaw właściwość , aby określić typ obiektu.

W przypadku ManagedImageużyj:

{
  imageId: 'string'
  type: 'ManagedImage'
}

W przypadku PlatformImageużyj:

{
  offer: 'string'
  planInfo: {
    planName: 'string'
    planProduct: 'string'
    planPublisher: 'string'
  }
  publisher: 'string'
  sku: 'string'
  type: 'PlatformImage'
  version: 'string'
}

W przypadku SharedImageVersionużyj:

{
  imageVersionId: 'string'
  type: 'SharedImageVersion'
}

Obiekty ImageTemplateDistributor

Ustaw właściwość , aby określić typ obiektu.

W przypadku ManagedImageużyj:

{
  imageId: 'string'
  location: 'string'
  type: 'ManagedImage'
}

W przypadku SharedImageużyj:

{
  excludeFromLatest: bool
  galleryImageId: 'string'
  replicationRegions: [
    'string'
  ]
  storageAccountType: 'string'
  type: 'SharedImage'
}

W przypadkuwirtualnego dysku twardego użyj:

{
  type: 'VHD'
}

Wartości właściwości

ImageTemplateCustomizer

Nazwa	Opis	Wartość
nazwa	Przyjazna nazwa, aby podać kontekst tego kroku dostosowywania	struna
typ	Ustaw wartość "Plik" dla typu ImageTemplateFileCustomizer. Ustaw wartość "PowerShell" dla typu ImageTemplatePowerShellCustomizer. Ustaw wartość "Shell" dla typu ImageTemplateShellCustomizer. Ustaw wartość "WindowsRestart" dla typu ImageTemplateRestartCustomizer. Ustaw wartość "WindowsUpdate" dla typu ImageTemplateWindowsUpdateCustomizer.	"Plik" "PowerShell" "Powłoka" "WindowsRestart" "WindowsUpdate" (wymagane)

ImageTemplateDistributor

Nazwa	Opis	Wartość
artifactTags	Tagi, które zostaną zastosowane do artefaktu po jego utworzeniu/zaktualizowaniu przez dystrybutora.	ImageTemplateDistributorArtifactTags
runOutputName	Nazwa, która ma być używana dla skojarzonego elementu RunOutput.	struna Ograniczenia: Wzorzec = `^[A-Za-z0-9-_.]{1,64}$` (wymagane)
typ	Ustaw wartość "ManagedImage" dla typu ImageTemplateManagedImageDistributor. Ustaw wartość "SharedImage" dla typu ImageTemplateSharedImageDistributor. Ustaw wartość "VHD" dla typu ImageTemplateVhdDistributor.	"ManagedImage" "SharedImage" "VHD" (wymagany)

ImageTemplateDistributorArtifactTags

Nazwa	Opis	Wartość

ImageTemplateFileCustomizer

Nazwa	Opis	Wartość
cel	Ścieżka bezwzględna do pliku (z już utworzonymi zagnieżdżonym strukturami katalogów), do którego zostanie przekazany plik (z identyfikatora sourceUri) na maszynie wirtualnej	struna
sha256Checksum	Sha256 suma kontrolna pliku podanego w polu sourceUri powyżej	struna
sourceUri	Identyfikator URI pliku, który ma zostać przekazany do dostosowywania maszyny wirtualnej. Może to być link github, identyfikator URI sygnatury dostępu współdzielonego dla usługi Azure Storage itp.	struna
typ	Typ narzędzia dostosowywania, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być konfiguratorem powłoki	"Plik" (wymagany)

ImageTemplateIdentity

Nazwa	Opis	Wartość
typ	Typ tożsamości używany dla szablonu obrazu. Typ "None" usunie wszystkie tożsamości z szablonu obrazu.	"Brak" "UserAssigned"
userAssignedIdentities	Zestaw tożsamości przypisanych przez użytkownika skojarzonych z zasobem. Klucze słownika userAssignedIdentities będą identyfikatorami zasobów usługi ARM w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Wartości słownika mogą być pustymi obiektami ({}) w żądaniach.	UserAssignedIdentities

ImageTemplateInVMValidator

Nazwa	Opis	Wartość
nazwa	Przyjazna nazwa, aby podać kontekst tego kroku weryfikacji	struna
typ	Ustaw wartość "PowerShell" dla typu ImageTemplatePowerShellValidator. Ustaw wartość "Shell" dla typu ImageTemplateShellValidator.	"PowerShell" "Shell" (wymagane)

ImageTemplateManagedImageDistributor

Nazwa	Opis	Wartość
imageId	Identyfikator zasobu obrazu dysku zarządzanego	ciąg (wymagany)
lokalizacja	Lokalizacja platformy Azure dla obrazu powinna być zgodna z tym, czy obraz już istnieje	ciąg (wymagany)
typ	Typ rozkładu.	"ManagedImage" (wymagane)

ImageTemplateManagedImageSource

Nazwa	Opis	Wartość
imageId	Identyfikator zasobu usługi ARM obrazu zarządzanego w subskrypcji klienta	ciąg (wymagany)
typ	Określa typ obrazu źródłowego, z którym chcesz zacząć.	"ManagedImage" (wymagane)

ImageTemplatePlatformImageSource

Nazwa	Opis	Wartość
oferta	Oferta obrazu z Azure Gallery Images.	struna
planInfo	Opcjonalna konfiguracja planu zakupu dla obrazu platformy.	PlatformImagePurchasePlan
wydawca	Program Image Publisher w usłudze Azure Gallery Images.	struna
Numer jednostki magazynowej	Jednostka SKU obrazu z Obrazów z galerii platformy Azure.	struna
typ	Określa typ obrazu źródłowego, z którym chcesz zacząć.	"PlatformImage" (wymagane)
Wersja	Wersja obrazu z Obrazów z galerii platformy Azure. Jeśli w tym miejscu określono wartość "latest", wersja jest oceniana podczas kompilacji obrazu, a nie podczas przesyłania szablonu.	struna

ImageTemplatePowerShellCustomizer

Nazwa	Opis	Wartość
Wbudowany	Tablica poleceń programu PowerShell do wykonania	string[]
runAsSystem	Jeśli zostanie określony, skrypt programu PowerShell zostanie uruchomiony z podwyższonym poziomem uprawnień przy użyciu użytkownika systemu lokalnego. Może mieć wartość true tylko wtedy, gdy powyższe pole runElevated ma wartość true.	Bool
runElevated	Jeśli zostanie określony, skrypt programu PowerShell zostanie uruchomiony z podwyższonym poziomem uprawnień	Bool
scriptUri	Identyfikator URI skryptu programu PowerShell do uruchomienia na potrzeby dostosowywania. Może to być link github, identyfikator URI sygnatury dostępu współdzielonego dla usługi Azure Storage itp.	struna
sha256Checksum	Suma kontrolna SHA256 skryptu powłoki power shell podana w polu scriptUri powyżej	struna
typ	Typ narzędzia dostosowywania, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być konfiguratorem powłoki	"PowerShell" (wymagany)
validExitCodes	Prawidłowe kody zakończenia skryptu programu PowerShell. [Wartość domyślna: 0]	int[]

ImageTemplatePowerShellValidator

Nazwa	Opis	Wartość
Wbudowany	Tablica poleceń programu PowerShell do wykonania	string[]
runAsSystem	Jeśli zostanie określony, skrypt programu PowerShell zostanie uruchomiony z podwyższonym poziomem uprawnień przy użyciu użytkownika systemu lokalnego. Może mieć wartość true tylko wtedy, gdy powyższe pole runElevated ma wartość true.	Bool
runElevated	Jeśli zostanie określony, skrypt programu PowerShell zostanie uruchomiony z podwyższonym poziomem uprawnień	Bool
scriptUri	Identyfikator URI skryptu programu PowerShell do uruchomienia w celu weryfikacji. Może to być link usługi GitHub, identyfikator URI usługi Azure Storage itp.	struna
sha256Checksum	Suma kontrolna SHA256 skryptu powłoki power shell podana w polu scriptUri powyżej	struna
typ	Typ weryfikacji, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być walidacją powłoki	"PowerShell" (wymagany)
validExitCodes	Prawidłowe kody zakończenia skryptu programu PowerShell. [Wartość domyślna: 0]	int[]

ImageTemplateProperties

Nazwa	Opis	Wartość
buildTimeoutInMinutes	Maksymalny czas trwania oczekiwania podczas kompilowania szablonu obrazu (obejmuje wszystkie dostosowania, walidacje i dystrybucje). Pomiń lub określ wartość 0, aby użyć wartości domyślnej (4 godziny).	Int Ograniczenia: Minimalna wartość = 0 Wartość maksymalna = 960
Dostosuj	Określa właściwości używane do opisywania kroków dostosowywania obrazu, takich jak źródło obrazu itp.	ImageTemplateCustomizer[]
rozdzielać	Lokalizacja docelowa dystrybucji, do której należy przejść dane wyjściowe obrazu.	ImageTemplateDistributor[] (wymagane)
źródło	Określa właściwości używane do opisywania obrazu źródłowego.	ImageTemplateSource (wymagane)
stagingResourceGroup	Identyfikator przejściowej grupy zasobów w tej samej subskrypcji co szablon obrazu, który będzie używany do kompilowania obrazu. Jeśli to pole jest puste, zostanie utworzona grupa zasobów o losowej nazwie. Jeśli grupa zasobów określona w tym polu nie istnieje, zostanie utworzona o tej samej nazwie. Jeśli określona grupa zasobów istnieje, musi być pusta i w tym samym regionie co szablon obrazu. Utworzona grupa zasobów zostanie usunięta podczas usuwania szablonu, jeśli to pole jest puste lub określona grupa zasobów nie istnieje, ale jeśli określona grupa zasobów istnieje, zasoby utworzone w grupie zasobów zostaną usunięte podczas usuwania szablonu, a sama grupa zasobów pozostanie.	struna
walidować	Opcje konfiguracji i lista weryfikacji, które mają zostać wykonane na obrazie wynikowym.	ImageTemplatePropertiesValidate
vmProfile	Opisuje sposób konfigurowania maszyny wirtualnej do kompilowania obrazów	ImageTemplateVmProfile

ImageTemplatePropertiesValidate

Nazwa	Opis	Wartość
continueDistributeOnFailure	Jeśli walidacja nie powiedzie się, a to pole ma wartość false, obrazy wyjściowe nie będą dystrybuowane. Jest to zachowanie domyślne. Jeśli walidacja nie powiedzie się, a to pole ma wartość true, obrazy wyjściowe będą nadal dystrybuowane. Użyj tej opcji z ostrożnością, ponieważ może to spowodować rozpowszechnianie nieprawidłowych obrazów do użytku. W obu przypadkach (prawda lub fałsz) uruchomienie obrazu końcowego zostanie zgłoszone jako zakończone niepowodzeniem w przypadku niepowodzenia weryfikacji. [Uwaga: to pole nie ma wpływu, jeśli walidacja zakończy się pomyślnie.]	Bool
inVMValidations	Lista walidacji do wykonania.	ImageTemplateInVMValidator[]
sourceValidationOnly	Jeśli to pole ma wartość true, obraz określony w sekcji "źródło" zostanie zweryfikowany bezpośrednio. W celu wygenerowania nie zostanie uruchomiona żadna oddzielna kompilacja, a następnie zweryfikuj dostosowany obraz.	Bool

ImageTemplateRestartCustomizer

Nazwa	Opis	Wartość
restartCheckCommand	Polecenie sprawdzania, czy ponowne uruchomienie zakończyło się pomyślnie [Ustawienie domyślne: ""]	struna
restartCommand	Polecenie do wykonania ponownego uruchomienia [Domyślne: "shutdown /r /f /t 0 /c "packer restart"]	struna
restartTimeout	Limit czasu ponownego uruchamiania określony jako ciąg wielkości i jednostki, np. "5m" (5 minut) lub "2h" (2 godziny) [Wartość domyślna: "5m"]	struna
typ	Typ narzędzia dostosowywania, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być konfiguratorem powłoki	"WindowsRestart" (wymagany)

ImageTemplateSharedImageDistributor

Nazwa	Opis	Wartość
excludeFromLatest	Flaga wskazująca, czy utworzona wersja obrazu powinna zostać wykluczona z najnowszej wersji. Pomiń użycie wartości domyślnej (false).	Bool
galleryImageId	Identyfikator zasobu obrazu galerii obrazów udostępnionych	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 udostępnionego obrazu. Pomiń użycie wartości domyślnej (Standard_LRS).	"Standard_LRS" "Standard_ZRS"
typ	Typ rozkładu.	"SharedImage" (wymagane)

ImageTemplateSharedImageVersionSource

Nazwa	Opis	Wartość
imageVersionId	Identyfikator zasobu usługi ARM wersji obrazu w galerii obrazów udostępnionych	ciąg (wymagany)
typ	Określa typ obrazu źródłowego, z którym chcesz zacząć.	"SharedImageVersion" (wymagane)

ImageTemplateShellCustomizer

Nazwa	Opis	Wartość
Wbudowany	Tablica poleceń powłoki do wykonania	string[]
scriptUri	Identyfikator URI skryptu powłoki do uruchomienia na potrzeby dostosowywania. Może to być link github, identyfikator URI sygnatury dostępu współdzielonego dla usługi Azure Storage itp.	struna
sha256Checksum	Suma kontrolna SHA256 skryptu powłoki podana w polu scriptUri	struna
typ	Typ narzędzia dostosowywania, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być konfiguratorem powłoki	"Shell" (wymagane)

ImageTemplateShellValidator

Nazwa	Opis	Wartość
Wbudowany	Tablica poleceń powłoki do wykonania	string[]
scriptUri	Identyfikator URI skryptu powłoki do uruchomienia w celu weryfikacji. Może to być link usługi GitHub, identyfikator URI usługi Azure Storage itp.	struna
sha256Checksum	Suma kontrolna SHA256 skryptu powłoki podana w polu scriptUri	struna
typ	Typ weryfikacji, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być walidacją powłoki	"Shell" (wymagane)

ImageTemplateSource

Nazwa	Opis	Wartość
typ	Ustaw wartość "ManagedImage" dla typu ImageTemplateManagedImageSource. Ustaw wartość "PlatformImage" dla typu ImageTemplatePlatformImageSource. Ustaw wartość "SharedImageVersion" dla typu ImageTemplateSharedImageVersionSource.	"ManagedImage" "PlatformImage" "SharedImageVersion" (wymagane)

ImageTemplateVhdDistributor

Nazwa	Opis	Wartość
typ	Typ rozkładu.	"VHD" (wymagany)

ImageTemplateVmProfile

Nazwa	Opis	Wartość
osDiskSizeGB	Rozmiar dysku systemu operacyjnego w GB. Pomiń lub określ wartość 0, aby użyć domyślnego rozmiaru dysku systemu operacyjnego platformy Azure.	Int Ograniczenia: Minimalna wartość = 0
userAssignedIdentities	Opcjonalna tablica identyfikatorów zasobów tożsamości zarządzanych przypisanych przez użytkownika do skonfigurowania na maszynie wirtualnej kompilacji i na maszynie wirtualnej weryfikacji. Może to obejmować tożsamość szablonu obrazu.	string[]
vmSize	Rozmiar maszyny wirtualnej używanej do kompilowania, dostosowywania i przechwytywania obrazów. Pomiń lub określ pusty ciąg, aby użyć wartości domyślnej (Standard_D1_v2 dla obrazów gen1 i Standard_D2ds_v4 obrazów gen2).	struna
vnetConfig	Opcjonalna konfiguracja sieci wirtualnej, która ma być używana do wdrażania maszyny wirtualnej kompilacji i sprawdzania poprawności maszyny wirtualnej w programie. Pomiń, jeśli nie trzeba używać określonej sieci wirtualnej.	VirtualNetworkConfig

ImageTemplateWindowsUpdateCustomizer

Nazwa	Opis	Wartość
Filtry	Tablica filtrów do wybrania aktualizacji do zastosowania. Pomiń lub określ pustą tablicę, aby użyć wartości domyślnej (bez filtru). Zapoznaj się z powyższym linkiem, aby zapoznać się z przykładami i szczegółowym opisem tego pola.	string[]
searchCriteria	Kryteria wyszukiwania aktualizacji. Pomiń lub określ pusty ciąg, aby użyć wartości domyślnej (wyszukaj wszystko). Zapoznaj się z powyższym linkiem, aby zapoznać się z przykładami i szczegółowym opisem tego pola.	struna
typ	Typ narzędzia dostosowywania, którego chcesz użyć na obrazie. Na przykład "Powłoka" może być konfiguratorem powłoki	"WindowsUpdate" (wymagane)
updateLimit	Maksymalna liczba aktualizacji do zastosowania w danym momencie. Pomiń lub określ wartość 0, aby użyć wartości domyślnej (1000)	Int Ograniczenia: Minimalna wartość = 0