Azure Native

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

DedicatedHostGroup

Specifies information about the dedicated host group that the dedicated hosts should be assigned to.

Currently, a dedicated host can only be added to a dedicated host group at creation time. An existing dedicated host cannot be added to another dedicated host group. API Version: 2020-12-01.

Example Usage

Create or update a dedicated host group.

using Pulumi;
using AzureNative = Pulumi.AzureNative;

class MyStack : Stack
{
    public MyStack()
    {
        var dedicatedHostGroup = new AzureNative.Compute.DedicatedHostGroup("dedicatedHostGroup", new AzureNative.Compute.DedicatedHostGroupArgs
        {
            HostGroupName = "myDedicatedHostGroup",
            Location = "westus",
            PlatformFaultDomainCount = 3,
            ResourceGroupName = "myResourceGroup",
            SupportAutomaticPlacement = true,
            Tags = 
            {
                { "department", "finance" },
            },
            Zones = 
            {
                "1",
            },
        });
    }

}
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.NewDedicatedHostGroup(ctx, "dedicatedHostGroup", &compute.DedicatedHostGroupArgs{
			HostGroupName:             pulumi.String("myDedicatedHostGroup"),
			Location:                  pulumi.String("westus"),
			PlatformFaultDomainCount:  pulumi.Int(3),
			ResourceGroupName:         pulumi.String("myResourceGroup"),
			SupportAutomaticPlacement: pulumi.Bool(true),
			Tags: pulumi.StringMap{
				"department": pulumi.String("finance"),
			},
			Zones: pulumi.StringArray{
				pulumi.String("1"),
			},
		})
		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 dedicatedHostGroup = new DedicatedHostGroup("dedicatedHostGroup", DedicatedHostGroupArgs.builder()        
            .hostGroupName("myDedicatedHostGroup")
            .location("westus")
            .platformFaultDomainCount(3)
            .resourceGroupName("myResourceGroup")
            .supportAutomaticPlacement(true)
            .tags(Map.of("department", "finance"))
            .zones("1")
            .build());

    }
}
import pulumi
import pulumi_azure_native as azure_native

dedicated_host_group = azure_native.compute.DedicatedHostGroup("dedicatedHostGroup",
    host_group_name="myDedicatedHostGroup",
    location="westus",
    platform_fault_domain_count=3,
    resource_group_name="myResourceGroup",
    support_automatic_placement=True,
    tags={
        "department": "finance",
    },
    zones=["1"])
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const dedicatedHostGroup = new azure_native.compute.DedicatedHostGroup("dedicatedHostGroup", {
    hostGroupName: "myDedicatedHostGroup",
    location: "westus",
    platformFaultDomainCount: 3,
    resourceGroupName: "myResourceGroup",
    supportAutomaticPlacement: true,
    tags: {
        department: "finance",
    },
    zones: ["1"],
});
resources:
  dedicatedHostGroup:
    type: azure-native:compute:DedicatedHostGroup
    properties:
      hostGroupName: myDedicatedHostGroup
      location: westus
      platformFaultDomainCount: 3
      resourceGroupName: myResourceGroup
      supportAutomaticPlacement: true
      tags:
        department: finance
      zones:
        - 1

Create a DedicatedHostGroup Resource

new DedicatedHostGroup(name: string, args: DedicatedHostGroupArgs, opts?: CustomResourceOptions);
@overload
def DedicatedHostGroup(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       host_group_name: Optional[str] = None,
                       location: Optional[str] = None,
                       platform_fault_domain_count: Optional[int] = None,
                       resource_group_name: Optional[str] = None,
                       support_automatic_placement: Optional[bool] = None,
                       tags: Optional[Mapping[str, str]] = None,
                       zones: Optional[Sequence[str]] = None)
@overload
def DedicatedHostGroup(resource_name: str,
                       args: DedicatedHostGroupArgs,
                       opts: Optional[ResourceOptions] = 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-native:compute:DedicatedHostGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

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

The DedicatedHostGroup resource accepts the following input properties:

PlatformFaultDomainCount int

Number of fault domains that the host group can span.

ResourceGroupName string

The name of the resource group.

HostGroupName string

The name of the dedicated host group.

Location string

Resource location

SupportAutomaticPlacement bool

Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to 'false' when not provided. Minimum api-version: 2020-06-01.

Tags Dictionary<string, string>

Resource tags

Zones List<string>

Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone.

PlatformFaultDomainCount int

Number of fault domains that the host group can span.

ResourceGroupName string

The name of the resource group.

HostGroupName string

The name of the dedicated host group.

Location string

Resource location

SupportAutomaticPlacement bool

Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to 'false' when not provided. Minimum api-version: 2020-06-01.

Tags map[string]string

Resource tags

Zones []string

Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone.

platformFaultDomainCount Integer

Number of fault domains that the host group can span.

resourceGroupName String

The name of the resource group.

hostGroupName String

The name of the dedicated host group.

location String

Resource location

supportAutomaticPlacement Boolean

Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to 'false' when not provided. Minimum api-version: 2020-06-01.

tags Map<String,String>

Resource tags

zones List<String>

Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone.

platformFaultDomainCount number

Number of fault domains that the host group can span.

resourceGroupName string

The name of the resource group.

hostGroupName string

The name of the dedicated host group.

location string

Resource location

supportAutomaticPlacement boolean

Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to 'false' when not provided. Minimum api-version: 2020-06-01.

tags {[key: string]: string}

Resource tags

zones string[]

Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone.

platform_fault_domain_count int

Number of fault domains that the host group can span.

resource_group_name str

The name of the resource group.

host_group_name str

The name of the dedicated host group.

location str

Resource location

support_automatic_placement bool

Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to 'false' when not provided. Minimum api-version: 2020-06-01.

tags Mapping[str, str]

Resource tags

zones Sequence[str]

Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone.

platformFaultDomainCount Number

Number of fault domains that the host group can span.

resourceGroupName String

The name of the resource group.

hostGroupName String

The name of the dedicated host group.

location String

Resource location

supportAutomaticPlacement Boolean

Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to 'false' when not provided. Minimum api-version: 2020-06-01.

tags Map<String>

Resource tags

zones List<String>

Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone.

Outputs

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

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

A list of references to all dedicated hosts in the dedicated host group.

Id string

The provider-assigned unique ID for this managed resource.

InstanceView Pulumi.AzureNative.Compute.Outputs.DedicatedHostGroupInstanceViewResponse

The dedicated host group instance view, which has the list of instance view of the dedicated hosts under the dedicated host group.

Name string

Resource name

Type string

Resource type

Hosts []SubResourceReadOnlyResponse

A list of references to all dedicated hosts in the dedicated host group.

Id string

The provider-assigned unique ID for this managed resource.

InstanceView DedicatedHostGroupInstanceViewResponse

The dedicated host group instance view, which has the list of instance view of the dedicated hosts under the dedicated host group.

Name string

Resource name

Type string

Resource type

hosts List<SubResourceReadOnlyResponse>

A list of references to all dedicated hosts in the dedicated host group.

id String

The provider-assigned unique ID for this managed resource.

instanceView DedicatedHostGroupInstanceViewResponse

The dedicated host group instance view, which has the list of instance view of the dedicated hosts under the dedicated host group.

name String

Resource name

type String

Resource type

hosts SubResourceReadOnlyResponse[]

A list of references to all dedicated hosts in the dedicated host group.

id string

The provider-assigned unique ID for this managed resource.

instanceView DedicatedHostGroupInstanceViewResponse

The dedicated host group instance view, which has the list of instance view of the dedicated hosts under the dedicated host group.

name string

Resource name

type string

Resource type

hosts Sequence[SubResourceReadOnlyResponse]

A list of references to all dedicated hosts in the dedicated host group.

id str

The provider-assigned unique ID for this managed resource.

instance_view DedicatedHostGroupInstanceViewResponse

The dedicated host group instance view, which has the list of instance view of the dedicated hosts under the dedicated host group.

name str

Resource name

type str

Resource type

hosts List<Property Map>

A list of references to all dedicated hosts in the dedicated host group.

id String

The provider-assigned unique ID for this managed resource.

instanceView Property Map

The dedicated host group instance view, which has the list of instance view of the dedicated hosts under the dedicated host group.

name String

Resource name

type String

Resource type

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.

DedicatedHostGroupInstanceViewResponse

Hosts List<Pulumi.AzureNative.Compute.Inputs.DedicatedHostInstanceViewWithNameResponse>

List of instance view of the dedicated hosts under the dedicated host group.

Hosts []DedicatedHostInstanceViewWithNameResponse

List of instance view of the dedicated hosts under the dedicated host group.

hosts List<DedicatedHostInstanceViewWithNameResponse>

List of instance view of the dedicated hosts under the dedicated host group.

hosts DedicatedHostInstanceViewWithNameResponse[]

List of instance view of the dedicated hosts under the dedicated host group.

hosts Sequence[DedicatedHostInstanceViewWithNameResponse]

List of instance view of the dedicated hosts under the dedicated host group.

hosts List<Property Map>

List of instance view of the dedicated hosts under the dedicated host group.

DedicatedHostInstanceViewWithNameResponse

AssetId string

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

Name string

The name of the dedicated host.

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.

Name string

The name of the dedicated host.

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.

name String

The name of the dedicated host.

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.

name string

The name of the dedicated host.

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.

name str

The name of the dedicated host.

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.

name String

The name of the dedicated host.

availableCapacity Property Map

Unutilized capacity of the dedicated host.

statuses List<Property Map>

The resource status information.

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.

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

Package Details

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