Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. proximity
  5. PlacementGroup

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-azure

azure.proximity.PlacementGroup

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-azure

    Manages a proximity placement group for virtual machines, virtual machine scale sets and availability sets.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const examplePlacementGroup = new azure.proximity.PlacementGroup("example", {
    name: "exampleProximityPlacementGroup",
    location: example.location,
    resourceGroupName: example.name,
    tags: {
        environment: "Production",
    },
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_placement_group = azure.proximity.PlacementGroup("example",
    name="exampleProximityPlacementGroup",
    location=example.location,
    resource_group_name=example.name,
    tags={
        "environment": "Production",
    })

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/proximity"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = proximity.NewPlacementGroup(ctx, "example", &proximity.PlacementGroupArgs{
			Name:              pulumi.String("exampleProximityPlacementGroup"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			Tags: pulumi.StringMap{
				"environment": pulumi.String("Production"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var examplePlacementGroup = new Azure.Proximity.PlacementGroup("example", new()
    {
        Name = "exampleProximityPlacementGroup",
        Location = example.Location,
        ResourceGroupName = example.Name,
        Tags = 
        {
            { "environment", "Production" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.proximity.PlacementGroup;
import com.pulumi.azure.proximity.PlacementGroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var examplePlacementGroup = new PlacementGroup("examplePlacementGroup", PlacementGroupArgs.builder()
            .name("exampleProximityPlacementGroup")
            .location(example.location())
            .resourceGroupName(example.name())
            .tags(Map.of("environment", "Production"))
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  examplePlacementGroup:
    type: azure:proximity:PlacementGroup
    name: example
    properties:
      name: exampleProximityPlacementGroup
      location: ${example.location}
      resourceGroupName: ${example.name}
      tags:
        environment: Production

    Create PlacementGroup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PlacementGroup(name: string, args: PlacementGroupArgs, opts?: CustomResourceOptions);
    @overload
def PlacementGroup(resource_name: str,
                   args: PlacementGroupArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def PlacementGroup(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   resource_group_name: Optional[str] = None,
                   allowed_vm_sizes: Optional[Sequence[str]] = None,
                   location: Optional[str] = None,
                   name: Optional[str] = None,
                   tags: Optional[Mapping[str, str]] = None,
                   zone: Optional[str] = None)
    func NewPlacementGroup(ctx *Context, name string, args PlacementGroupArgs, opts ...ResourceOption) (*PlacementGroup, error)
    public PlacementGroup(string name, PlacementGroupArgs args, CustomResourceOptions? opts = null)
    public PlacementGroup(String name, PlacementGroupArgs args)
public PlacementGroup(String name, PlacementGroupArgs args, CustomResourceOptions options)

    type: azure:proximity:PlacementGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args PlacementGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PlacementGroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PlacementGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PlacementGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PlacementGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var placementGroupResource = new Azure.Proximity.PlacementGroup("placementGroupResource", new()
{
    ResourceGroupName = "string",
    AllowedVmSizes = new[]
    {
        "string",
    },
    Location = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
    Zone = "string",
});

    example, err := proximity.NewPlacementGroup(ctx, "placementGroupResource", &proximity.PlacementGroupArgs{
	ResourceGroupName: pulumi.String("string"),
	AllowedVmSizes: pulumi.StringArray{
		pulumi.String("string"),
	},
	Location: pulumi.String("string"),
	Name:     pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Zone: pulumi.String("string"),
})

    var placementGroupResource = new PlacementGroup("placementGroupResource", PlacementGroupArgs.builder()
    .resourceGroupName("string")
    .allowedVmSizes("string")
    .location("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .zone("string")
    .build());

    placement_group_resource = azure.proximity.PlacementGroup("placementGroupResource",
    resource_group_name="string",
    allowed_vm_sizes=["string"],
    location="string",
    name="string",
    tags={
        "string": "string",
    },
    zone="string")

    const placementGroupResource = new azure.proximity.PlacementGroup("placementGroupResource", {
    resourceGroupName: "string",
    allowedVmSizes: ["string"],
    location: "string",
    name: "string",
    tags: {
        string: "string",
    },
    zone: "string",
});

    type: azure:proximity:PlacementGroup
properties:
    allowedVmSizes:
        - string
    location: string
    name: string
    resourceGroupName: string
    tags:
        string: string
    zone: string

    PlacementGroup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The PlacementGroup resource accepts the following input properties:

    ResourceGroupName string
    The name of the resource group in which to create the availability set. Changing this forces a new resource to be created.
    AllowedVmSizes List<string>

    Specifies the supported sizes of Virtual Machines that can be created in the Proximity Placement Group.

    NOTE: Removing allowed_vm_sizes after it is set forces a new resource to be created.

    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Name string
    Specifies the name of the proximity placement group. Changing this forces a new resource to be created.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    Zone string

    Specifies the supported zone of the Proximity Placement Group. Changing this forces a new resource to be created.

    NOTE: allowed_vm_sizes must be set when zone is specified.

    ResourceGroupName string
    The name of the resource group in which to create the availability set. Changing this forces a new resource to be created.
    AllowedVmSizes []string

    Specifies the supported sizes of Virtual Machines that can be created in the Proximity Placement Group.

    NOTE: Removing allowed_vm_sizes after it is set forces a new resource to be created.

    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Name string
    Specifies the name of the proximity placement group. Changing this forces a new resource to be created.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    Zone string

    Specifies the supported zone of the Proximity Placement Group. Changing this forces a new resource to be created.

    NOTE: allowed_vm_sizes must be set when zone is specified.

    resourceGroupName String
    The name of the resource group in which to create the availability set. Changing this forces a new resource to be created.
    allowedVmSizes List<String>

    Specifies the supported sizes of Virtual Machines that can be created in the Proximity Placement Group.

    NOTE: Removing allowed_vm_sizes after it is set forces a new resource to be created.

    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name String
    Specifies the name of the proximity placement group. Changing this forces a new resource to be created.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    zone String

    Specifies the supported zone of the Proximity Placement Group. Changing this forces a new resource to be created.

    NOTE: allowed_vm_sizes must be set when zone is specified.

    resourceGroupName string
    The name of the resource group in which to create the availability set. Changing this forces a new resource to be created.
    allowedVmSizes string[]

    Specifies the supported sizes of Virtual Machines that can be created in the Proximity Placement Group.

    NOTE: Removing allowed_vm_sizes after it is set forces a new resource to be created.

    location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name string
    Specifies the name of the proximity placement group. Changing this forces a new resource to be created.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    zone string

    Specifies the supported zone of the Proximity Placement Group. Changing this forces a new resource to be created.

    NOTE: allowed_vm_sizes must be set when zone is specified.

    resource_group_name str
    The name of the resource group in which to create the availability set. Changing this forces a new resource to be created.
    allowed_vm_sizes Sequence[str]

    Specifies the supported sizes of Virtual Machines that can be created in the Proximity Placement Group.

    NOTE: Removing allowed_vm_sizes after it is set forces a new resource to be created.

    location str
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name str
    Specifies the name of the proximity placement group. Changing this forces a new resource to be created.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    zone str

    Specifies the supported zone of the Proximity Placement Group. Changing this forces a new resource to be created.

    NOTE: allowed_vm_sizes must be set when zone is specified.

    resourceGroupName String
    The name of the resource group in which to create the availability set. Changing this forces a new resource to be created.
    allowedVmSizes List<String>

    Specifies the supported sizes of Virtual Machines that can be created in the Proximity Placement Group.

    NOTE: Removing allowed_vm_sizes after it is set forces a new resource to be created.

    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name String
    Specifies the name of the proximity placement group. Changing this forces a new resource to be created.
    tags Map<String>
    A mapping of tags to assign to the resource.
    zone String

    Specifies the supported zone of the Proximity Placement Group. Changing this forces a new resource to be created.

    NOTE: allowed_vm_sizes must be set when zone is specified.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PlacementGroup resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing PlacementGroup Resource

    Get an existing PlacementGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: PlacementGroupState, opts?: CustomResourceOptions): PlacementGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allowed_vm_sizes: Optional[Sequence[str]] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        zone: Optional[str] = None) -> PlacementGroup
    func GetPlacementGroup(ctx *Context, name string, id IDInput, state *PlacementGroupState, opts ...ResourceOption) (*PlacementGroup, error)
    public static PlacementGroup Get(string name, Input<string> id, PlacementGroupState? state, CustomResourceOptions? opts = null)
    public static PlacementGroup get(String name, Output<String> id, PlacementGroupState state, CustomResourceOptions options)
    resources:  _:    type: azure:proximity:PlacementGroup    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AllowedVmSizes List<string>

    Specifies the supported sizes of Virtual Machines that can be created in the Proximity Placement Group.

    NOTE: Removing allowed_vm_sizes after it is set forces a new resource to be created.

    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Name string
    Specifies the name of the proximity placement group. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which to create the availability set. Changing this forces a new resource to be created.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    Zone string

    Specifies the supported zone of the Proximity Placement Group. Changing this forces a new resource to be created.

    NOTE: allowed_vm_sizes must be set when zone is specified.

    AllowedVmSizes []string

    Specifies the supported sizes of Virtual Machines that can be created in the Proximity Placement Group.

    NOTE: Removing allowed_vm_sizes after it is set forces a new resource to be created.

    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Name string
    Specifies the name of the proximity placement group. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which to create the availability set. Changing this forces a new resource to be created.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    Zone string

    Specifies the supported zone of the Proximity Placement Group. Changing this forces a new resource to be created.

    NOTE: allowed_vm_sizes must be set when zone is specified.

    allowedVmSizes List<String>

    Specifies the supported sizes of Virtual Machines that can be created in the Proximity Placement Group.

    NOTE: Removing allowed_vm_sizes after it is set forces a new resource to be created.

    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name String
    Specifies the name of the proximity placement group. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which to create the availability set. Changing this forces a new resource to be created.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    zone String

    Specifies the supported zone of the Proximity Placement Group. Changing this forces a new resource to be created.

    NOTE: allowed_vm_sizes must be set when zone is specified.

    allowedVmSizes string[]

    Specifies the supported sizes of Virtual Machines that can be created in the Proximity Placement Group.

    NOTE: Removing allowed_vm_sizes after it is set forces a new resource to be created.

    location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name string
    Specifies the name of the proximity placement group. Changing this forces a new resource to be created.
    resourceGroupName string
    The name of the resource group in which to create the availability set. Changing this forces a new resource to be created.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    zone string

    Specifies the supported zone of the Proximity Placement Group. Changing this forces a new resource to be created.

    NOTE: allowed_vm_sizes must be set when zone is specified.

    allowed_vm_sizes Sequence[str]

    Specifies the supported sizes of Virtual Machines that can be created in the Proximity Placement Group.

    NOTE: Removing allowed_vm_sizes after it is set forces a new resource to be created.

    location str
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name str
    Specifies the name of the proximity placement group. Changing this forces a new resource to be created.
    resource_group_name str
    The name of the resource group in which to create the availability set. Changing this forces a new resource to be created.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    zone str

    Specifies the supported zone of the Proximity Placement Group. Changing this forces a new resource to be created.

    NOTE: allowed_vm_sizes must be set when zone is specified.

    allowedVmSizes List<String>

    Specifies the supported sizes of Virtual Machines that can be created in the Proximity Placement Group.

    NOTE: Removing allowed_vm_sizes after it is set forces a new resource to be created.

    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name String
    Specifies the name of the proximity placement group. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which to create the availability set. Changing this forces a new resource to be created.
    tags Map<String>
    A mapping of tags to assign to the resource.
    zone String

    Specifies the supported zone of the Proximity Placement Group. Changing this forces a new resource to be created.

    NOTE: allowed_vm_sizes must be set when zone is specified.

    Import

    Proximity Placement Groups can be imported using the resource id, e.g.

    $ pulumi import azure:proximity/placementGroup:PlacementGroup example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example-rg/providers/Microsoft.Compute/proximityPlacementGroups/example-ppg

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
    pulumi/pulumi-azure