Oracle Cloud Infrastructure v2.15.0 published on Thursday, Oct 31, 2024 by Pulumi
oci.Identity.getDomain
Explore with Pulumi AI
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
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testDomain = oci.Identity.getDomain({
domainId: testDomainOciIdentityDomain.id,
});
import pulumi
import pulumi_oci as oci
test_domain = oci.Identity.get_domain(domain_id=test_domain_oci_identity_domain["id"])
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v2/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: testDomainOciIdentityDomain.Id,
}, 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 testDomain = Oci.Identity.GetDomain.Invoke(new()
{
DomainId = testDomainOciIdentityDomain.Id,
});
});
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(testDomainOciIdentityDomain.id())
.build());
}
}
variables:
testDomain:
fn::invoke:
Function: oci:Identity:getDomain
Arguments:
domainId: ${testDomainOciIdentityDomain.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:
- Domain
Id string - The OCID of the domain
- Domain
Id string - The OCID of the domain
- domain
Id String - The OCID of the domain
- domain
Id string - The OCID of the domain
- domain_
id str - The OCID of the domain
- domain
Id String - The OCID of the domain
getDomain Result
The following output properties are available:
- Admin
Email string - Admin
First stringName - Admin
Last stringName - Admin
User stringName - Compartment
Id string - The OCID of the compartment containing the domain.
- 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
- The domain descripition
- Display
Name string - The mutable display name of the domain
- Domain
Id string - 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"}
- Home
Region string - 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 stringUrl - Region specific domain URL.
- Id string
- The OCID of the domain
- bool
- Indicates whether domain is hidden on login screen or not.
- Is
Notification boolBypassed - Is
Primary boolEmail Required - License
Type string - The License type of Domain
- Lifecycle
Details string - Any additional details about the current state of the Domain.
- Replica
Regions List<GetDomain Replica Region> - The regions domain is replication to.
- State string
- The current state.
- Time
Created 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 string - Admin
First stringName - Admin
Last stringName - Admin
User stringName - Compartment
Id string - The OCID of the compartment containing the domain.
- 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
- The domain descripition
- Display
Name string - The mutable display name of the domain
- Domain
Id string - 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"}
- Home
Region string - 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 stringUrl - Region specific domain URL.
- Id string
- The OCID of the domain
- bool
- Indicates whether domain is hidden on login screen or not.
- Is
Notification boolBypassed - Is
Primary boolEmail Required - License
Type string - The License type of Domain
- Lifecycle
Details string - Any additional details about the current state of the Domain.
- Replica
Regions []GetDomain Replica Region - The regions domain is replication to.
- State string
- The current state.
- Time
Created 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 String - admin
First StringName - admin
Last StringName - admin
User StringName - compartment
Id String - The OCID of the compartment containing the domain.
- 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
- The domain descripition
- display
Name String - The mutable display name of the domain
- domain
Id String - 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"}
- home
Region String - 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 StringUrl - Region specific domain URL.
- id String
- The OCID of the domain
- Boolean
- Indicates whether domain is hidden on login screen or not.
- is
Notification BooleanBypassed - is
Primary BooleanEmail Required - license
Type String - The License type of Domain
- lifecycle
Details String - Any additional details about the current state of the Domain.
- replica
Regions List<GetDomain Replica Region> - The regions domain is replication to.
- state String
- The current state.
- time
Created 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 string - admin
First stringName - admin
Last stringName - admin
User stringName - compartment
Id string - The OCID of the compartment containing the domain.
- {[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
- The domain descripition
- display
Name string - The mutable display name of the domain
- domain
Id string - {[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"}
- home
Region string - 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 stringUrl - Region specific domain URL.
- id string
- The OCID of the domain
- boolean
- Indicates whether domain is hidden on login screen or not.
- is
Notification booleanBypassed - is
Primary booleanEmail Required - license
Type string - The License type of Domain
- lifecycle
Details string - Any additional details about the current state of the Domain.
- replica
Regions GetDomain Replica Region[] - The regions domain is replication to.
- state string
- The current state.
- time
Created 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_ strname - admin_
last_ strname - admin_
user_ strname - compartment_
id str - The OCID of the compartment containing the domain.
- 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
- The domain descripition
- display_
name str - The mutable display name of the domain
- domain_
id str - 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"}
- 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_ strurl - Region specific domain URL.
- id str
- The OCID of the domain
- bool
- Indicates whether domain is hidden on login screen or not.
- is_
notification_ boolbypassed - is_
primary_ boolemail_ required - license_
type str - The License type of Domain
- lifecycle_
details str - Any additional details about the current state of the Domain.
- replica_
regions Sequence[identity.Get Domain Replica Region] - 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.
- admin
Email String - admin
First StringName - admin
Last StringName - admin
User StringName - compartment
Id String - The OCID of the compartment containing the domain.
- 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
- The domain descripition
- display
Name String - The mutable display name of the domain
- domain
Id String - 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"}
- home
Region String - 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 StringUrl - Region specific domain URL.
- id String
- The OCID of the domain
- Boolean
- Indicates whether domain is hidden on login screen or not.
- is
Notification BooleanBypassed - is
Primary BooleanEmail Required - license
Type String - The License type of Domain
- lifecycle
Details String - Any additional details about the current state of the Domain.
- replica
Regions List<Property Map> - The regions domain is replication to.
- state String
- The current state.
- time
Created 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
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.