Skip to content

Data Source: azurermDedicatedHostGroup

Use this data source to access information about an existing Dedicated Host Group.

Example Usage

import * as cdktf from "cdktf";
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as azurerm from "./.gen/providers/azurerm";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: azurerm.
For a more precise conversion please use the --provider flag in convert.*/
const dataAzurermDedicatedHostGroupExample =
  new azurerm.dataAzurermDedicatedHostGroup.DataAzurermDedicatedHostGroup(
    this,
    "example",
    {
      name: "example-dedicated-host-group",
      resource_group_name: "example-rg",
    }
  );
new cdktf.TerraformOutput(this, "id", {
  value: dataAzurermDedicatedHostGroupExample.id,
});

Argument Reference

The following arguments are supported:

  • name - Specifies the name of the Dedicated Host Group.

  • resourceGroupName - Specifies the name of the resource group the Dedicated Host Group is located in.

Attributes Reference

The following attributes are exported:

  • id - The ID of the Dedicated Host Group.

  • location - The Azure location where the Dedicated Host Group exists.

  • platformFaultDomainCount - The number of fault domains that the Dedicated Host Group spans.

  • automaticPlacementEnabled - Whether virtual machines or virtual machine scale sets be placed automatically on this Dedicated Host Group.

  • zones - A list of Availability Zones in which this Dedicated Host Group is located.

  • tags - A mapping of tags assigned to the resource.

Timeouts

The timeouts block allows you to specify timeouts for certain actions:

  • read - (Defaults to 5 minutes) Used when retrieving the Dedicated Host Group.