Oracle Cloud Infrastructure

Pulumi Official
Package maintained by Pulumi
v0.1.1 published on Tuesday, May 3, 2022 by Pulumi

getDomains

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

List all domains that are homed or have a replica region in current region.

  • If any internal error occurs, return 500 INTERNAL SERVER ERROR.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testDomains = Output.Create(Oci.Identity.GetDomains.InvokeAsync(new Oci.Identity.GetDomainsArgs
        {
            CompartmentId = @var.Compartment_id,
            DisplayName = @var.Domain_display_name,
            HomeRegionUrl = @var.Domain_home_region_url,
            IsHiddenOnLogin = @var.Domain_is_hidden_on_login,
            LicenseType = @var.Domain_license_type,
            Name = @var.Domain_name,
            State = @var.Domain_state,
            Type = @var.Domain_type,
            Url = @var.Domain_url,
        }));
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Identity.GetDomains(ctx, &identity.GetDomainsArgs{
			CompartmentId:   _var.Compartment_id,
			DisplayName:     pulumi.StringRef(_var.Domain_display_name),
			HomeRegionUrl:   pulumi.StringRef(_var.Domain_home_region_url),
			IsHiddenOnLogin: pulumi.BoolRef(_var.Domain_is_hidden_on_login),
			LicenseType:     pulumi.StringRef(_var.Domain_license_type),
			Name:            pulumi.StringRef(_var.Domain_name),
			State:           pulumi.StringRef(_var.Domain_state),
			Type:            pulumi.StringRef(_var.Domain_type),
			Url:             pulumi.StringRef(_var.Domain_url),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_domains = oci.Identity.get_domains(compartment_id=var["compartment_id"],
    display_name=var["domain_display_name"],
    home_region_url=var["domain_home_region_url"],
    is_hidden_on_login=var["domain_is_hidden_on_login"],
    license_type=var["domain_license_type"],
    name=var["domain_name"],
    state=var["domain_state"],
    type=var["domain_type"],
    url=var["domain_url"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testDomains = oci.Identity.getDomains({
    compartmentId: _var.compartment_id,
    displayName: _var.domain_display_name,
    homeRegionUrl: _var.domain_home_region_url,
    isHiddenOnLogin: _var.domain_is_hidden_on_login,
    licenseType: _var.domain_license_type,
    name: _var.domain_name,
    state: _var.domain_state,
    type: _var.domain_type,
    url: _var.domain_url,
});

Coming soon!

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,
                display_name: Optional[str] = None,
                filters: Optional[Sequence[_identity.GetDomainsFilter]] = None,
                home_region_url: Optional[str] = None,
                is_hidden_on_login: Optional[bool] = None,
                license_type: Optional[str] = None,
                name: Optional[str] = None,
                state: Optional[str] = None,
                type: Optional[str] = None,
                url: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetDomainsResult
def get_domains_output(compartment_id: Optional[pulumi.Input[str]] = None,
                display_name: Optional[pulumi.Input[str]] = None,
                filters: Optional[pulumi.Input[Sequence[pulumi.Input[_identity.GetDomainsFilterArgs]]]] = None,
                home_region_url: Optional[pulumi.Input[str]] = None,
                is_hidden_on_login: Optional[pulumi.Input[bool]] = None,
                license_type: Optional[pulumi.Input[str]] = None,
                name: Optional[pulumi.Input[str]] = None,
                state: Optional[pulumi.Input[str]] = None,
                type: Optional[pulumi.Input[str]] = None,
                url: 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)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: oci:Identity/getDomains:getDomains
  Arguments:
    # Arguments dictionary

The following arguments are supported:

CompartmentId string

The OCID of the compartment (remember that the tenancy is simply the root compartment).

DisplayName string

The mutable display name of the domain

Filters List<GetDomainsFilter>
HomeRegionUrl string

The region specific domain URL

IsHiddenOnLogin bool

Indicate if the domain is visible at login screen or not

LicenseType string

The domain license type

Name string

A filter to only return resources that match the given name exactly.

State string

A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

Type string

The domain type

Url string

The region agnostic domain URL

CompartmentId string

The OCID of the compartment (remember that the tenancy is simply the root compartment).

DisplayName string

The mutable display name of the domain

Filters []GetDomainsFilter
HomeRegionUrl string

The region specific domain URL

IsHiddenOnLogin bool

Indicate if the domain is visible at login screen or not

LicenseType string

The domain license type

Name string

A filter to only return resources that match the given name exactly.

State string

A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

Type string

The domain type

Url string

The region agnostic domain URL

compartmentId String

The OCID of the compartment (remember that the tenancy is simply the root compartment).

displayName String

The mutable display name of the domain

filters List<GetDomainsFilter>
homeRegionUrl String

The region specific domain URL

isHiddenOnLogin Boolean

Indicate if the domain is visible at login screen or not

licenseType String

The domain license type

name String

A filter to only return resources that match the given name exactly.

state String

A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

type String

The domain type

url String

The region agnostic domain URL

compartmentId string

The OCID of the compartment (remember that the tenancy is simply the root compartment).

displayName string

The mutable display name of the domain

filters GetDomainsFilter[]
homeRegionUrl string

The region specific domain URL

isHiddenOnLogin boolean

Indicate if the domain is visible at login screen or not

licenseType string

The domain license type

name string

A filter to only return resources that match the given name exactly.

state string

A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

type string

The domain type

url string

The region agnostic domain URL

compartment_id str

The OCID of the compartment (remember that the tenancy is simply the root compartment).

display_name str

The mutable display name of the domain

filters GetDomainsFilter]
home_region_url str

The region specific domain URL

is_hidden_on_login bool

Indicate if the domain is visible at login screen or not

license_type str

The domain license type

name str

A filter to only return resources that match the given name exactly.

state str

A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

type str

The domain type

url str

The region agnostic domain URL

compartmentId String

The OCID of the compartment (remember that the tenancy is simply the root compartment).

displayName String

The mutable display name of the domain

filters List<Property Map>
homeRegionUrl String

The region specific domain URL

isHiddenOnLogin Boolean

Indicate if the domain is visible at login screen or not

licenseType String

The domain license type

name String

A filter to only return resources that match the given name exactly.

state String

A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

type String

The domain type

url String

The region agnostic domain URL

getDomains Result

The following output properties are available:

CompartmentId string

The OCID of the compartment containing the domain.

Domains List<GetDomainsDomain>

The list of domains.

Id string

The provider-assigned unique ID for this managed resource.

DisplayName string

The mutable display name of the domain

Filters List<GetDomainsFilter>
HomeRegionUrl string

Region specific domain URL.

IsHiddenOnLogin bool

Indicates whether domain is hidden on login screen or not.

LicenseType string

The License type of Domain

Name string
State string

The current state.

Type string

The type of the domain.

Url string

Region agnostic domain URL.

CompartmentId string

The OCID of the compartment containing the domain.

Domains []GetDomainsDomain

The list of domains.

Id string

The provider-assigned unique ID for this managed resource.

DisplayName string

The mutable display name of the domain

Filters []GetDomainsFilter
HomeRegionUrl string

Region specific domain URL.

IsHiddenOnLogin bool

Indicates whether domain is hidden on login screen or not.

LicenseType string

The License type of Domain

Name string
State string

The current state.

Type string

The type of the domain.

Url string

Region agnostic domain URL.

compartmentId String

The OCID of the compartment containing the domain.

domains List<GetDomainsDomain>

The list of domains.

id String

The provider-assigned unique ID for this managed resource.

displayName String

The mutable display name of the domain

filters List<GetDomainsFilter>
homeRegionUrl String

Region specific domain URL.

isHiddenOnLogin Boolean

Indicates whether domain is hidden on login screen or not.

licenseType String

The License type of Domain

name String
state String

The current state.

type String

The type of the domain.

url String

Region agnostic domain URL.

compartmentId string

The OCID of the compartment containing the domain.

domains GetDomainsDomain[]

The list of domains.

id string

The provider-assigned unique ID for this managed resource.

displayName string

The mutable display name of the domain

filters GetDomainsFilter[]
homeRegionUrl string

Region specific domain URL.

isHiddenOnLogin boolean

Indicates whether domain is hidden on login screen or not.

licenseType string

The License type of Domain

name string
state string

The current state.

type string

The type of the domain.

url string

Region agnostic domain URL.

compartment_id str

The OCID of the compartment containing the domain.

domains GetDomainsDomain]

The list of domains.

id str

The provider-assigned unique ID for this managed resource.

display_name str

The mutable display name of the domain

filters GetDomainsFilter]
home_region_url str

Region specific domain URL.

is_hidden_on_login bool

Indicates whether domain is hidden on login screen or not.

license_type str

The License type of Domain

name str
state str

The current state.

type str

The type of the domain.

url str

Region agnostic domain URL.

compartmentId String

The OCID of the compartment containing the domain.

domains List<Property Map>

The list of domains.

id String

The provider-assigned unique ID for this managed resource.

displayName String

The mutable display name of the domain

filters List<Property Map>
homeRegionUrl String

Region specific domain URL.

isHiddenOnLogin Boolean

Indicates whether domain is hidden on login screen or not.

licenseType String

The License type of Domain

name String
state String

The current state.

type String

The type of the domain.

url String

Region agnostic domain URL.

Supporting Types

GetDomainsDomain

AdminEmail string
AdminFirstName string
AdminLastName string
AdminUserName string
CompartmentId string

The OCID of the compartment (remember that the tenancy is simply the root compartment).

DefinedTags Dictionary<string, object>

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

The domain descripition

DisplayName string

The mutable display name of the domain

FreeformTags Dictionary<string, object>

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"}

HomeRegion string

The home region for the domain. See Regions and Availability Domains for the full list of supported region names. Example: us-phoenix-1

HomeRegionUrl string

The region specific domain URL

Id string

The OCID of the domain

IsHiddenOnLogin bool

Indicate if the domain is visible at login screen or not

IsNotificationBypassed bool
IsPrimaryEmailRequired bool
LicenseType string

The domain license type

LifecycleDetails string

Any additional details about the current state of the Domain.

ReplicaRegions List<GetDomainsDomainReplicaRegion>

The regions domain is replication to.

State string

A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

TimeCreated string

Date and time the domain was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

Type string

The domain type

Url string

The region agnostic domain URL

AdminEmail string
AdminFirstName string
AdminLastName string
AdminUserName string
CompartmentId string

The OCID of the compartment (remember that the tenancy is simply the root compartment).

DefinedTags map[string]interface{}

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

The domain descripition

DisplayName string

The mutable display name of the domain

FreeformTags map[string]interface{}

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"}

HomeRegion string

The home region for the domain. See Regions and Availability Domains for the full list of supported region names. Example: us-phoenix-1

HomeRegionUrl string

The region specific domain URL

Id string

The OCID of the domain

IsHiddenOnLogin bool

Indicate if the domain is visible at login screen or not

IsNotificationBypassed bool
IsPrimaryEmailRequired bool
LicenseType string

The domain license type

LifecycleDetails string

Any additional details about the current state of the Domain.

ReplicaRegions []GetDomainsDomainReplicaRegion

The regions domain is replication to.

State string

A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

TimeCreated string

Date and time the domain was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

Type string

The domain type

Url string

The region agnostic domain URL

adminEmail String
adminFirstName String
adminLastName String
adminUserName String
compartmentId String

The OCID of the compartment (remember that the tenancy is simply the root compartment).

definedTags Map<String,Object>

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

The domain descripition

displayName String

The mutable display name of the domain

freeformTags Map<String,Object>

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"}

homeRegion String

The home region for the domain. See Regions and Availability Domains for the full list of supported region names. Example: us-phoenix-1

homeRegionUrl String

The region specific domain URL

id String

The OCID of the domain

isHiddenOnLogin Boolean

Indicate if the domain is visible at login screen or not

isNotificationBypassed Boolean
isPrimaryEmailRequired Boolean
licenseType String

The domain license type

lifecycleDetails String

Any additional details about the current state of the Domain.

replicaRegions List<GetDomainsDomainReplicaRegion>

The regions domain is replication to.

state String

A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

timeCreated String

Date and time the domain was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

type String

The domain type

url String

The region agnostic domain URL

adminEmail string
adminFirstName string
adminLastName string
adminUserName string
compartmentId string

The OCID of the compartment (remember that the tenancy is simply the root compartment).

definedTags {[key: string]: any}

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

The domain descripition

displayName string

The mutable display name of the domain

freeformTags {[key: string]: any}

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"}

homeRegion string

The home region for the domain. See Regions and Availability Domains for the full list of supported region names. Example: us-phoenix-1

homeRegionUrl string

The region specific domain URL

id string

The OCID of the domain

isHiddenOnLogin boolean

Indicate if the domain is visible at login screen or not

isNotificationBypassed boolean
isPrimaryEmailRequired boolean
licenseType string

The domain license type

lifecycleDetails string

Any additional details about the current state of the Domain.

replicaRegions GetDomainsDomainReplicaRegion[]

The regions domain is replication to.

state string

A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

timeCreated string

Date and time the domain was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

type string

The domain type

url string

The region agnostic domain URL

admin_email str
admin_first_name str
admin_last_name str
admin_user_name str
compartment_id str

The OCID of the compartment (remember that the tenancy is simply the root compartment).

defined_tags Mapping[str, Any]

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

The domain descripition

display_name str

The mutable display name of the domain

freeform_tags Mapping[str, Any]

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"}

home_region str

The home region for the domain. See Regions and Availability Domains for the full list of supported region names. Example: us-phoenix-1

home_region_url str

The region specific domain URL

id str

The OCID of the domain

is_hidden_on_login bool

Indicate if the domain is visible at login screen or not

is_notification_bypassed bool
is_primary_email_required bool
license_type str

The domain license type

lifecycle_details str

Any additional details about the current state of the Domain.

replica_regions GetDomainsDomainReplicaRegion]

The regions domain is replication to.

state str

A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

time_created str

Date and time the domain was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

type str

The domain type

url str

The region agnostic domain URL

adminEmail String
adminFirstName String
adminLastName String
adminUserName String
compartmentId String

The OCID of the compartment (remember that the tenancy is simply the root compartment).

definedTags Map<Any>

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

The domain descripition

displayName String

The mutable display name of the domain

freeformTags Map<Any>

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"}

homeRegion String

The home region for the domain. See Regions and Availability Domains for the full list of supported region names. Example: us-phoenix-1

homeRegionUrl String

The region specific domain URL

id String

The OCID of the domain

isHiddenOnLogin Boolean

Indicate if the domain is visible at login screen or not

isNotificationBypassed Boolean
isPrimaryEmailRequired Boolean
licenseType String

The domain license type

lifecycleDetails String

Any additional details about the current state of the Domain.

replicaRegions List<Property Map>

The regions domain is replication to.

state String

A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

timeCreated String

Date and time the domain was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

type String

The domain type

url String

The region agnostic domain URL

GetDomainsDomainReplicaRegion

Region string

A REPLICATION_ENABLED region, e.g. us-ashburn-1. See Regions and Availability Domains for the full list of supported region names.

State string

A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

Url string

The region agnostic domain URL

Region string

A REPLICATION_ENABLED region, e.g. us-ashburn-1. See Regions and Availability Domains for the full list of supported region names.

State string

A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

Url string

The region agnostic domain URL

region String

A REPLICATION_ENABLED region, e.g. us-ashburn-1. See Regions and Availability Domains for the full list of supported region names.

state String

A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

url String

The region agnostic domain URL

region string

A REPLICATION_ENABLED region, e.g. us-ashburn-1. See Regions and Availability Domains for the full list of supported region names.

state string

A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

url string

The region agnostic domain URL

region str

A REPLICATION_ENABLED region, e.g. us-ashburn-1. See Regions and Availability Domains for the full list of supported region names.

state str

A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

url str

The region agnostic domain URL

region String

A REPLICATION_ENABLED region, e.g. us-ashburn-1. See Regions and Availability Domains for the full list of supported region names.

state String

A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

url String

The region agnostic domain URL

GetDomainsFilter

Name string

A filter to only return resources that match the given name exactly.

Values List<string>
Regex bool
Name string

A filter to only return resources that match the given name exactly.

Values []string
Regex bool
name String

A filter to only return resources that match the given name exactly.

values List<String>
regex Boolean
name string

A filter to only return resources that match the given name exactly.

values string[]
regex boolean
name str

A filter to only return resources that match the given name exactly.

values Sequence[str]
regex bool
name String

A filter to only return resources that match the given name exactly.

values List<String>
regex Boolean

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.