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

We recommend using Azure Native.

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

azure.compute.DedicatedHost

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 within 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-resources",
    location: "West Europe",
});
const exampleDedicatedHostGroup = new azure.compute.DedicatedHostGroup("example", {
    name: "example-host-group",
    resourceGroupName: example.name,
    location: example.location,
    platformFaultDomainCount: 2,
});
const exampleDedicatedHost = new azure.compute.DedicatedHost("example", {
    name: "example-host",
    location: example.location,
    dedicatedHostGroupId: exampleDedicatedHostGroup.id,
    skuName: "DSv3-Type3",
    platformFaultDomain: 1,
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_dedicated_host_group = azure.compute.DedicatedHostGroup("example",
    name="example-host-group",
    resource_group_name=example.name,
    location=example.location,
    platform_fault_domain_count=2)
example_dedicated_host = azure.compute.DedicatedHost("example",
    name="example-host",
    location=example.location,
    dedicated_host_group_id=example_dedicated_host_group.id,
    sku_name="DSv3-Type3",
    platform_fault_domain=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-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleDedicatedHostGroup, err := compute.NewDedicatedHostGroup(ctx, "example", &compute.DedicatedHostGroupArgs{
			Name:                     pulumi.String("example-host-group"),
			ResourceGroupName:        example.Name,
			Location:                 example.Location,
			PlatformFaultDomainCount: pulumi.Int(2),
		})
		if err != nil {
			return err
		}
		_, err = compute.NewDedicatedHost(ctx, "example", &compute.DedicatedHostArgs{
			Name:                 pulumi.String("example-host"),
			Location:             example.Location,
			DedicatedHostGroupId: exampleDedicatedHostGroup.ID(),
			SkuName:              pulumi.String("DSv3-Type3"),
			PlatformFaultDomain:  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-resources",
        Location = "West Europe",
    });

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

    var exampleDedicatedHost = new Azure.Compute.DedicatedHost("example", new()
    {
        Name = "example-host",
        Location = example.Location,
        DedicatedHostGroupId = exampleDedicatedHostGroup.Id,
        SkuName = "DSv3-Type3",
        PlatformFaultDomain = 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 com.pulumi.azure.compute.DedicatedHost;
import com.pulumi.azure.compute.DedicatedHostArgs;
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 exampleDedicatedHostGroup = new DedicatedHostGroup("exampleDedicatedHostGroup", DedicatedHostGroupArgs.builder()
            .name("example-host-group")
            .resourceGroupName(example.name())
            .location(example.location())
            .platformFaultDomainCount(2)
            .build());

        var exampleDedicatedHost = new DedicatedHost("exampleDedicatedHost", DedicatedHostArgs.builder()
            .name("example-host")
            .location(example.location())
            .dedicatedHostGroupId(exampleDedicatedHostGroup.id())
            .skuName("DSv3-Type3")
            .platformFaultDomain(1)
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleDedicatedHostGroup:
    type: azure:compute:DedicatedHostGroup
    name: example
    properties:
      name: example-host-group
      resourceGroupName: ${example.name}
      location: ${example.location}
      platformFaultDomainCount: 2
  exampleDedicatedHost:
    type: azure:compute:DedicatedHost
    name: example
    properties:
      name: example-host
      location: ${example.location}
      dedicatedHostGroupId: ${exampleDedicatedHostGroup.id}
      skuName: DSv3-Type3
      platformFaultDomain: 1
Copy

Create DedicatedHost Resource

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

Constructor syntax

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

@overload
def DedicatedHost(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  dedicated_host_group_id: Optional[str] = None,
                  platform_fault_domain: Optional[int] = None,
                  sku_name: Optional[str] = None,
                  auto_replace_on_failure: Optional[bool] = None,
                  license_type: Optional[str] = None,
                  location: Optional[str] = None,
                  name: Optional[str] = None,
                  tags: Optional[Mapping[str, str]] = None)
func NewDedicatedHost(ctx *Context, name string, args DedicatedHostArgs, opts ...ResourceOption) (*DedicatedHost, error)
public DedicatedHost(string name, DedicatedHostArgs args, CustomResourceOptions? opts = null)
public DedicatedHost(String name, DedicatedHostArgs args)
public DedicatedHost(String name, DedicatedHostArgs args, CustomResourceOptions options)

type: azure:compute:DedicatedHost
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. DedicatedHostArgs
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. DedicatedHostArgs
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. DedicatedHostArgs
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. DedicatedHostArgs
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. DedicatedHostArgs
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 dedicatedHostResource = new Azure.Compute.DedicatedHost("dedicatedHostResource", new()
{
    DedicatedHostGroupId = "string",
    PlatformFaultDomain = 0,
    SkuName = "string",
    AutoReplaceOnFailure = false,
    LicenseType = "string",
    Location = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := compute.NewDedicatedHost(ctx, "dedicatedHostResource", &compute.DedicatedHostArgs{
	DedicatedHostGroupId: pulumi.String("string"),
	PlatformFaultDomain:  pulumi.Int(0),
	SkuName:              pulumi.String("string"),
	AutoReplaceOnFailure: pulumi.Bool(false),
	LicenseType:          pulumi.String("string"),
	Location:             pulumi.String("string"),
	Name:                 pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var dedicatedHostResource = new DedicatedHost("dedicatedHostResource", DedicatedHostArgs.builder()
    .dedicatedHostGroupId("string")
    .platformFaultDomain(0)
    .skuName("string")
    .autoReplaceOnFailure(false)
    .licenseType("string")
    .location("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
dedicated_host_resource = azure.compute.DedicatedHost("dedicatedHostResource",
    dedicated_host_group_id="string",
    platform_fault_domain=0,
    sku_name="string",
    auto_replace_on_failure=False,
    license_type="string",
    location="string",
    name="string",
    tags={
        "string": "string",
    })
Copy
const dedicatedHostResource = new azure.compute.DedicatedHost("dedicatedHostResource", {
    dedicatedHostGroupId: "string",
    platformFaultDomain: 0,
    skuName: "string",
    autoReplaceOnFailure: false,
    licenseType: "string",
    location: "string",
    name: "string",
    tags: {
        string: "string",
    },
});
Copy
type: azure:compute:DedicatedHost
properties:
    autoReplaceOnFailure: false
    dedicatedHostGroupId: string
    licenseType: string
    location: string
    name: string
    platformFaultDomain: 0
    skuName: string
    tags:
        string: string
Copy

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

DedicatedHostGroupId
This property is required.
Changes to this property will trigger replacement.
string
Specifies the ID of the Dedicated Host Group where the Dedicated Host should exist. Changing this forces a new resource to be created.
PlatformFaultDomain
This property is required.
Changes to this property will trigger replacement.
int
Specify the fault domain of the Dedicated Host Group in which to create the Dedicated Host. Changing this forces a new resource to be created.
SkuName
This property is required.
Changes to this property will trigger replacement.
string
Specify the SKU name of the Dedicated Host. Possible values are DADSv5-Type1, DASv4-Type1, DASv4-Type2, DASv5-Type1, DCSv2-Type1, DDSv4-Type1, DDSv4-Type2, DDSv5-Type1, DSv3-Type1, DSv3-Type2, DSv3-Type3, DSv3-Type4, DSv4-Type1, DSv4-Type2, DSv5-Type1, EADSv5-Type1, EASv4-Type1, EASv4-Type2, EASv5-Type1, EDSv4-Type1, EDSv4-Type2, EDSv5-Type1, ESv3-Type1, ESv3-Type2, ESv3-Type3, ESv3-Type4, ESv4-Type1, ESv4-Type2, ESv5-Type1, FSv2-Type2, FSv2-Type3, FSv2-Type4, FXmds-Type1, LSv2-Type1, LSv3-Type1, MDMSv2MedMem-Type1, MDSv2MedMem-Type1, MMSv2MedMem-Type1, MS-Type1, MSm-Type1, MSmv2-Type1, MSv2-Type1, MSv2MedMem-Type1, NVASv4-Type1 and NVSv3-Type1. Changing this forces a new resource to be created.
AutoReplaceOnFailure bool
Should the Dedicated Host automatically be replaced in case of a Hardware Failure? Defaults to true.
LicenseType string
Specifies the software license type that will be applied to the VMs deployed on the Dedicated Host. Possible values are None, Windows_Server_Hybrid and Windows_Server_Perpetual. Defaults to None.
Location Changes to this property will trigger replacement. string
Specify the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of this Dedicated Host. Changing this forces a new resource to be created.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
DedicatedHostGroupId
This property is required.
Changes to this property will trigger replacement.
string
Specifies the ID of the Dedicated Host Group where the Dedicated Host should exist. Changing this forces a new resource to be created.
PlatformFaultDomain
This property is required.
Changes to this property will trigger replacement.
int
Specify the fault domain of the Dedicated Host Group in which to create the Dedicated Host. Changing this forces a new resource to be created.
SkuName
This property is required.
Changes to this property will trigger replacement.
string
Specify the SKU name of the Dedicated Host. Possible values are DADSv5-Type1, DASv4-Type1, DASv4-Type2, DASv5-Type1, DCSv2-Type1, DDSv4-Type1, DDSv4-Type2, DDSv5-Type1, DSv3-Type1, DSv3-Type2, DSv3-Type3, DSv3-Type4, DSv4-Type1, DSv4-Type2, DSv5-Type1, EADSv5-Type1, EASv4-Type1, EASv4-Type2, EASv5-Type1, EDSv4-Type1, EDSv4-Type2, EDSv5-Type1, ESv3-Type1, ESv3-Type2, ESv3-Type3, ESv3-Type4, ESv4-Type1, ESv4-Type2, ESv5-Type1, FSv2-Type2, FSv2-Type3, FSv2-Type4, FXmds-Type1, LSv2-Type1, LSv3-Type1, MDMSv2MedMem-Type1, MDSv2MedMem-Type1, MMSv2MedMem-Type1, MS-Type1, MSm-Type1, MSmv2-Type1, MSv2-Type1, MSv2MedMem-Type1, NVASv4-Type1 and NVSv3-Type1. Changing this forces a new resource to be created.
AutoReplaceOnFailure bool
Should the Dedicated Host automatically be replaced in case of a Hardware Failure? Defaults to true.
LicenseType string
Specifies the software license type that will be applied to the VMs deployed on the Dedicated Host. Possible values are None, Windows_Server_Hybrid and Windows_Server_Perpetual. Defaults to None.
Location Changes to this property will trigger replacement. string
Specify the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of this Dedicated Host. Changing this forces a new resource to be created.
Tags map[string]string
A mapping of tags to assign to the resource.
dedicatedHostGroupId
This property is required.
Changes to this property will trigger replacement.
String
Specifies the ID of the Dedicated Host Group where the Dedicated Host should exist. Changing this forces a new resource to be created.
platformFaultDomain
This property is required.
Changes to this property will trigger replacement.
Integer
Specify the fault domain of the Dedicated Host Group in which to create the Dedicated Host. Changing this forces a new resource to be created.
skuName
This property is required.
Changes to this property will trigger replacement.
String
Specify the SKU name of the Dedicated Host. Possible values are DADSv5-Type1, DASv4-Type1, DASv4-Type2, DASv5-Type1, DCSv2-Type1, DDSv4-Type1, DDSv4-Type2, DDSv5-Type1, DSv3-Type1, DSv3-Type2, DSv3-Type3, DSv3-Type4, DSv4-Type1, DSv4-Type2, DSv5-Type1, EADSv5-Type1, EASv4-Type1, EASv4-Type2, EASv5-Type1, EDSv4-Type1, EDSv4-Type2, EDSv5-Type1, ESv3-Type1, ESv3-Type2, ESv3-Type3, ESv3-Type4, ESv4-Type1, ESv4-Type2, ESv5-Type1, FSv2-Type2, FSv2-Type3, FSv2-Type4, FXmds-Type1, LSv2-Type1, LSv3-Type1, MDMSv2MedMem-Type1, MDSv2MedMem-Type1, MMSv2MedMem-Type1, MS-Type1, MSm-Type1, MSmv2-Type1, MSv2-Type1, MSv2MedMem-Type1, NVASv4-Type1 and NVSv3-Type1. Changing this forces a new resource to be created.
autoReplaceOnFailure Boolean
Should the Dedicated Host automatically be replaced in case of a Hardware Failure? Defaults to true.
licenseType String
Specifies the software license type that will be applied to the VMs deployed on the Dedicated Host. Possible values are None, Windows_Server_Hybrid and Windows_Server_Perpetual. Defaults to None.
location Changes to this property will trigger replacement. String
Specify the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of this Dedicated Host. Changing this forces a new resource to be created.
tags Map<String,String>
A mapping of tags to assign to the resource.
dedicatedHostGroupId
This property is required.
Changes to this property will trigger replacement.
string
Specifies the ID of the Dedicated Host Group where the Dedicated Host should exist. Changing this forces a new resource to be created.
platformFaultDomain
This property is required.
Changes to this property will trigger replacement.
number
Specify the fault domain of the Dedicated Host Group in which to create the Dedicated Host. Changing this forces a new resource to be created.
skuName
This property is required.
Changes to this property will trigger replacement.
string
Specify the SKU name of the Dedicated Host. Possible values are DADSv5-Type1, DASv4-Type1, DASv4-Type2, DASv5-Type1, DCSv2-Type1, DDSv4-Type1, DDSv4-Type2, DDSv5-Type1, DSv3-Type1, DSv3-Type2, DSv3-Type3, DSv3-Type4, DSv4-Type1, DSv4-Type2, DSv5-Type1, EADSv5-Type1, EASv4-Type1, EASv4-Type2, EASv5-Type1, EDSv4-Type1, EDSv4-Type2, EDSv5-Type1, ESv3-Type1, ESv3-Type2, ESv3-Type3, ESv3-Type4, ESv4-Type1, ESv4-Type2, ESv5-Type1, FSv2-Type2, FSv2-Type3, FSv2-Type4, FXmds-Type1, LSv2-Type1, LSv3-Type1, MDMSv2MedMem-Type1, MDSv2MedMem-Type1, MMSv2MedMem-Type1, MS-Type1, MSm-Type1, MSmv2-Type1, MSv2-Type1, MSv2MedMem-Type1, NVASv4-Type1 and NVSv3-Type1. Changing this forces a new resource to be created.
autoReplaceOnFailure boolean
Should the Dedicated Host automatically be replaced in case of a Hardware Failure? Defaults to true.
licenseType string
Specifies the software license type that will be applied to the VMs deployed on the Dedicated Host. Possible values are None, Windows_Server_Hybrid and Windows_Server_Perpetual. Defaults to None.
location Changes to this property will trigger replacement. string
Specify the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
Specifies the name of this Dedicated Host. Changing this forces a new resource to be created.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
dedicated_host_group_id
This property is required.
Changes to this property will trigger replacement.
str
Specifies the ID of the Dedicated Host Group where the Dedicated Host should exist. Changing this forces a new resource to be created.
platform_fault_domain
This property is required.
Changes to this property will trigger replacement.
int
Specify the fault domain of the Dedicated Host Group in which to create the Dedicated Host. Changing this forces a new resource to be created.
sku_name
This property is required.
Changes to this property will trigger replacement.
str
Specify the SKU name of the Dedicated Host. Possible values are DADSv5-Type1, DASv4-Type1, DASv4-Type2, DASv5-Type1, DCSv2-Type1, DDSv4-Type1, DDSv4-Type2, DDSv5-Type1, DSv3-Type1, DSv3-Type2, DSv3-Type3, DSv3-Type4, DSv4-Type1, DSv4-Type2, DSv5-Type1, EADSv5-Type1, EASv4-Type1, EASv4-Type2, EASv5-Type1, EDSv4-Type1, EDSv4-Type2, EDSv5-Type1, ESv3-Type1, ESv3-Type2, ESv3-Type3, ESv3-Type4, ESv4-Type1, ESv4-Type2, ESv5-Type1, FSv2-Type2, FSv2-Type3, FSv2-Type4, FXmds-Type1, LSv2-Type1, LSv3-Type1, MDMSv2MedMem-Type1, MDSv2MedMem-Type1, MMSv2MedMem-Type1, MS-Type1, MSm-Type1, MSmv2-Type1, MSv2-Type1, MSv2MedMem-Type1, NVASv4-Type1 and NVSv3-Type1. Changing this forces a new resource to be created.
auto_replace_on_failure bool
Should the Dedicated Host automatically be replaced in case of a Hardware Failure? Defaults to true.
license_type str
Specifies the software license type that will be applied to the VMs deployed on the Dedicated Host. Possible values are None, Windows_Server_Hybrid and Windows_Server_Perpetual. Defaults to None.
location Changes to this property will trigger replacement. str
Specify the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
Specifies the name of this Dedicated Host. Changing this forces a new resource to be created.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
dedicatedHostGroupId
This property is required.
Changes to this property will trigger replacement.
String
Specifies the ID of the Dedicated Host Group where the Dedicated Host should exist. Changing this forces a new resource to be created.
platformFaultDomain
This property is required.
Changes to this property will trigger replacement.
Number
Specify the fault domain of the Dedicated Host Group in which to create the Dedicated Host. Changing this forces a new resource to be created.
skuName
This property is required.
Changes to this property will trigger replacement.
String
Specify the SKU name of the Dedicated Host. Possible values are DADSv5-Type1, DASv4-Type1, DASv4-Type2, DASv5-Type1, DCSv2-Type1, DDSv4-Type1, DDSv4-Type2, DDSv5-Type1, DSv3-Type1, DSv3-Type2, DSv3-Type3, DSv3-Type4, DSv4-Type1, DSv4-Type2, DSv5-Type1, EADSv5-Type1, EASv4-Type1, EASv4-Type2, EASv5-Type1, EDSv4-Type1, EDSv4-Type2, EDSv5-Type1, ESv3-Type1, ESv3-Type2, ESv3-Type3, ESv3-Type4, ESv4-Type1, ESv4-Type2, ESv5-Type1, FSv2-Type2, FSv2-Type3, FSv2-Type4, FXmds-Type1, LSv2-Type1, LSv3-Type1, MDMSv2MedMem-Type1, MDSv2MedMem-Type1, MMSv2MedMem-Type1, MS-Type1, MSm-Type1, MSmv2-Type1, MSv2-Type1, MSv2MedMem-Type1, NVASv4-Type1 and NVSv3-Type1. Changing this forces a new resource to be created.
autoReplaceOnFailure Boolean
Should the Dedicated Host automatically be replaced in case of a Hardware Failure? Defaults to true.
licenseType String
Specifies the software license type that will be applied to the VMs deployed on the Dedicated Host. Possible values are None, Windows_Server_Hybrid and Windows_Server_Perpetual. Defaults to None.
location Changes to this property will trigger replacement. String
Specify the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of this Dedicated Host. Changing this forces a new resource to be created.
tags Map<String>
A mapping of tags to assign to the resource.

Outputs

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

Get an existing DedicatedHost 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?: DedicatedHostState, opts?: CustomResourceOptions): DedicatedHost
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_replace_on_failure: Optional[bool] = None,
        dedicated_host_group_id: Optional[str] = None,
        license_type: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        platform_fault_domain: Optional[int] = None,
        sku_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None) -> DedicatedHost
func GetDedicatedHost(ctx *Context, name string, id IDInput, state *DedicatedHostState, opts ...ResourceOption) (*DedicatedHost, error)
public static DedicatedHost Get(string name, Input<string> id, DedicatedHostState? state, CustomResourceOptions? opts = null)
public static DedicatedHost get(String name, Output<String> id, DedicatedHostState state, CustomResourceOptions options)
resources:  _:    type: azure:compute:DedicatedHost    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:
AutoReplaceOnFailure bool
Should the Dedicated Host automatically be replaced in case of a Hardware Failure? Defaults to true.
DedicatedHostGroupId Changes to this property will trigger replacement. string
Specifies the ID of the Dedicated Host Group where the Dedicated Host should exist. Changing this forces a new resource to be created.
LicenseType string
Specifies the software license type that will be applied to the VMs deployed on the Dedicated Host. Possible values are None, Windows_Server_Hybrid and Windows_Server_Perpetual. Defaults to None.
Location Changes to this property will trigger replacement. string
Specify the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of this Dedicated Host. Changing this forces a new resource to be created.
PlatformFaultDomain Changes to this property will trigger replacement. int
Specify the fault domain of the Dedicated Host Group in which to create the Dedicated Host. Changing this forces a new resource to be created.
SkuName Changes to this property will trigger replacement. string
Specify the SKU name of the Dedicated Host. Possible values are DADSv5-Type1, DASv4-Type1, DASv4-Type2, DASv5-Type1, DCSv2-Type1, DDSv4-Type1, DDSv4-Type2, DDSv5-Type1, DSv3-Type1, DSv3-Type2, DSv3-Type3, DSv3-Type4, DSv4-Type1, DSv4-Type2, DSv5-Type1, EADSv5-Type1, EASv4-Type1, EASv4-Type2, EASv5-Type1, EDSv4-Type1, EDSv4-Type2, EDSv5-Type1, ESv3-Type1, ESv3-Type2, ESv3-Type3, ESv3-Type4, ESv4-Type1, ESv4-Type2, ESv5-Type1, FSv2-Type2, FSv2-Type3, FSv2-Type4, FXmds-Type1, LSv2-Type1, LSv3-Type1, MDMSv2MedMem-Type1, MDSv2MedMem-Type1, MMSv2MedMem-Type1, MS-Type1, MSm-Type1, MSmv2-Type1, MSv2-Type1, MSv2MedMem-Type1, NVASv4-Type1 and NVSv3-Type1. Changing this forces a new resource to be created.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
AutoReplaceOnFailure bool
Should the Dedicated Host automatically be replaced in case of a Hardware Failure? Defaults to true.
DedicatedHostGroupId Changes to this property will trigger replacement. string
Specifies the ID of the Dedicated Host Group where the Dedicated Host should exist. Changing this forces a new resource to be created.
LicenseType string
Specifies the software license type that will be applied to the VMs deployed on the Dedicated Host. Possible values are None, Windows_Server_Hybrid and Windows_Server_Perpetual. Defaults to None.
Location Changes to this property will trigger replacement. string
Specify the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of this Dedicated Host. Changing this forces a new resource to be created.
PlatformFaultDomain Changes to this property will trigger replacement. int
Specify the fault domain of the Dedicated Host Group in which to create the Dedicated Host. Changing this forces a new resource to be created.
SkuName Changes to this property will trigger replacement. string
Specify the SKU name of the Dedicated Host. Possible values are DADSv5-Type1, DASv4-Type1, DASv4-Type2, DASv5-Type1, DCSv2-Type1, DDSv4-Type1, DDSv4-Type2, DDSv5-Type1, DSv3-Type1, DSv3-Type2, DSv3-Type3, DSv3-Type4, DSv4-Type1, DSv4-Type2, DSv5-Type1, EADSv5-Type1, EASv4-Type1, EASv4-Type2, EASv5-Type1, EDSv4-Type1, EDSv4-Type2, EDSv5-Type1, ESv3-Type1, ESv3-Type2, ESv3-Type3, ESv3-Type4, ESv4-Type1, ESv4-Type2, ESv5-Type1, FSv2-Type2, FSv2-Type3, FSv2-Type4, FXmds-Type1, LSv2-Type1, LSv3-Type1, MDMSv2MedMem-Type1, MDSv2MedMem-Type1, MMSv2MedMem-Type1, MS-Type1, MSm-Type1, MSmv2-Type1, MSv2-Type1, MSv2MedMem-Type1, NVASv4-Type1 and NVSv3-Type1. Changing this forces a new resource to be created.
Tags map[string]string
A mapping of tags to assign to the resource.
autoReplaceOnFailure Boolean
Should the Dedicated Host automatically be replaced in case of a Hardware Failure? Defaults to true.
dedicatedHostGroupId Changes to this property will trigger replacement. String
Specifies the ID of the Dedicated Host Group where the Dedicated Host should exist. Changing this forces a new resource to be created.
licenseType String
Specifies the software license type that will be applied to the VMs deployed on the Dedicated Host. Possible values are None, Windows_Server_Hybrid and Windows_Server_Perpetual. Defaults to None.
location Changes to this property will trigger replacement. String
Specify the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of this Dedicated Host. Changing this forces a new resource to be created.
platformFaultDomain Changes to this property will trigger replacement. Integer
Specify the fault domain of the Dedicated Host Group in which to create the Dedicated Host. Changing this forces a new resource to be created.
skuName Changes to this property will trigger replacement. String
Specify the SKU name of the Dedicated Host. Possible values are DADSv5-Type1, DASv4-Type1, DASv4-Type2, DASv5-Type1, DCSv2-Type1, DDSv4-Type1, DDSv4-Type2, DDSv5-Type1, DSv3-Type1, DSv3-Type2, DSv3-Type3, DSv3-Type4, DSv4-Type1, DSv4-Type2, DSv5-Type1, EADSv5-Type1, EASv4-Type1, EASv4-Type2, EASv5-Type1, EDSv4-Type1, EDSv4-Type2, EDSv5-Type1, ESv3-Type1, ESv3-Type2, ESv3-Type3, ESv3-Type4, ESv4-Type1, ESv4-Type2, ESv5-Type1, FSv2-Type2, FSv2-Type3, FSv2-Type4, FXmds-Type1, LSv2-Type1, LSv3-Type1, MDMSv2MedMem-Type1, MDSv2MedMem-Type1, MMSv2MedMem-Type1, MS-Type1, MSm-Type1, MSmv2-Type1, MSv2-Type1, MSv2MedMem-Type1, NVASv4-Type1 and NVSv3-Type1. Changing this forces a new resource to be created.
tags Map<String,String>
A mapping of tags to assign to the resource.
autoReplaceOnFailure boolean
Should the Dedicated Host automatically be replaced in case of a Hardware Failure? Defaults to true.
dedicatedHostGroupId Changes to this property will trigger replacement. string
Specifies the ID of the Dedicated Host Group where the Dedicated Host should exist. Changing this forces a new resource to be created.
licenseType string
Specifies the software license type that will be applied to the VMs deployed on the Dedicated Host. Possible values are None, Windows_Server_Hybrid and Windows_Server_Perpetual. Defaults to None.
location Changes to this property will trigger replacement. string
Specify the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
Specifies the name of this Dedicated Host. Changing this forces a new resource to be created.
platformFaultDomain Changes to this property will trigger replacement. number
Specify the fault domain of the Dedicated Host Group in which to create the Dedicated Host. Changing this forces a new resource to be created.
skuName Changes to this property will trigger replacement. string
Specify the SKU name of the Dedicated Host. Possible values are DADSv5-Type1, DASv4-Type1, DASv4-Type2, DASv5-Type1, DCSv2-Type1, DDSv4-Type1, DDSv4-Type2, DDSv5-Type1, DSv3-Type1, DSv3-Type2, DSv3-Type3, DSv3-Type4, DSv4-Type1, DSv4-Type2, DSv5-Type1, EADSv5-Type1, EASv4-Type1, EASv4-Type2, EASv5-Type1, EDSv4-Type1, EDSv4-Type2, EDSv5-Type1, ESv3-Type1, ESv3-Type2, ESv3-Type3, ESv3-Type4, ESv4-Type1, ESv4-Type2, ESv5-Type1, FSv2-Type2, FSv2-Type3, FSv2-Type4, FXmds-Type1, LSv2-Type1, LSv3-Type1, MDMSv2MedMem-Type1, MDSv2MedMem-Type1, MMSv2MedMem-Type1, MS-Type1, MSm-Type1, MSmv2-Type1, MSv2-Type1, MSv2MedMem-Type1, NVASv4-Type1 and NVSv3-Type1. Changing this forces a new resource to be created.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
auto_replace_on_failure bool
Should the Dedicated Host automatically be replaced in case of a Hardware Failure? Defaults to true.
dedicated_host_group_id Changes to this property will trigger replacement. str
Specifies the ID of the Dedicated Host Group where the Dedicated Host should exist. Changing this forces a new resource to be created.
license_type str
Specifies the software license type that will be applied to the VMs deployed on the Dedicated Host. Possible values are None, Windows_Server_Hybrid and Windows_Server_Perpetual. Defaults to None.
location Changes to this property will trigger replacement. str
Specify the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
Specifies the name of this Dedicated Host. Changing this forces a new resource to be created.
platform_fault_domain Changes to this property will trigger replacement. int
Specify the fault domain of the Dedicated Host Group in which to create the Dedicated Host. Changing this forces a new resource to be created.
sku_name Changes to this property will trigger replacement. str
Specify the SKU name of the Dedicated Host. Possible values are DADSv5-Type1, DASv4-Type1, DASv4-Type2, DASv5-Type1, DCSv2-Type1, DDSv4-Type1, DDSv4-Type2, DDSv5-Type1, DSv3-Type1, DSv3-Type2, DSv3-Type3, DSv3-Type4, DSv4-Type1, DSv4-Type2, DSv5-Type1, EADSv5-Type1, EASv4-Type1, EASv4-Type2, EASv5-Type1, EDSv4-Type1, EDSv4-Type2, EDSv5-Type1, ESv3-Type1, ESv3-Type2, ESv3-Type3, ESv3-Type4, ESv4-Type1, ESv4-Type2, ESv5-Type1, FSv2-Type2, FSv2-Type3, FSv2-Type4, FXmds-Type1, LSv2-Type1, LSv3-Type1, MDMSv2MedMem-Type1, MDSv2MedMem-Type1, MMSv2MedMem-Type1, MS-Type1, MSm-Type1, MSmv2-Type1, MSv2-Type1, MSv2MedMem-Type1, NVASv4-Type1 and NVSv3-Type1. Changing this forces a new resource to be created.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
autoReplaceOnFailure Boolean
Should the Dedicated Host automatically be replaced in case of a Hardware Failure? Defaults to true.
dedicatedHostGroupId Changes to this property will trigger replacement. String
Specifies the ID of the Dedicated Host Group where the Dedicated Host should exist. Changing this forces a new resource to be created.
licenseType String
Specifies the software license type that will be applied to the VMs deployed on the Dedicated Host. Possible values are None, Windows_Server_Hybrid and Windows_Server_Perpetual. Defaults to None.
location Changes to this property will trigger replacement. String
Specify the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of this Dedicated Host. Changing this forces a new resource to be created.
platformFaultDomain Changes to this property will trigger replacement. Number
Specify the fault domain of the Dedicated Host Group in which to create the Dedicated Host. Changing this forces a new resource to be created.
skuName Changes to this property will trigger replacement. String
Specify the SKU name of the Dedicated Host. Possible values are DADSv5-Type1, DASv4-Type1, DASv4-Type2, DASv5-Type1, DCSv2-Type1, DDSv4-Type1, DDSv4-Type2, DDSv5-Type1, DSv3-Type1, DSv3-Type2, DSv3-Type3, DSv3-Type4, DSv4-Type1, DSv4-Type2, DSv5-Type1, EADSv5-Type1, EASv4-Type1, EASv4-Type2, EASv5-Type1, EDSv4-Type1, EDSv4-Type2, EDSv5-Type1, ESv3-Type1, ESv3-Type2, ESv3-Type3, ESv3-Type4, ESv4-Type1, ESv4-Type2, ESv5-Type1, FSv2-Type2, FSv2-Type3, FSv2-Type4, FXmds-Type1, LSv2-Type1, LSv3-Type1, MDMSv2MedMem-Type1, MDSv2MedMem-Type1, MMSv2MedMem-Type1, MS-Type1, MSm-Type1, MSmv2-Type1, MSv2-Type1, MSv2MedMem-Type1, NVASv4-Type1 and NVSv3-Type1. Changing this forces a new resource to be created.
tags Map<String>
A mapping of tags to assign to the resource.

Import

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

$ pulumi import azure:compute/dedicatedHost:DedicatedHost example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Compute/hostGroups/group1/hosts/host1
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