Microsoft.Compute proximityPlacementGroups 2023-03-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@2023-03-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
properties: {
colocationStatus: {
code: 'string'
displayStatus: 'string'
level: 'string'
message: 'string'
time: 'string'
}
intent: {
vmSizes: [
'string'
]
}
proximityPlacementGroupType: 'string'
}
zones: [
'string' or int
]
}
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 |
| zones | Specifies the Availability Zone where virtual machine, virtual machine scale set or availability set associated with the proximity placement group can be created. | Array of availability zones as string or int. |
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' |
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 |
ProximityPlacementGroupPropertiesIntent
| Name | Description | Value |
|---|---|---|
| vmSizes | Specifies possible sizes of virtual machines that can be created in the proximity placement group. | 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": "2023-03-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"colocationStatus": {
"code": "string",
"displayStatus": "string",
"level": "string",
"message": "string",
"time": "string"
},
"intent": {
"vmSizes": [ "string" ]
},
"proximityPlacementGroupType": "string"
},
"zones": [ "string" or int ]
}
Property values
proximityPlacementGroups
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.Compute/proximityPlacementGroups' |
| apiVersion | The resource api version | '2023-03-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 |
| zones | Specifies the Availability Zone where virtual machine, virtual machine scale set or availability set associated with the proximity placement group can be created. | Array of availability zones as string or int. |
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' |
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 |
ProximityPlacementGroupPropertiesIntent
| Name | Description | Value |
|---|---|---|
| vmSizes | Specifies possible sizes of virtual machines that can be created in the proximity placement group. | 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@2023-03-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"
}
intent = {
vmSizes = [
"string"
]
}
proximityPlacementGroupType = "string"
}
zones = [
"string" or int
]
})
}
Property values
proximityPlacementGroups
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Compute/proximityPlacementGroups@2023-03-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 |
| zones | Specifies the Availability Zone where virtual machine, virtual machine scale set or availability set associated with the proximity placement group can be created. | Array of availability zones as string or int. |
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" |
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 |
ProximityPlacementGroupPropertiesIntent
| Name | Description | Value |
|---|---|---|
| vmSizes | Specifies possible sizes of virtual machines that can be created in the proximity placement group. | string[] |