Microsoft.Compute proximityPlacementGroups 2025-04-01

Bicep resource definition

The proximityPlacementGroups 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/proximityPlacementGroups resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Compute/proximityPlacementGroups@2025-04-01' = {
  scope: resourceSymbolicName or scope
  ___location: 'string'
  name: 'string'
  properties: {
    colocationStatus: {
      code: 'string'
      displayStatus: 'string'
      level: 'string'
      message: 'string'
      time: 'string'
    }
    intent: {
      vmSizes: [
        'string'
      ]
    }
    proximityPlacementGroupType: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
  zones: [
    'string'
  ]
}

Property Values

Microsoft.Compute/proximityPlacementGroups

InstanceViewStatus

ProximityPlacementGroupProperties

ProximityPlacementGroupPropertiesIntent

TrackedResourceTags

Usage Examples

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

ARM template resource definition

The proximityPlacementGroups 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/proximityPlacementGroups resource, add the following JSON to your template.

{
  "type": "Microsoft.Compute/proximityPlacementGroups",
  "apiVersion": "2025-04-01",
  "name": "string",
  "___location": "string",
  "properties": {
    "colocationStatus": {
      "code": "string",
      "displayStatus": "string",
      "level": "string",
      "message": "string",
      "time": "string"
    },
    "intent": {
      "vmSizes": [ "string" ]
    },
    "proximityPlacementGroupType": "string"
  },
  "tags": {
    "{customized property}": "string"
  },
  "zones": [ "string" ]
}

Property Values

Microsoft.Compute/proximityPlacementGroups

InstanceViewStatus

ProximityPlacementGroupProperties

ProximityPlacementGroupPropertiesIntent

TrackedResourceTags

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template	Description
Example Parameterized Deployment With Linked Templates	This sample template will deploy multiple tiers of resources into an Azure Resource Group. Each tier has configurable elements, to show how you can expose parameterization to the end user.

Terraform (AzAPI provider) resource definition

The proximityPlacementGroups 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/proximityPlacementGroups resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/proximityPlacementGroups@2025-04-01"
  name = "string"
  parent_id = "string"
  ___location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      colocationStatus = {
        code = "string"
        displayStatus = "string"
        level = "string"
        message = "string"
        time = "string"
      }
      intent = {
        vmSizes = [
          "string"
        ]
      }
      proximityPlacementGroupType = "string"
    }
    zones = [
      "string"
    ]
  }
}

Property Values

Microsoft.Compute/proximityPlacementGroups

InstanceViewStatus

ProximityPlacementGroupProperties

ProximityPlacementGroupPropertiesIntent

TrackedResourceTags

Usage Examples

Terraform Samples

A basic example of deploying proximity placement group for virtual machines, virtual machine scale sets and availability sets.

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" "proximityPlacementGroup" {
  type      = "Microsoft.Compute/proximityPlacementGroups@2022-03-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  ___location  = var.___location
  body = {
    properties = {
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.