Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. getIsDedicatedHostGroup
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getIsDedicatedHostGroup

Explore with Pulumi AI

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

Retrieve the dedicated host group data sources. For more information, about dedicated host group in your IBM Cloud VPC, see dedicated hosts groups.

Note: VPC infrastructure services are a regional specific based endpoint, by default targets to us-south. Please make sure to target right region in the provider block as shown in the provider.tf file, if VPC service is created in region other than us-south.

provider.tf

import * as pulumi from "@pulumi/pulumi";
Copy
import pulumi
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;

return await Deployment.RunAsync(() => 
{
});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
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) {
    }
}
Copy
{}
Copy

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const example = ibm.getIsDedicatedHostGroup({
    name: "example-host-group",
});
Copy
import pulumi
import pulumi_ibm as ibm

example = ibm.get_is_dedicated_host_group(name="example-host-group")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.LookupIsDedicatedHostGroup(ctx, &ibm.LookupIsDedicatedHostGroupArgs{
			Name: "example-host-group",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var example = Ibm.GetIsDedicatedHostGroup.Invoke(new()
    {
        Name = "example-host-group",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetIsDedicatedHostGroupArgs;
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) {
        final var example = IbmFunctions.getIsDedicatedHostGroup(GetIsDedicatedHostGroupArgs.builder()
            .name("example-host-group")
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: ibm:getIsDedicatedHostGroup
      arguments:
        name: example-host-group
Copy

Using getIsDedicatedHostGroup

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 getIsDedicatedHostGroup(args: GetIsDedicatedHostGroupArgs, opts?: InvokeOptions): Promise<GetIsDedicatedHostGroupResult>
function getIsDedicatedHostGroupOutput(args: GetIsDedicatedHostGroupOutputArgs, opts?: InvokeOptions): Output<GetIsDedicatedHostGroupResult>
Copy
def get_is_dedicated_host_group(id: Optional[str] = None,
                                name: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetIsDedicatedHostGroupResult
def get_is_dedicated_host_group_output(id: Optional[pulumi.Input[str]] = None,
                                name: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetIsDedicatedHostGroupResult]
Copy
func LookupIsDedicatedHostGroup(ctx *Context, args *LookupIsDedicatedHostGroupArgs, opts ...InvokeOption) (*LookupIsDedicatedHostGroupResult, error)
func LookupIsDedicatedHostGroupOutput(ctx *Context, args *LookupIsDedicatedHostGroupOutputArgs, opts ...InvokeOption) LookupIsDedicatedHostGroupResultOutput
Copy

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

public static class GetIsDedicatedHostGroup 
{
    public static Task<GetIsDedicatedHostGroupResult> InvokeAsync(GetIsDedicatedHostGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetIsDedicatedHostGroupResult> Invoke(GetIsDedicatedHostGroupInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetIsDedicatedHostGroupResult> getIsDedicatedHostGroup(GetIsDedicatedHostGroupArgs args, InvokeOptions options)
public static Output<GetIsDedicatedHostGroupResult> getIsDedicatedHostGroup(GetIsDedicatedHostGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getIsDedicatedHostGroup:getIsDedicatedHostGroup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
The unique user defined name of this dedicated host group.
Id string
(String) The unique identifier of the dedicated host group.
Name This property is required. string
The unique user defined name of this dedicated host group.
Id string
(String) The unique identifier of the dedicated host group.
name This property is required. String
The unique user defined name of this dedicated host group.
id String
(String) The unique identifier of the dedicated host group.
name This property is required. string
The unique user defined name of this dedicated host group.
id string
(String) The unique identifier of the dedicated host group.
name This property is required. str
The unique user defined name of this dedicated host group.
id str
(String) The unique identifier of the dedicated host group.
name This property is required. String
The unique user defined name of this dedicated host group.
id String
(String) The unique identifier of the dedicated host group.

getIsDedicatedHostGroup Result

The following output properties are available:

Class string
(String) The dedicated host profile class for hosts in this group.
CreatedAt string
(String) The date and time that the dedicated host group was created.
Crn string
(String) The CRN for this dedicated host.
DedicatedHosts List<GetIsDedicatedHostGroupDedicatedHost>
(List) The dedicated hosts that are in this dedicated host group.
Family string
(String) The dedicated host profile family for hosts in this group.
Href string
(String) The URL for this virtual server instance profile.
Id string
(String) The unique identifier of the dedicated host group.
Name string
(String) The unique name for this virtual server instance profile.
ResourceGroup string
(String) The unique identifier of the resource group for this dedicated host.
ResourceType string
(String) The type of resource referenced.
SupportedInstanceProfiles List<GetIsDedicatedHostGroupSupportedInstanceProfile>
(List) Array of instance profiles that can be used by instances placed on this dedicated host group.
Zone string
(String) The zone this dedicated host group resides in.
Class string
(String) The dedicated host profile class for hosts in this group.
CreatedAt string
(String) The date and time that the dedicated host group was created.
Crn string
(String) The CRN for this dedicated host.
DedicatedHosts []GetIsDedicatedHostGroupDedicatedHost
(List) The dedicated hosts that are in this dedicated host group.
Family string
(String) The dedicated host profile family for hosts in this group.
Href string
(String) The URL for this virtual server instance profile.
Id string
(String) The unique identifier of the dedicated host group.
Name string
(String) The unique name for this virtual server instance profile.
ResourceGroup string
(String) The unique identifier of the resource group for this dedicated host.
ResourceType string
(String) The type of resource referenced.
SupportedInstanceProfiles []GetIsDedicatedHostGroupSupportedInstanceProfile
(List) Array of instance profiles that can be used by instances placed on this dedicated host group.
Zone string
(String) The zone this dedicated host group resides in.
class_ String
(String) The dedicated host profile class for hosts in this group.
createdAt String
(String) The date and time that the dedicated host group was created.
crn String
(String) The CRN for this dedicated host.
dedicatedHosts List<GetIsDedicatedHostGroupDedicatedHost>
(List) The dedicated hosts that are in this dedicated host group.
family String
(String) The dedicated host profile family for hosts in this group.
href String
(String) The URL for this virtual server instance profile.
id String
(String) The unique identifier of the dedicated host group.
name String
(String) The unique name for this virtual server instance profile.
resourceGroup String
(String) The unique identifier of the resource group for this dedicated host.
resourceType String
(String) The type of resource referenced.
supportedInstanceProfiles List<GetIsDedicatedHostGroupSupportedInstanceProfile>
(List) Array of instance profiles that can be used by instances placed on this dedicated host group.
zone String
(String) The zone this dedicated host group resides in.
class string
(String) The dedicated host profile class for hosts in this group.
createdAt string
(String) The date and time that the dedicated host group was created.
crn string
(String) The CRN for this dedicated host.
dedicatedHosts GetIsDedicatedHostGroupDedicatedHost[]
(List) The dedicated hosts that are in this dedicated host group.
family string
(String) The dedicated host profile family for hosts in this group.
href string
(String) The URL for this virtual server instance profile.
id string
(String) The unique identifier of the dedicated host group.
name string
(String) The unique name for this virtual server instance profile.
resourceGroup string
(String) The unique identifier of the resource group for this dedicated host.
resourceType string
(String) The type of resource referenced.
supportedInstanceProfiles GetIsDedicatedHostGroupSupportedInstanceProfile[]
(List) Array of instance profiles that can be used by instances placed on this dedicated host group.
zone string
(String) The zone this dedicated host group resides in.
class_ str
(String) The dedicated host profile class for hosts in this group.
created_at str
(String) The date and time that the dedicated host group was created.
crn str
(String) The CRN for this dedicated host.
dedicated_hosts Sequence[GetIsDedicatedHostGroupDedicatedHost]
(List) The dedicated hosts that are in this dedicated host group.
family str
(String) The dedicated host profile family for hosts in this group.
href str
(String) The URL for this virtual server instance profile.
id str
(String) The unique identifier of the dedicated host group.
name str
(String) The unique name for this virtual server instance profile.
resource_group str
(String) The unique identifier of the resource group for this dedicated host.
resource_type str
(String) The type of resource referenced.
supported_instance_profiles Sequence[GetIsDedicatedHostGroupSupportedInstanceProfile]
(List) Array of instance profiles that can be used by instances placed on this dedicated host group.
zone str
(String) The zone this dedicated host group resides in.
class String
(String) The dedicated host profile class for hosts in this group.
createdAt String
(String) The date and time that the dedicated host group was created.
crn String
(String) The CRN for this dedicated host.
dedicatedHosts List<Property Map>
(List) The dedicated hosts that are in this dedicated host group.
family String
(String) The dedicated host profile family for hosts in this group.
href String
(String) The URL for this virtual server instance profile.
id String
(String) The unique identifier of the dedicated host group.
name String
(String) The unique name for this virtual server instance profile.
resourceGroup String
(String) The unique identifier of the resource group for this dedicated host.
resourceType String
(String) The type of resource referenced.
supportedInstanceProfiles List<Property Map>
(List) Array of instance profiles that can be used by instances placed on this dedicated host group.
zone String
(String) The zone this dedicated host group resides in.

Supporting Types

GetIsDedicatedHostGroupDedicatedHost

Crn This property is required. string
(String) The CRN for this dedicated host.
Deleteds This property is required. List<GetIsDedicatedHostGroupDedicatedHostDeleted>
(List) If present, this property indicates the referenced resource has been deleted and provides supplementary information. Nested deleted blocks have the following structure.
Href This property is required. string
(String) The URL for this virtual server instance profile.
Id This property is required. string
(String) The unique identifier of the dedicated host group.
Name This property is required. string
The unique user defined name of this dedicated host group.
ResourceType This property is required. string
(String) The type of resource referenced.
Crn This property is required. string
(String) The CRN for this dedicated host.
Deleteds This property is required. []GetIsDedicatedHostGroupDedicatedHostDeleted
(List) If present, this property indicates the referenced resource has been deleted and provides supplementary information. Nested deleted blocks have the following structure.
Href This property is required. string
(String) The URL for this virtual server instance profile.
Id This property is required. string
(String) The unique identifier of the dedicated host group.
Name This property is required. string
The unique user defined name of this dedicated host group.
ResourceType This property is required. string
(String) The type of resource referenced.
crn This property is required. String
(String) The CRN for this dedicated host.
deleteds This property is required. List<GetIsDedicatedHostGroupDedicatedHostDeleted>
(List) If present, this property indicates the referenced resource has been deleted and provides supplementary information. Nested deleted blocks have the following structure.
href This property is required. String
(String) The URL for this virtual server instance profile.
id This property is required. String
(String) The unique identifier of the dedicated host group.
name This property is required. String
The unique user defined name of this dedicated host group.
resourceType This property is required. String
(String) The type of resource referenced.
crn This property is required. string
(String) The CRN for this dedicated host.
deleteds This property is required. GetIsDedicatedHostGroupDedicatedHostDeleted[]
(List) If present, this property indicates the referenced resource has been deleted and provides supplementary information. Nested deleted blocks have the following structure.
href This property is required. string
(String) The URL for this virtual server instance profile.
id This property is required. string
(String) The unique identifier of the dedicated host group.
name This property is required. string
The unique user defined name of this dedicated host group.
resourceType This property is required. string
(String) The type of resource referenced.
crn This property is required. str
(String) The CRN for this dedicated host.
deleteds This property is required. Sequence[GetIsDedicatedHostGroupDedicatedHostDeleted]
(List) If present, this property indicates the referenced resource has been deleted and provides supplementary information. Nested deleted blocks have the following structure.
href This property is required. str
(String) The URL for this virtual server instance profile.
id This property is required. str
(String) The unique identifier of the dedicated host group.
name This property is required. str
The unique user defined name of this dedicated host group.
resource_type This property is required. str
(String) The type of resource referenced.
crn This property is required. String
(String) The CRN for this dedicated host.
deleteds This property is required. List<Property Map>
(List) If present, this property indicates the referenced resource has been deleted and provides supplementary information. Nested deleted blocks have the following structure.
href This property is required. String
(String) The URL for this virtual server instance profile.
id This property is required. String
(String) The unique identifier of the dedicated host group.
name This property is required. String
The unique user defined name of this dedicated host group.
resourceType This property is required. String
(String) The type of resource referenced.

GetIsDedicatedHostGroupDedicatedHostDeleted

MoreInfo This property is required. string
(String) Link to documentation about deleted resources.
MoreInfo This property is required. string
(String) Link to documentation about deleted resources.
moreInfo This property is required. String
(String) Link to documentation about deleted resources.
moreInfo This property is required. string
(String) Link to documentation about deleted resources.
more_info This property is required. str
(String) Link to documentation about deleted resources.
moreInfo This property is required. String
(String) Link to documentation about deleted resources.

GetIsDedicatedHostGroupSupportedInstanceProfile

Href This property is required. string
(String) The URL for this virtual server instance profile.
Name This property is required. string
The unique user defined name of this dedicated host group.
Href This property is required. string
(String) The URL for this virtual server instance profile.
Name This property is required. string
The unique user defined name of this dedicated host group.
href This property is required. String
(String) The URL for this virtual server instance profile.
name This property is required. String
The unique user defined name of this dedicated host group.
href This property is required. string
(String) The URL for this virtual server instance profile.
name This property is required. string
The unique user defined name of this dedicated host group.
href This property is required. str
(String) The URL for this virtual server instance profile.
name This property is required. str
The unique user defined name of this dedicated host group.
href This property is required. String
(String) The URL for this virtual server instance profile.
name This property is required. String
The unique user defined name of this dedicated host group.

Package Details

Repository
ibm ibm-cloud/terraform-provider-ibm
License
Notes
This Pulumi package is based on the ibm Terraform Provider.
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm