Microsoft.Compute proximityPlacementGroups 2024-03-01

• Latest
• 2024-07-01
• 2024-03-01
• 2023-09-01
• 2023-07-01
• 2023-03-01
• 2022-11-01
• 2022-08-01
• 2022-03-01
• 2021-11-01
• 2021-07-01
• 2021-04-01
• 2021-03-01
• 2020-12-01
• 2020-06-01
• 2019-12-01
• 2019-07-01
• 2019-03-01
• 2018-10-01
• 2018-06-01
• 2018-04-01

Bicep resource definition

The proximityPlacementGroups resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

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@2024-03-01' = {
  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

InstanceViewStatus

Name	Description	Value
code	The status code.	string
displayStatus	The short localizable label for the status.	string
level	The level code.	'Error' 'Info' 'Warning'
message	The detailed status message, including for alerts and error messages.	string
time	The time of the status.	string

Microsoft.Compute/proximityPlacementGroups

Name	Description	Value
location	Resource location	string (required)
name	The resource name	string (required)
properties	Describes the properties of a Proximity Placement Group.	ProximityPlacementGroupProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
zones	Specifies the Availability Zone where virtual machine, virtual machine scale set or availability set associated with the proximity placement group can be created.	string[]

ProximityPlacementGroupProperties

Name	Description	Value
colocationStatus	Describes colocation status of the Proximity Placement Group.	InstanceViewStatus
intent	Specifies the user intent of the proximity placement group.	ProximityPlacementGroupPropertiesIntent
proximityPlacementGroupType	Specifies the type of the proximity placement group. Possible values are: Standard : Co-locate resources within an Azure region or Availability Zone. Ultra : For future use.	'Standard' 'Ultra'

ProximityPlacementGroupPropertiesIntent

Name	Description	Value
vmSizes	Specifies possible sizes of virtual machines that can be created in the proximity placement group.	string[]

ResourceTags

Name	Description	Value

ARM template resource definition

The proximityPlacementGroups resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

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": "2024-03-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

InstanceViewStatus

Name	Description	Value
code	The status code.	string
displayStatus	The short localizable label for the status.	string
level	The level code.	'Error' 'Info' 'Warning'
message	The detailed status message, including for alerts and error messages.	string
time	The time of the status.	string

Microsoft.Compute/proximityPlacementGroups

Name	Description	Value
apiVersion	The api version	'2024-03-01'
location	Resource location	string (required)
name	The resource name	string (required)
properties	Describes the properties of a Proximity Placement Group.	ProximityPlacementGroupProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.Compute/proximityPlacementGroups'
zones	Specifies the Availability Zone where virtual machine, virtual machine scale set or availability set associated with the proximity placement group can be created.	string[]

ProximityPlacementGroupProperties

Name	Description	Value
colocationStatus	Describes colocation status of the Proximity Placement Group.	InstanceViewStatus
intent	Specifies the user intent of the proximity placement group.	ProximityPlacementGroupPropertiesIntent
proximityPlacementGroupType	Specifies the type of the proximity placement group. Possible values are: Standard : Co-locate resources within an Azure region or Availability Zone. Ultra : For future use.	'Standard' 'Ultra'

ProximityPlacementGroupPropertiesIntent

Name	Description	Value
vmSizes	Specifies possible sizes of virtual machines that can be created in the proximity placement group.	string[]

ResourceTags

Name	Description	Value

Quickstart templates

The following 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:

• Resource groups

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@2024-03-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  zones = [
    "string"
  ]
  body = jsonencode({
    properties = {
      colocationStatus = {
        code = "string"
        displayStatus = "string"
        level = "string"
        message = "string"
        time = "string"
      }
      intent = {
        vmSizes = [
          "string"
        ]
      }
      proximityPlacementGroupType = "string"
    }
  })
}

Property values

InstanceViewStatus

Name	Description	Value
code	The status code.	string
displayStatus	The short localizable label for the status.	string
level	The level code.	'Error' 'Info' 'Warning'
message	The detailed status message, including for alerts and error messages.	string
time	The time of the status.	string

Microsoft.Compute/proximityPlacementGroups

Name	Description	Value
location	Resource location	string (required)
name	The resource name	string (required)
properties	Describes the properties of a Proximity Placement Group.	ProximityPlacementGroupProperties
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.Compute/proximityPlacementGroups@2024-03-01"
zones	Specifies the Availability Zone where virtual machine, virtual machine scale set or availability set associated with the proximity placement group can be created.	string[]

ProximityPlacementGroupProperties

Name	Description	Value
colocationStatus	Describes colocation status of the Proximity Placement Group.	InstanceViewStatus
intent	Specifies the user intent of the proximity placement group.	ProximityPlacementGroupPropertiesIntent
proximityPlacementGroupType	Specifies the type of the proximity placement group. Possible values are: Standard : Co-locate resources within an Azure region or Availability Zone. Ultra : For future use.	'Standard' 'Ultra'

ProximityPlacementGroupPropertiesIntent

Name	Description	Value
vmSizes	Specifies possible sizes of virtual machines that can be created in the proximity placement group.	string[]

ResourceTags

Name	Description	Value