Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. compute
  5. DedicatedHostGroup

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.compute.DedicatedHostGroup

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manage a Dedicated Host Group.

Example Usage

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

const example = new azure.core.ResourceGroup("example", {
    name: "example-rg-compute",
    location: "West Europe",
});
const exampleDedicatedHostGroup = new azure.compute.DedicatedHostGroup("example", {
    name: "example-dedicated-host-group",
    resourceGroupName: example.name,
    location: example.location,
    platformFaultDomainCount: 1,
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-rg-compute",
    location="West Europe")
example_dedicated_host_group = azure.compute.DedicatedHostGroup("example",
    name="example-dedicated-host-group",
    resource_group_name=example.name,
    location=example.location,
    platform_fault_domain_count=1)
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/compute"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"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-rg-compute"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = compute.NewDedicatedHostGroup(ctx, "example", &compute.DedicatedHostGroupArgs{
			Name:                     pulumi.String("example-dedicated-host-group"),
			ResourceGroupName:        example.Name,
			Location:                 example.Location,
			PlatformFaultDomainCount: pulumi.Int(1),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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-rg-compute",
        Location = "West Europe",
    });

    var exampleDedicatedHostGroup = new Azure.Compute.DedicatedHostGroup("example", new()
    {
        Name = "example-dedicated-host-group",
        ResourceGroupName = example.Name,
        Location = example.Location,
        PlatformFaultDomainCount = 1,
    });

});
Copy
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.compute.DedicatedHostGroup;
import com.pulumi.azure.compute.DedicatedHostGroupArgs;
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-rg-compute")
            .location("West Europe")
            .build());

        var exampleDedicatedHostGroup = new DedicatedHostGroup("exampleDedicatedHostGroup", DedicatedHostGroupArgs.builder()
            .name("example-dedicated-host-group")
            .resourceGroupName(example.name())
            .location(example.location())
            .platformFaultDomainCount(1)
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-rg-compute
      location: West Europe
  exampleDedicatedHostGroup:
    type: azure:compute:DedicatedHostGroup
    name: example
    properties:
      name: example-dedicated-host-group
      resourceGroupName: ${example.name}
      location: ${example.location}
      platformFaultDomainCount: 1
Copy

Create DedicatedHostGroup Resource

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

Constructor syntax

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

@overload
def DedicatedHostGroup(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       platform_fault_domain_count: Optional[int] = None,
                       resource_group_name: Optional[str] = None,
                       automatic_placement_enabled: Optional[bool] = None,
                       location: Optional[str] = None,
                       name: Optional[str] = None,
                       tags: Optional[Mapping[str, str]] = None,
                       zone: Optional[str] = None)
func NewDedicatedHostGroup(ctx *Context, name string, args DedicatedHostGroupArgs, opts ...ResourceOption) (*DedicatedHostGroup, error)
public DedicatedHostGroup(string name, DedicatedHostGroupArgs args, CustomResourceOptions? opts = null)
public DedicatedHostGroup(String name, DedicatedHostGroupArgs args)
public DedicatedHostGroup(String name, DedicatedHostGroupArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DedicatedHostGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. DedicatedHostGroupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. DedicatedHostGroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DedicatedHostGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DedicatedHostGroupArgs
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 dedicatedHostGroupResource = new Azure.Compute.DedicatedHostGroup("dedicatedHostGroupResource", new()
{
    PlatformFaultDomainCount = 0,
    ResourceGroupName = "string",
    AutomaticPlacementEnabled = false,
    Location = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
    Zone = "string",
});
Copy
example, err := compute.NewDedicatedHostGroup(ctx, "dedicatedHostGroupResource", &compute.DedicatedHostGroupArgs{
	PlatformFaultDomainCount:  pulumi.Int(0),
	ResourceGroupName:         pulumi.String("string"),
	AutomaticPlacementEnabled: pulumi.Bool(false),
	Location:                  pulumi.String("string"),
	Name:                      pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Zone: pulumi.String("string"),
})
Copy
var dedicatedHostGroupResource = new DedicatedHostGroup("dedicatedHostGroupResource", DedicatedHostGroupArgs.builder()
    .platformFaultDomainCount(0)
    .resourceGroupName("string")
    .automaticPlacementEnabled(false)
    .location("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .zone("string")
    .build());
Copy
dedicated_host_group_resource = azure.compute.DedicatedHostGroup("dedicatedHostGroupResource",
    platform_fault_domain_count=0,
    resource_group_name="string",
    automatic_placement_enabled=False,
    location="string",
    name="string",
    tags={
        "string": "string",
    },
    zone="string")
Copy
const dedicatedHostGroupResource = new azure.compute.DedicatedHostGroup("dedicatedHostGroupResource", {
    platformFaultDomainCount: 0,
    resourceGroupName: "string",
    automaticPlacementEnabled: false,
    location: "string",
    name: "string",
    tags: {
        string: "string",
    },
    zone: "string",
});
Copy
type: azure:compute:DedicatedHostGroup
properties:
    automaticPlacementEnabled: false
    location: string
    name: string
    platformFaultDomainCount: 0
    resourceGroupName: string
    tags:
        string: string
    zone: string
Copy

DedicatedHostGroup 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 DedicatedHostGroup resource accepts the following input properties:

PlatformFaultDomainCount
This property is required.
Changes to this property will trigger replacement.
int
The number of fault domains that the Dedicated Host Group spans. Changing this forces a new resource to be created.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the name of the resource group the Dedicated Host Group is located in. Changing this forces a new resource to be created.
AutomaticPlacementEnabled Changes to this property will trigger replacement. bool
Would virtual machines or virtual machine scale sets be placed automatically on this Dedicated Host Group? Defaults to false. Changing this forces a new resource to be created.
Location Changes to this property will trigger replacement. string
The Azure location where the Dedicated Host Group exists. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the Dedicated Host Group. Changing this forces a new resource to be created.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
Zone Changes to this property will trigger replacement. string
Specifies the Availability Zone in which this Dedicated Host Group should be located. Changing this forces a new Dedicated Host Group to be created.
PlatformFaultDomainCount
This property is required.
Changes to this property will trigger replacement.
int
The number of fault domains that the Dedicated Host Group spans. Changing this forces a new resource to be created.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the name of the resource group the Dedicated Host Group is located in. Changing this forces a new resource to be created.
AutomaticPlacementEnabled Changes to this property will trigger replacement. bool
Would virtual machines or virtual machine scale sets be placed automatically on this Dedicated Host Group? Defaults to false. Changing this forces a new resource to be created.
Location Changes to this property will trigger replacement. string
The Azure location where the Dedicated Host Group exists. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the Dedicated Host Group. Changing this forces a new resource to be created.
Tags map[string]string
A mapping of tags to assign to the resource.
Zone Changes to this property will trigger replacement. string
Specifies the Availability Zone in which this Dedicated Host Group should be located. Changing this forces a new Dedicated Host Group to be created.
platformFaultDomainCount
This property is required.
Changes to this property will trigger replacement.
Integer
The number of fault domains that the Dedicated Host Group spans. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Specifies the name of the resource group the Dedicated Host Group is located in. Changing this forces a new resource to be created.
automaticPlacementEnabled Changes to this property will trigger replacement. Boolean
Would virtual machines or virtual machine scale sets be placed automatically on this Dedicated Host Group? Defaults to false. Changing this forces a new resource to be created.
location Changes to this property will trigger replacement. String
The Azure location where the Dedicated Host Group exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the Dedicated Host Group. Changing this forces a new resource to be created.
tags Map<String,String>
A mapping of tags to assign to the resource.
zone Changes to this property will trigger replacement. String
Specifies the Availability Zone in which this Dedicated Host Group should be located. Changing this forces a new Dedicated Host Group to be created.
platformFaultDomainCount
This property is required.
Changes to this property will trigger replacement.
number
The number of fault domains that the Dedicated Host Group spans. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the name of the resource group the Dedicated Host Group is located in. Changing this forces a new resource to be created.
automaticPlacementEnabled Changes to this property will trigger replacement. boolean
Would virtual machines or virtual machine scale sets be placed automatically on this Dedicated Host Group? Defaults to false. Changing this forces a new resource to be created.
location Changes to this property will trigger replacement. string
The Azure location where the Dedicated Host Group exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
Specifies the name of the Dedicated Host Group. Changing this forces a new resource to be created.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
zone Changes to this property will trigger replacement. string
Specifies the Availability Zone in which this Dedicated Host Group should be located. Changing this forces a new Dedicated Host Group to be created.
platform_fault_domain_count
This property is required.
Changes to this property will trigger replacement.
int
The number of fault domains that the Dedicated Host Group spans. Changing this forces a new resource to be created.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
Specifies the name of the resource group the Dedicated Host Group is located in. Changing this forces a new resource to be created.
automatic_placement_enabled Changes to this property will trigger replacement. bool
Would virtual machines or virtual machine scale sets be placed automatically on this Dedicated Host Group? Defaults to false. Changing this forces a new resource to be created.
location Changes to this property will trigger replacement. str
The Azure location where the Dedicated Host Group exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
Specifies the name of the Dedicated Host Group. Changing this forces a new resource to be created.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
zone Changes to this property will trigger replacement. str
Specifies the Availability Zone in which this Dedicated Host Group should be located. Changing this forces a new Dedicated Host Group to be created.
platformFaultDomainCount
This property is required.
Changes to this property will trigger replacement.
Number
The number of fault domains that the Dedicated Host Group spans. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Specifies the name of the resource group the Dedicated Host Group is located in. Changing this forces a new resource to be created.
automaticPlacementEnabled Changes to this property will trigger replacement. Boolean
Would virtual machines or virtual machine scale sets be placed automatically on this Dedicated Host Group? Defaults to false. Changing this forces a new resource to be created.
location Changes to this property will trigger replacement. String
The Azure location where the Dedicated Host Group exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the Dedicated Host Group. Changing this forces a new resource to be created.
tags Map<String>
A mapping of tags to assign to the resource.
zone Changes to this property will trigger replacement. String
Specifies the Availability Zone in which this Dedicated Host Group should be located. Changing this forces a new Dedicated Host Group to be created.

Outputs

All input properties are implicitly available as output properties. Additionally, the DedicatedHostGroup 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 DedicatedHostGroup Resource

Get an existing DedicatedHostGroup 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?: DedicatedHostGroupState, opts?: CustomResourceOptions): DedicatedHostGroup
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        automatic_placement_enabled: Optional[bool] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        platform_fault_domain_count: Optional[int] = None,
        resource_group_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        zone: Optional[str] = None) -> DedicatedHostGroup
func GetDedicatedHostGroup(ctx *Context, name string, id IDInput, state *DedicatedHostGroupState, opts ...ResourceOption) (*DedicatedHostGroup, error)
public static DedicatedHostGroup Get(string name, Input<string> id, DedicatedHostGroupState? state, CustomResourceOptions? opts = null)
public static DedicatedHostGroup get(String name, Output<String> id, DedicatedHostGroupState state, CustomResourceOptions options)
resources:  _:    type: azure:compute:DedicatedHostGroup    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AutomaticPlacementEnabled Changes to this property will trigger replacement. bool
Would virtual machines or virtual machine scale sets be placed automatically on this Dedicated Host Group? Defaults to false. Changing this forces a new resource to be created.
Location Changes to this property will trigger replacement. string
The Azure location where the Dedicated Host Group exists. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the Dedicated Host Group. Changing this forces a new resource to be created.
PlatformFaultDomainCount Changes to this property will trigger replacement. int
The number of fault domains that the Dedicated Host Group spans. Changing this forces a new resource to be created.
ResourceGroupName Changes to this property will trigger replacement. string
Specifies the name of the resource group the Dedicated Host Group is located in. Changing this forces a new resource to be created.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
Zone Changes to this property will trigger replacement. string
Specifies the Availability Zone in which this Dedicated Host Group should be located. Changing this forces a new Dedicated Host Group to be created.
AutomaticPlacementEnabled Changes to this property will trigger replacement. bool
Would virtual machines or virtual machine scale sets be placed automatically on this Dedicated Host Group? Defaults to false. Changing this forces a new resource to be created.
Location Changes to this property will trigger replacement. string
The Azure location where the Dedicated Host Group exists. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the Dedicated Host Group. Changing this forces a new resource to be created.
PlatformFaultDomainCount Changes to this property will trigger replacement. int
The number of fault domains that the Dedicated Host Group spans. Changing this forces a new resource to be created.
ResourceGroupName Changes to this property will trigger replacement. string
Specifies the name of the resource group the Dedicated Host Group is located in. Changing this forces a new resource to be created.
Tags map[string]string
A mapping of tags to assign to the resource.
Zone Changes to this property will trigger replacement. string
Specifies the Availability Zone in which this Dedicated Host Group should be located. Changing this forces a new Dedicated Host Group to be created.
automaticPlacementEnabled Changes to this property will trigger replacement. Boolean
Would virtual machines or virtual machine scale sets be placed automatically on this Dedicated Host Group? Defaults to false. Changing this forces a new resource to be created.
location Changes to this property will trigger replacement. String
The Azure location where the Dedicated Host Group exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the Dedicated Host Group. Changing this forces a new resource to be created.
platformFaultDomainCount Changes to this property will trigger replacement. Integer
The number of fault domains that the Dedicated Host Group spans. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. String
Specifies the name of the resource group the Dedicated Host Group is located in. Changing this forces a new resource to be created.
tags Map<String,String>
A mapping of tags to assign to the resource.
zone Changes to this property will trigger replacement. String
Specifies the Availability Zone in which this Dedicated Host Group should be located. Changing this forces a new Dedicated Host Group to be created.
automaticPlacementEnabled Changes to this property will trigger replacement. boolean
Would virtual machines or virtual machine scale sets be placed automatically on this Dedicated Host Group? Defaults to false. Changing this forces a new resource to be created.
location Changes to this property will trigger replacement. string
The Azure location where the Dedicated Host Group exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
Specifies the name of the Dedicated Host Group. Changing this forces a new resource to be created.
platformFaultDomainCount Changes to this property will trigger replacement. number
The number of fault domains that the Dedicated Host Group spans. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. string
Specifies the name of the resource group the Dedicated Host Group is located in. Changing this forces a new resource to be created.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
zone Changes to this property will trigger replacement. string
Specifies the Availability Zone in which this Dedicated Host Group should be located. Changing this forces a new Dedicated Host Group to be created.
automatic_placement_enabled Changes to this property will trigger replacement. bool
Would virtual machines or virtual machine scale sets be placed automatically on this Dedicated Host Group? Defaults to false. Changing this forces a new resource to be created.
location Changes to this property will trigger replacement. str
The Azure location where the Dedicated Host Group exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
Specifies the name of the Dedicated Host Group. Changing this forces a new resource to be created.
platform_fault_domain_count Changes to this property will trigger replacement. int
The number of fault domains that the Dedicated Host Group spans. Changing this forces a new resource to be created.
resource_group_name Changes to this property will trigger replacement. str
Specifies the name of the resource group the Dedicated Host Group is located in. Changing this forces a new resource to be created.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
zone Changes to this property will trigger replacement. str
Specifies the Availability Zone in which this Dedicated Host Group should be located. Changing this forces a new Dedicated Host Group to be created.
automaticPlacementEnabled Changes to this property will trigger replacement. Boolean
Would virtual machines or virtual machine scale sets be placed automatically on this Dedicated Host Group? Defaults to false. Changing this forces a new resource to be created.
location Changes to this property will trigger replacement. String
The Azure location where the Dedicated Host Group exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the Dedicated Host Group. Changing this forces a new resource to be created.
platformFaultDomainCount Changes to this property will trigger replacement. Number
The number of fault domains that the Dedicated Host Group spans. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. String
Specifies the name of the resource group the Dedicated Host Group is located in. Changing this forces a new resource to be created.
tags Map<String>
A mapping of tags to assign to the resource.
zone Changes to this property will trigger replacement. String
Specifies the Availability Zone in which this Dedicated Host Group should be located. Changing this forces a new Dedicated Host Group to be created.

Import

Dedicated Host Group can be imported using the resource id, e.g.

$ pulumi import azure:compute/dedicatedHostGroup:DedicatedHostGroup example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example-rg/providers/Microsoft.Compute/hostGroups/group1
Copy

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.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure