1. Packages
  2. Ibm Provider
  3. API Docs
  4. getIsDedicatedHostGroups
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm.getIsDedicatedHostGroups

Explore with Pulumi AI

Retrieve an information the dedicated host group collection. For more information, about dedicated host group collection, see managing dedicated hosts and 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.getIsDedicatedHostGroups({});
Copy
import pulumi
import pulumi_ibm as ibm

example = ibm.get_is_dedicated_host_groups()
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.GetIsDedicatedHostGroups(ctx, &ibm.GetIsDedicatedHostGroupsArgs{}, 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.GetIsDedicatedHostGroups.Invoke();

});
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.GetIsDedicatedHostGroupsArgs;
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.getIsDedicatedHostGroups();

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: ibm:getIsDedicatedHostGroups
      arguments: {}
Copy

Using getIsDedicatedHostGroups

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 getIsDedicatedHostGroups(args: GetIsDedicatedHostGroupsArgs, opts?: InvokeOptions): Promise<GetIsDedicatedHostGroupsResult>
function getIsDedicatedHostGroupsOutput(args: GetIsDedicatedHostGroupsOutputArgs, opts?: InvokeOptions): Output<GetIsDedicatedHostGroupsResult>
Copy
def get_is_dedicated_host_groups(id: Optional[str] = None,
                                 name: Optional[str] = None,
                                 resource_group: Optional[str] = None,
                                 zone: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetIsDedicatedHostGroupsResult
def get_is_dedicated_host_groups_output(id: Optional[pulumi.Input[str]] = None,
                                 name: Optional[pulumi.Input[str]] = None,
                                 resource_group: Optional[pulumi.Input[str]] = None,
                                 zone: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetIsDedicatedHostGroupsResult]
Copy
func GetIsDedicatedHostGroups(ctx *Context, args *GetIsDedicatedHostGroupsArgs, opts ...InvokeOption) (*GetIsDedicatedHostGroupsResult, error)
func GetIsDedicatedHostGroupsOutput(ctx *Context, args *GetIsDedicatedHostGroupsOutputArgs, opts ...InvokeOption) GetIsDedicatedHostGroupsResultOutput
Copy

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

public static class GetIsDedicatedHostGroups 
{
    public static Task<GetIsDedicatedHostGroupsResult> InvokeAsync(GetIsDedicatedHostGroupsArgs args, InvokeOptions? opts = null)
    public static Output<GetIsDedicatedHostGroupsResult> Invoke(GetIsDedicatedHostGroupsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetIsDedicatedHostGroupsResult> getIsDedicatedHostGroups(GetIsDedicatedHostGroupsArgs args, InvokeOptions options)
public static Output<GetIsDedicatedHostGroupsResult> getIsDedicatedHostGroups(GetIsDedicatedHostGroupsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getIsDedicatedHostGroups:getIsDedicatedHostGroups
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id string
(String) The unique identifier for this dedicated host group.
Name string
The name of the dedicated host group
ResourceGroup string
The ID of the Resource group this dedicated host group belongs to.
Zone string
The name of the zone this dedicated host group is in
Id string
(String) The unique identifier for this dedicated host group.
Name string
The name of the dedicated host group
ResourceGroup string
The ID of the Resource group this dedicated host group belongs to.
Zone string
The name of the zone this dedicated host group is in
id String
(String) The unique identifier for this dedicated host group.
name String
The name of the dedicated host group
resourceGroup String
The ID of the Resource group this dedicated host group belongs to.
zone String
The name of the zone this dedicated host group is in
id string
(String) The unique identifier for this dedicated host group.
name string
The name of the dedicated host group
resourceGroup string
The ID of the Resource group this dedicated host group belongs to.
zone string
The name of the zone this dedicated host group is in
id str
(String) The unique identifier for this dedicated host group.
name str
The name of the dedicated host group
resource_group str
The ID of the Resource group this dedicated host group belongs to.
zone str
The name of the zone this dedicated host group is in
id String
(String) The unique identifier for this dedicated host group.
name String
The name of the dedicated host group
resourceGroup String
The ID of the Resource group this dedicated host group belongs to.
zone String
The name of the zone this dedicated host group is in

getIsDedicatedHostGroups Result

The following output properties are available:

HostGroups List<GetIsDedicatedHostGroupsHostGroup>
(List) Collection of dedicated host groups.
Id string
(String) The unique identifier for this dedicated host group.
TotalCount double
(String) The total number of resources across all pages.
Name string
(String) The global unique name for this virtual server instance profile.
ResourceGroup string
(String) The unique identifier of the resource group for this dedicated host group.
Zone string
(String) The global unique name of the zone this dedicated host group resides in.
HostGroups []GetIsDedicatedHostGroupsHostGroup
(List) Collection of dedicated host groups.
Id string
(String) The unique identifier for this dedicated host group.
TotalCount float64
(String) The total number of resources across all pages.
Name string
(String) The global unique name for this virtual server instance profile.
ResourceGroup string
(String) The unique identifier of the resource group for this dedicated host group.
Zone string
(String) The global unique name of the zone this dedicated host group resides in.
hostGroups List<GetIsDedicatedHostGroupsHostGroup>
(List) Collection of dedicated host groups.
id String
(String) The unique identifier for this dedicated host group.
totalCount Double
(String) The total number of resources across all pages.
name String
(String) The global unique name for this virtual server instance profile.
resourceGroup String
(String) The unique identifier of the resource group for this dedicated host group.
zone String
(String) The global unique name of the zone this dedicated host group resides in.
hostGroups GetIsDedicatedHostGroupsHostGroup[]
(List) Collection of dedicated host groups.
id string
(String) The unique identifier for this dedicated host group.
totalCount number
(String) The total number of resources across all pages.
name string
(String) The global unique name for this virtual server instance profile.
resourceGroup string
(String) The unique identifier of the resource group for this dedicated host group.
zone string
(String) The global unique name of the zone this dedicated host group resides in.
host_groups Sequence[GetIsDedicatedHostGroupsHostGroup]
(List) Collection of dedicated host groups.
id str
(String) The unique identifier for this dedicated host group.
total_count float
(String) The total number of resources across all pages.
name str
(String) The global unique name for this virtual server instance profile.
resource_group str
(String) The unique identifier of the resource group for this dedicated host group.
zone str
(String) The global unique name of the zone this dedicated host group resides in.
hostGroups List<Property Map>
(List) Collection of dedicated host groups.
id String
(String) The unique identifier for this dedicated host group.
totalCount Number
(String) The total number of resources across all pages.
name String
(String) The global unique name for this virtual server instance profile.
resourceGroup String
(String) The unique identifier of the resource group for this dedicated host group.
zone String
(String) The global unique name of the zone this dedicated host group resides in.

Supporting Types

GetIsDedicatedHostGroupsHostGroup

Class This property is required. string
(String) The dedicated host profile class for hosts in this group.
CreatedAt This property is required. string
(Timestamp) The date and time that the dedicated host group was created.
Crn This property is required. string
(String) The CRN for this dedicated host.
DedicatedHosts This property is required. List<GetIsDedicatedHostGroupsHostGroupDedicatedHost>
(List) The dedicated hosts that are in this dedicated host group.
Family This property is required. string
(String) The dedicated host profile family for hosts in this group.
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 for this dedicated host group.
Name This property is required. string
The name of the dedicated host group
ResourceGroup This property is required. string
The ID of the Resource group this dedicated host group belongs to.
ResourceType This property is required. string
(String) The type of resource referenced.
SupportedInstanceProfiles This property is required. List<GetIsDedicatedHostGroupsHostGroupSupportedInstanceProfile>
(List) Array of instance profiles that can be used by instances placed on this dedicated host group.
Zone This property is required. string
The name of the zone this dedicated host group is in
Class This property is required. string
(String) The dedicated host profile class for hosts in this group.
CreatedAt This property is required. string
(Timestamp) The date and time that the dedicated host group was created.
Crn This property is required. string
(String) The CRN for this dedicated host.
DedicatedHosts This property is required. []GetIsDedicatedHostGroupsHostGroupDedicatedHost
(List) The dedicated hosts that are in this dedicated host group.
Family This property is required. string
(String) The dedicated host profile family for hosts in this group.
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 for this dedicated host group.
Name This property is required. string
The name of the dedicated host group
ResourceGroup This property is required. string
The ID of the Resource group this dedicated host group belongs to.
ResourceType This property is required. string
(String) The type of resource referenced.
SupportedInstanceProfiles This property is required. []GetIsDedicatedHostGroupsHostGroupSupportedInstanceProfile
(List) Array of instance profiles that can be used by instances placed on this dedicated host group.
Zone This property is required. string
The name of the zone this dedicated host group is in
class_ This property is required. String
(String) The dedicated host profile class for hosts in this group.
createdAt This property is required. String
(Timestamp) The date and time that the dedicated host group was created.
crn This property is required. String
(String) The CRN for this dedicated host.
dedicatedHosts This property is required. List<GetIsDedicatedHostGroupsHostGroupDedicatedHost>
(List) The dedicated hosts that are in this dedicated host group.
family This property is required. String
(String) The dedicated host profile family for hosts in this group.
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 for this dedicated host group.
name This property is required. String
The name of the dedicated host group
resourceGroup This property is required. String
The ID of the Resource group this dedicated host group belongs to.
resourceType This property is required. String
(String) The type of resource referenced.
supportedInstanceProfiles This property is required. List<GetIsDedicatedHostGroupsHostGroupSupportedInstanceProfile>
(List) Array of instance profiles that can be used by instances placed on this dedicated host group.
zone This property is required. String
The name of the zone this dedicated host group is in
class This property is required. string
(String) The dedicated host profile class for hosts in this group.
createdAt This property is required. string
(Timestamp) The date and time that the dedicated host group was created.
crn This property is required. string
(String) The CRN for this dedicated host.
dedicatedHosts This property is required. GetIsDedicatedHostGroupsHostGroupDedicatedHost[]
(List) The dedicated hosts that are in this dedicated host group.
family This property is required. string
(String) The dedicated host profile family for hosts in this group.
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 for this dedicated host group.
name This property is required. string
The name of the dedicated host group
resourceGroup This property is required. string
The ID of the Resource group this dedicated host group belongs to.
resourceType This property is required. string
(String) The type of resource referenced.
supportedInstanceProfiles This property is required. GetIsDedicatedHostGroupsHostGroupSupportedInstanceProfile[]
(List) Array of instance profiles that can be used by instances placed on this dedicated host group.
zone This property is required. string
The name of the zone this dedicated host group is in
class_ This property is required. str
(String) The dedicated host profile class for hosts in this group.
created_at This property is required. str
(Timestamp) The date and time that the dedicated host group was created.
crn This property is required. str
(String) The CRN for this dedicated host.
dedicated_hosts This property is required. Sequence[GetIsDedicatedHostGroupsHostGroupDedicatedHost]
(List) The dedicated hosts that are in this dedicated host group.
family This property is required. str
(String) The dedicated host profile family for hosts in this group.
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 for this dedicated host group.
name This property is required. str
The name of the dedicated host group
resource_group This property is required. str
The ID of the Resource group this dedicated host group belongs to.
resource_type This property is required. str
(String) The type of resource referenced.
supported_instance_profiles This property is required. Sequence[GetIsDedicatedHostGroupsHostGroupSupportedInstanceProfile]
(List) Array of instance profiles that can be used by instances placed on this dedicated host group.
zone This property is required. str
The name of the zone this dedicated host group is in
class This property is required. String
(String) The dedicated host profile class for hosts in this group.
createdAt This property is required. String
(Timestamp) The date and time that the dedicated host group was created.
crn This property is required. String
(String) The CRN for this dedicated host.
dedicatedHosts This property is required. List<Property Map>
(List) The dedicated hosts that are in this dedicated host group.
family This property is required. String
(String) The dedicated host profile family for hosts in this group.
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 for this dedicated host group.
name This property is required. String
The name of the dedicated host group
resourceGroup This property is required. String
The ID of the Resource group this dedicated host group belongs to.
resourceType This property is required. String
(String) The type of resource referenced.
supportedInstanceProfiles This property is required. List<Property Map>
(List) Array of instance profiles that can be used by instances placed on this dedicated host group.
zone This property is required. String
The name of the zone this dedicated host group is in

GetIsDedicatedHostGroupsHostGroupDedicatedHost

Crn This property is required. string
(String) The CRN for this dedicated host.
Deleteds This property is required. List<GetIsDedicatedHostGroupsHostGroupDedicatedHostDeleted>
(List) If present, this property indicates the referenced resource has been deleted and providessome supplementary information.
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 for this dedicated host group.
Name This property is required. string
The name of the 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. []GetIsDedicatedHostGroupsHostGroupDedicatedHostDeleted
(List) If present, this property indicates the referenced resource has been deleted and providessome supplementary information.
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 for this dedicated host group.
Name This property is required. string
The name of the 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<GetIsDedicatedHostGroupsHostGroupDedicatedHostDeleted>
(List) If present, this property indicates the referenced resource has been deleted and providessome supplementary information.
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 for this dedicated host group.
name This property is required. String
The name of the 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. GetIsDedicatedHostGroupsHostGroupDedicatedHostDeleted[]
(List) If present, this property indicates the referenced resource has been deleted and providessome supplementary information.
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 for this dedicated host group.
name This property is required. string
The name of the 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[GetIsDedicatedHostGroupsHostGroupDedicatedHostDeleted]
(List) If present, this property indicates the referenced resource has been deleted and providessome supplementary information.
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 for this dedicated host group.
name This property is required. str
The name of the 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 providessome supplementary information.
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 for this dedicated host group.
name This property is required. String
The name of the dedicated host group
resourceType This property is required. String
(String) The type of resource referenced.

GetIsDedicatedHostGroupsHostGroupDedicatedHostDeleted

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.

GetIsDedicatedHostGroupsHostGroupSupportedInstanceProfile

Href This property is required. string
(String) The URL for this virtual server instance profile.
Name This property is required. string
The name of the 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 name of the 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 name of the 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 name of the 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 name of the 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 name of the dedicated host group

Package Details

Repository
ibm ibm-cloud/terraform-provider-ibm
License
Notes
This Pulumi package is based on the ibm Terraform Provider.