Oracle Cloud Infrastructure v2.31.0, Apr 17 25

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

oci.DatabaseManagement.getExternalDbHomes

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const testExternalDbHomes = oci.DatabaseManagement.getExternalDbHomes({
    compartmentId: compartmentId,
    displayName: externalDbHomeDisplayName,
    externalDbSystemId: testExternalDbSystem.id,
});

import pulumi
import pulumi_oci as oci

test_external_db_homes = oci.DatabaseManagement.get_external_db_homes(compartment_id=compartment_id,
    display_name=external_db_home_display_name,
    external_db_system_id=test_external_db_system["id"])

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := databasemanagement.GetExternalDbHomes(ctx, &databasemanagement.GetExternalDbHomesArgs{
			CompartmentId:      pulumi.StringRef(compartmentId),
			DisplayName:        pulumi.StringRef(externalDbHomeDisplayName),
			ExternalDbSystemId: pulumi.StringRef(testExternalDbSystem.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 testExternalDbHomes = Oci.DatabaseManagement.GetExternalDbHomes.Invoke(new()
    {
        CompartmentId = compartmentId,
        DisplayName = externalDbHomeDisplayName,
        ExternalDbSystemId = testExternalDbSystem.Id,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DatabaseManagement.DatabaseManagementFunctions;
import com.pulumi.oci.DatabaseManagement.inputs.GetExternalDbHomesArgs;
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 testExternalDbHomes = DatabaseManagementFunctions.getExternalDbHomes(GetExternalDbHomesArgs.builder()
            .compartmentId(compartmentId)
            .displayName(externalDbHomeDisplayName)
            .externalDbSystemId(testExternalDbSystem.id())
            .build());

    }
}

variables:
  testExternalDbHomes:
    fn::invoke:
      function: oci:DatabaseManagement:getExternalDbHomes
      arguments:
        compartmentId: ${compartmentId}
        displayName: ${externalDbHomeDisplayName}
        externalDbSystemId: ${testExternalDbSystem.id}

Using getExternalDbHomes

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.

TypeScript
Python
Go
C#
Java
YAML

function getExternalDbHomes(args: GetExternalDbHomesArgs, opts?: InvokeOptions): Promise<GetExternalDbHomesResult>
function getExternalDbHomesOutput(args: GetExternalDbHomesOutputArgs, opts?: InvokeOptions): Output<GetExternalDbHomesResult>

def get_external_db_homes(compartment_id: Optional[str] = None,
                          display_name: Optional[str] = None,
                          external_db_system_id: Optional[str] = None,
                          filters: Optional[Sequence[_databasemanagement.GetExternalDbHomesFilter]] = None,
                          opts: Optional[InvokeOptions] = None) -> GetExternalDbHomesResult
def get_external_db_homes_output(compartment_id: Optional[pulumi.Input[str]] = None,
                          display_name: Optional[pulumi.Input[str]] = None,
                          external_db_system_id: Optional[pulumi.Input[str]] = None,
                          filters: Optional[pulumi.Input[Sequence[pulumi.Input[_databasemanagement.GetExternalDbHomesFilterArgs]]]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetExternalDbHomesResult]

func GetExternalDbHomes(ctx *Context, args *GetExternalDbHomesArgs, opts ...InvokeOption) (*GetExternalDbHomesResult, error)
func GetExternalDbHomesOutput(ctx *Context, args *GetExternalDbHomesOutputArgs, opts ...InvokeOption) GetExternalDbHomesResultOutput

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

public static class GetExternalDbHomes 
{
    public static Task<GetExternalDbHomesResult> InvokeAsync(GetExternalDbHomesArgs args, InvokeOptions? opts = null)
    public static Output<GetExternalDbHomesResult> Invoke(GetExternalDbHomesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetExternalDbHomesResult> getExternalDbHomes(GetExternalDbHomesArgs args, InvokeOptions options)
public static Output<GetExternalDbHomesResult> getExternalDbHomes(GetExternalDbHomesArgs args, InvokeOptions options)

fn::invoke:
  function: oci:DatabaseManagement/getExternalDbHomes:getExternalDbHomes
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string: The OCID of the compartment.
DisplayName string: A filter to only return the resources that match the entire display name.
ExternalDbSystemId string: The OCID of the external DB system.
Filters List<GetExternalDbHomesFilter>

CompartmentId string: The OCID of the compartment.
DisplayName string: A filter to only return the resources that match the entire display name.
ExternalDbSystemId string: The OCID of the external DB system.
Filters []GetExternalDbHomesFilter

compartmentId String: The OCID of the compartment.
displayName String: A filter to only return the resources that match the entire display name.
externalDbSystemId String: The OCID of the external DB system.
filters List<GetExternalDbHomesFilter>

compartmentId string: The OCID of the compartment.
displayName string: A filter to only return the resources that match the entire display name.
externalDbSystemId string: The OCID of the external DB system.
filters GetExternalDbHomesFilter[]

compartment_id str: The OCID of the compartment.
display_name str: A filter to only return the resources that match the entire display name.
external_db_system_id str: The OCID of the external DB system.
filters Sequence[databasemanagement.GetExternalDbHomesFilter]

compartmentId String: The OCID of the compartment.
displayName String: A filter to only return the resources that match the entire display name.
externalDbSystemId String: The OCID of the external DB system.
filters List<Property Map>

getExternalDbHomes Result

The following output properties are available:

ExternalDbHomeCollections List<GetExternalDbHomesExternalDbHomeCollection>: The list of external_db_home_collection.
Id string: The provider-assigned unique ID for this managed resource.
CompartmentId string: The OCID of the compartment.
DisplayName string: The user-friendly name for the external DB home. The name does not have to be unique.
ExternalDbSystemId string: The OCID of the external DB system that the DB home is a part of.
Filters List<GetExternalDbHomesFilter>

ExternalDbHomeCollections []GetExternalDbHomesExternalDbHomeCollection: The list of external_db_home_collection.
Id string: The provider-assigned unique ID for this managed resource.
CompartmentId string: The OCID of the compartment.
DisplayName string: The user-friendly name for the external DB home. The name does not have to be unique.
ExternalDbSystemId string: The OCID of the external DB system that the DB home is a part of.
Filters []GetExternalDbHomesFilter

externalDbHomeCollections List<GetExternalDbHomesExternalDbHomeCollection>: The list of external_db_home_collection.
id String: The provider-assigned unique ID for this managed resource.
compartmentId String: The OCID of the compartment.
displayName String: The user-friendly name for the external DB home. The name does not have to be unique.
externalDbSystemId String: The OCID of the external DB system that the DB home is a part of.
filters List<GetExternalDbHomesFilter>

externalDbHomeCollections GetExternalDbHomesExternalDbHomeCollection[]: The list of external_db_home_collection.
id string: The provider-assigned unique ID for this managed resource.
compartmentId string: The OCID of the compartment.
displayName string: The user-friendly name for the external DB home. The name does not have to be unique.
externalDbSystemId string: The OCID of the external DB system that the DB home is a part of.
filters GetExternalDbHomesFilter[]

external_db_home_collections Sequence[databasemanagement.GetExternalDbHomesExternalDbHomeCollection]: The list of external_db_home_collection.
id str: The provider-assigned unique ID for this managed resource.
compartment_id str: The OCID of the compartment.
display_name str: The user-friendly name for the external DB home. The name does not have to be unique.
external_db_system_id str: The OCID of the external DB system that the DB home is a part of.
filters Sequence[databasemanagement.GetExternalDbHomesFilter]

externalDbHomeCollections List<Property Map>: The list of external_db_home_collection.
id String: The provider-assigned unique ID for this managed resource.
compartmentId String: The OCID of the compartment.
displayName String: The user-friendly name for the external DB home. The name does not have to be unique.
externalDbSystemId String: The OCID of the external DB system that the DB home is a part of.
filters List<Property Map>

Supporting Types

GetExternalDbHomesExternalDbHomeCollection

Items List<GetExternalDbHomesExternalDbHomeCollectionItem>

Items []GetExternalDbHomesExternalDbHomeCollectionItem

items List<GetExternalDbHomesExternalDbHomeCollectionItem>

items GetExternalDbHomesExternalDbHomeCollectionItem[]

items Sequence[databasemanagement.GetExternalDbHomesExternalDbHomeCollectionItem]

items List<Property Map>

GetExternalDbHomesExternalDbHomeCollectionItem

AdditionalDetails Dictionary<string, string>: The additional details of the DB home defined in {"key": "value"} format. Example: {"bar-key": "value"}
CompartmentId string: The OCID of the compartment.
ComponentName string: The name of the external DB home.
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"}
DisplayName string: A filter to only return the resources that match the entire display name.
ExternalDbHomeId string
ExternalDbSystemId string: The OCID of the external DB system.
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"}
HomeDirectory string: The location of the DB home.
Id string: The OCID of the external DB home.
LifecycleDetails string: Additional information about the current lifecycle state.
State string: The current lifecycle state of the external DB home.
SystemTags Dictionary<string, string>: System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: The date and time the external DB home was created.
TimeUpdated string: The date and time the external DB home was last updated.

AdditionalDetails map[string]string: The additional details of the DB home defined in {"key": "value"} format. Example: {"bar-key": "value"}
CompartmentId string: The OCID of the compartment.
ComponentName string: The name of the external DB home.
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"}
DisplayName string: A filter to only return the resources that match the entire display name.
ExternalDbHomeId string
ExternalDbSystemId string: The OCID of the external DB system.
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"}
HomeDirectory string: The location of the DB home.
Id string: The OCID of the external DB home.
LifecycleDetails string: Additional information about the current lifecycle state.
State string: The current lifecycle state of the external DB home.
SystemTags map[string]string: System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: The date and time the external DB home was created.
TimeUpdated string: The date and time the external DB home was last updated.

additionalDetails Map<String,String>: The additional details of the DB home defined in {"key": "value"} format. Example: {"bar-key": "value"}
compartmentId String: The OCID of the compartment.
componentName String: The name of the external DB home.
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"}
displayName String: A filter to only return the resources that match the entire display name.
externalDbHomeId String
externalDbSystemId String: The OCID of the external DB system.
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"}
homeDirectory String: The location of the DB home.
id String: The OCID of the external DB home.
lifecycleDetails String: Additional information about the current lifecycle state.
state String: The current lifecycle state of the external DB home.
systemTags Map<String,String>: System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: The date and time the external DB home was created.
timeUpdated String: The date and time the external DB home was last updated.

additionalDetails {[key: string]: string}: The additional details of the DB home defined in {"key": "value"} format. Example: {"bar-key": "value"}
compartmentId string: The OCID of the compartment.
componentName string: The name of the external DB home.
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"}
displayName string: A filter to only return the resources that match the entire display name.
externalDbHomeId string
externalDbSystemId string: The OCID of the external DB system.
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"}
homeDirectory string: The location of the DB home.
id string: The OCID of the external DB home.
lifecycleDetails string: Additional information about the current lifecycle state.
state string: The current lifecycle state of the external DB home.
systemTags {[key: string]: string}: System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated string: The date and time the external DB home was created.
timeUpdated string: The date and time the external DB home was last updated.

additional_details Mapping[str, str]: The additional details of the DB home defined in {"key": "value"} format. Example: {"bar-key": "value"}
compartment_id str: The OCID of the compartment.
component_name str: The name of the external DB home.
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"}
display_name str: A filter to only return the resources that match the entire display name.
external_db_home_id str
external_db_system_id str: The OCID of the external DB system.
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"}
home_directory str: The location of the DB home.
id str: The OCID of the external DB home.
lifecycle_details str: Additional information about the current lifecycle state.
state str: The current lifecycle state of the external DB home.
system_tags Mapping[str, str]: System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
time_created str: The date and time the external DB home was created.
time_updated str: The date and time the external DB home was last updated.

additionalDetails Map<String>: The additional details of the DB home defined in {"key": "value"} format. Example: {"bar-key": "value"}
compartmentId String: The OCID of the compartment.
componentName String: The name of the external DB home.
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"}
displayName String: A filter to only return the resources that match the entire display name.
externalDbHomeId String
externalDbSystemId String: The OCID of the external DB system.
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"}
homeDirectory String: The location of the DB home.
id String: The OCID of the external DB home.
lifecycleDetails String: Additional information about the current lifecycle state.
state String: The current lifecycle state of the external DB home.
systemTags Map<String>: System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: The date and time the external DB home was created.
timeUpdated String: The date and time the external DB home was last updated.

GetExternalDbHomesFilter

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

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 v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

pulumi/pulumi-oci

oci.DatabaseManagement.getExternalDbHomes

On this page

On this page

Example Usage

Using getExternalDbHomes

getExternalDbHomes Result

Supporting Types

GetExternalDbHomesExternalDbHomeCollection

GetExternalDbHomesExternalDbHomeCollectionItem

GetExternalDbHomesFilter

Package Details

On this page

On this page