Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. compute
  5. ProximityPlacementGroup
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.compute.ProximityPlacementGroup

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

    Specifies information about the proximity placement group. API Version: 2020-12-01.

    Example Usage

    Create or Update a proximity placement group.

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

return await Deployment.RunAsync(() => 
{
    var proximityPlacementGroup = new AzureNative.Compute.ProximityPlacementGroup("proximityPlacementGroup", new()
    {
        Location = "westus",
        ProximityPlacementGroupName = "myProximityPlacementGroup",
        ProximityPlacementGroupType = "Standard",
        ResourceGroupName = "myResourceGroup",
    });

});

    package main

import (
	compute "github.com/pulumi/pulumi-azure-native-sdk/compute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.NewProximityPlacementGroup(ctx, "proximityPlacementGroup", &compute.ProximityPlacementGroupArgs{
			Location:                    pulumi.String("westus"),
			ProximityPlacementGroupName: pulumi.String("myProximityPlacementGroup"),
			ProximityPlacementGroupType: pulumi.String("Standard"),
			ResourceGroupName:           pulumi.String("myResourceGroup"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.compute.ProximityPlacementGroup;
import com.pulumi.azurenative.compute.ProximityPlacementGroupArgs;
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 proximityPlacementGroup = new ProximityPlacementGroup("proximityPlacementGroup", ProximityPlacementGroupArgs.builder()        
            .location("westus")
            .proximityPlacementGroupName("myProximityPlacementGroup")
            .proximityPlacementGroupType("Standard")
            .resourceGroupName("myResourceGroup")
            .build());

    }
}

    import pulumi
import pulumi_azure_native as azure_native

proximity_placement_group = azure_native.compute.ProximityPlacementGroup("proximityPlacementGroup",
    location="westus",
    proximity_placement_group_name="myProximityPlacementGroup",
    proximity_placement_group_type="Standard",
    resource_group_name="myResourceGroup")

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const proximityPlacementGroup = new azure_native.compute.ProximityPlacementGroup("proximityPlacementGroup", {
    location: "westus",
    proximityPlacementGroupName: "myProximityPlacementGroup",
    proximityPlacementGroupType: "Standard",
    resourceGroupName: "myResourceGroup",
});

    resources:
  proximityPlacementGroup:
    type: azure-native:compute:ProximityPlacementGroup
    properties:
      location: westus
      proximityPlacementGroupName: myProximityPlacementGroup
      proximityPlacementGroupType: Standard
      resourceGroupName: myResourceGroup

    Create ProximityPlacementGroup Resource

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

    Constructor syntax

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

@overload
def ProximityPlacementGroup(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            resource_group_name: Optional[str] = None,
                            colocation_status: Optional[InstanceViewStatusArgs] = None,
                            location: Optional[str] = None,
                            proximity_placement_group_name: Optional[str] = None,
                            proximity_placement_group_type: Optional[Union[str, ProximityPlacementGroupType]] = None,
                            tags: Optional[Mapping[str, str]] = None)
    func NewProximityPlacementGroup(ctx *Context, name string, args ProximityPlacementGroupArgs, opts ...ResourceOption) (*ProximityPlacementGroup, error)
    public ProximityPlacementGroup(string name, ProximityPlacementGroupArgs args, CustomResourceOptions? opts = null)
    public ProximityPlacementGroup(String name, ProximityPlacementGroupArgs args)
public ProximityPlacementGroup(String name, ProximityPlacementGroupArgs args, CustomResourceOptions options)

    type: azure-native:compute:ProximityPlacementGroup
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 ProximityPlacementGroupArgs
    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 ProximityPlacementGroupArgs
    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 ProximityPlacementGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProximityPlacementGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProximityPlacementGroupArgs
    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 proximityPlacementGroupResource = new AzureNative.Compute.ProximityPlacementGroup("proximityPlacementGroupResource", new()
{
    ResourceGroupName = "string",
    ColocationStatus = 
    {
        { "code", "string" },
        { "displayStatus", "string" },
        { "level", "Info" },
        { "message", "string" },
        { "time", "string" },
    },
    Location = "string",
    ProximityPlacementGroupName = "string",
    ProximityPlacementGroupType = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := compute.NewProximityPlacementGroup(ctx, "proximityPlacementGroupResource", &compute.ProximityPlacementGroupArgs{
	ResourceGroupName: "string",
	ColocationStatus: map[string]interface{}{
		"code":          "string",
		"displayStatus": "string",
		"level":         "Info",
		"message":       "string",
		"time":          "string",
	},
	Location:                    "string",
	ProximityPlacementGroupName: "string",
	ProximityPlacementGroupType: "string",
	Tags: map[string]interface{}{
		"string": "string",
	},
})

    var proximityPlacementGroupResource = new ProximityPlacementGroup("proximityPlacementGroupResource", ProximityPlacementGroupArgs.builder()
    .resourceGroupName("string")
    .colocationStatus(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .location("string")
    .proximityPlacementGroupName("string")
    .proximityPlacementGroupType("string")
    .tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .build());

    proximity_placement_group_resource = azure_native.compute.ProximityPlacementGroup("proximityPlacementGroupResource",
    resource_group_name=string,
    colocation_status={
        code: string,
        displayStatus: string,
        level: Info,
        message: string,
        time: string,
    },
    location=string,
    proximity_placement_group_name=string,
    proximity_placement_group_type=string,
    tags={
        string: string,
    })

    const proximityPlacementGroupResource = new azure_native.compute.ProximityPlacementGroup("proximityPlacementGroupResource", {
    resourceGroupName: "string",
    colocationStatus: {
        code: "string",
        displayStatus: "string",
        level: "Info",
        message: "string",
        time: "string",
    },
    location: "string",
    proximityPlacementGroupName: "string",
    proximityPlacementGroupType: "string",
    tags: {
        string: "string",
    },
});

    type: azure-native:compute:ProximityPlacementGroup
properties:
    colocationStatus:
        code: string
        displayStatus: string
        level: Info
        message: string
        time: string
    location: string
    proximityPlacementGroupName: string
    proximityPlacementGroupType: string
    resourceGroupName: string
    tags:
        string: string

    ProximityPlacementGroup Resource Properties

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

    Inputs

    The ProximityPlacementGroup resource accepts the following input properties:

    ResourceGroupName string
    The name of the resource group.
    ColocationStatus Pulumi.AzureNative.Compute.Inputs.InstanceViewStatus
    Describes colocation status of the Proximity Placement Group.
    Location string
    Resource location
    ProximityPlacementGroupName string
    The name of the proximity placement group.
    ProximityPlacementGroupType string | Pulumi.AzureNative.Compute.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.
    Tags Dictionary<string, string>
    Resource tags
    ResourceGroupName string
    The name of the resource group.
    ColocationStatus InstanceViewStatusArgs
    Describes colocation status of the Proximity Placement Group.
    Location string
    Resource location
    ProximityPlacementGroupName string
    The name of the proximity placement group.
    ProximityPlacementGroupType string | 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.
    Tags map[string]string
    Resource tags
    resourceGroupName String
    The name of the resource group.
    colocationStatus InstanceViewStatus
    Describes colocation status of the Proximity Placement Group.
    location String
    Resource location
    proximityPlacementGroupName String
    The name of the proximity placement group.
    proximityPlacementGroupType String | 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.
    tags Map<String,String>
    Resource tags
    resourceGroupName string
    The name of the resource group.
    colocationStatus InstanceViewStatus
    Describes colocation status of the Proximity Placement Group.
    location string
    Resource location
    proximityPlacementGroupName string
    The name of the proximity placement group.
    proximityPlacementGroupType string | 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.
    tags {[key: string]: string}
    Resource tags
    resource_group_name str
    The name of the resource group.
    colocation_status InstanceViewStatusArgs
    Describes colocation status of the Proximity Placement Group.
    location str
    Resource location
    proximity_placement_group_name str
    The name of the proximity placement group.
    proximity_placement_group_type str | 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.
    tags Mapping[str, str]
    Resource tags
    resourceGroupName String
    The name of the resource group.
    colocationStatus Property Map
    Describes colocation status of the Proximity Placement Group.
    location String
    Resource location
    proximityPlacementGroupName String
    The name of the proximity placement group.
    proximityPlacementGroupType String | "Standard" | "Ultra"
    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.
    tags Map<String>
    Resource tags

    Outputs

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

    AvailabilitySets List<Pulumi.AzureNative.Compute.Outputs.SubResourceWithColocationStatusResponse>
    A list of references to all availability sets in the proximity placement group.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name
    Type string
    Resource type
    VirtualMachineScaleSets List<Pulumi.AzureNative.Compute.Outputs.SubResourceWithColocationStatusResponse>
    A list of references to all virtual machine scale sets in the proximity placement group.
    VirtualMachines List<Pulumi.AzureNative.Compute.Outputs.SubResourceWithColocationStatusResponse>
    A list of references to all virtual machines in the proximity placement group.
    AvailabilitySets []SubResourceWithColocationStatusResponse
    A list of references to all availability sets in the proximity placement group.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name
    Type string
    Resource type
    VirtualMachineScaleSets []SubResourceWithColocationStatusResponse
    A list of references to all virtual machine scale sets in the proximity placement group.
    VirtualMachines []SubResourceWithColocationStatusResponse
    A list of references to all virtual machines in the proximity placement group.
    availabilitySets List<SubResourceWithColocationStatusResponse>
    A list of references to all availability sets in the proximity placement group.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name
    type String
    Resource type
    virtualMachineScaleSets List<SubResourceWithColocationStatusResponse>
    A list of references to all virtual machine scale sets in the proximity placement group.
    virtualMachines List<SubResourceWithColocationStatusResponse>
    A list of references to all virtual machines in the proximity placement group.
    availabilitySets SubResourceWithColocationStatusResponse[]
    A list of references to all availability sets in the proximity placement group.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Resource name
    type string
    Resource type
    virtualMachineScaleSets SubResourceWithColocationStatusResponse[]
    A list of references to all virtual machine scale sets in the proximity placement group.
    virtualMachines SubResourceWithColocationStatusResponse[]
    A list of references to all virtual machines in the proximity placement group.
    availability_sets Sequence[SubResourceWithColocationStatusResponse]
    A list of references to all availability sets in the proximity placement group.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Resource name
    type str
    Resource type
    virtual_machine_scale_sets Sequence[SubResourceWithColocationStatusResponse]
    A list of references to all virtual machine scale sets in the proximity placement group.
    virtual_machines Sequence[SubResourceWithColocationStatusResponse]
    A list of references to all virtual machines in the proximity placement group.
    availabilitySets List<Property Map>
    A list of references to all availability sets in the proximity placement group.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name
    type String
    Resource type
    virtualMachineScaleSets List<Property Map>
    A list of references to all virtual machine scale sets in the proximity placement group.
    virtualMachines List<Property Map>
    A list of references to all virtual machines in the proximity placement group.

    Supporting Types

    InstanceViewStatus, InstanceViewStatusArgs

    Code string
    The status code.
    DisplayStatus string
    The short localizable label for the status.
    Level Pulumi.AzureNative.Compute.StatusLevelTypes
    The level code.
    Message string
    The detailed status message, including for alerts and error messages.
    Time string
    The time of the status.
    Code string
    The status code.
    DisplayStatus string
    The short localizable label for the status.
    Level StatusLevelTypes
    The level code.
    Message string
    The detailed status message, including for alerts and error messages.
    Time string
    The time of the status.
    code String
    The status code.
    displayStatus String
    The short localizable label for the status.
    level StatusLevelTypes
    The level code.
    message String
    The detailed status message, including for alerts and error messages.
    time String
    The time of the status.
    code string
    The status code.
    displayStatus string
    The short localizable label for the status.
    level StatusLevelTypes
    The level code.
    message string
    The detailed status message, including for alerts and error messages.
    time string
    The time of the status.
    code str
    The status code.
    display_status str
    The short localizable label for the status.
    level StatusLevelTypes
    The level code.
    message str
    The detailed status message, including for alerts and error messages.
    time str
    The time of the status.
    code String
    The status code.
    displayStatus String
    The short localizable label for the status.
    level "Info" | "Warning" | "Error"
    The level code.
    message String
    The detailed status message, including for alerts and error messages.
    time String
    The time of the status.

    InstanceViewStatusResponse, InstanceViewStatusResponseArgs

    Code string
    The status code.
    DisplayStatus string
    The short localizable label for the status.
    Level string
    The level code.
    Message string
    The detailed status message, including for alerts and error messages.
    Time string
    The time of the status.
    Code string
    The status code.
    DisplayStatus string
    The short localizable label for the status.
    Level string
    The level code.
    Message string
    The detailed status message, including for alerts and error messages.
    Time string
    The time of the status.
    code String
    The status code.
    displayStatus String
    The short localizable label for the status.
    level String
    The level code.
    message String
    The detailed status message, including for alerts and error messages.
    time String
    The time of the status.
    code string
    The status code.
    displayStatus string
    The short localizable label for the status.
    level string
    The level code.
    message string
    The detailed status message, including for alerts and error messages.
    time string
    The time of the status.
    code str
    The status code.
    display_status str
    The short localizable label for the status.
    level str
    The level code.
    message str
    The detailed status message, including for alerts and error messages.
    time str
    The time of the status.
    code String
    The status code.
    displayStatus String
    The short localizable label for the status.
    level String
    The level code.
    message String
    The detailed status message, including for alerts and error messages.
    time String
    The time of the status.

    ProximityPlacementGroupType, ProximityPlacementGroupTypeArgs

    Standard
    Standard
    Ultra
    Ultra
    ProximityPlacementGroupTypeStandard
    Standard
    ProximityPlacementGroupTypeUltra
    Ultra
    Standard
    Standard
    Ultra
    Ultra
    Standard
    Standard
    Ultra
    Ultra
    STANDARD
    Standard
    ULTRA
    Ultra
    "Standard"
    Standard
    "Ultra"
    Ultra

    StatusLevelTypes, StatusLevelTypesArgs

    Info
    Info
    Warning
    Warning
    Error
    Error
    StatusLevelTypesInfo
    Info
    StatusLevelTypesWarning
    Warning
    StatusLevelTypesError
    Error
    Info
    Info
    Warning
    Warning
    Error
    Error
    Info
    Info
    Warning
    Warning
    Error
    Error
    INFO
    Info
    WARNING
    Warning
    ERROR
    Error
    "Info"
    Info
    "Warning"
    Warning
    "Error"
    Error

    SubResourceWithColocationStatusResponse, SubResourceWithColocationStatusResponseArgs

    ColocationStatus Pulumi.AzureNative.Compute.Inputs.InstanceViewStatusResponse
    Describes colocation status of a resource in the Proximity Placement Group.
    Id string
    Resource Id
    ColocationStatus InstanceViewStatusResponse
    Describes colocation status of a resource in the Proximity Placement Group.
    Id string
    Resource Id
    colocationStatus InstanceViewStatusResponse
    Describes colocation status of a resource in the Proximity Placement Group.
    id String
    Resource Id
    colocationStatus InstanceViewStatusResponse
    Describes colocation status of a resource in the Proximity Placement Group.
    id string
    Resource Id
    colocation_status InstanceViewStatusResponse
    Describes colocation status of a resource in the Proximity Placement Group.
    id str
    Resource Id
    colocationStatus Property Map
    Describes colocation status of a resource in the Proximity Placement Group.
    id String
    Resource Id

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:compute:ProximityPlacementGroup myProximityPlacementGroup /subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myProximityPlacementGroup

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

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native