Oracle Cloud Infrastructure

v0.5.0 published on Monday, Sep 12, 2022 by Pulumi

getDomain

This data source provides details about a specific Domain resource in Oracle Cloud Infrastructure Identity service.

Get the specified domain’s information.

  • If the domain doesn’t exists, returns 404 NOT FOUND.
  • If any internal error occurs, returns 500 INTERNAL SERVER ERROR.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testDomain = Oci.Identity.GetDomain.Invoke(new()
    {
        DomainId = oci_identity_domain.Test_domain.Id,
    });

});
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.GetDomain(ctx, &identity.GetDomainArgs{
			DomainId: oci_identity_domain.Test_domain.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Identity.IdentityFunctions;
import com.pulumi.oci.Identity.inputs.GetDomainArgs;
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 testDomain = IdentityFunctions.getDomain(GetDomainArgs.builder()
            .domainId(oci_identity_domain.test_domain().id())
            .build());

    }
}
import pulumi
import pulumi_oci as oci

test_domain = oci.Identity.get_domain(domain_id=oci_identity_domain["test_domain"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testDomain = oci.Identity.getDomain({
    domainId: oci_identity_domain.test_domain.id,
});
variables:
  testDomain:
    Fn::Invoke:
      Function: oci:Identity:getDomain
      Arguments:
        domainId: ${oci_identity_domain.test_domain.id}

Using getDomain

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 getDomain(args: GetDomainArgs, opts?: InvokeOptions): Promise<GetDomainResult>
function getDomainOutput(args: GetDomainOutputArgs, opts?: InvokeOptions): Output<GetDomainResult>
def get_domain(domain_id: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetDomainResult
def get_domain_output(domain_id: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetDomainResult]
func GetDomain(ctx *Context, args *GetDomainArgs, opts ...InvokeOption) (*GetDomainResult, error)
func GetDomainOutput(ctx *Context, args *GetDomainOutputArgs, opts ...InvokeOption) GetDomainResultOutput

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

public static class GetDomain 
{
    public static Task<GetDomainResult> InvokeAsync(GetDomainArgs args, InvokeOptions? opts = null)
    public static Output<GetDomainResult> Invoke(GetDomainInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetDomainResult> getDomain(GetDomainArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: oci:Identity/getDomain:getDomain
  arguments:
    # arguments dictionary

The following arguments are supported:

DomainId string

The OCID of the domain

DomainId string

The OCID of the domain

domainId String

The OCID of the domain

domainId string

The OCID of the domain

domain_id str

The OCID of the domain

domainId String

The OCID of the domain

getDomain Result

The following output properties are available:

AdminEmail string
AdminFirstName string
AdminLastName string
AdminUserName string
CompartmentId string

The OCID of the compartment containing the domain.

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

DomainId string
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

Region specific domain URL.

Id string

The OCID of the domain

IsHiddenOnLogin bool

Indicates whether domain is hidden on login screen or not.

IsNotificationBypassed bool
IsPrimaryEmailRequired bool
LicenseType string

The License type of Domain

LifecycleDetails string

Any additional details about the current state of the Domain.

ReplicaRegions List<GetDomainReplicaRegion>

The regions domain is replication to.

State string

The current state.

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 type of the domain.

Url string

Region agnostic domain URL.

AdminEmail string
AdminFirstName string
AdminLastName string
AdminUserName string
CompartmentId string

The OCID of the compartment containing the domain.

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

DomainId string
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

Region specific domain URL.

Id string

The OCID of the domain

IsHiddenOnLogin bool

Indicates whether domain is hidden on login screen or not.

IsNotificationBypassed bool
IsPrimaryEmailRequired bool
LicenseType string

The License type of Domain

LifecycleDetails string

Any additional details about the current state of the Domain.

ReplicaRegions []GetDomainReplicaRegion

The regions domain is replication to.

State string

The current state.

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 type of the domain.

Url string

Region agnostic domain URL.

adminEmail String
adminFirstName String
adminLastName String
adminUserName String
compartmentId String

The OCID of the compartment containing the domain.

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

domainId String
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

Region specific domain URL.

id String

The OCID of the domain

isHiddenOnLogin Boolean

Indicates whether domain is hidden on login screen or not.

isNotificationBypassed Boolean
isPrimaryEmailRequired Boolean
licenseType String

The License type of Domain

lifecycleDetails String

Any additional details about the current state of the Domain.

replicaRegions List<GetDomainReplicaRegion>

The regions domain is replication to.

state String

The current state.

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 type of the domain.

url String

Region agnostic domain URL.

adminEmail string
adminFirstName string
adminLastName string
adminUserName string
compartmentId string

The OCID of the compartment containing the domain.

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

domainId string
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

Region specific domain URL.

id string

The OCID of the domain

isHiddenOnLogin boolean

Indicates whether domain is hidden on login screen or not.

isNotificationBypassed boolean
isPrimaryEmailRequired boolean
licenseType string

The License type of Domain

lifecycleDetails string

Any additional details about the current state of the Domain.

replicaRegions GetDomainReplicaRegion[]

The regions domain is replication to.

state string

The current state.

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 type of the domain.

url string

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 containing the domain.

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

domain_id str
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

Region specific domain URL.

id str

The OCID of the domain

is_hidden_on_login bool

Indicates whether domain is hidden on login screen or not.

is_notification_bypassed bool
is_primary_email_required bool
license_type str

The License type of Domain

lifecycle_details str

Any additional details about the current state of the Domain.

replica_regions GetDomainReplicaRegion]

The regions domain is replication to.

state str

The current state.

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 type of the domain.

url str

Region agnostic domain URL.

adminEmail String
adminFirstName String
adminLastName String
adminUserName String
compartmentId String

The OCID of the compartment containing the domain.

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

domainId String
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

Region specific domain URL.

id String

The OCID of the domain

isHiddenOnLogin Boolean

Indicates whether domain is hidden on login screen or not.

isNotificationBypassed Boolean
isPrimaryEmailRequired Boolean
licenseType String

The License type of Domain

lifecycleDetails String

Any additional details about the current state of the Domain.

replicaRegions List<Property Map>

The regions domain is replication to.

state String

The current state.

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 type of the domain.

url String

Region agnostic domain URL.

Supporting Types

GetDomainReplicaRegion

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

The current state.

Url string

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

The current state.

Url string

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

The current state.

url String

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

The current state.

url string

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

The current state.

url str

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

The current state.

url String

Region agnostic domain URL.

Package Details

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

This Pulumi package is based on the oci Terraform Provider.