Azure Native v1.102.0, May 2 23

azure-native.compute.getDedicatedHost

Explore with Pulumi AI

Retrieves information about a dedicated host. API Version: 2020-12-01.

Using getDedicatedHost

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDedicatedHost(args: GetDedicatedHostArgs, opts?: InvokeOptions): Promise<GetDedicatedHostResult>
function getDedicatedHostOutput(args: GetDedicatedHostOutputArgs, opts?: InvokeOptions): Output<GetDedicatedHostResult>

def get_dedicated_host(expand: Optional[str] = None,
                       host_group_name: Optional[str] = None,
                       host_name: Optional[str] = None,
                       resource_group_name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetDedicatedHostResult
def get_dedicated_host_output(expand: Optional[pulumi.Input[str]] = None,
                       host_group_name: Optional[pulumi.Input[str]] = None,
                       host_name: Optional[pulumi.Input[str]] = None,
                       resource_group_name: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetDedicatedHostResult]

func LookupDedicatedHost(ctx *Context, args *LookupDedicatedHostArgs, opts ...InvokeOption) (*LookupDedicatedHostResult, error)
func LookupDedicatedHostOutput(ctx *Context, args *LookupDedicatedHostOutputArgs, opts ...InvokeOption) LookupDedicatedHostResultOutput

> Note: This function is named LookupDedicatedHost in the Go SDK.

public static class GetDedicatedHost 
{
    public static Task<GetDedicatedHostResult> InvokeAsync(GetDedicatedHostArgs args, InvokeOptions? opts = null)
    public static Output<GetDedicatedHostResult> Invoke(GetDedicatedHostInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDedicatedHostResult> getDedicatedHost(GetDedicatedHostArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:compute:getDedicatedHost
  arguments:
    # arguments dictionary

The following arguments are supported:

HostGroupName string: The name of the dedicated host group.
HostName string: The name of the dedicated host.
ResourceGroupName string: The name of the resource group.
Expand string: The expand expression to apply on the operation.

HostGroupName string: The name of the dedicated host group.
HostName string: The name of the dedicated host.
ResourceGroupName string: The name of the resource group.
Expand string: The expand expression to apply on the operation.

hostGroupName String: The name of the dedicated host group.
hostName String: The name of the dedicated host.
resourceGroupName String: The name of the resource group.
expand String: The expand expression to apply on the operation.

hostGroupName string: The name of the dedicated host group.
hostName string: The name of the dedicated host.
resourceGroupName string: The name of the resource group.
expand string: The expand expression to apply on the operation.

host_group_name str: The name of the dedicated host group.
host_name str: The name of the dedicated host.
resource_group_name str: The name of the resource group.
expand str: The expand expression to apply on the operation.

hostGroupName String: The name of the dedicated host group.
hostName String: The name of the dedicated host.
resourceGroupName String: The name of the resource group.
expand String: The expand expression to apply on the operation.

getDedicatedHost Result

The following output properties are available:

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: Resource Id
InstanceView Pulumi.AzureNative.Compute.Outputs.DedicatedHostInstanceViewResponse: The dedicated host instance view.
Location string: Resource location
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.
Sku Pulumi.AzureNative.Compute.Outputs.SkuResponse: 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.
Type string: Resource type
VirtualMachines List<Pulumi.AzureNative.Compute.Outputs.SubResourceReadOnlyResponse>: A list of references to all virtual machines in the Dedicated Host.
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.
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 Windows_Server_Perpetual Default: None
PlatformFaultDomain int: Fault domain of the dedicated host within a dedicated host group.
Tags Dictionary<string, string>: Resource tags

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: Resource Id
InstanceView DedicatedHostInstanceViewResponse: The dedicated host instance view.
Location string: Resource location
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.
Sku SkuResponse: 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.
Type string: Resource type
VirtualMachines []SubResourceReadOnlyResponse: A list of references to all virtual machines in the Dedicated Host.
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.
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 Windows_Server_Perpetual Default: None
PlatformFaultDomain int: Fault domain of the dedicated host within a dedicated host group.
Tags map[string]string: Resource tags

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: Resource Id
instanceView DedicatedHostInstanceViewResponse: The dedicated host instance view.
location String: Resource location
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.
sku SkuResponse: 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.
type String: Resource type
virtualMachines List<SubResourceReadOnlyResponse>: A list of references to all virtual machines in the Dedicated Host.
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.
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 Windows_Server_Perpetual Default: None
platformFaultDomain Integer: Fault domain of the dedicated host within a dedicated host group.
tags Map<String,String>: Resource tags

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: Resource Id
instanceView DedicatedHostInstanceViewResponse: The dedicated host instance view.
location string: Resource location
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.
sku SkuResponse: 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.
type string: Resource type
virtualMachines SubResourceReadOnlyResponse[]: A list of references to all virtual machines in the Dedicated Host.
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.
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 Windows_Server_Perpetual Default: None
platformFaultDomain number: Fault domain of the dedicated host within a dedicated host group.
tags {[key: string]: string}: Resource tags

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: Resource Id
instance_view DedicatedHostInstanceViewResponse: The dedicated host instance view.
location str: Resource location
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.
sku SkuResponse: 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.
type str: Resource type
virtual_machines Sequence[SubResourceReadOnlyResponse]: A list of references to all virtual machines in the Dedicated Host.
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.
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 Windows_Server_Perpetual Default: None
platform_fault_domain int: Fault domain of the dedicated host within a dedicated host group.
tags Mapping[str, str]: Resource tags

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: Resource Id
instanceView Property Map: The dedicated host instance view.
location String: Resource location
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.
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.
type String: Resource type
virtualMachines List<Property Map>: A list of references to all virtual machines in the Dedicated Host.
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.
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 Windows_Server_Perpetual Default: None
platformFaultDomain Number: Fault domain of the dedicated host within a dedicated host group.
tags Map<String>: Resource tags

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.

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.

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

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0