1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. oci
  5. getIotIotDomains
Oracle Cloud Infrastructure v3.16.0 published on Wednesday, Jan 28, 2026 by Pulumi
oci logo
Oracle Cloud Infrastructure v3.16.0 published on Wednesday, Jan 28, 2026 by Pulumi

    This data source provides the list of Iot Domains in Oracle Cloud Infrastructure Iot service.

    Retrieves a list of IoT domains within the specified compartment.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testIotDomains = oci.oci.getIotIotDomains({
        compartmentId: compartmentId,
        displayName: iotDomainDisplayName,
        id: iotDomainId,
        iotDomainGroupId: testIotDomainGroup.id,
        state: iotDomainState,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_iot_domains = oci.oci.get_iot_iot_domains(compartment_id=compartment_id,
        display_name=iot_domain_display_name,
        id=iot_domain_id,
        iot_domain_group_id=test_iot_domain_group["id"],
        state=iot_domain_state)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/v3/go/oci/oci"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := oci.GetIotIotDomains(ctx, &oci.GetIotIotDomainsArgs{
    			CompartmentId:    compartmentId,
    			DisplayName:      pulumi.StringRef(iotDomainDisplayName),
    			Id:               pulumi.StringRef(iotDomainId),
    			IotDomainGroupId: pulumi.StringRef(testIotDomainGroup.Id),
    			State:            pulumi.StringRef(iotDomainState),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testIotDomains = Oci.Oci.GetIotIotDomains.Invoke(new()
        {
            CompartmentId = compartmentId,
            DisplayName = iotDomainDisplayName,
            Id = iotDomainId,
            IotDomainGroupId = testIotDomainGroup.Id,
            State = iotDomainState,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.oci.OciFunctions;
    import com.pulumi.oci.oci.inputs.GetIotIotDomainsArgs;
    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 testIotDomains = OciFunctions.getIotIotDomains(GetIotIotDomainsArgs.builder()
                .compartmentId(compartmentId)
                .displayName(iotDomainDisplayName)
                .id(iotDomainId)
                .iotDomainGroupId(testIotDomainGroup.id())
                .state(iotDomainState)
                .build());
    
        }
    }
    
    variables:
      testIotDomains:
        fn::invoke:
          function: oci:oci:getIotIotDomains
          arguments:
            compartmentId: ${compartmentId}
            displayName: ${iotDomainDisplayName}
            id: ${iotDomainId}
            iotDomainGroupId: ${testIotDomainGroup.id}
            state: ${iotDomainState}
    

    Using getIotIotDomains

    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 getIotIotDomains(args: GetIotIotDomainsArgs, opts?: InvokeOptions): Promise<GetIotIotDomainsResult>
    function getIotIotDomainsOutput(args: GetIotIotDomainsOutputArgs, opts?: InvokeOptions): Output<GetIotIotDomainsResult>
    def get_iot_iot_domains(compartment_id: Optional[str] = None,
                            display_name: Optional[str] = None,
                            filters: Optional[Sequence[GetIotIotDomainsFilter]] = None,
                            id: Optional[str] = None,
                            iot_domain_group_id: Optional[str] = None,
                            state: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetIotIotDomainsResult
    def get_iot_iot_domains_output(compartment_id: Optional[pulumi.Input[str]] = None,
                            display_name: Optional[pulumi.Input[str]] = None,
                            filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetIotIotDomainsFilterArgs]]]] = None,
                            id: Optional[pulumi.Input[str]] = None,
                            iot_domain_group_id: Optional[pulumi.Input[str]] = None,
                            state: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetIotIotDomainsResult]
    func GetIotIotDomains(ctx *Context, args *GetIotIotDomainsArgs, opts ...InvokeOption) (*GetIotIotDomainsResult, error)
    func GetIotIotDomainsOutput(ctx *Context, args *GetIotIotDomainsOutputArgs, opts ...InvokeOption) GetIotIotDomainsResultOutput

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

    public static class GetIotIotDomains 
    {
        public static Task<GetIotIotDomainsResult> InvokeAsync(GetIotIotDomainsArgs args, InvokeOptions? opts = null)
        public static Output<GetIotIotDomainsResult> Invoke(GetIotIotDomainsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetIotIotDomainsResult> getIotIotDomains(GetIotIotDomainsArgs args, InvokeOptions options)
    public static Output<GetIotIotDomainsResult> getIotIotDomains(GetIotIotDomainsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: oci:oci/getIotIotDomains:getIotIotDomains
      arguments:
        # arguments dictionary

    The following arguments are supported:

    CompartmentId string
    The OCID of the compartment in which to list resources.
    DisplayName string
    Filter resources whose display name matches the specified value.
    Filters List<GetIotIotDomainsFilter>
    Id string
    Filter resources by OCID. Must be a valid OCID of the resource type.
    IotDomainGroupId string
    Filter resources that match the specified OCID of the IoT domain group.
    State string
    Filter resources whose lifecycleState matches the specified value.
    CompartmentId string
    The OCID of the compartment in which to list resources.
    DisplayName string
    Filter resources whose display name matches the specified value.
    Filters []GetIotIotDomainsFilter
    Id string
    Filter resources by OCID. Must be a valid OCID of the resource type.
    IotDomainGroupId string
    Filter resources that match the specified OCID of the IoT domain group.
    State string
    Filter resources whose lifecycleState matches the specified value.
    compartmentId String
    The OCID of the compartment in which to list resources.
    displayName String
    Filter resources whose display name matches the specified value.
    filters List<GetIotIotDomainsFilter>
    id String
    Filter resources by OCID. Must be a valid OCID of the resource type.
    iotDomainGroupId String
    Filter resources that match the specified OCID of the IoT domain group.
    state String
    Filter resources whose lifecycleState matches the specified value.
    compartmentId string
    The OCID of the compartment in which to list resources.
    displayName string
    Filter resources whose display name matches the specified value.
    filters GetIotIotDomainsFilter[]
    id string
    Filter resources by OCID. Must be a valid OCID of the resource type.
    iotDomainGroupId string
    Filter resources that match the specified OCID of the IoT domain group.
    state string
    Filter resources whose lifecycleState matches the specified value.
    compartment_id str
    The OCID of the compartment in which to list resources.
    display_name str
    Filter resources whose display name matches the specified value.
    filters Sequence[GetIotIotDomainsFilter]
    id str
    Filter resources by OCID. Must be a valid OCID of the resource type.
    iot_domain_group_id str
    Filter resources that match the specified OCID of the IoT domain group.
    state str
    Filter resources whose lifecycleState matches the specified value.
    compartmentId String
    The OCID of the compartment in which to list resources.
    displayName String
    Filter resources whose display name matches the specified value.
    filters List<Property Map>
    id String
    Filter resources by OCID. Must be a valid OCID of the resource type.
    iotDomainGroupId String
    Filter resources that match the specified OCID of the IoT domain group.
    state String
    Filter resources whose lifecycleState matches the specified value.

    getIotIotDomains Result

    The following output properties are available:

    CompartmentId string
    The OCID of the compartment corresponding to the resource.
    IotDomainCollections List<GetIotIotDomainsIotDomainCollection>
    The list of iot_domain_collection.
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    Filters List<GetIotIotDomainsFilter>
    Id string
    The OCID of the resource.
    IotDomainGroupId string
    The OCID of the IoT domain group.
    State string
    The current state of the IoT domain.
    CompartmentId string
    The OCID of the compartment corresponding to the resource.
    IotDomainCollections []GetIotIotDomainsIotDomainCollection
    The list of iot_domain_collection.
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    Filters []GetIotIotDomainsFilter
    Id string
    The OCID of the resource.
    IotDomainGroupId string
    The OCID of the IoT domain group.
    State string
    The current state of the IoT domain.
    compartmentId String
    The OCID of the compartment corresponding to the resource.
    iotDomainCollections List<GetIotIotDomainsIotDomainCollection>
    The list of iot_domain_collection.
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    filters List<GetIotIotDomainsFilter>
    id String
    The OCID of the resource.
    iotDomainGroupId String
    The OCID of the IoT domain group.
    state String
    The current state of the IoT domain.
    compartmentId string
    The OCID of the compartment corresponding to the resource.
    iotDomainCollections GetIotIotDomainsIotDomainCollection[]
    The list of iot_domain_collection.
    displayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    filters GetIotIotDomainsFilter[]
    id string
    The OCID of the resource.
    iotDomainGroupId string
    The OCID of the IoT domain group.
    state string
    The current state of the IoT domain.
    compartment_id str
    The OCID of the compartment corresponding to the resource.
    iot_domain_collections Sequence[GetIotIotDomainsIotDomainCollection]
    The list of iot_domain_collection.
    display_name str
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    filters Sequence[GetIotIotDomainsFilter]
    id str
    The OCID of the resource.
    iot_domain_group_id str
    The OCID of the IoT domain group.
    state str
    The current state of the IoT domain.
    compartmentId String
    The OCID of the compartment corresponding to the resource.
    iotDomainCollections List<Property Map>
    The list of iot_domain_collection.
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    filters List<Property Map>
    id String
    The OCID of the resource.
    iotDomainGroupId String
    The OCID of the IoT domain group.
    state String
    The current state of the IoT domain.

    Supporting Types

    GetIotIotDomainsFilter

    Name string
    Values List<string>
    Regex bool
    Name string
    Values []string
    Regex bool
    name String
    values List<String>
    regex Boolean
    name string
    values string[]
    regex boolean
    name str
    values Sequence[str]
    regex bool
    name String
    values List<String>
    regex Boolean

    GetIotIotDomainsIotDomainCollection

    GetIotIotDomainsIotDomainCollectionItem

    CompartmentId string
    The OCID of the compartment in which to list resources.
    DataRetentionPeriodsInDays List<GetIotIotDomainsIotDomainCollectionItemDataRetentionPeriodsInDay>
    Data Retention periods
    DbAllowListedIdentityGroupNames List<string>
    List of IAM groups of form described in here that are allowed to directly connect to the data host.
    DbAllowedIdentityDomainHost string
    Host name of identity domain that is used for authenticating connect to data host via ORDS.
    DefinedTags Dictionary<string, string>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    A short description of the resource.
    DeviceHost string
    Host name of an IoT domain, where IoT devices can connect to.
    DisplayName string
    Filter resources whose display name matches the specified value.
    FreeformTags Dictionary<string, string>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    Filter resources by OCID. Must be a valid OCID of the resource type.
    IotDomainGroupId string
    Filter resources that match the specified OCID of the IoT domain group.
    State string
    Filter resources whose lifecycleState matches the specified value.
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time when the resource was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time when the resource was last updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    CompartmentId string
    The OCID of the compartment in which to list resources.
    DataRetentionPeriodsInDays []GetIotIotDomainsIotDomainCollectionItemDataRetentionPeriodsInDay
    Data Retention periods
    DbAllowListedIdentityGroupNames []string
    List of IAM groups of form described in here that are allowed to directly connect to the data host.
    DbAllowedIdentityDomainHost string
    Host name of identity domain that is used for authenticating connect to data host via ORDS.
    DefinedTags map[string]string
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    A short description of the resource.
    DeviceHost string
    Host name of an IoT domain, where IoT devices can connect to.
    DisplayName string
    Filter resources whose display name matches the specified value.
    FreeformTags map[string]string
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    Filter resources by OCID. Must be a valid OCID of the resource type.
    IotDomainGroupId string
    Filter resources that match the specified OCID of the IoT domain group.
    State string
    Filter resources whose lifecycleState matches the specified value.
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time when the resource was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time when the resource was last updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    compartmentId String
    The OCID of the compartment in which to list resources.
    dataRetentionPeriodsInDays List<GetIotIotDomainsIotDomainCollectionItemDataRetentionPeriodsInDay>
    Data Retention periods
    dbAllowListedIdentityGroupNames List<String>
    List of IAM groups of form described in here that are allowed to directly connect to the data host.
    dbAllowedIdentityDomainHost String
    Host name of identity domain that is used for authenticating connect to data host via ORDS.
    definedTags Map<String,String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    A short description of the resource.
    deviceHost String
    Host name of an IoT domain, where IoT devices can connect to.
    displayName String
    Filter resources whose display name matches the specified value.
    freeformTags Map<String,String>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    Filter resources by OCID. Must be a valid OCID of the resource type.
    iotDomainGroupId String
    Filter resources that match the specified OCID of the IoT domain group.
    state String
    Filter resources whose lifecycleState matches the specified value.
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time when the resource was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time when the resource was last updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    compartmentId string
    The OCID of the compartment in which to list resources.
    dataRetentionPeriodsInDays GetIotIotDomainsIotDomainCollectionItemDataRetentionPeriodsInDay[]
    Data Retention periods
    dbAllowListedIdentityGroupNames string[]
    List of IAM groups of form described in here that are allowed to directly connect to the data host.
    dbAllowedIdentityDomainHost string
    Host name of identity domain that is used for authenticating connect to data host via ORDS.
    definedTags {[key: string]: string}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description string
    A short description of the resource.
    deviceHost string
    Host name of an IoT domain, where IoT devices can connect to.
    displayName string
    Filter resources whose display name matches the specified value.
    freeformTags {[key: string]: string}
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id string
    Filter resources by OCID. Must be a valid OCID of the resource type.
    iotDomainGroupId string
    Filter resources that match the specified OCID of the IoT domain group.
    state string
    Filter resources whose lifecycleState matches the specified value.
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The date and time when the resource was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated string
    The date and time when the resource was last updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    compartment_id str
    The OCID of the compartment in which to list resources.
    data_retention_periods_in_days Sequence[GetIotIotDomainsIotDomainCollectionItemDataRetentionPeriodsInDay]
    Data Retention periods
    db_allow_listed_identity_group_names Sequence[str]
    List of IAM groups of form described in here that are allowed to directly connect to the data host.
    db_allowed_identity_domain_host str
    Host name of identity domain that is used for authenticating connect to data host via ORDS.
    defined_tags Mapping[str, str]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description str
    A short description of the resource.
    device_host str
    Host name of an IoT domain, where IoT devices can connect to.
    display_name str
    Filter resources whose display name matches the specified value.
    freeform_tags Mapping[str, str]
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id str
    Filter resources by OCID. Must be a valid OCID of the resource type.
    iot_domain_group_id str
    Filter resources that match the specified OCID of the IoT domain group.
    state str
    Filter resources whose lifecycleState matches the specified value.
    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The date and time when the resource was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    time_updated str
    The date and time when the resource was last updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    compartmentId String
    The OCID of the compartment in which to list resources.
    dataRetentionPeriodsInDays List<Property Map>
    Data Retention periods
    dbAllowListedIdentityGroupNames List<String>
    List of IAM groups of form described in here that are allowed to directly connect to the data host.
    dbAllowedIdentityDomainHost String
    Host name of identity domain that is used for authenticating connect to data host via ORDS.
    definedTags Map<String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    A short description of the resource.
    deviceHost String
    Host name of an IoT domain, where IoT devices can connect to.
    displayName String
    Filter resources whose display name matches the specified value.
    freeformTags Map<String>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    Filter resources by OCID. Must be a valid OCID of the resource type.
    iotDomainGroupId String
    Filter resources that match the specified OCID of the IoT domain group.
    state String
    Filter resources whose lifecycleState matches the specified value.
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time when the resource was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time when the resource was last updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

    GetIotIotDomainsIotDomainCollectionItemDataRetentionPeriodsInDay

    HistorizedData int
    Number of days for which any normalized data sent to IoT devices would be retained for.
    RawCommandData int
    Number of days for which any raw command data sent to IoT devices would be retained for.
    RawData int
    Number of days for which any raw data sent to IoT devices would be retained for.
    RejectedData int
    Number of days for which any data sent to IoT devices would be retained for.
    HistorizedData int
    Number of days for which any normalized data sent to IoT devices would be retained for.
    RawCommandData int
    Number of days for which any raw command data sent to IoT devices would be retained for.
    RawData int
    Number of days for which any raw data sent to IoT devices would be retained for.
    RejectedData int
    Number of days for which any data sent to IoT devices would be retained for.
    historizedData Integer
    Number of days for which any normalized data sent to IoT devices would be retained for.
    rawCommandData Integer
    Number of days for which any raw command data sent to IoT devices would be retained for.
    rawData Integer
    Number of days for which any raw data sent to IoT devices would be retained for.
    rejectedData Integer
    Number of days for which any data sent to IoT devices would be retained for.
    historizedData number
    Number of days for which any normalized data sent to IoT devices would be retained for.
    rawCommandData number
    Number of days for which any raw command data sent to IoT devices would be retained for.
    rawData number
    Number of days for which any raw data sent to IoT devices would be retained for.
    rejectedData number
    Number of days for which any data sent to IoT devices would be retained for.
    historized_data int
    Number of days for which any normalized data sent to IoT devices would be retained for.
    raw_command_data int
    Number of days for which any raw command data sent to IoT devices would be retained for.
    raw_data int
    Number of days for which any raw data sent to IoT devices would be retained for.
    rejected_data int
    Number of days for which any data sent to IoT devices would be retained for.
    historizedData Number
    Number of days for which any normalized data sent to IoT devices would be retained for.
    rawCommandData Number
    Number of days for which any raw command data sent to IoT devices would be retained for.
    rawData Number
    Number of days for which any raw data sent to IoT devices would be retained for.
    rejectedData Number
    Number of days for which any data sent to IoT devices would be retained for.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v3.16.0 published on Wednesday, Jan 28, 2026 by Pulumi
      Meet Neo: Your AI Platform Teammate