azure-native.compute.ProximityPlacementGroup
Explore with Pulumi AI
Specifies information about the proximity placement group. Azure REST API version: 2023-03-01. Prior API version in Azure Native 1.x: 2020-12-01.
Other available API versions: 2019-03-01, 2023-07-01, 2023-09-01, 2024-03-01, 2024-07-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()
{
Intent = new AzureNative.Compute.Inputs.ProximityPlacementGroupPropertiesIntentArgs
{
VmSizes = new[]
{
"Basic_A0",
"Basic_A2",
},
},
Location = "westus",
ProximityPlacementGroupName = "myProximityPlacementGroup",
ProximityPlacementGroupType = AzureNative.Compute.ProximityPlacementGroupType.Standard,
ResourceGroupName = "myResourceGroup",
Zones = new[]
{
"1",
},
});
});
package main
import (
compute "github.com/pulumi/pulumi-azure-native-sdk/compute/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := compute.NewProximityPlacementGroup(ctx, "proximityPlacementGroup", &compute.ProximityPlacementGroupArgs{
Intent: &compute.ProximityPlacementGroupPropertiesIntentArgs{
VmSizes: pulumi.StringArray{
pulumi.String("Basic_A0"),
pulumi.String("Basic_A2"),
},
},
Location: pulumi.String("westus"),
ProximityPlacementGroupName: pulumi.String("myProximityPlacementGroup"),
ProximityPlacementGroupType: pulumi.String(compute.ProximityPlacementGroupTypeStandard),
ResourceGroupName: pulumi.String("myResourceGroup"),
Zones: pulumi.StringArray{
pulumi.String("1"),
},
})
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 com.pulumi.azurenative.compute.inputs.ProximityPlacementGroupPropertiesIntentArgs;
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()
.intent(ProximityPlacementGroupPropertiesIntentArgs.builder()
.vmSizes(
"Basic_A0",
"Basic_A2")
.build())
.location("westus")
.proximityPlacementGroupName("myProximityPlacementGroup")
.proximityPlacementGroupType("Standard")
.resourceGroupName("myResourceGroup")
.zones("1")
.build());
}
}
import pulumi
import pulumi_azure_native as azure_native
proximity_placement_group = azure_native.compute.ProximityPlacementGroup("proximityPlacementGroup",
intent={
"vm_sizes": [
"Basic_A0",
"Basic_A2",
],
},
location="westus",
proximity_placement_group_name="myProximityPlacementGroup",
proximity_placement_group_type=azure_native.compute.ProximityPlacementGroupType.STANDARD,
resource_group_name="myResourceGroup",
zones=["1"])
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const proximityPlacementGroup = new azure_native.compute.ProximityPlacementGroup("proximityPlacementGroup", {
intent: {
vmSizes: [
"Basic_A0",
"Basic_A2",
],
},
location: "westus",
proximityPlacementGroupName: "myProximityPlacementGroup",
proximityPlacementGroupType: azure_native.compute.ProximityPlacementGroupType.Standard,
resourceGroupName: "myResourceGroup",
zones: ["1"],
});
resources:
proximityPlacementGroup:
type: azure-native:compute:ProximityPlacementGroup
properties:
intent:
vmSizes:
- Basic_A0
- Basic_A2
location: westus
proximityPlacementGroupName: myProximityPlacementGroup
proximityPlacementGroupType: Standard
resourceGroupName: myResourceGroup
zones:
- '1'
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,
intent: Optional[ProximityPlacementGroupPropertiesIntentArgs] = 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,
zones: Optional[Sequence[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 = new AzureNative.Compute.Inputs.InstanceViewStatusArgs
{
Code = "string",
DisplayStatus = "string",
Level = AzureNative.Compute.StatusLevelTypes.Info,
Message = "string",
Time = "string",
},
Intent = new AzureNative.Compute.Inputs.ProximityPlacementGroupPropertiesIntentArgs
{
VmSizes = new[]
{
"string",
},
},
Location = "string",
ProximityPlacementGroupName = "string",
ProximityPlacementGroupType = "string",
Tags =
{
{ "string", "string" },
},
Zones = new[]
{
"string",
},
});
example, err := compute.NewProximityPlacementGroup(ctx, "proximityPlacementGroupResource", &compute.ProximityPlacementGroupArgs{
ResourceGroupName: pulumi.String("string"),
ColocationStatus: &compute.InstanceViewStatusArgs{
Code: pulumi.String("string"),
DisplayStatus: pulumi.String("string"),
Level: compute.StatusLevelTypesInfo,
Message: pulumi.String("string"),
Time: pulumi.String("string"),
},
Intent: &compute.ProximityPlacementGroupPropertiesIntentArgs{
VmSizes: pulumi.StringArray{
pulumi.String("string"),
},
},
Location: pulumi.String("string"),
ProximityPlacementGroupName: pulumi.String("string"),
ProximityPlacementGroupType: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
Zones: pulumi.StringArray{
pulumi.String("string"),
},
})
var proximityPlacementGroupResource = new ProximityPlacementGroup("proximityPlacementGroupResource", ProximityPlacementGroupArgs.builder()
.resourceGroupName("string")
.colocationStatus(InstanceViewStatusArgs.builder()
.code("string")
.displayStatus("string")
.level("Info")
.message("string")
.time("string")
.build())
.intent(ProximityPlacementGroupPropertiesIntentArgs.builder()
.vmSizes("string")
.build())
.location("string")
.proximityPlacementGroupName("string")
.proximityPlacementGroupType("string")
.tags(Map.of("string", "string"))
.zones("string")
.build());
proximity_placement_group_resource = azure_native.compute.ProximityPlacementGroup("proximityPlacementGroupResource",
resource_group_name="string",
colocation_status={
"code": "string",
"display_status": "string",
"level": azure_native.compute.StatusLevelTypes.INFO,
"message": "string",
"time": "string",
},
intent={
"vm_sizes": ["string"],
},
location="string",
proximity_placement_group_name="string",
proximity_placement_group_type="string",
tags={
"string": "string",
},
zones=["string"])
const proximityPlacementGroupResource = new azure_native.compute.ProximityPlacementGroup("proximityPlacementGroupResource", {
resourceGroupName: "string",
colocationStatus: {
code: "string",
displayStatus: "string",
level: azure_native.compute.StatusLevelTypes.Info,
message: "string",
time: "string",
},
intent: {
vmSizes: ["string"],
},
location: "string",
proximityPlacementGroupName: "string",
proximityPlacementGroupType: "string",
tags: {
string: "string",
},
zones: ["string"],
});
type: azure-native:compute:ProximityPlacementGroup
properties:
colocationStatus:
code: string
displayStatus: string
level: Info
message: string
time: string
intent:
vmSizes:
- string
location: string
proximityPlacementGroupName: string
proximityPlacementGroupType: string
resourceGroupName: string
tags:
string: string
zones:
- 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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ProximityPlacementGroup resource accepts the following input properties:
- Resource
Group stringName - The name of the resource group.
- Colocation
Status Pulumi.Azure Native. Compute. Inputs. Instance View Status - Describes colocation status of the Proximity Placement Group.
- Intent
Pulumi.
Azure Native. Compute. Inputs. Proximity Placement Group Properties Intent - Specifies the user intent of the proximity placement group.
- Location string
- Resource location
- Proximity
Placement stringGroup Name - The name of the proximity placement group.
- Proximity
Placement string | Pulumi.Group Type Azure Native. Compute. Proximity Placement Group Type - 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.
- Dictionary<string, string>
- Resource tags
- Zones List<string>
- Specifies the Availability Zone where virtual machine, virtual machine scale set or availability set associated with the proximity placement group can be created.
- Resource
Group stringName - The name of the resource group.
- Colocation
Status InstanceView Status Args - Describes colocation status of the Proximity Placement Group.
- Intent
Proximity
Placement Group Properties Intent Args - Specifies the user intent of the proximity placement group.
- Location string
- Resource location
- Proximity
Placement stringGroup Name - The name of the proximity placement group.
- Proximity
Placement string | ProximityGroup Type Placement Group Type - 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.
- map[string]string
- Resource tags
- Zones []string
- Specifies the Availability Zone where virtual machine, virtual machine scale set or availability set associated with the proximity placement group can be created.
- resource
Group StringName - The name of the resource group.
- colocation
Status InstanceView Status - Describes colocation status of the Proximity Placement Group.
- intent
Proximity
Placement Group Properties Intent - Specifies the user intent of the proximity placement group.
- location String
- Resource location
- proximity
Placement StringGroup Name - The name of the proximity placement group.
- proximity
Placement String | ProximityGroup Type Placement Group Type - 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.
- Map<String,String>
- Resource tags
- zones List<String>
- Specifies the Availability Zone where virtual machine, virtual machine scale set or availability set associated with the proximity placement group can be created.
- resource
Group stringName - The name of the resource group.
- colocation
Status InstanceView Status - Describes colocation status of the Proximity Placement Group.
- intent
Proximity
Placement Group Properties Intent - Specifies the user intent of the proximity placement group.
- location string
- Resource location
- proximity
Placement stringGroup Name - The name of the proximity placement group.
- proximity
Placement string | ProximityGroup Type Placement Group Type - 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.
- {[key: string]: string}
- Resource tags
- zones string[]
- Specifies the Availability Zone where virtual machine, virtual machine scale set or availability set associated with the proximity placement group can be created.
- resource_
group_ strname - The name of the resource group.
- colocation_
status InstanceView Status Args - Describes colocation status of the Proximity Placement Group.
- intent
Proximity
Placement Group Properties Intent Args - Specifies the user intent of the proximity placement group.
- location str
- Resource location
- proximity_
placement_ strgroup_ name - The name of the proximity placement group.
- proximity_
placement_ str | Proximitygroup_ type Placement Group Type - 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.
- Mapping[str, str]
- Resource tags
- zones Sequence[str]
- Specifies the Availability Zone where virtual machine, virtual machine scale set or availability set associated with the proximity placement group can be created.
- resource
Group StringName - The name of the resource group.
- colocation
Status Property Map - Describes colocation status of the Proximity Placement Group.
- intent Property Map
- Specifies the user intent of the proximity placement group.
- location String
- Resource location
- proximity
Placement StringGroup Name - The name of the proximity placement group.
- proximity
Placement String | "Standard" | "Ultra"Group Type - 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.
- Map<String>
- Resource tags
- zones List<String>
- Specifies the Availability Zone where virtual machine, virtual machine scale set or availability set associated with the proximity placement group can be created.
Outputs
All input properties are implicitly available as output properties. Additionally, the ProximityPlacementGroup resource produces the following output properties:
- Availability
Sets List<Pulumi.Azure Native. Compute. Outputs. Sub Resource With Colocation Status Response> - 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
- Virtual
Machine List<Pulumi.Scale Sets Azure Native. Compute. Outputs. Sub Resource With Colocation Status Response> - A list of references to all virtual machine scale sets in the proximity placement group.
- Virtual
Machines List<Pulumi.Azure Native. Compute. Outputs. Sub Resource With Colocation Status Response> - A list of references to all virtual machines in the proximity placement group.
- Availability
Sets []SubResource With Colocation Status Response - 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
- Virtual
Machine []SubScale Sets Resource With Colocation Status Response - A list of references to all virtual machine scale sets in the proximity placement group.
- Virtual
Machines []SubResource With Colocation Status Response - A list of references to all virtual machines in the proximity placement group.
- availability
Sets List<SubResource With Colocation Status Response> - 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
- virtual
Machine List<SubScale Sets Resource With Colocation Status Response> - A list of references to all virtual machine scale sets in the proximity placement group.
- virtual
Machines List<SubResource With Colocation Status Response> - A list of references to all virtual machines in the proximity placement group.
- availability
Sets SubResource With Colocation Status Response[] - 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
- virtual
Machine SubScale Sets Resource With Colocation Status Response[] - A list of references to all virtual machine scale sets in the proximity placement group.
- virtual
Machines SubResource With Colocation Status Response[] - A list of references to all virtual machines in the proximity placement group.
- availability_
sets Sequence[SubResource With Colocation Status Response] - 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_ Sequence[Subscale_ sets Resource With Colocation Status Response] - A list of references to all virtual machine scale sets in the proximity placement group.
- virtual_
machines Sequence[SubResource With Colocation Status Response] - A list of references to all virtual machines in the proximity placement group.
- availability
Sets 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
- virtual
Machine List<Property Map>Scale Sets - A list of references to all virtual machine scale sets in the proximity placement group.
- virtual
Machines 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.
- Display
Status string - The short localizable label for the status.
- Level
Pulumi.
Azure Native. Compute. Status Level Types - 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.
- Display
Status string - The short localizable label for the status.
- Level
Status
Level Types - 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.
- display
Status String - The short localizable label for the status.
- level
Status
Level Types - 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.
- display
Status string - The short localizable label for the status.
- level
Status
Level Types - 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
Status
Level Types - 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.
- display
Status 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.
- Display
Status 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.
- Display
Status 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.
- display
Status 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.
- display
Status 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.
- display
Status 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.
ProximityPlacementGroupPropertiesIntent, ProximityPlacementGroupPropertiesIntentArgs
- Vm
Sizes List<string> - Specifies possible sizes of virtual machines that can be created in the proximity placement group.
- Vm
Sizes []string - Specifies possible sizes of virtual machines that can be created in the proximity placement group.
- vm
Sizes List<String> - Specifies possible sizes of virtual machines that can be created in the proximity placement group.
- vm
Sizes string[] - Specifies possible sizes of virtual machines that can be created in the proximity placement group.
- vm_
sizes Sequence[str] - Specifies possible sizes of virtual machines that can be created in the proximity placement group.
- vm
Sizes List<String> - Specifies possible sizes of virtual machines that can be created in the proximity placement group.
ProximityPlacementGroupPropertiesResponseIntent, ProximityPlacementGroupPropertiesResponseIntentArgs
- Vm
Sizes List<string> - Specifies possible sizes of virtual machines that can be created in the proximity placement group.
- Vm
Sizes []string - Specifies possible sizes of virtual machines that can be created in the proximity placement group.
- vm
Sizes List<String> - Specifies possible sizes of virtual machines that can be created in the proximity placement group.
- vm
Sizes string[] - Specifies possible sizes of virtual machines that can be created in the proximity placement group.
- vm_
sizes Sequence[str] - Specifies possible sizes of virtual machines that can be created in the proximity placement group.
- vm
Sizes List<String> - Specifies possible sizes of virtual machines that can be created in the proximity placement group.
ProximityPlacementGroupType, ProximityPlacementGroupTypeArgs
- Standard
- Standard
- Ultra
- Ultra
- Proximity
Placement Group Type Standard - Standard
- Proximity
Placement Group Type Ultra - 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
- Status
Level Types Info - Info
- Status
Level Types Warning - Warning
- Status
Level Types Error - 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
- Colocation
Status Pulumi.Azure Native. Compute. Inputs. Instance View Status Response - Describes colocation status of a resource in the Proximity Placement Group.
- Id string
- Resource Id
- Colocation
Status InstanceView Status Response - Describes colocation status of a resource in the Proximity Placement Group.
- Id string
- Resource Id
- colocation
Status InstanceView Status Response - Describes colocation status of a resource in the Proximity Placement Group.
- id String
- Resource Id
- colocation
Status InstanceView Status Response - Describes colocation status of a resource in the Proximity Placement Group.
- id string
- Resource Id
- colocation_
status InstanceView Status Response - Describes colocation status of a resource in the Proximity Placement Group.
- id str
- Resource Id
- colocation
Status 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/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/proximityPlacementGroups/{proximityPlacementGroupName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0