Azure Native v1.98.1, Mar 24 23

azure-native.compute.getDedicatedHostGroup

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

Using getDedicatedHostGroup

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 getDedicatedHostGroup(args: GetDedicatedHostGroupArgs, opts?: InvokeOptions): Promise<GetDedicatedHostGroupResult>
function getDedicatedHostGroupOutput(args: GetDedicatedHostGroupOutputArgs, opts?: InvokeOptions): Output<GetDedicatedHostGroupResult>

def get_dedicated_host_group(expand: Optional[str] = None,
                             host_group_name: Optional[str] = None,
                             resource_group_name: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetDedicatedHostGroupResult
def get_dedicated_host_group_output(expand: Optional[pulumi.Input[str]] = None,
                             host_group_name: Optional[pulumi.Input[str]] = None,
                             resource_group_name: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetDedicatedHostGroupResult]

func LookupDedicatedHostGroup(ctx *Context, args *LookupDedicatedHostGroupArgs, opts ...InvokeOption) (*LookupDedicatedHostGroupResult, error)
func LookupDedicatedHostGroupOutput(ctx *Context, args *LookupDedicatedHostGroupOutputArgs, opts ...InvokeOption) LookupDedicatedHostGroupResultOutput

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

public static class GetDedicatedHostGroup 
{
    public static Task<GetDedicatedHostGroupResult> InvokeAsync(GetDedicatedHostGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetDedicatedHostGroupResult> Invoke(GetDedicatedHostGroupInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDedicatedHostGroupResult> getDedicatedHostGroup(GetDedicatedHostGroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

HostGroupName string: The name of the dedicated host group.
ResourceGroupName string: The name of the resource group.
Expand string: The expand expression to apply on the operation. The response shows the list of instance view of the dedicated hosts under the dedicated host group.

HostGroupName string: The name of the dedicated host group.
ResourceGroupName string: The name of the resource group.
Expand string: The expand expression to apply on the operation. The response shows the list of instance view of the dedicated hosts under the dedicated host group.

hostGroupName String: The name of the dedicated host group.
resourceGroupName String: The name of the resource group.
expand String: The expand expression to apply on the operation. The response shows the list of instance view of the dedicated hosts under the dedicated host group.

hostGroupName string: The name of the dedicated host group.
resourceGroupName string: The name of the resource group.
expand string: The expand expression to apply on the operation. The response shows the list of instance view of the dedicated hosts under the dedicated host group.

host_group_name str: The name of the dedicated host group.
resource_group_name str: The name of the resource group.
expand str: The expand expression to apply on the operation. The response shows the list of instance view of the dedicated hosts under the dedicated host group.

hostGroupName String: The name of the dedicated host group.
resourceGroupName String: The name of the resource group.
expand String: The expand expression to apply on the operation. The response shows the list of instance view of the dedicated hosts under the dedicated host group.

getDedicatedHostGroup Result

The following output properties are available:

Hosts List<Pulumi.AzureNative.Compute.Outputs.SubResourceReadOnlyResponse>: A list of references to all dedicated hosts in the dedicated host group.
Id string: Resource Id
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.
Location string: Resource location
Name string: Resource name
PlatformFaultDomainCount int: Number of fault domains that the host group can span.
Type string: Resource type
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.

Hosts []SubResourceReadOnlyResponse: A list of references to all dedicated hosts in the dedicated host group.
Id string: Resource Id
InstanceView DedicatedHostGroupInstanceViewResponse: The dedicated host group instance view, which has the list of instance view of the dedicated hosts under the dedicated host group.
Location string: Resource location
Name string: Resource name
PlatformFaultDomainCount int: Number of fault domains that the host group can span.
Type string: Resource type
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.

hosts List<SubResourceReadOnlyResponse>: A list of references to all dedicated hosts in the dedicated host group.
id String: Resource Id
instanceView DedicatedHostGroupInstanceViewResponse: The dedicated host group instance view, which has the list of instance view of the dedicated hosts under the dedicated host group.
location String: Resource location
name String: Resource name
platformFaultDomainCount Integer: Number of fault domains that the host group can span.
type String: Resource type
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.

hosts SubResourceReadOnlyResponse[]: A list of references to all dedicated hosts in the dedicated host group.
id string: Resource Id
instanceView DedicatedHostGroupInstanceViewResponse: The dedicated host group instance view, which has the list of instance view of the dedicated hosts under the dedicated host group.
location string: Resource location
name string: Resource name
platformFaultDomainCount number: Number of fault domains that the host group can span.
type string: Resource type
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.

hosts Sequence[SubResourceReadOnlyResponse]: A list of references to all dedicated hosts in the dedicated host group.
id str: Resource Id
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.
location str: Resource location
name str: Resource name
platform_fault_domain_count int: Number of fault domains that the host group can span.
type str: Resource type
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.

hosts List<Property Map>: A list of references to all dedicated hosts in the dedicated host group.
id String: Resource Id
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.
location String: Resource location
name String: Resource name
platformFaultDomainCount Number: Number of fault domains that the host group can span.
type String: Resource type
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.

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

Package Details

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