Azure Native

Pulumi Official
Package maintained by Pulumi
v1.67.0 published on Tuesday, Jul 12, 2022 by Pulumi

DedicatedHost

Specifies information about the Dedicated host. API Version: 2020-12-01.

Example Usage

Create or update a dedicated host .

using Pulumi;
using AzureNative = Pulumi.AzureNative;

class MyStack : Stack
{
    public MyStack()
    {
        var dedicatedHost = new AzureNative.Compute.DedicatedHost("dedicatedHost", new AzureNative.Compute.DedicatedHostArgs
        {
            HostGroupName = "myDedicatedHostGroup",
            HostName = "myDedicatedHost",
            Location = "westus",
            PlatformFaultDomain = 1,
            ResourceGroupName = "myResourceGroup",
            Sku = new AzureNative.Compute.Inputs.SkuArgs
            {
                Name = "DSv3-Type1",
            },
            Tags = 
            {
                { "department", "HR" },
            },
        });
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.NewDedicatedHost(ctx, "dedicatedHost", &compute.DedicatedHostArgs{
			HostGroupName:       pulumi.String("myDedicatedHostGroup"),
			HostName:            pulumi.String("myDedicatedHost"),
			Location:            pulumi.String("westus"),
			PlatformFaultDomain: pulumi.Int(1),
			ResourceGroupName:   pulumi.String("myResourceGroup"),
			Sku: &compute.SkuArgs{
				Name: pulumi.String("DSv3-Type1"),
			},
			Tags: pulumi.StringMap{
				"department": pulumi.String("HR"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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

    public static void stack(Context ctx) {
        var dedicatedHost = new DedicatedHost("dedicatedHost", DedicatedHostArgs.builder()        
            .hostGroupName("myDedicatedHostGroup")
            .hostName("myDedicatedHost")
            .location("westus")
            .platformFaultDomain(1)
            .resourceGroupName("myResourceGroup")
            .sku(Map.of("name", "DSv3-Type1"))
            .tags(Map.of("department", "HR"))
            .build());

    }
}
import pulumi
import pulumi_azure_native as azure_native

dedicated_host = azure_native.compute.DedicatedHost("dedicatedHost",
    host_group_name="myDedicatedHostGroup",
    host_name="myDedicatedHost",
    location="westus",
    platform_fault_domain=1,
    resource_group_name="myResourceGroup",
    sku=azure_native.compute.SkuArgs(
        name="DSv3-Type1",
    ),
    tags={
        "department": "HR",
    })
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const dedicatedHost = new azure_native.compute.DedicatedHost("dedicatedHost", {
    hostGroupName: "myDedicatedHostGroup",
    hostName: "myDedicatedHost",
    location: "westus",
    platformFaultDomain: 1,
    resourceGroupName: "myResourceGroup",
    sku: {
        name: "DSv3-Type1",
    },
    tags: {
        department: "HR",
    },
});
resources:
  dedicatedHost:
    type: azure-native:compute:DedicatedHost
    properties:
      hostGroupName: myDedicatedHostGroup
      hostName: myDedicatedHost
      location: westus
      platformFaultDomain: 1
      resourceGroupName: myResourceGroup
      sku:
        name: DSv3-Type1
      tags:
        department: HR

Create a DedicatedHost Resource

new DedicatedHost(name: string, args: DedicatedHostArgs, opts?: CustomResourceOptions);
@overload
def DedicatedHost(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  auto_replace_on_failure: Optional[bool] = None,
                  host_group_name: Optional[str] = None,
                  host_name: Optional[str] = None,
                  license_type: Optional[DedicatedHostLicenseTypes] = None,
                  location: Optional[str] = None,
                  platform_fault_domain: Optional[int] = None,
                  resource_group_name: Optional[str] = None,
                  sku: Optional[SkuArgs] = None,
                  tags: Optional[Mapping[str, str]] = None)
@overload
def DedicatedHost(resource_name: str,
                  args: DedicatedHostArgs,
                  opts: Optional[ResourceOptions] = 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-native:compute:DedicatedHost
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args DedicatedHostArgs
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 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 string
The unique name of the resource.
args DedicatedHostArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DedicatedHostArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args DedicatedHostArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

The DedicatedHost resource accepts the following input properties:

HostGroupName string

The name of the dedicated host group.

ResourceGroupName string

The name of the resource group.

Sku Pulumi.AzureNative.Compute.Inputs.SkuArgs

SKU of the dedicated host for Hardware Generation and VM family. Only name is required to be set. List Microsoft.Compute SKUs for a list of possible values.

AutoReplaceOnFailure bool

Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided.

HostName string

The name of the dedicated host .

LicenseType Pulumi.AzureNative.Compute.DedicatedHostLicenseTypes

Specifies the software license type that will be applied to the VMs deployed on the dedicated host. Possible values are: None Windows_Server_Hybrid Windows_Server_Perpetual Default: None

Location string

Resource location

PlatformFaultDomain int

Fault domain of the dedicated host within a dedicated host group.

Tags Dictionary<string, string>

Resource tags

HostGroupName string

The name of the dedicated host group.

ResourceGroupName string

The name of the resource group.

Sku SkuArgs

SKU of the dedicated host for Hardware Generation and VM family. Only name is required to be set. List Microsoft.Compute SKUs for a list of possible values.

AutoReplaceOnFailure bool

Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided.

HostName string

The name of the dedicated host .

LicenseType DedicatedHostLicenseTypes

Specifies the software license type that will be applied to the VMs deployed on the dedicated host. Possible values are: None Windows_Server_Hybrid Windows_Server_Perpetual Default: None

Location string

Resource location

PlatformFaultDomain int

Fault domain of the dedicated host within a dedicated host group.

Tags map[string]string

Resource tags

hostGroupName String

The name of the dedicated host group.

resourceGroupName String

The name of the resource group.

sku SkuArgs

SKU of the dedicated host for Hardware Generation and VM family. Only name is required to be set. List Microsoft.Compute SKUs for a list of possible values.

autoReplaceOnFailure Boolean

Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided.

hostName String

The name of the dedicated host .

licenseType DedicatedHostLicenseTypes

Specifies the software license type that will be applied to the VMs deployed on the dedicated host. Possible values are: None Windows_Server_Hybrid Windows_Server_Perpetual Default: None

location String

Resource location

platformFaultDomain Integer

Fault domain of the dedicated host within a dedicated host group.

tags Map<String,String>

Resource tags

hostGroupName string

The name of the dedicated host group.

resourceGroupName string

The name of the resource group.

sku SkuArgs

SKU of the dedicated host for Hardware Generation and VM family. Only name is required to be set. List Microsoft.Compute SKUs for a list of possible values.

autoReplaceOnFailure boolean

Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided.

hostName string

The name of the dedicated host .

licenseType DedicatedHostLicenseTypes

Specifies the software license type that will be applied to the VMs deployed on the dedicated host. Possible values are: None Windows_Server_Hybrid Windows_Server_Perpetual Default: None

location string

Resource location

platformFaultDomain number

Fault domain of the dedicated host within a dedicated host group.

tags {[key: string]: string}

Resource tags

host_group_name str

The name of the dedicated host group.

resource_group_name str

The name of the resource group.

sku SkuArgs

SKU of the dedicated host for Hardware Generation and VM family. Only name is required to be set. List Microsoft.Compute SKUs for a list of possible values.

auto_replace_on_failure bool

Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided.

host_name str

The name of the dedicated host .

license_type DedicatedHostLicenseTypes

Specifies the software license type that will be applied to the VMs deployed on the dedicated host. Possible values are: None Windows_Server_Hybrid Windows_Server_Perpetual Default: None

location str

Resource location

platform_fault_domain int

Fault domain of the dedicated host within a dedicated host group.

tags Mapping[str, str]

Resource tags

hostGroupName String

The name of the dedicated host group.

resourceGroupName String

The name of the resource group.

sku Property Map

SKU of the dedicated host for Hardware Generation and VM family. Only name is required to be set. List Microsoft.Compute SKUs for a list of possible values.

autoReplaceOnFailure Boolean

Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided.

hostName String

The name of the dedicated host .

licenseType "None" | "Windows_Server_Hybrid" | "Windows_Server_Perpetual"

Specifies the software license type that will be applied to the VMs deployed on the dedicated host. Possible values are: None Windows_Server_Hybrid Windows_Server_Perpetual Default: None

location String

Resource location

platformFaultDomain Number

Fault domain of the dedicated host within a dedicated host group.

tags Map<String>

Resource tags

Outputs

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

HostId string

A unique id generated and assigned to the dedicated host by the platform. Does not change throughout the lifetime of the host.

Id string

The provider-assigned unique ID for this managed resource.

InstanceView Pulumi.AzureNative.Compute.Outputs.DedicatedHostInstanceViewResponse

The dedicated host instance view.

Name string

Resource name

ProvisioningState string

The provisioning state, which only appears in the response.

ProvisioningTime string

The date when the host was first provisioned.

Type string

Resource type

VirtualMachines List<Pulumi.AzureNative.Compute.Outputs.SubResourceReadOnlyResponse>

A list of references to all virtual machines in the Dedicated Host.

HostId string

A unique id generated and assigned to the dedicated host by the platform. Does not change throughout the lifetime of the host.

Id string

The provider-assigned unique ID for this managed resource.

InstanceView DedicatedHostInstanceViewResponse

The dedicated host instance view.

Name string

Resource name

ProvisioningState string

The provisioning state, which only appears in the response.

ProvisioningTime string

The date when the host was first provisioned.

Type string

Resource type

VirtualMachines []SubResourceReadOnlyResponse

A list of references to all virtual machines in the Dedicated Host.

hostId String

A unique id generated and assigned to the dedicated host by the platform. Does not change throughout the lifetime of the host.

id String

The provider-assigned unique ID for this managed resource.

instanceView DedicatedHostInstanceViewResponse

The dedicated host instance view.

name String

Resource name

provisioningState String

The provisioning state, which only appears in the response.

provisioningTime String

The date when the host was first provisioned.

type String

Resource type

virtualMachines List<SubResourceReadOnlyResponse>

A list of references to all virtual machines in the Dedicated Host.

hostId string

A unique id generated and assigned to the dedicated host by the platform. Does not change throughout the lifetime of the host.

id string

The provider-assigned unique ID for this managed resource.

instanceView DedicatedHostInstanceViewResponse

The dedicated host instance view.

name string

Resource name

provisioningState string

The provisioning state, which only appears in the response.

provisioningTime string

The date when the host was first provisioned.

type string

Resource type

virtualMachines SubResourceReadOnlyResponse[]

A list of references to all virtual machines in the Dedicated Host.

host_id str

A unique id generated and assigned to the dedicated host by the platform. Does not change throughout the lifetime of the host.

id str

The provider-assigned unique ID for this managed resource.

instance_view DedicatedHostInstanceViewResponse

The dedicated host instance view.

name str

Resource name

provisioning_state str

The provisioning state, which only appears in the response.

provisioning_time str

The date when the host was first provisioned.

type str

Resource type

virtual_machines Sequence[SubResourceReadOnlyResponse]

A list of references to all virtual machines in the Dedicated Host.

hostId String

A unique id generated and assigned to the dedicated host by the platform. Does not change throughout the lifetime of the host.

id String

The provider-assigned unique ID for this managed resource.

instanceView Property Map

The dedicated host instance view.

name String

Resource name

provisioningState String

The provisioning state, which only appears in the response.

provisioningTime String

The date when the host was first provisioned.

type String

Resource type

virtualMachines List<Property Map>

A list of references to all virtual machines in the Dedicated Host.

Supporting Types

DedicatedHostAllocatableVMResponse

Count double

Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity.

VmSize string

VM size in terms of which the unutilized capacity is represented.

Count float64

Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity.

VmSize string

VM size in terms of which the unutilized capacity is represented.

count Double

Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity.

vmSize String

VM size in terms of which the unutilized capacity is represented.

count number

Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity.

vmSize string

VM size in terms of which the unutilized capacity is represented.

count float

Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity.

vm_size str

VM size in terms of which the unutilized capacity is represented.

count Number

Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity.

vmSize String

VM size in terms of which the unutilized capacity is represented.

DedicatedHostAvailableCapacityResponse

AllocatableVMs List<Pulumi.AzureNative.Compute.Inputs.DedicatedHostAllocatableVMResponse>

The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host.

AllocatableVMs []DedicatedHostAllocatableVMResponse

The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host.

allocatableVMs List<DedicatedHostAllocatableVMResponse>

The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host.

allocatableVMs DedicatedHostAllocatableVMResponse[]

The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host.

allocatable_vms Sequence[DedicatedHostAllocatableVMResponse]

The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host.

allocatableVMs List<Property Map>

The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host.

DedicatedHostInstanceViewResponse

AssetId string

Specifies the unique id of the dedicated physical machine on which the dedicated host resides.

AvailableCapacity Pulumi.AzureNative.Compute.Inputs.DedicatedHostAvailableCapacityResponse

Unutilized capacity of the dedicated host.

Statuses List<Pulumi.AzureNative.Compute.Inputs.InstanceViewStatusResponse>

The resource status information.

AssetId string

Specifies the unique id of the dedicated physical machine on which the dedicated host resides.

AvailableCapacity DedicatedHostAvailableCapacityResponse

Unutilized capacity of the dedicated host.

Statuses []InstanceViewStatusResponse

The resource status information.

assetId String

Specifies the unique id of the dedicated physical machine on which the dedicated host resides.

availableCapacity DedicatedHostAvailableCapacityResponse

Unutilized capacity of the dedicated host.

statuses List<InstanceViewStatusResponse>

The resource status information.

assetId string

Specifies the unique id of the dedicated physical machine on which the dedicated host resides.

availableCapacity DedicatedHostAvailableCapacityResponse

Unutilized capacity of the dedicated host.

statuses InstanceViewStatusResponse[]

The resource status information.

asset_id str

Specifies the unique id of the dedicated physical machine on which the dedicated host resides.

available_capacity DedicatedHostAvailableCapacityResponse

Unutilized capacity of the dedicated host.

statuses Sequence[InstanceViewStatusResponse]

The resource status information.

assetId String

Specifies the unique id of the dedicated physical machine on which the dedicated host resides.

availableCapacity Property Map

Unutilized capacity of the dedicated host.

statuses List<Property Map>

The resource status information.

DedicatedHostLicenseTypes

None
None
Windows_Server_Hybrid
Windows_Server_Hybrid
Windows_Server_Perpetual
Windows_Server_Perpetual
DedicatedHostLicenseTypesNone
None
DedicatedHostLicenseTypes_Windows_Server_Hybrid
Windows_Server_Hybrid
DedicatedHostLicenseTypes_Windows_Server_Perpetual
Windows_Server_Perpetual
None
None
Windows_Server_Hybrid
Windows_Server_Hybrid
Windows_Server_Perpetual
Windows_Server_Perpetual
None
None
Windows_Server_Hybrid
Windows_Server_Hybrid
Windows_Server_Perpetual
Windows_Server_Perpetual
NONE
None
WINDOWS_SERVER_HYBRID
Windows_Server_Hybrid
WINDOWS_SERVER_PERPETUAL
Windows_Server_Perpetual
"None"
None
"Windows_Server_Hybrid"
Windows_Server_Hybrid
"Windows_Server_Perpetual"
Windows_Server_Perpetual

InstanceViewStatusResponse

Code string

The status code.

DisplayStatus string

The short localizable label for the status.

Level string

The level code.

Message string

The detailed status message, including for alerts and error messages.

Time string

The time of the status.

Code string

The status code.

DisplayStatus string

The short localizable label for the status.

Level string

The level code.

Message string

The detailed status message, including for alerts and error messages.

Time string

The time of the status.

code String

The status code.

displayStatus String

The short localizable label for the status.

level String

The level code.

message String

The detailed status message, including for alerts and error messages.

time String

The time of the status.

code string

The status code.

displayStatus string

The short localizable label for the status.

level string

The level code.

message string

The detailed status message, including for alerts and error messages.

time string

The time of the status.

code str

The status code.

display_status str

The short localizable label for the status.

level str

The level code.

message str

The detailed status message, including for alerts and error messages.

time str

The time of the status.

code String

The status code.

displayStatus String

The short localizable label for the status.

level String

The level code.

message String

The detailed status message, including for alerts and error messages.

time String

The time of the status.

Sku

Capacity double

Specifies the number of virtual machines in the scale set.

Name string

The sku name.

Tier string

Specifies the tier of virtual machines in a scale set. Possible Values: Standard Basic

Capacity float64

Specifies the number of virtual machines in the scale set.

Name string

The sku name.

Tier string

Specifies the tier of virtual machines in a scale set. Possible Values: Standard Basic

capacity Double

Specifies the number of virtual machines in the scale set.

name String

The sku name.

tier String

Specifies the tier of virtual machines in a scale set. Possible Values: Standard Basic

capacity number

Specifies the number of virtual machines in the scale set.

name string

The sku name.

tier string

Specifies the tier of virtual machines in a scale set. Possible Values: Standard Basic

capacity float

Specifies the number of virtual machines in the scale set.

name str

The sku name.

tier str

Specifies the tier of virtual machines in a scale set. Possible Values: Standard Basic

capacity Number

Specifies the number of virtual machines in the scale set.

name String

The sku name.

tier String

Specifies the tier of virtual machines in a scale set. Possible Values: Standard Basic

SkuResponse

Capacity double

Specifies the number of virtual machines in the scale set.

Name string

The sku name.

Tier string

Specifies the tier of virtual machines in a scale set. Possible Values: Standard Basic

Capacity float64

Specifies the number of virtual machines in the scale set.

Name string

The sku name.

Tier string

Specifies the tier of virtual machines in a scale set. Possible Values: Standard Basic

capacity Double

Specifies the number of virtual machines in the scale set.

name String

The sku name.

tier String

Specifies the tier of virtual machines in a scale set. Possible Values: Standard Basic

capacity number

Specifies the number of virtual machines in the scale set.

name string

The sku name.

tier string

Specifies the tier of virtual machines in a scale set. Possible Values: Standard Basic

capacity float

Specifies the number of virtual machines in the scale set.

name str

The sku name.

tier str

Specifies the tier of virtual machines in a scale set. Possible Values: Standard Basic

capacity Number

Specifies the number of virtual machines in the scale set.

name String

The sku name.

tier String

Specifies the tier of virtual machines in a scale set. Possible Values: Standard Basic

SubResourceReadOnlyResponse

Id string

Resource Id

Id string

Resource Id

id String

Resource Id

id string

Resource Id

id str

Resource Id

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:DedicatedHost myDedicatedHost /subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup/hosts/myDedicatedHost 

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0