Oracle Cloud Infrastructure v3.10.0, Nov 5 25

Oracle Cloud Infrastructure v3.10.0 published on Wednesday, Nov 5, 2025 by Pulumi

oci.Tenantmanagercontrolplane.getDomains

Start a Neo task

Explain and create an oci.Tenantmanagercontrolplane.getDomains resource

Oracle Cloud Infrastructure v3.10.0 published on Wednesday, Nov 5, 2025 by Pulumi

pulumi/pulumi-oci

Example Usage

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

const testDomains = oci.Tenantmanagercontrolplane.getDomains({
    compartmentId: compartmentId,
    domainId: testDomain.id,
    name: domainName,
    state: domainState,
    status: domainStatus,
});

import pulumi
import pulumi_oci as oci

test_domains = oci.Tenantmanagercontrolplane.get_domains(compartment_id=compartment_id,
    domain_id=test_domain["id"],
    name=domain_name,
    state=domain_state,
    status=domain_status)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tenantmanagercontrolplane.GetDomains(ctx, &tenantmanagercontrolplane.GetDomainsArgs{
			CompartmentId: compartmentId,
			DomainId:      pulumi.StringRef(testDomain.Id),
			Name:          pulumi.StringRef(domainName),
			State:         pulumi.StringRef(domainState),
			Status:        pulumi.StringRef(domainStatus),
		}, 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 testDomains = Oci.Tenantmanagercontrolplane.GetDomains.Invoke(new()
    {
        CompartmentId = compartmentId,
        DomainId = testDomain.Id,
        Name = domainName,
        State = domainState,
        Status = domainStatus,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Tenantmanagercontrolplane.TenantmanagercontrolplaneFunctions;
import com.pulumi.oci.Tenantmanagercontrolplane.inputs.GetDomainsArgs;
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 testDomains = TenantmanagercontrolplaneFunctions.getDomains(GetDomainsArgs.builder()
            .compartmentId(compartmentId)
            .domainId(testDomain.id())
            .name(domainName)
            .state(domainState)
            .status(domainStatus)
            .build());

    }
}

variables:
  testDomains:
    fn::invoke:
      function: oci:Tenantmanagercontrolplane:getDomains
      arguments:
        compartmentId: ${compartmentId}
        domainId: ${testDomain.id}
        name: ${domainName}
        state: ${domainState}
        status: ${domainStatus}

Using getDomains

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 getDomains(args: GetDomainsArgs, opts?: InvokeOptions): Promise<GetDomainsResult>
function getDomainsOutput(args: GetDomainsOutputArgs, opts?: InvokeOptions): Output<GetDomainsResult>

def get_domains(compartment_id: Optional[str] = None,
                domain_id: Optional[str] = None,
                filters: Optional[Sequence[GetDomainsFilter]] = None,
                name: Optional[str] = None,
                state: Optional[str] = None,
                status: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetDomainsResult
def get_domains_output(compartment_id: Optional[pulumi.Input[str]] = None,
                domain_id: Optional[pulumi.Input[str]] = None,
                filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetDomainsFilterArgs]]]] = None,
                name: Optional[pulumi.Input[str]] = None,
                state: Optional[pulumi.Input[str]] = None,
                status: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetDomainsResult]

func GetDomains(ctx *Context, args *GetDomainsArgs, opts ...InvokeOption) (*GetDomainsResult, error)
func GetDomainsOutput(ctx *Context, args *GetDomainsOutputArgs, opts ...InvokeOption) GetDomainsResultOutput

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

public static class GetDomains 
{
    public static Task<GetDomainsResult> InvokeAsync(GetDomainsArgs args, InvokeOptions? opts = null)
    public static Output<GetDomainsResult> Invoke(GetDomainsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDomainsResult> getDomains(GetDomainsArgs args, InvokeOptions options)
public static Output<GetDomainsResult> getDomains(GetDomainsArgs args, InvokeOptions options)

fn::invoke:
  function: oci:Tenantmanagercontrolplane/getDomains:getDomains
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string: The ID of the compartment in which to list resources.
DomainId string: The domain OCID.
Filters List<GetDomainsFilter>
Name string: A filter to return only resources that exactly match the name given.
State string: The lifecycle state of the resource.
Status string: The status of the domain.

CompartmentId string: The ID of the compartment in which to list resources.
DomainId string: The domain OCID.
Filters []GetDomainsFilter
Name string: A filter to return only resources that exactly match the name given.
State string: The lifecycle state of the resource.
Status string: The status of the domain.

compartmentId String: The ID of the compartment in which to list resources.
domainId String: The domain OCID.
filters List<GetDomainsFilter>
name String: A filter to return only resources that exactly match the name given.
state String: The lifecycle state of the resource.
status String: The status of the domain.

compartmentId string: The ID of the compartment in which to list resources.
domainId string: The domain OCID.
filters GetDomainsFilter[]
name string: A filter to return only resources that exactly match the name given.
state string: The lifecycle state of the resource.
status string: The status of the domain.

compartment_id str: The ID of the compartment in which to list resources.
domain_id str: The domain OCID.
filters Sequence[GetDomainsFilter]
name str: A filter to return only resources that exactly match the name given.
state str: The lifecycle state of the resource.
status str: The status of the domain.

compartmentId String: The ID of the compartment in which to list resources.
domainId String: The domain OCID.
filters List<Property Map>
name String: A filter to return only resources that exactly match the name given.
state String: The lifecycle state of the resource.
status String: The status of the domain.

getDomains Result

The following output properties are available:

CompartmentId string
DomainCollections List<GetDomainsDomainCollection>: The list of domain_collection.
Id string: The provider-assigned unique ID for this managed resource.
DomainId string
Filters List<GetDomainsFilter>
Name string
State string: Lifecycle state of the domain.
Status string: Status of the domain.

CompartmentId string
DomainCollections []GetDomainsDomainCollection: The list of domain_collection.
Id string: The provider-assigned unique ID for this managed resource.
DomainId string
Filters []GetDomainsFilter
Name string
State string: Lifecycle state of the domain.
Status string: Status of the domain.

compartmentId String
domainCollections List<GetDomainsDomainCollection>: The list of domain_collection.
id String: The provider-assigned unique ID for this managed resource.
domainId String
filters List<GetDomainsFilter>
name String
state String: Lifecycle state of the domain.
status String: Status of the domain.

compartmentId string
domainCollections GetDomainsDomainCollection[]: The list of domain_collection.
id string: The provider-assigned unique ID for this managed resource.
domainId string
filters GetDomainsFilter[]
name string
state string: Lifecycle state of the domain.
status string: Status of the domain.

compartment_id str
domain_collections Sequence[GetDomainsDomainCollection]: The list of domain_collection.
id str: The provider-assigned unique ID for this managed resource.
domain_id str
filters Sequence[GetDomainsFilter]
name str
state str: Lifecycle state of the domain.
status str: Status of the domain.

compartmentId String
domainCollections List<Property Map>: The list of domain_collection.
id String: The provider-assigned unique ID for this managed resource.
domainId String
filters List<Property Map>
name String
state String: Lifecycle state of the domain.
status String: Status of the domain.

Supporting Types

GetDomainsDomainCollection

Items List<GetDomainsDomainCollectionItem>

Items []GetDomainsDomainCollectionItem

items List<GetDomainsDomainCollectionItem>

items GetDomainsDomainCollectionItem[]

items Sequence[GetDomainsDomainCollectionItem]

items List<Property Map>

GetDomainsDomainCollectionItem

CompartmentId string: The ID of the compartment in which to list resources.
DefinedTags Dictionary<string, string>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DomainName string: The domain name.
FreeformTags Dictionary<string, string>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id string: The OCID of the domain.
IsGovernanceEnabled bool
OwnerId string: The OCID of the tenancy that has started the registration process for this domain.
State string: The lifecycle state of the resource.
Status string: The status of the domain.
SubscriptionEmail string
SystemTags Dictionary<string, string>: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: Date-time when this domain was created. An RFC 3339-formatted date and time string.
TimeUpdated string: Date-time when this domain was last updated. An RFC 3339-formatted date and time string.
TxtRecord string: The code that the owner of the domain will need to add as a TXT record to their domain.

CompartmentId string: The ID of the compartment in which to list resources.
DefinedTags map[string]string: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DomainName string: The domain name.
FreeformTags map[string]string: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id string: The OCID of the domain.
IsGovernanceEnabled bool
OwnerId string: The OCID of the tenancy that has started the registration process for this domain.
State string: The lifecycle state of the resource.
Status string: The status of the domain.
SubscriptionEmail string
SystemTags map[string]string: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: Date-time when this domain was created. An RFC 3339-formatted date and time string.
TimeUpdated string: Date-time when this domain was last updated. An RFC 3339-formatted date and time string.
TxtRecord string: The code that the owner of the domain will need to add as a TXT record to their domain.

compartmentId String: The ID of the compartment in which to list resources.
definedTags Map<String,String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
domainName String: The domain name.
freeformTags Map<String,String>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id String: The OCID of the domain.
isGovernanceEnabled Boolean
ownerId String: The OCID of the tenancy that has started the registration process for this domain.
state String: The lifecycle state of the resource.
status String: The status of the domain.
subscriptionEmail String
systemTags Map<String,String>: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: Date-time when this domain was created. An RFC 3339-formatted date and time string.
timeUpdated String: Date-time when this domain was last updated. An RFC 3339-formatted date and time string.
txtRecord String: The code that the owner of the domain will need to add as a TXT record to their domain.

compartmentId string: The ID of the compartment in which to list resources.
definedTags {[key: string]: string}: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
domainName string: The domain name.
freeformTags {[key: string]: string}: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id string: The OCID of the domain.
isGovernanceEnabled boolean
ownerId string: The OCID of the tenancy that has started the registration process for this domain.
state string: The lifecycle state of the resource.
status string: The status of the domain.
subscriptionEmail string
systemTags {[key: string]: string}: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated string: Date-time when this domain was created. An RFC 3339-formatted date and time string.
timeUpdated string: Date-time when this domain was last updated. An RFC 3339-formatted date and time string.
txtRecord string: The code that the owner of the domain will need to add as a TXT record to their domain.

compartment_id str: The ID of the compartment in which to list resources.
defined_tags Mapping[str, str]: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
domain_name str: The domain name.
freeform_tags Mapping[str, str]: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id str: The OCID of the domain.
is_governance_enabled bool
owner_id str: The OCID of the tenancy that has started the registration process for this domain.
state str: The lifecycle state of the resource.
status str: The status of the domain.
subscription_email str
system_tags Mapping[str, str]: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
time_created str: Date-time when this domain was created. An RFC 3339-formatted date and time string.
time_updated str: Date-time when this domain was last updated. An RFC 3339-formatted date and time string.
txt_record str: The code that the owner of the domain will need to add as a TXT record to their domain.

compartmentId String: The ID of the compartment in which to list resources.
definedTags Map<String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
domainName String: The domain name.
freeformTags Map<String>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id String: The OCID of the domain.
isGovernanceEnabled Boolean
ownerId String: The OCID of the tenancy that has started the registration process for this domain.
state String: The lifecycle state of the resource.
status String: The status of the domain.
subscriptionEmail String
systemTags Map<String>: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: Date-time when this domain was created. An RFC 3339-formatted date and time string.
timeUpdated String: Date-time when this domain was last updated. An RFC 3339-formatted date and time string.
txtRecord String: The code that the owner of the domain will need to add as a TXT record to their domain.

GetDomainsFilter

Name string: A filter to return only resources that exactly match the name given.
Values List<string>
Regex bool

Name string: A filter to return only resources that exactly match the name given.
Values []string
Regex bool

name String: A filter to return only resources that exactly match the name given.
values List<String>
regex Boolean

name string: A filter to return only resources that exactly match the name given.
values string[]
regex boolean

name str: A filter to return only resources that exactly match the name given.
values Sequence[str]
regex bool

name String: A filter to return only resources that exactly match the name given.
values List<String>
regex Boolean

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.

Oracle Cloud Infrastructure v3.10.0 published on Wednesday, Nov 5, 2025 by Pulumi

pulumi/pulumi-oci

oci.Tenantmanagercontrolplane.getDomains

On this page

On this page

Example Usage

Using getDomains

getDomains Result

Supporting Types

GetDomainsDomainCollection

GetDomainsDomainCollectionItem

GetDomainsFilter

Package Details

On this page

On this page