Microsoft.Compute galleries/images 2018-06-01

Bicep resource definition

The galleries/images resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Compute/galleries/images resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Compute/galleries/images@2018-06-01' = {
  parent: resourceSymbolicName
  ___location: 'string'
  name: 'string'
  properties: {
    description: 'string'
    disallowed: {
      diskTypes: [
        'string'
      ]
    }
    endOfLifeDate: 'string'
    eula: 'string'
    identifier: {
      offer: 'string'
      publisher: 'string'
      sku: 'string'
    }
    osState: 'string'
    osType: 'string'
    privacyStatementUri: 'string'
    purchasePlan: {
      name: 'string'
      product: 'string'
      publisher: 'string'
    }
    recommended: {
      memory: {
        max: int
        min: int
      }
      vCPUs: {
        max: int
        min: int
      }
    }
    releaseNoteUri: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.Compute/galleries/images

Disallowed

GalleryImageIdentifier

GalleryImageProperties

ImagePurchasePlan

RecommendedMachineConfiguration

ResourceRange

ResourceTags

Usage Examples

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

ARM template resource definition

The galleries/images resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Compute/galleries/images resource, add the following JSON to your template.

{
  "type": "Microsoft.Compute/galleries/images",
  "apiVersion": "2018-06-01",
  "name": "string",
  "___location": "string",
  "properties": {
    "description": "string",
    "disallowed": {
      "diskTypes": [ "string" ]
    },
    "endOfLifeDate": "string",
    "eula": "string",
    "identifier": {
      "offer": "string",
      "publisher": "string",
      "sku": "string"
    },
    "osState": "string",
    "osType": "string",
    "privacyStatementUri": "string",
    "purchasePlan": {
      "name": "string",
      "product": "string",
      "publisher": "string"
    },
    "recommended": {
      "memory": {
        "max": "int",
        "min": "int"
      },
      "vCPUs": {
        "max": "int",
        "min": "int"
      }
    },
    "releaseNoteUri": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.Compute/galleries/images

Disallowed

GalleryImageIdentifier

GalleryImageProperties

ImagePurchasePlan

RecommendedMachineConfiguration

ResourceRange

ResourceTags

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template	Description
Azure Image Builder with Azure Windows Baseline	Creates an Azure Image Builder environment and builds a Windows Server image with the latest Windows Updates and Azure Windows Baseline applied.
Configure Dev Box service	This template would create all Dev Box admin resources as per Dev Box quick start guide (/azure/dev-box/quickstart-create-dev-box). You can view all resources created, or directly go to DevPortal.microsoft.com to create your first Dev Box.
Create an Image Definition in a Azure Compute Gallery	This template allows you to create a simple Image Definition in a Azure Compute Gallery. Please ensure that you have run the Shared Image Gallery 101 Template before you deploy this.

Terraform (AzAPI provider) resource definition

The galleries/images resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Compute/galleries/images resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/galleries/images@2018-06-01"
  name = "string"
  parent_id = "string"
  ___location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      description = "string"
      disallowed = {
        diskTypes = [
          "string"
        ]
      }
      endOfLifeDate = "string"
      eula = "string"
      identifier = {
        offer = "string"
        publisher = "string"
        sku = "string"
      }
      osState = "string"
      osType = "string"
      privacyStatementUri = "string"
      purchasePlan = {
        name = "string"
        product = "string"
        publisher = "string"
      }
      recommended = {
        memory = {
          max = int
          min = int
        }
        vCPUs = {
          max = int
          min = int
        }
      }
      releaseNoteUri = "string"
    }
  }
}

Property Values

Microsoft.Compute/galleries/images

Disallowed

GalleryImageIdentifier

GalleryImageProperties

ImagePurchasePlan

RecommendedMachineConfiguration

ResourceRange

ResourceTags

Usage Examples

Terraform Samples

A basic example of deploying Shared Image within a Shared Image Gallery.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "___location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  ___location = var.___location
}

resource "azapi_resource" "gallery" {
  type      = "Microsoft.Compute/galleries@2022-03-03"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  ___location  = var.___location
  body = {
    properties = {
      description = ""
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "image" {
  type      = "Microsoft.Compute/galleries/images@2022-03-03"
  parent_id = azapi_resource.gallery.id
  name      = var.resource_name
  ___location  = var.___location
  body = {
    properties = {
      architecture = "x64"
      description  = ""
      disallowed = {
        diskTypes = [
        ]
      }
      features         = null
      hyperVGeneration = "V1"
      identifier = {
        offer     = "AccTesOffer230630032848825313"
        publisher = "AccTesPublisher230630032848825313"
        sku       = "AccTesSku230630032848825313"
      }
      osState             = "Generalized"
      osType              = "Linux"
      privacyStatementUri = ""
      recommended = {
        memory = {
        }
        vCPUs = {
        }
      }
      releaseNoteUri = ""
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}