Microsoft.Compute proximityPlacementGroups 2020-12-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

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@2020-12-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    colocationStatus: {
      code: 'string'
      displayStatus: 'string'
      level: 'string'
      message: 'string'
      time: 'string'
    }
    proximityPlacementGroupType: 'string'
  }
}

Property values

proximityPlacementGroups

Name	Description	Value
name	The resource name	string (required)
location	Resource location	string (required)
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
properties	Describes the properties of a Proximity Placement Group.	ProximityPlacementGroupProperties

ProximityPlacementGroupProperties

Name	Description	Value
colocationStatus	Describes colocation status of the Proximity Placement Group.	InstanceViewStatus
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'

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

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.

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": "2020-12-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "colocationStatus": {
      "code": "string",
      "displayStatus": "string",
      "level": "string",
      "message": "string",
      "time": "string"
    },
    "proximityPlacementGroupType": "string"
  }
}

Property values

proximityPlacementGroups

Name	Description	Value
type	The resource type	'Microsoft.Compute/proximityPlacementGroups'
apiVersion	The resource api version	'2020-12-01'
name	The resource name	string (required)
location	Resource location	string (required)
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
properties	Describes the properties of a Proximity Placement Group.	ProximityPlacementGroupProperties

ProximityPlacementGroupProperties

Name	Description	Value
colocationStatus	Describes colocation status of the Proximity Placement Group.	InstanceViewStatus
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'

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

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@2020-12-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      colocationStatus = {
        code = "string"
        displayStatus = "string"
        level = "string"
        message = "string"
        time = "string"
      }
      proximityPlacementGroupType = "string"
    }
  })
}

Property values

proximityPlacementGroups

Name	Description	Value
type	The resource type	"Microsoft.Compute/proximityPlacementGroups@2020-12-01"
name	The resource name	string (required)
location	Resource location	string (required)
parent_id	To deploy to a resource group, use the ID of that resource group.	string (required)
tags	Resource tags	Dictionary of tag names and values.
properties	Describes the properties of a Proximity Placement Group.	ProximityPlacementGroupProperties

ProximityPlacementGroupProperties

Name	Description	Value
colocationStatus	Describes colocation status of the Proximity Placement Group.	InstanceViewStatus
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"

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