azure-native.compute.DedicatedHost
Explore with Pulumi AI
Specifies information about the Dedicated host. Azure REST API version: 2023-03-01. Prior API version in Azure Native 1.x: 2020-12-01.
Other available API versions: 2023-07-01, 2023-09-01, 2024-03-01, 2024-07-01.
Example Usage
Create or update a dedicated host .
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var dedicatedHost = new AzureNative.Compute.DedicatedHost("dedicatedHost", new()
{
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/compute/v2"
"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 com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.compute.DedicatedHost;
import com.pulumi.azurenative.compute.DedicatedHostArgs;
import com.pulumi.azurenative.compute.inputs.SkuArgs;
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 dedicatedHost = new DedicatedHost("dedicatedHost", DedicatedHostArgs.builder()
.hostGroupName("myDedicatedHostGroup")
.hostName("myDedicatedHost")
.location("westus")
.platformFaultDomain(1)
.resourceGroupName("myResourceGroup")
.sku(SkuArgs.builder()
.name("DSv3-Type1")
.build())
.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={
"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 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,
host_group_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
sku: Optional[SkuArgs] = None,
auto_replace_on_failure: Optional[bool] = None,
host_name: Optional[str] = None,
license_type: Optional[DedicatedHostLicenseTypes] = None,
location: Optional[str] = None,
platform_fault_domain: Optional[int] = 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-native:compute:DedicatedHost
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var dedicatedHostResource = new AzureNative.Compute.DedicatedHost("dedicatedHostResource", new()
{
HostGroupName = "string",
ResourceGroupName = "string",
Sku = new AzureNative.Compute.Inputs.SkuArgs
{
Capacity = 0,
Name = "string",
Tier = "string",
},
AutoReplaceOnFailure = false,
HostName = "string",
LicenseType = AzureNative.Compute.DedicatedHostLicenseTypes.None,
Location = "string",
PlatformFaultDomain = 0,
Tags =
{
{ "string", "string" },
},
});
example, err := compute.NewDedicatedHost(ctx, "dedicatedHostResource", &compute.DedicatedHostArgs{
HostGroupName: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
Sku: &compute.SkuArgs{
Capacity: pulumi.Float64(0),
Name: pulumi.String("string"),
Tier: pulumi.String("string"),
},
AutoReplaceOnFailure: pulumi.Bool(false),
HostName: pulumi.String("string"),
LicenseType: compute.DedicatedHostLicenseTypesNone,
Location: pulumi.String("string"),
PlatformFaultDomain: pulumi.Int(0),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var dedicatedHostResource = new DedicatedHost("dedicatedHostResource", DedicatedHostArgs.builder()
.hostGroupName("string")
.resourceGroupName("string")
.sku(SkuArgs.builder()
.capacity(0)
.name("string")
.tier("string")
.build())
.autoReplaceOnFailure(false)
.hostName("string")
.licenseType("None")
.location("string")
.platformFaultDomain(0)
.tags(Map.of("string", "string"))
.build());
dedicated_host_resource = azure_native.compute.DedicatedHost("dedicatedHostResource",
host_group_name="string",
resource_group_name="string",
sku={
"capacity": 0,
"name": "string",
"tier": "string",
},
auto_replace_on_failure=False,
host_name="string",
license_type=azure_native.compute.DedicatedHostLicenseTypes.NONE,
location="string",
platform_fault_domain=0,
tags={
"string": "string",
})
const dedicatedHostResource = new azure_native.compute.DedicatedHost("dedicatedHostResource", {
hostGroupName: "string",
resourceGroupName: "string",
sku: {
capacity: 0,
name: "string",
tier: "string",
},
autoReplaceOnFailure: false,
hostName: "string",
licenseType: azure_native.compute.DedicatedHostLicenseTypes.None,
location: "string",
platformFaultDomain: 0,
tags: {
string: "string",
},
});
type: azure-native:compute:DedicatedHost
properties:
autoReplaceOnFailure: false
hostGroupName: string
hostName: string
licenseType: None
location: string
platformFaultDomain: 0
resourceGroupName: string
sku:
capacity: 0
name: string
tier: string
tags:
string: string
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:
- Host
Group stringName - The name of the dedicated host group.
- Resource
Group stringName - The name of the resource group.
- Sku
Pulumi.
Azure Native. Compute. Inputs. Sku - 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 boolOn Failure - 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 string - The name of the dedicated host .
- License
Type Pulumi.Azure Native. Compute. Dedicated Host License Types - 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. The default value is: None.
- Location string
- Resource location
- Platform
Fault intDomain - Fault domain of the dedicated host within a dedicated host group.
- Dictionary<string, string>
- Resource tags
- Host
Group stringName - The name of the dedicated host group.
- Resource
Group stringName - The name of the resource group.
- Sku
Sku
Args - 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 boolOn Failure - 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 string - The name of the dedicated host .
- License
Type DedicatedHost License Types - 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. The default value is: None.
- Location string
- Resource location
- Platform
Fault intDomain - Fault domain of the dedicated host within a dedicated host group.
- map[string]string
- Resource tags
- host
Group StringName - The name of the dedicated host group.
- resource
Group StringName - The name of the resource group.
- sku Sku
- 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 BooleanOn Failure - 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 String - The name of the dedicated host .
- license
Type DedicatedHost License Types - 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. The default value is: None.
- location String
- Resource location
- platform
Fault IntegerDomain - Fault domain of the dedicated host within a dedicated host group.
- Map<String,String>
- Resource tags
- host
Group stringName - The name of the dedicated host group.
- resource
Group stringName - The name of the resource group.
- sku Sku
- 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 booleanOn Failure - 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 string - The name of the dedicated host .
- license
Type DedicatedHost License Types - 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. The default value is: None.
- location string
- Resource location
- platform
Fault numberDomain - Fault domain of the dedicated host within a dedicated host group.
- {[key: string]: string}
- Resource tags
- host_
group_ strname - The name of the dedicated host group.
- resource_
group_ strname - The name of the resource group.
- sku
Sku
Args - 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_ boolon_ failure - 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 DedicatedHost License Types - 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. The default value is: None.
- location str
- Resource location
- platform_
fault_ intdomain - Fault domain of the dedicated host within a dedicated host group.
- Mapping[str, str]
- Resource tags
- host
Group StringName - The name of the dedicated host group.
- resource
Group StringName - 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.
- auto
Replace BooleanOn Failure - 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 String - The name of the dedicated host .
- license
Type "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. The default value is: None.
- location String
- Resource location
- platform
Fault NumberDomain - Fault domain of the dedicated host within a dedicated host group.
- Map<String>
- Resource tags
Outputs
All input properties are implicitly available as output properties. Additionally, the DedicatedHost resource produces the following output properties:
- Host
Id 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.
- Instance
View Pulumi.Azure Native. Compute. Outputs. Dedicated Host Instance View Response - The dedicated host instance view.
- Name string
- Resource name
- Provisioning
State string - The provisioning state, which only appears in the response.
- Provisioning
Time string - The date when the host was first provisioned.
- Time
Created string - Specifies the time at which the Dedicated Host resource was created. Minimum api-version: 2021-11-01.
- Type string
- Resource type
- Virtual
Machines List<Pulumi.Azure Native. Compute. Outputs. Sub Resource Read Only Response> - A list of references to all virtual machines in the Dedicated Host.
- Host
Id 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.
- Instance
View DedicatedHost Instance View Response - The dedicated host instance view.
- Name string
- Resource name
- Provisioning
State string - The provisioning state, which only appears in the response.
- Provisioning
Time string - The date when the host was first provisioned.
- Time
Created string - Specifies the time at which the Dedicated Host resource was created. Minimum api-version: 2021-11-01.
- Type string
- Resource type
- Virtual
Machines []SubResource Read Only Response - A list of references to all virtual machines in the Dedicated Host.
- host
Id 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.
- instance
View DedicatedHost Instance View Response - The dedicated host instance view.
- name String
- Resource name
- provisioning
State String - The provisioning state, which only appears in the response.
- provisioning
Time String - The date when the host was first provisioned.
- time
Created String - Specifies the time at which the Dedicated Host resource was created. Minimum api-version: 2021-11-01.
- type String
- Resource type
- virtual
Machines List<SubResource Read Only Response> - A list of references to all virtual machines in the Dedicated Host.
- host
Id 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.
- instance
View DedicatedHost Instance View Response - The dedicated host instance view.
- name string
- Resource name
- provisioning
State string - The provisioning state, which only appears in the response.
- provisioning
Time string - The date when the host was first provisioned.
- time
Created string - Specifies the time at which the Dedicated Host resource was created. Minimum api-version: 2021-11-01.
- type string
- Resource type
- virtual
Machines SubResource Read Only Response[] - 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 DedicatedHost Instance View Response - 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.
- time_
created str - Specifies the time at which the Dedicated Host resource was created. Minimum api-version: 2021-11-01.
- type str
- Resource type
- virtual_
machines Sequence[SubResource Read Only Response] - A list of references to all virtual machines in the Dedicated Host.
- host
Id 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.
- instance
View Property Map - The dedicated host instance view.
- name String
- Resource name
- provisioning
State String - The provisioning state, which only appears in the response.
- provisioning
Time String - The date when the host was first provisioned.
- time
Created String - Specifies the time at which the Dedicated Host resource was created. Minimum api-version: 2021-11-01.
- type String
- Resource type
- virtual
Machines List<Property Map> - A list of references to all virtual machines in the Dedicated Host.
Supporting Types
DedicatedHostAllocatableVMResponse, DedicatedHostAllocatableVMResponseArgs
DedicatedHostAvailableCapacityResponse, DedicatedHostAvailableCapacityResponseArgs
- Allocatable
VMs List<Pulumi.Azure Native. Compute. Inputs. Dedicated Host Allocatable VMResponse> - 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 []DedicatedHost Allocatable VMResponse - 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 List<DedicatedHost Allocatable VMResponse> - 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 DedicatedHost Allocatable VMResponse[] - 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[DedicatedHost Allocatable VMResponse] - 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 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, DedicatedHostInstanceViewResponseArgs
- Asset
Id string - Specifies the unique id of the dedicated physical machine on which the dedicated host resides.
- Available
Capacity Pulumi.Azure Native. Compute. Inputs. Dedicated Host Available Capacity Response - Unutilized capacity of the dedicated host.
- Statuses
List<Pulumi.
Azure Native. Compute. Inputs. Instance View Status Response> - The resource status information.
- Asset
Id string - Specifies the unique id of the dedicated physical machine on which the dedicated host resides.
- Available
Capacity DedicatedHost Available Capacity Response - Unutilized capacity of the dedicated host.
- Statuses
[]Instance
View Status Response - The resource status information.
- asset
Id String - Specifies the unique id of the dedicated physical machine on which the dedicated host resides.
- available
Capacity DedicatedHost Available Capacity Response - Unutilized capacity of the dedicated host.
- statuses
List<Instance
View Status Response> - The resource status information.
- asset
Id string - Specifies the unique id of the dedicated physical machine on which the dedicated host resides.
- available
Capacity DedicatedHost Available Capacity Response - Unutilized capacity of the dedicated host.
- statuses
Instance
View Status Response[] - The resource status information.
- asset_
id str - Specifies the unique id of the dedicated physical machine on which the dedicated host resides.
- available_
capacity DedicatedHost Available Capacity Response - Unutilized capacity of the dedicated host.
- statuses
Sequence[Instance
View Status Response] - The resource status information.
- asset
Id String - Specifies the unique id of the dedicated physical machine on which the dedicated host resides.
- available
Capacity Property Map - Unutilized capacity of the dedicated host.
- statuses List<Property Map>
- The resource status information.
DedicatedHostLicenseTypes, DedicatedHostLicenseTypesArgs
- None
- None
- Windows_Server_Hybrid
- Windows_Server_Hybrid
- Windows_Server_Perpetual
- Windows_Server_Perpetual
- Dedicated
Host License Types None - None
- Dedicated
Host License Types_Windows_Server_Hybrid - Windows_Server_Hybrid
- Dedicated
Host License Types_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, InstanceViewStatusResponseArgs
- Code string
- The status code.
- Display
Status string - The short localizable label for the status.
- Level string
- The level code.
- Message string
- The detailed status message, including for alerts and error messages.
- Time string
- The time of the status.
- Code string
- The status code.
- Display
Status string - The short localizable label for the status.
- Level string
- The level code.
- Message string
- The detailed status message, including for alerts and error messages.
- Time string
- The time of the status.
- code String
- The status code.
- display
Status String - The short localizable label for the status.
- level String
- The level code.
- message String
- The detailed status message, including for alerts and error messages.
- time String
- The time of the status.
- code string
- The status code.
- display
Status string - The short localizable label for the status.
- level string
- The level code.
- message string
- The detailed status message, including for alerts and error messages.
- time string
- The time of the status.
- code str
- The status code.
- display_
status str - The short localizable label for the status.
- level str
- The level code.
- message str
- The detailed status message, including for alerts and error messages.
- time str
- The time of the status.
- code String
- The status code.
- display
Status String - The short localizable label for the status.
- level String
- The level code.
- message String
- The detailed status message, including for alerts and error messages.
- time String
- The time of the status.
Sku, SkuArgs
SkuResponse, SkuResponseArgs
SubResourceReadOnlyResponse, SubResourceReadOnlyResponseArgs
- 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/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0