PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/proximityPlacementGroups/{proximityPlacementGroupName}/?api-version=2023-09-01

Create or update a proximity placement group.

Servers

https://management.azure.com/

Path parameters

Name	Type	Required	Description
`subscriptionId`	String	Yes	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
`proximityPlacementGroupName`	String	Yes	The name of the proximity placement group.
`resourceGroupName`	String	Yes	The name of the resource group.

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`id`	String	No	Resource Id
`name`	String	No	Resource name
`properties`	Object	No	Describes the properties of a Proximity Placement Group.
`properties.virtualMachines[]`	Array	No	A list of references to all virtual machines in the proximity placement group.
`properties.virtualMachines[].id`	String	No	Resource Id
`properties.virtualMachines[].colocationStatus`	Object	No	Instance view status.
`properties.virtualMachines[].colocationStatus.time`	String	No	The time of the status.
`properties.virtualMachines[].colocationStatus.displayStatus`	String	No	The short localizable label for the status.
`properties.virtualMachines[].colocationStatus.message`	String	No	The detailed status message, including for alerts and error messages.
`properties.virtualMachines[].colocationStatus.level`	String	No	The level code. Possible values: `"Error"` `"Warning"` `"Info"`
`properties.virtualMachines[].colocationStatus.code`	String	No	The status code.
`properties.intent`	Object	No	Specifies the user intent of the proximity placement group.
`properties.intent.vmSizes[]`	Array	No	Specifies possible sizes of virtual machines that can be created in the proximity placement group.
`properties.availabilitySets[]`	Array	No	A list of references to all availability sets in the proximity placement group.
`properties.availabilitySets[].id`	String	No	Resource Id
`properties.availabilitySets[].colocationStatus`	Object	No	Instance view status.
`properties.availabilitySets[].colocationStatus.time`	String	No	The time of the status.
`properties.availabilitySets[].colocationStatus.displayStatus`	String	No	The short localizable label for the status.
`properties.availabilitySets[].colocationStatus.message`	String	No	The detailed status message, including for alerts and error messages.
`properties.availabilitySets[].colocationStatus.level`	String	No	The level code. Possible values: `"Error"` `"Warning"` `"Info"`
`properties.availabilitySets[].colocationStatus.code`	String	No	The status code.
`properties.colocationStatus`	Object	No	Instance view status.
`properties.colocationStatus.time`	String	No	The time of the status.
`properties.colocationStatus.displayStatus`	String	No	The short localizable label for the status.
`properties.colocationStatus.message`	String	No	The detailed status message, including for alerts and error messages.
`properties.colocationStatus.level`	String	No	The level code. Possible values: `"Error"` `"Warning"` `"Info"`
`properties.colocationStatus.code`	String	No	The status code.
`properties.virtualMachineScaleSets[]`	Array	No	A list of references to all virtual machine scale sets in the proximity placement group.
`properties.virtualMachineScaleSets[].id`	String	No	Resource Id
`properties.virtualMachineScaleSets[].colocationStatus`	Object	No	Instance view status.
`properties.virtualMachineScaleSets[].colocationStatus.time`	String	No	The time of the status.
`properties.virtualMachineScaleSets[].colocationStatus.displayStatus`	String	No	The short localizable label for the status.
`properties.virtualMachineScaleSets[].colocationStatus.message`	String	No	The detailed status message, including for alerts and error messages.
`properties.virtualMachineScaleSets[].colocationStatus.level`	String	No	The level code. Possible values: `"Error"` `"Warning"` `"Info"`
`properties.virtualMachineScaleSets[].colocationStatus.code`	String	No	The status code.
`properties.proximityPlacementGroupType`	String	No	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. Possible values: `"Ultra"` `"Standard"`
`location`	String	No	Resource location
`zones[]`	Array	No	Specifies the Availability Zone where virtual machine, virtual machine scale set or availability set associated with the proximity placement group can be created.
`tags`	Object	No	Resource tags
`type`	String	No	Resource type

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.