共用方式為

Microsoft.VirtualMachineImages imageTemplates 2019-02-01-preview

  • 發行項

Bicep 資源定義

imageTemplates 資源類型可以使用目標作業來部署：

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.VirtualMachineImages/imageTemplates 資源，請將下列 Bicep 新增至範本。

resource symbolicname 'Microsoft.VirtualMachineImages/imageTemplates@2019-02-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    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
    }
  }
}

ImageTemplateCustomizer 物件

設定 類型 屬性，以指定物件的類型。

針對 PowerShell，請使用：

  type: 'PowerShell'
  inline: [
    'string'
  ]
  script: 'string'
  validExitCodes: [
    int
  ]

針對 Shell，請使用：

  type: 'Shell'
  inline: [
    'string'
  ]
  script: 'string'

針對 windowsRestart，請使用：

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

ImageTemplateDistributor 物件

設定 類型 屬性，以指定物件的類型。

針對 ManagedImage，請使用：

  type: 'ManagedImage'
  imageId: 'string'
  location: 'string'

針對 SharedImage，請使用：

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

針對 VHD，請使用：

  type: 'VHD'

ImageTemplateSource 物件

設定 類型 屬性，以指定物件的類型。

針對 ISO，請使用：

  type: 'ISO'
  sha256Checksum: 'string'
  sourceURI: 'string'

針對 ManagedImage，請使用：

  type: 'ManagedImage'
  imageId: 'string'

針對 PlatformImage，請使用：

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

屬性值

imageTemplates

名字 描述 價值
名字 資源名稱 字串 （必要）
位置 資源位置 字串 （必要）
標籤 資源標籤 標記名稱和值的字典。 請參閱範本中的 標籤
性能 ImageTemplateProperties

ImageTemplateProperties

名字 描述 價值
自訂 指定用來描述映像自定義步驟的屬性，例如影像來源等 ImageTemplateCustomizer[]
分發 影像輸出需要前往的散發目標。 ImageTemplateDistributor[] （必要）
源 指定用來描述來源影像的屬性。 ImageTemplateSource （必要）

ImageTemplateCustomizer

名字 描述 價值
名字 易記名稱，提供此自定義步驟的內容 字串
類型 設定物件類型 PowerShell
Shell
WindowsRestart （必要）

ImageTemplatePowerShellCustomizer

名字 描述 價值
類型 您想要在映像上使用的自訂工具類型。 例如，“Shell” 可以是殼層自定義工具 'PowerShell' （必要）
內嵌 要執行的PowerShell命令陣列 string[]
腳本 要執行以進行自定義的PowerShell腳本。 它可以是 Github 連結、Azure 記憶體的 SAS URI 等等 字串
validExitCodes PowerShell 腳本的有效結束代碼。 [預設值： 0] int[]

ImageTemplateShellCustomizer

名字 描述 價值
類型 您想要在映像上使用的自訂工具類型。 例如，“Shell” 可以是殼層自定義工具 'Shell' （必要）
內嵌 要執行的殼層命令陣列 string[]
腳本 要執行以進行自定義的殼層腳本。 它可以是 Github 連結、Azure 記憶體的 SAS URI 等等 字串

ImageTemplateRestartCustomizer

名字 描述 價值
類型 您想要在映像上使用的自訂工具類型。 例如，“Shell” 可以是殼層自定義工具 'WindowsRestart' （必要）
restartCheckCommand 檢查重新啟動是否成功的命令 [預設值： ''] 字串
restartCommand 執行重新啟動的命令 [預設值： 'shutdown /r /f /t 0 /c “packer restart”'] 字串
restartTimeout 指定為大小和單位字串的重新啟動逾時，例如 '5m' （5 分鐘） 或 '2h' （2 小時） [預設值： '5m'] 字串

ImageTemplateDistributor

名字 描述 價值
artifactTags 散發者建立/更新成品后，將會套用至成品的標記。 物件
runOutputName 要用於相關聯 RunOutput 的名稱。 字串 （必要）

約束：
Pattern = ^[A-Za-z0-9-_]{1,64}$
類型 設定物件類型 ManagedImage
SharedImage
VHD （必要）

ImageTemplateManagedImageDistributor

名字 描述 價值
類型 分佈類型。 'ManagedImage' （必要）
imageId 受控磁碟映像的資源標識碼 字串 （必要）
位置 映射的 Azure 位置，如果映射已經存在，則應該相符 字串 （必要）

ImageTemplateSharedImageDistributor

名字 描述 價值
類型 分佈類型。 'SharedImage' （必要）
galleryImageId 共用映像庫映像的資源標識碼 字串 （必要）
replicationRegions string[] （必要）

ImageTemplateVhdDistributor

名字 描述 價值
類型 分佈類型。 'VHD' （必要）

ImageTemplateSource

名字 描述 價值
類型 設定物件類型 ISO
ManagedImage
PlatformImage （必要）

ImageTemplateIsoSource

名字 描述 價值
類型 指定您想要開頭的來源影像類型。 'ISO' （必要）
sha256Checksum ISO 映射的SHA256總和檢查碼。 字串 （必要）
sourceURI 用來取得 ISO 映像的 URI。 建立映像範本時，資源提供者必須能夠存取此 URI。 字串 （必要）

ImageTemplateManagedImageSource

名字 描述 價值
類型 指定您想要開頭的來源影像類型。 'ManagedImage' （必要）
imageId 客戶訂用帳戶中受控映像的 ARM 資源識別碼 字串 （必要）

ImageTemplatePlatformImageSource

名字 描述 價值
類型 指定您想要開頭的來源影像類型。 'PlatformImage' （必要）
提供 azure 資源庫映像映像供應專案。 字串
發行人 Azure 資源庫映像中的映像發行者。 字串
sku 來自 Azure 資源庫映像的映像 sku。 字串
版本 Azure 資源庫映像中的映射版本。 字串

快速入門範本

下列快速入門範本會部署此資源類型。

範本 描述
使用 Azure Windows 基準 Azure Image Builder

部署至 Azure 		建立 Azure Image Builder 環境，並建置已套用最新 Windows Update 和 Azure Windows 基準的 Windows Server 映射。
設定開發箱服務

部署至 Azure 		此範本會根據 Dev Box 快速入門指南建立所有 Dev Box 系統管理員資源（https://learn.microsoft.com/azure/dev-box/quickstart-create-dev-box）。 您可以檢視所有建立的資源，或直接移至 DevPortal.microsoft.com 來建立您的第一個開發方塊。

ARM 樣本資源定義

imageTemplates 資源類型可以使用目標作業來部署：

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.VirtualMachineImages/imageTemplates 資源，請將下列 JSON 新增至範本。

{
  "type": "Microsoft.VirtualMachineImages/imageTemplates",
  "apiVersion": "2019-02-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "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
    }
  }
}

ImageTemplateCustomizer 物件

設定 類型 屬性，以指定物件的類型。

針對 PowerShell，請使用：

  "type": "PowerShell",
  "inline": [ "string" ],
  "script": "string",
  "validExitCodes": [ "int" ]

針對 Shell，請使用：

  "type": "Shell",
  "inline": [ "string" ],
  "script": "string"

針對 windowsRestart，請使用：

  "type": "WindowsRestart",
  "restartCheckCommand": "string",
  "restartCommand": "string",
  "restartTimeout": "string"

ImageTemplateDistributor 物件

設定 類型 屬性，以指定物件的類型。

針對 ManagedImage，請使用：

  "type": "ManagedImage",
  "imageId": "string",
  "location": "string"

針對 SharedImage，請使用：

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

針對 VHD，請使用：

  "type": "VHD"

ImageTemplateSource 物件

設定 類型 屬性，以指定物件的類型。

針對 ISO，請使用：

  "type": "ISO",
  "sha256Checksum": "string",
  "sourceURI": "string"

針對 ManagedImage，請使用：

  "type": "ManagedImage",
  "imageId": "string"

針對 PlatformImage，請使用：

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

屬性值

imageTemplates

名字 描述 價值
類型 資源類型 'Microsoft.VirtualMachineImages/imageTemplates'
apiVersion 資源 API 版本 '2019-02-01-preview'
名字 資源名稱 字串 （必要）
位置 資源位置 字串 （必要）
標籤 資源標籤 標記名稱和值的字典。 請參閱範本中的 標籤
性能 ImageTemplateProperties

ImageTemplateProperties

名字 描述 價值
自訂 指定用來描述映像自定義步驟的屬性，例如影像來源等 ImageTemplateCustomizer[]
分發 影像輸出需要前往的散發目標。 ImageTemplateDistributor[] （必要）
源 指定用來描述來源影像的屬性。 ImageTemplateSource （必要）

ImageTemplateCustomizer

名字 描述 價值
名字 易記名稱，提供此自定義步驟的內容 字串
類型 設定物件類型 PowerShell
Shell
WindowsRestart （必要）

ImageTemplatePowerShellCustomizer

名字 描述 價值
類型 您想要在映像上使用的自訂工具類型。 例如，“Shell” 可以是殼層自定義工具 'PowerShell' （必要）
內嵌 要執行的PowerShell命令陣列 string[]
腳本 要執行以進行自定義的PowerShell腳本。 它可以是 Github 連結、Azure 記憶體的 SAS URI 等等 字串
validExitCodes PowerShell 腳本的有效結束代碼。 [預設值： 0] int[]

ImageTemplateShellCustomizer

名字 描述 價值
類型 您想要在映像上使用的自訂工具類型。 例如，“Shell” 可以是殼層自定義工具 'Shell' （必要）
內嵌 要執行的殼層命令陣列 string[]
腳本 要執行以進行自定義的殼層腳本。 它可以是 Github 連結、Azure 記憶體的 SAS URI 等等 字串

ImageTemplateRestartCustomizer

名字 描述 價值
類型 您想要在映像上使用的自訂工具類型。 例如，“Shell” 可以是殼層自定義工具 'WindowsRestart' （必要）
restartCheckCommand 檢查重新啟動是否成功的命令 [預設值： ''] 字串
restartCommand 執行重新啟動的命令 [預設值： 'shutdown /r /f /t 0 /c “packer restart”'] 字串
restartTimeout 指定為大小和單位字串的重新啟動逾時，例如 '5m' （5 分鐘） 或 '2h' （2 小時） [預設值： '5m'] 字串

ImageTemplateDistributor

名字 描述 價值
artifactTags 散發者建立/更新成品后，將會套用至成品的標記。 物件
runOutputName 要用於相關聯 RunOutput 的名稱。 字串 （必要）

約束：
Pattern = ^[A-Za-z0-9-_]{1,64}$
類型 設定物件類型 ManagedImage
SharedImage
VHD （必要）

ImageTemplateManagedImageDistributor

名字 描述 價值
類型 分佈類型。 'ManagedImage' （必要）
imageId 受控磁碟映像的資源標識碼 字串 （必要）
位置 映射的 Azure 位置，如果映射已經存在，則應該相符 字串 （必要）

ImageTemplateSharedImageDistributor

名字 描述 價值
類型 分佈類型。 'SharedImage' （必要）
galleryImageId 共用映像庫映像的資源標識碼 字串 （必要）
replicationRegions string[] （必要）

ImageTemplateVhdDistributor

名字 描述 價值
類型 分佈類型。 'VHD' （必要）

ImageTemplateSource

名字 描述 價值
類型 設定物件類型 ISO
ManagedImage
PlatformImage （必要）

ImageTemplateIsoSource

名字 描述 價值
類型 指定您想要開頭的來源影像類型。 'ISO' （必要）
sha256Checksum ISO 映射的SHA256總和檢查碼。 字串 （必要）
sourceURI 用來取得 ISO 映像的 URI。 建立映像範本時，資源提供者必須能夠存取此 URI。 字串 （必要）

ImageTemplateManagedImageSource

名字 描述 價值
類型 指定您想要開頭的來源影像類型。 'ManagedImage' （必要）
imageId 客戶訂用帳戶中受控映像的 ARM 資源識別碼 字串 （必要）

ImageTemplatePlatformImageSource

名字 描述 價值
類型 指定您想要開頭的來源影像類型。 'PlatformImage' （必要）
提供 azure 資源庫映像映像供應專案。 字串
發行人 Azure 資源庫映像中的映像發行者。 字串
sku 來自 Azure 資源庫映像的映像 sku。 字串
版本 Azure 資源庫映像中的映射版本。 字串

快速入門範本

下列快速入門範本會部署此資源類型。

範本 描述
使用 Azure Windows 基準 Azure Image Builder

部署至 Azure 		建立 Azure Image Builder 環境，並建置已套用最新 Windows Update 和 Azure Windows 基準的 Windows Server 映射。
設定開發箱服務

部署至 Azure 		此範本會根據 Dev Box 快速入門指南建立所有 Dev Box 系統管理員資源（https://learn.microsoft.com/azure/dev-box/quickstart-create-dev-box）。 您可以檢視所有建立的資源，或直接移至 DevPortal.microsoft.com 來建立您的第一個開發方塊。

Terraform （AzAPI 提供者） 資源定義

imageTemplates 資源類型可以使用目標作業來部署：

  • 資源群組

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.VirtualMachineImages/imageTemplates 資源，請將下列 Terraform 新增至範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.VirtualMachineImages/imageTemplates@2019-02-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      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
      }
    }
  })
}

ImageTemplateCustomizer 物件

設定 類型 屬性，以指定物件的類型。

針對 PowerShell，請使用：

  type = "PowerShell"
  inline = [
    "string"
  ]
  script = "string"
  validExitCodes = [
    int
  ]

針對 Shell，請使用：

  type = "Shell"
  inline = [
    "string"
  ]
  script = "string"

針對 windowsRestart，請使用：

  type = "WindowsRestart"
  restartCheckCommand = "string"
  restartCommand = "string"
  restartTimeout = "string"

ImageTemplateDistributor 物件

設定 類型 屬性，以指定物件的類型。

針對 ManagedImage，請使用：

  type = "ManagedImage"
  imageId = "string"
  location = "string"

針對 SharedImage，請使用：

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

針對 VHD，請使用：

  type = "VHD"

ImageTemplateSource 物件

設定 類型 屬性，以指定物件的類型。

針對 ISO，請使用：

  type = "ISO"
  sha256Checksum = "string"
  sourceURI = "string"

針對 ManagedImage，請使用：

  type = "ManagedImage"
  imageId = "string"

針對 PlatformImage，請使用：

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

屬性值

imageTemplates

名字 描述 價值
類型 資源類型 “Microsoft.VirtualMachineImages/imageTemplates@2019-02-01-preview”
名字 資源名稱 字串 （必要）
位置 資源位置 字串 （必要）
parent_id 若要部署至資源群組，請使用該資源群組的標識碼。 字串 （必要）
標籤 資源標籤 標記名稱和值的字典。
性能 ImageTemplateProperties

ImageTemplateProperties

名字 描述 價值
自訂 指定用來描述映像自定義步驟的屬性，例如影像來源等 ImageTemplateCustomizer[]
分發 影像輸出需要前往的散發目標。 ImageTemplateDistributor[] （必要）
源 指定用來描述來源影像的屬性。 ImageTemplateSource （必要）

ImageTemplateCustomizer

名字 描述 價值
名字 易記名稱，提供此自定義步驟的內容 字串
類型 設定物件類型 PowerShell
Shell
WindowsRestart （必要）

ImageTemplatePowerShellCustomizer

名字 描述 價值
類型 您想要在映像上使用的自訂工具類型。 例如，“Shell” 可以是殼層自定義工具 “PowerShell” （必要）
內嵌 要執行的PowerShell命令陣列 string[]
腳本 要執行以進行自定義的PowerShell腳本。 它可以是 Github 連結、Azure 記憶體的 SAS URI 等等 字串
validExitCodes PowerShell 腳本的有效結束代碼。 [預設值： 0] int[]

ImageTemplateShellCustomizer

名字 描述 價值
類型 您想要在映像上使用的自訂工具類型。 例如，“Shell” 可以是殼層自定義工具 “Shell” （必要）
內嵌 要執行的殼層命令陣列 string[]
腳本 要執行以進行自定義的殼層腳本。 它可以是 Github 連結、Azure 記憶體的 SAS URI 等等 字串

ImageTemplateRestartCustomizer

名字 描述 價值
類型 您想要在映像上使用的自訂工具類型。 例如，“Shell” 可以是殼層自定義工具 “WindowsRestart” （必要）
restartCheckCommand 檢查重新啟動是否成功的命令 [預設值： ''] 字串
restartCommand 執行重新啟動的命令 [預設值： 'shutdown /r /f /t 0 /c “packer restart”'] 字串
restartTimeout 指定為大小和單位字串的重新啟動逾時，例如 '5m' （5 分鐘） 或 '2h' （2 小時） [預設值： '5m'] 字串

ImageTemplateDistributor

名字 描述 價值
artifactTags 散發者建立/更新成品后，將會套用至成品的標記。 物件
runOutputName 要用於相關聯 RunOutput 的名稱。 字串 （必要）

約束：
Pattern = ^[A-Za-z0-9-_]{1,64}$
類型 設定物件類型 ManagedImage
SharedImage
VHD （必要）

ImageTemplateManagedImageDistributor

名字 描述 價值
類型 分佈類型。 “ManagedImage” （必要）
imageId 受控磁碟映像的資源標識碼 字串 （必要）
位置 映射的 Azure 位置，如果映射已經存在，則應該相符 字串 （必要）

ImageTemplateSharedImageDistributor

名字 描述 價值
類型 分佈類型。 “SharedImage” （必要）
galleryImageId 共用映像庫映像的資源標識碼 字串 （必要）
replicationRegions string[] （必要）

ImageTemplateVhdDistributor

名字 描述 價值
類型 分佈類型。 “VHD” （必要）

ImageTemplateSource

名字 描述 價值
類型 設定物件類型 ISO
ManagedImage
PlatformImage （必要）

ImageTemplateIsoSource

名字 描述 價值
類型 指定您想要開頭的來源影像類型。 “ISO” （必要）
sha256Checksum ISO 映射的SHA256總和檢查碼。 字串 （必要）
sourceURI 用來取得 ISO 映像的 URI。 建立映像範本時，資源提供者必須能夠存取此 URI。 字串 （必要）

ImageTemplateManagedImageSource

名字 描述 價值
類型 指定您想要開頭的來源影像類型。 “ManagedImage” （必要）
imageId 客戶訂用帳戶中受控映像的 ARM 資源識別碼 字串 （必要）

ImageTemplatePlatformImageSource

名字 描述 價值
類型 指定您想要開頭的來源影像類型。 “PlatformImage” （必要）
提供 azure 資源庫映像映像供應專案。 字串
發行人 Azure 資源庫映像中的映像發行者。 字串
sku 來自 Azure 資源庫映像的映像 sku。 字串
版本 Azure 資源庫映像中的映射版本。 字串