Microsoft.VirtualMachineImages imageTemplates 2019-05-01-preview

Bicep リソース定義

imageTemplates リソースの種類は、次のようにデプロイできます。

• リソース グループ - リソース グループのデプロイ コマンドに関するページを参照してください

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.VirtualMachineImages/imageTemplates リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.VirtualMachineImages/imageTemplates@2019-05-01-preview' = {
  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
    }
    vmProfile: {
      vmSize: 'string'
    }
  }
}

ImageTemplateCustomizer オブジェクト

type プロパティを設定して、オブジェクトの種類を指定します。

[ファイル] には、次の値を使用します。

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

PowerShell の場合は、次の値を使用します。

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

Shell の場合は、次のコマンドを使用します。

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

WindowsRestart の場合は、次の値を使用します。

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

ImageTemplateDistributor オブジェクト

type プロパティを設定して、オブジェクトの種類を指定します。

ManagedImage の場合は、次の値を使用します。

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

SharedImage の場合は、次の値を使用します。

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

VHD の場合は、次の値を使用します。

  type: 'VHD'

ImageTemplateSource オブジェクト

type プロパティを設定して、オブジェクトの種類を指定します。

ISO の場合は、次の値を使用します。

  type: 'ISO'
  sha256Checksum: 'string'
  sourceUri: 'string'

ManagedImage の場合は、次の値を使用します。

  type: 'ManagedImage'
  imageId: 'string'

PlatformImage の場合は、次の値を使用します。

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

SharedImageVersion の場合は、次の値を使用します。

  type: 'SharedImageVersion'
  imageVersionId: 'string'

プロパティ値

imageTemplates

ImageTemplateIdentity

ImageTemplateProperties

ImageTemplateCustomizer

ImageTemplateFileCustomizer

ImageTemplatePowerShellCustomizer

ImageTemplateShellCustomizer

ImageTemplateRestartCustomizer

ImageTemplateDistributor

ImageTemplateManagedImageDistributor

ImageTemplateSharedImageDistributor

ImageTemplateVhdDistributor

ImageTemplateSource

ImageTemplateIsoSource

ImageTemplateManagedImageSource

ImageTemplatePlatformImageSource

ImageTemplateSharedImageVersionSource

ImageTemplateVmProfile

クイック スタート テンプレート

次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。

Template	説明
Azure Image Builder と Azure Windows ベースライン	Azure Image Builder 環境を作成し、最新の Windows 更新と Azure Windows ベースラインが適用された Windows Server イメージを構築します。
Dev Box サービスを構成する	このテンプレートでは、Dev Box クイック スタート ガイドに従って、すべての Dev Box 管理リソースが作成されます。 作成されたすべてのリソースを表示することも、DevPortal.microsoft.com に直接移動して最初の Dev Box を作成することもできます。

ARM テンプレート リソース定義

imageTemplates リソースの種類は、次の対象にデプロイできます。

• リソース グループ - リソース グループのデプロイ コマンドを参照してください

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.VirtualMachineImages/imageTemplates リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.VirtualMachineImages/imageTemplates",
  "apiVersion": "2019-05-01-preview",
  "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
    },
    "vmProfile": {
      "vmSize": "string"
    }
  }
}

ImageTemplateCustomizer オブジェクト

オブジェクトの 型 を指定するには、type プロパティを設定します。

[ファイル] には、次の値を使用します。

  "type": "File",
  "destination": "string",
  "sha256Checksum": "string",
  "sourceUri": "string"

PowerShell の場合は、次の値を使用します。

  "type": "PowerShell",
  "inline": [ "string" ],
  "runElevated": "bool",
  "scriptUri": "string",
  "sha256Checksum": "string",
  "validExitCodes": [ "int" ]

Shell の場合は、次のコマンドを使用します。

  "type": "Shell",
  "inline": [ "string" ],
  "scriptUri": "string",
  "sha256Checksum": "string"

WindowsRestart の場合は、次の値を使用します。

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

ImageTemplateDistributor オブジェクト

オブジェクトの 型 を指定するには、type プロパティを設定します。

ManagedImage の場合は、次の値を使用します。

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

SharedImage の場合は、次の値を使用します。

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

VHD の場合は、次の値を使用します。

  "type": "VHD"

ImageTemplateSource オブジェクト

オブジェクトの 型 を指定するには、type プロパティを設定します。

ISO の場合は、次の値を使用します。

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

ManagedImage の場合は、次の値を使用します。

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

PlatformImage の場合は、次の値を使用します。

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

SharedImageVersion の場合は、次の値を使用します。

  "type": "SharedImageVersion",
  "imageVersionId": "string"

プロパティ値

imageTemplates

ImageTemplateIdentity

ImageTemplateProperties

ImageTemplateCustomizer

ImageTemplateFileCustomizer

ImageTemplatePowerShellCustomizer

ImageTemplateShellCustomizer

ImageTemplateRestartCustomizer

ImageTemplateDistributor

ImageTemplateManagedImageDistributor

ImageTemplateSharedImageDistributor

ImageTemplateVhdDistributor

ImageTemplateSource

ImageTemplateIsoSource

ImageTemplateManagedImageSource

ImageTemplatePlatformImageSource

ImageTemplateSharedImageVersionSource

ImageTemplateVmProfile

クイック スタート テンプレート

次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。

Template	説明
Azure Image Builder と Azure Windows ベースライン	Azure Image Builder 環境を作成し、最新の Windows 更新と Azure Windows ベースラインが適用された Windows Server イメージを構築します。
Dev Box サービスを構成する	このテンプレートでは、Dev Box クイック スタート ガイドに従って、すべての Dev Box 管理リソースが作成されます。 作成されたすべてのリソースを表示することも、DevPortal.microsoft.com に直接移動して最初の Dev Box を作成することもできます。

Terraform (AzAPI プロバイダー) リソース定義

imageTemplates リソースの種類は、次の対象にデプロイできます。

• リソース グループ

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.VirtualMachineImages/imageTemplates リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.VirtualMachineImages/imageTemplates@2019-05-01-preview"
  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
      }
      vmProfile = {
        vmSize = "string"
      }
    }
  })
}

ImageTemplateCustomizer オブジェクト

オブジェクトの 型 を指定するには、type プロパティを設定します。

[ファイル] には、次の値を使用します。

  type = "File"
  destination = "string"
  sha256Checksum = "string"
  sourceUri = "string"

PowerShell の場合は、次の値を使用します。

  type = "PowerShell"
  inline = [
    "string"
  ]
  runElevated = bool
  scriptUri = "string"
  sha256Checksum = "string"
  validExitCodes = [
    int
  ]

Shell の場合は、次のコマンドを使用します。

  type = "Shell"
  inline = [
    "string"
  ]
  scriptUri = "string"
  sha256Checksum = "string"

WindowsRestart の場合は、次の値を使用します。

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

ImageTemplateDistributor オブジェクト

オブジェクトの 型 を指定するには、type プロパティを設定します。

ManagedImage の場合は、次の値を使用します。

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

SharedImage の場合は、次の値を使用します。

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

VHD の場合は、次の値を使用します。

  type = "VHD"

ImageTemplateSource オブジェクト

オブジェクトの 型 を指定するには、type プロパティを設定します。

ISO の場合は、次の値を使用します。

  type = "ISO"
  sha256Checksum = "string"
  sourceUri = "string"

ManagedImage の場合は、次の値を使用します。

  type = "ManagedImage"
  imageId = "string"

PlatformImage の場合は、次の値を使用します。

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

SharedImageVersion の場合は、次の値を使用します。

  type = "SharedImageVersion"
  imageVersionId = "string"

プロパティ値

imageTemplates

ImageTemplateIdentity

ImageTemplateProperties

ImageTemplateCustomizer

ImageTemplateFileCustomizer

ImageTemplatePowerShellCustomizer

ImageTemplateShellCustomizer

ImageTemplateRestartCustomizer

ImageTemplateDistributor

ImageTemplateManagedImageDistributor

ImageTemplateSharedImageDistributor

ImageTemplateVhdDistributor

ImageTemplateSource

ImageTemplateIsoSource

ImageTemplateManagedImageSource

ImageTemplatePlatformImageSource

ImageTemplateSharedImageVersionSource

ImageTemplateVmProfile