1. Packages
  2. Ibm Provider
  3. API Docs
  4. getIsDedicatedHostGroups
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.getIsDedicatedHostGroups

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

    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";
    
    import pulumi
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    
    return await Deployment.RunAsync(() => 
    {
    });
    
    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) {
        }
    }
    
    {}
    

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const example = ibm.getIsDedicatedHostGroups({});
    
    import pulumi
    import pulumi_ibm as ibm
    
    example = ibm.get_is_dedicated_host_groups()
    
    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
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ibm = Pulumi.Ibm;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Ibm.GetIsDedicatedHostGroups.Invoke();
    
    });
    
    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();
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: ibm:getIsDedicatedHostGroups
          arguments: {}
    

    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>
    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]
    func GetIsDedicatedHostGroups(ctx *Context, args *GetIsDedicatedHostGroupsArgs, opts ...InvokeOption) (*GetIsDedicatedHostGroupsResult, error)
    func GetIsDedicatedHostGroupsOutput(ctx *Context, args *GetIsDedicatedHostGroupsOutputArgs, opts ...InvokeOption) GetIsDedicatedHostGroupsResultOutput

    > 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)
    }
    public static CompletableFuture<GetIsDedicatedHostGroupsResult> getIsDedicatedHostGroups(GetIsDedicatedHostGroupsArgs args, InvokeOptions options)
    public static Output<GetIsDedicatedHostGroupsResult> getIsDedicatedHostGroups(GetIsDedicatedHostGroupsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getIsDedicatedHostGroups:getIsDedicatedHostGroups
      arguments:
        # arguments dictionary

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

    GetIsDedicatedHostGroupsHostGroupDedicatedHost

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

    GetIsDedicatedHostGroupsHostGroupDedicatedHostDeleted

    MoreInfo string
    (String) Link to documentation about deleted resources.
    MoreInfo string
    (String) Link to documentation about deleted resources.
    moreInfo String
    (String) Link to documentation about deleted resources.
    moreInfo string
    (String) Link to documentation about deleted resources.
    more_info str
    (String) Link to documentation about deleted resources.
    moreInfo String
    (String) Link to documentation about deleted resources.

    GetIsDedicatedHostGroupsHostGroupSupportedInstanceProfile

    Href string
    (String) The URL for this virtual server instance profile.
    Name string
    The name of the dedicated host group
    Href string
    (String) The URL for this virtual server instance profile.
    Name string
    The name of the dedicated host group
    href String
    (String) The URL for this virtual server instance profile.
    name String
    The name of the dedicated host group
    href string
    (String) The URL for this virtual server instance profile.
    name string
    The name of the dedicated host group
    href str
    (String) The URL for this virtual server instance profile.
    name str
    The name of the dedicated host group
    href String
    (String) The URL for this virtual server instance profile.
    name 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.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud