Udostępnij za pośrednictwem


Microsoft.VirtualMachineImages imageTemplates 2019-05-01-preview

Definicja zasobu Bicep

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

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@2019-05-01-preview' = {
  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
    }
    vmProfile: {
      vmSize: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

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'
  ]
  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'
}

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:

{
  galleryImageId: 'string'
  replicationRegions: [
    'string'
  ]
  type: 'SharedImage'
}

W przypadkuwirtualnego dysku twardego użyj:

{
  type: 'VHD'
}

Obiekty ImageTemplateSource

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

W przypadku ISO użyj:

{
  sha256Checksum: 'string'
  sourceUri: 'string'
  type: 'ISO'
}

W przypadku ManagedImageużyj:

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

W przypadku PlatformImageużyj:

{
  offer: 'string'
  publisher: 'string'
  sku: 'string'
  type: 'PlatformImage'
  version: 'string'
}

W przypadku SharedImageVersionużyj:

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

Wartości właściwości

ComponentsVrq145SchemasImagetemplateidentityPropertiesUserassignedidentitiesAdditionalproperties

Nazwa Opis Wartość

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. "Plik"
"PowerShell"
"Powłoka"
"WindowsRestart" (wymagany)

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 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 arm w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". ImageTemplateIdentityUserAssignedIdentities

ImageTemplateIdentityUserAssignedIdentities

Nazwa Opis Wartość

ImageTemplateIsoSource

Nazwa Opis Wartość
sha256Checksum Sha256 Suma kontrolna obrazu ISO. ciąg (wymagany)
sourceUri Identyfikator URI umożliwiający pobranie obrazu ISO. Ten identyfikator URI musi być dostępny dla dostawcy zasobów podczas tworzenia szablonu obrazu. ciąg (wymagany)
typ Określa typ obrazu źródłowego, z którym chcesz zacząć. "ISO" (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
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. struna

ImageTemplatePowerShellCustomizer

Nazwa Opis Wartość
Wbudowany Tablica poleceń programu PowerShell do wykonania string[]
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[]

ImageTemplateProperties

Nazwa Opis Wartość
buildTimeoutInMinutes Maksymalny czas trwania oczekiwania podczas kompilowania szablonu obrazu. 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)
vmProfile Opisuje sposób konfigurowania maszyny wirtualnej do kompilowania obrazów ImageTemplateVmProfile

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ść
galleryImageId Identyfikator zasobu obrazu galerii obrazów udostępnionych ciąg (wymagany)
replicationRegions Lista regionów, do których obraz zostanie zreplikowany string[] (wymagane)
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)

ImageTemplateSource

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

ImageTemplateVhdDistributor

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

ImageTemplateVmProfile

Nazwa Opis Wartość
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). struna

Microsoft.VirtualMachineImages/imageTemplates

Nazwa Opis Wartość
tożsamość Tożsamość szablonu obrazu, jeśli jest skonfigurowana. ImageTemplateIdentity
lokalizacja Lokalizacja zasobu ciąg (wymagany)
nazwa Nazwa zasobu struna

Ograniczenia:
Wzorzec = ^[A-Za-z0-9-_.]{1,64}$ (wymagane)
Właściwości Właściwości szablonu obrazu ImageTemplateProperties
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach

Tagi zasobów

Nazwa Opis Wartość

Przykłady z przewodnika Szybki start

W poniższych przykładach szybkiego startu wdrożono ten typ zasobu.

Plik Bicep Opis
Azure Image Builder z programem Azure Windows Baseline Tworzy środowisko narzędzia Azure Image Builder i tworzy obraz systemu Windows Server z zastosowanymi najnowszymi aktualizacjami systemu Windows i punktem odniesienia platformy Azure.
Konfigurowanie usługi Dev Box Ten szablon umożliwia utworzenie wszystkich zasobów administracyjnych usługi Dev Box zgodnie z przewodnikiem Szybki start dotyczącym usługi Dev Box (/azure/dev-box/quickstart-create-dev-box). Możesz wyświetlić wszystkie utworzone zasoby lub bezpośrednio przejść do DevPortal.microsoft.com, aby utworzyć pierwsze rozwiązanie Dev Box.

Definicja zasobu szablonu usługi ARM

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

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

Format zasobu

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

{
  "type": "Microsoft.VirtualMachineImages/imageTemplates",
  "apiVersion": "2019-05-01-preview",
  "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
    } ],
    "source": {
      "type": "string"
      // For remaining properties, see ImageTemplateSource objects
    },
    "vmProfile": {
      "vmSize": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

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" ],
  "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"
}

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:

{
  "galleryImageId": "string",
  "replicationRegions": [ "string" ],
  "type": "SharedImage"
}

W przypadkuwirtualnego dysku twardego użyj:

{
  "type": "VHD"
}

Obiekty ImageTemplateSource

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

W przypadku ISO użyj:

{
  "sha256Checksum": "string",
  "sourceUri": "string",
  "type": "ISO"
}

W przypadku ManagedImageużyj:

{
  "imageId": "string",
  "type": "ManagedImage"
}

W przypadku PlatformImageużyj:

{
  "offer": "string",
  "publisher": "string",
  "sku": "string",
  "type": "PlatformImage",
  "version": "string"
}

W przypadku SharedImageVersionużyj:

{
  "imageVersionId": "string",
  "type": "SharedImageVersion"
}

Wartości właściwości

ComponentsVrq145SchemasImagetemplateidentityPropertiesUserassignedidentitiesAdditionalproperties

Nazwa Opis Wartość

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. "Plik"
"PowerShell"
"Powłoka"
"WindowsRestart" (wymagany)

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 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 arm w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". ImageTemplateIdentityUserAssignedIdentities

ImageTemplateIdentityUserAssignedIdentities

Nazwa Opis Wartość

ImageTemplateIsoSource

Nazwa Opis Wartość
sha256Checksum Sha256 Suma kontrolna obrazu ISO. ciąg (wymagany)
sourceUri Identyfikator URI umożliwiający pobranie obrazu ISO. Ten identyfikator URI musi być dostępny dla dostawcy zasobów podczas tworzenia szablonu obrazu. ciąg (wymagany)
typ Określa typ obrazu źródłowego, z którym chcesz zacząć. "ISO" (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
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. struna

ImageTemplatePowerShellCustomizer

Nazwa Opis Wartość
Wbudowany Tablica poleceń programu PowerShell do wykonania string[]
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[]

ImageTemplateProperties

Nazwa Opis Wartość
buildTimeoutInMinutes Maksymalny czas trwania oczekiwania podczas kompilowania szablonu obrazu. 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)
vmProfile Opisuje sposób konfigurowania maszyny wirtualnej do kompilowania obrazów ImageTemplateVmProfile

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ść
galleryImageId Identyfikator zasobu obrazu galerii obrazów udostępnionych ciąg (wymagany)
replicationRegions Lista regionów, do których obraz zostanie zreplikowany string[] (wymagane)
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)

ImageTemplateSource

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

ImageTemplateVhdDistributor

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

ImageTemplateVmProfile

Nazwa Opis Wartość
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). struna

Microsoft.VirtualMachineImages/imageTemplates

Nazwa Opis Wartość
apiVersion Wersja interfejsu API "2019-05-01-preview"
tożsamość Tożsamość szablonu obrazu, jeśli jest skonfigurowana. ImageTemplateIdentity
lokalizacja Lokalizacja zasobu ciąg (wymagany)
nazwa Nazwa zasobu struna

Ograniczenia:
Wzorzec = ^[A-Za-z0-9-_.]{1,64}$ (wymagane)
Właściwości Właściwości szablonu obrazu ImageTemplateProperties
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach
typ Typ zasobu "Microsoft.VirtualMachineImages/imageTemplates"

Tagi zasobów

Nazwa Opis Wartość

Szablony szybkiego startu

Następujące szablony szybkiego startu wdrażają ten typ zasobu.

Szablon Opis
Azure Image Builder z programem Azure Windows Baseline

wdrażanie w usłudze Azure
Tworzy środowisko narzędzia Azure Image Builder i tworzy obraz systemu Windows Server z zastosowanymi najnowszymi aktualizacjami systemu Windows i punktem odniesienia platformy Azure.
Konfigurowanie usługi Dev Box

wdrażanie w usłudze Azure
Ten szablon umożliwia utworzenie wszystkich zasobów administracyjnych usługi Dev Box zgodnie z przewodnikiem Szybki start dotyczącym usługi Dev Box (/azure/dev-box/quickstart-create-dev-box). Możesz wyświetlić wszystkie utworzone zasoby lub bezpośrednio przejść do DevPortal.microsoft.com, aby utworzyć pierwsze rozwiązanie Dev Box.

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

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

  • grupy zasobów

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

Format zasobu

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.VirtualMachineImages/imageTemplates@2019-05-01-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    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
      }
      vmProfile = {
        vmSize = "string"
      }
    }
  })
}

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"
  ]
  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"
}

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:

{
  galleryImageId = "string"
  replicationRegions = [
    "string"
  ]
  type = "SharedImage"
}

W przypadkuwirtualnego dysku twardego użyj:

{
  type = "VHD"
}

Obiekty ImageTemplateSource

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

W przypadku ISO użyj:

{
  sha256Checksum = "string"
  sourceUri = "string"
  type = "ISO"
}

W przypadku ManagedImageużyj:

{
  imageId = "string"
  type = "ManagedImage"
}

W przypadku PlatformImageużyj:

{
  offer = "string"
  publisher = "string"
  sku = "string"
  type = "PlatformImage"
  version = "string"
}

W przypadku SharedImageVersionużyj:

{
  imageVersionId = "string"
  type = "SharedImageVersion"
}

Wartości właściwości

ComponentsVrq145SchemasImagetemplateidentityPropertiesUserassignedidentitiesAdditionalproperties

Nazwa Opis Wartość

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. "Plik"
"PowerShell"
"Powłoka"
"WindowsRestart" (wymagany)

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 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 arm w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". ImageTemplateIdentityUserAssignedIdentities

ImageTemplateIdentityUserAssignedIdentities

Nazwa Opis Wartość

ImageTemplateIsoSource

Nazwa Opis Wartość
sha256Checksum Sha256 Suma kontrolna obrazu ISO. ciąg (wymagany)
sourceUri Identyfikator URI umożliwiający pobranie obrazu ISO. Ten identyfikator URI musi być dostępny dla dostawcy zasobów podczas tworzenia szablonu obrazu. ciąg (wymagany)
typ Określa typ obrazu źródłowego, z którym chcesz zacząć. "ISO" (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
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. struna

ImageTemplatePowerShellCustomizer

Nazwa Opis Wartość
Wbudowany Tablica poleceń programu PowerShell do wykonania string[]
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[]

ImageTemplateProperties

Nazwa Opis Wartość
buildTimeoutInMinutes Maksymalny czas trwania oczekiwania podczas kompilowania szablonu obrazu. 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)
vmProfile Opisuje sposób konfigurowania maszyny wirtualnej do kompilowania obrazów ImageTemplateVmProfile

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ść
galleryImageId Identyfikator zasobu obrazu galerii obrazów udostępnionych ciąg (wymagany)
replicationRegions Lista regionów, do których obraz zostanie zreplikowany string[] (wymagane)
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)

ImageTemplateSource

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

ImageTemplateVhdDistributor

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

ImageTemplateVmProfile

Nazwa Opis Wartość
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). struna

Microsoft.VirtualMachineImages/imageTemplates

Nazwa Opis Wartość
tożsamość Tożsamość szablonu obrazu, jeśli jest skonfigurowana. ImageTemplateIdentity
lokalizacja Lokalizacja zasobu ciąg (wymagany)
nazwa Nazwa zasobu struna

Ograniczenia:
Wzorzec = ^[A-Za-z0-9-_.]{1,64}$ (wymagane)
Właściwości Właściwości szablonu obrazu ImageTemplateProperties
Tagi Tagi zasobów Słownik nazw tagów i wartości.
typ Typ zasobu "Microsoft.VirtualMachineImages/imageTemplates@2019-05-01-preview"

Tagi zasobów

Nazwa Opis Wartość