Microsoft.Compute proximityPlacementGroups 2019-07-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@2019-07-01' = {
  location: 'string'
  name: 'string'
  properties: {
    colocationStatus: {
      code: 'string'
      displayStatus: 'string'
      level: 'string'
      message: 'string'
      time: 'string'
    }
    proximityPlacementGroupType: 'string'
  }
  tags: {
    {customized property}: '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

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'

ResourceTags

Name Description Value

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": "2019-07-01",
  "name": "string",
  "location": "string",
  "properties": {
    "colocationStatus": {
      "code": "string",
      "displayStatus": "string",
      "level": "string",
      "message": "string",
      "time": "string"
    },
    "proximityPlacementGroupType": "string"
  },
  "tags": {
    "{customized property}": "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 '2019-07-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'

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'

ResourceTags

Name Description Value

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Example Parameterized Deployment With Linked Templates

Deploy to Azure
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@2019-07-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      colocationStatus = {
        code = "string"
        displayStatus = "string"
        level = "string"
        message = "string"
        time = "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@2019-07-01"

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'

ResourceTags

Name Description Value