Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DatabaseManagement
  5. getExternalDbSystems
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

oci.DatabaseManagement.getExternalDbSystems

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

    This data source provides the list of External Db Systems in Oracle Cloud Infrastructure Database Management service.

    Lists the external DB systems in the specified compartment.

    Example Usage

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

const testExternalDbSystems = oci.DatabaseManagement.getExternalDbSystems({
    compartmentId: compartmentId,
    displayName: externalDbSystemDisplayName,
});

    import pulumi
import pulumi_oci as oci

test_external_db_systems = oci.DatabaseManagement.get_external_db_systems(compartment_id=compartment_id,
    display_name=external_db_system_display_name)

    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.GetExternalDbSystems(ctx, &databasemanagement.GetExternalDbSystemsArgs{
			CompartmentId: compartmentId,
			DisplayName:   pulumi.StringRef(externalDbSystemDisplayName),
		}, 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 testExternalDbSystems = Oci.DatabaseManagement.GetExternalDbSystems.Invoke(new()
    {
        CompartmentId = compartmentId,
        DisplayName = externalDbSystemDisplayName,
    });

});

    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.GetExternalDbSystemsArgs;
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 testExternalDbSystems = DatabaseManagementFunctions.getExternalDbSystems(GetExternalDbSystemsArgs.builder()
            .compartmentId(compartmentId)
            .displayName(externalDbSystemDisplayName)
            .build());

    }
}

    variables:
  testExternalDbSystems:
    fn::invoke:
      function: oci:DatabaseManagement:getExternalDbSystems
      arguments:
        compartmentId: ${compartmentId}
        displayName: ${externalDbSystemDisplayName}

    Using getExternalDbSystems

    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 getExternalDbSystems(args: GetExternalDbSystemsArgs, opts?: InvokeOptions): Promise<GetExternalDbSystemsResult>
function getExternalDbSystemsOutput(args: GetExternalDbSystemsOutputArgs, opts?: InvokeOptions): Output<GetExternalDbSystemsResult>
    def get_external_db_systems(compartment_id: Optional[str] = None,
                            display_name: Optional[str] = None,
                            filters: Optional[Sequence[GetExternalDbSystemsFilter]] = None,
                            opts: Optional[InvokeOptions] = None) -> GetExternalDbSystemsResult
def get_external_db_systems_output(compartment_id: Optional[pulumi.Input[str]] = None,
                            display_name: Optional[pulumi.Input[str]] = None,
                            filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetExternalDbSystemsFilterArgs]]]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetExternalDbSystemsResult]
    func GetExternalDbSystems(ctx *Context, args *GetExternalDbSystemsArgs, opts ...InvokeOption) (*GetExternalDbSystemsResult, error)
func GetExternalDbSystemsOutput(ctx *Context, args *GetExternalDbSystemsOutputArgs, opts ...InvokeOption) GetExternalDbSystemsResultOutput

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

    public static class GetExternalDbSystems 
{
    public static Task<GetExternalDbSystemsResult> InvokeAsync(GetExternalDbSystemsArgs args, InvokeOptions? opts = null)
    public static Output<GetExternalDbSystemsResult> Invoke(GetExternalDbSystemsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetExternalDbSystemsResult> getExternalDbSystems(GetExternalDbSystemsArgs args, InvokeOptions options)
public static Output<GetExternalDbSystemsResult> getExternalDbSystems(GetExternalDbSystemsArgs args, InvokeOptions options)

    fn::invoke:
  function: oci:DatabaseManagement/getExternalDbSystems:getExternalDbSystems
  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.
    Filters List<GetExternalDbSystemsFilter>
    CompartmentId string
    The OCID of the compartment.
    DisplayName string
    A filter to only return the resources that match the entire display name.
    Filters []GetExternalDbSystemsFilter
    compartmentId String
    The OCID of the compartment.
    displayName String
    A filter to only return the resources that match the entire display name.
    filters List<GetExternalDbSystemsFilter>
    compartmentId string
    The OCID of the compartment.
    displayName string
    A filter to only return the resources that match the entire display name.
    filters GetExternalDbSystemsFilter[]
    compartment_id str
    The OCID of the compartment.
    display_name str
    A filter to only return the resources that match the entire display name.
    filters Sequence[GetExternalDbSystemsFilter]
    compartmentId String
    The OCID of the compartment.
    displayName String
    A filter to only return the resources that match the entire display name.
    filters List<Property Map>

    getExternalDbSystems Result

    The following output properties are available:

    CompartmentId string
    The OCID of the compartment.
    ExternalDbSystemCollections List<GetExternalDbSystemsExternalDbSystemCollection>
    The list of external_db_system_collection.
    Id string
    The provider-assigned unique ID for this managed resource.
    DisplayName string
    The user-friendly name for the DB system. The name does not have to be unique.
    Filters List<GetExternalDbSystemsFilter>
    CompartmentId string
    The OCID of the compartment.
    ExternalDbSystemCollections []GetExternalDbSystemsExternalDbSystemCollection
    The list of external_db_system_collection.
    Id string
    The provider-assigned unique ID for this managed resource.
    DisplayName string
    The user-friendly name for the DB system. The name does not have to be unique.
    Filters []GetExternalDbSystemsFilter
    compartmentId String
    The OCID of the compartment.
    externalDbSystemCollections List<GetExternalDbSystemsExternalDbSystemCollection>
    The list of external_db_system_collection.
    id String
    The provider-assigned unique ID for this managed resource.
    displayName String
    The user-friendly name for the DB system. The name does not have to be unique.
    filters List<GetExternalDbSystemsFilter>
    compartmentId string
    The OCID of the compartment.
    externalDbSystemCollections GetExternalDbSystemsExternalDbSystemCollection[]
    The list of external_db_system_collection.
    id string
    The provider-assigned unique ID for this managed resource.
    displayName string
    The user-friendly name for the DB system. The name does not have to be unique.
    filters GetExternalDbSystemsFilter[]
    compartment_id str
    The OCID of the compartment.
    external_db_system_collections Sequence[GetExternalDbSystemsExternalDbSystemCollection]
    The list of external_db_system_collection.
    id str
    The provider-assigned unique ID for this managed resource.
    display_name str
    The user-friendly name for the DB system. The name does not have to be unique.
    filters Sequence[GetExternalDbSystemsFilter]
    compartmentId String
    The OCID of the compartment.
    externalDbSystemCollections List<Property Map>
    The list of external_db_system_collection.
    id String
    The provider-assigned unique ID for this managed resource.
    displayName String
    The user-friendly name for the DB system. The name does not have to be unique.
    filters List<Property Map>

    Supporting Types

    GetExternalDbSystemsExternalDbSystemCollection

    GetExternalDbSystemsExternalDbSystemCollectionItem

    CompartmentId string
    The OCID of the compartment.
    DatabaseManagementConfigs List<GetExternalDbSystemsExternalDbSystemCollectionItemDatabaseManagementConfig>
    The details required to enable Database Management for an external DB system.
    DbSystemDiscoveryId string
    The OCID of the DB system discovery.
    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"}
    DiscoveryAgentId string
    The OCID of the management agent used during the discovery of the DB system.
    DisplayName string
    A filter to only return the resources that match the entire display name.
    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 Oracle Grid home directory in case of cluster-based DB system and Oracle home directory in case of single instance-based DB system.
    Id string
    The OCID of the external DB system.
    IsCluster bool
    Indicates whether the DB system is a cluster DB system or not.
    LifecycleDetails string
    Additional information about the current lifecycle state.
    StackMonitoringConfigs List<GetExternalDbSystemsExternalDbSystemCollectionItemStackMonitoringConfig>
    The configuration details of Stack Monitoring for an external DB system.
    State string
    The current lifecycle state of the external DB system resource.
    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 system was created.
    TimeUpdated string
    The date and time the external DB system was last updated.
    CompartmentId string
    The OCID of the compartment.
    DatabaseManagementConfigs []GetExternalDbSystemsExternalDbSystemCollectionItemDatabaseManagementConfig
    The details required to enable Database Management for an external DB system.
    DbSystemDiscoveryId string
    The OCID of the DB system discovery.
    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"}
    DiscoveryAgentId string
    The OCID of the management agent used during the discovery of the DB system.
    DisplayName string
    A filter to only return the resources that match the entire display name.
    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 Oracle Grid home directory in case of cluster-based DB system and Oracle home directory in case of single instance-based DB system.
    Id string
    The OCID of the external DB system.
    IsCluster bool
    Indicates whether the DB system is a cluster DB system or not.
    LifecycleDetails string
    Additional information about the current lifecycle state.
    StackMonitoringConfigs []GetExternalDbSystemsExternalDbSystemCollectionItemStackMonitoringConfig
    The configuration details of Stack Monitoring for an external DB system.
    State string
    The current lifecycle state of the external DB system resource.
    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 system was created.
    TimeUpdated string
    The date and time the external DB system was last updated.
    compartmentId String
    The OCID of the compartment.
    databaseManagementConfigs List<GetExternalDbSystemsExternalDbSystemCollectionItemConfig>
    The details required to enable Database Management for an external DB system.
    dbSystemDiscoveryId String
    The OCID of the DB system discovery.
    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"}
    discoveryAgentId String
    The OCID of the management agent used during the discovery of the DB system.
    displayName String
    A filter to only return the resources that match the entire display name.
    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 Oracle Grid home directory in case of cluster-based DB system and Oracle home directory in case of single instance-based DB system.
    id String
    The OCID of the external DB system.
    isCluster Boolean
    Indicates whether the DB system is a cluster DB system or not.
    lifecycleDetails String
    Additional information about the current lifecycle state.
    stackMonitoringConfigs List<GetExternalDbSystemsExternalDbSystemCollectionItemStackMonitoringConfig>
    The configuration details of Stack Monitoring for an external DB system.
    state String
    The current lifecycle state of the external DB system resource.
    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 system was created.
    timeUpdated String
    The date and time the external DB system was last updated.
    compartmentId string
    The OCID of the compartment.
    databaseManagementConfigs GetExternalDbSystemsExternalDbSystemCollectionItemDatabaseManagementConfig[]
    The details required to enable Database Management for an external DB system.
    dbSystemDiscoveryId string
    The OCID of the DB system discovery.
    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"}
    discoveryAgentId string
    The OCID of the management agent used during the discovery of the DB system.
    displayName string
    A filter to only return the resources that match the entire display name.
    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 Oracle Grid home directory in case of cluster-based DB system and Oracle home directory in case of single instance-based DB system.
    id string
    The OCID of the external DB system.
    isCluster boolean
    Indicates whether the DB system is a cluster DB system or not.
    lifecycleDetails string
    Additional information about the current lifecycle state.
    stackMonitoringConfigs GetExternalDbSystemsExternalDbSystemCollectionItemStackMonitoringConfig[]
    The configuration details of Stack Monitoring for an external DB system.
    state string
    The current lifecycle state of the external DB system resource.
    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 system was created.
    timeUpdated string
    The date and time the external DB system was last updated.
    compartment_id str
    The OCID of the compartment.
    database_management_configs Sequence[GetExternalDbSystemsExternalDbSystemCollectionItemDatabaseManagementConfig]
    The details required to enable Database Management for an external DB system.
    db_system_discovery_id str
    The OCID of the DB system discovery.
    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"}
    discovery_agent_id str
    The OCID of the management agent used during the discovery of the DB system.
    display_name str
    A filter to only return the resources that match the entire display name.
    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 Oracle Grid home directory in case of cluster-based DB system and Oracle home directory in case of single instance-based DB system.
    id str
    The OCID of the external DB system.
    is_cluster bool
    Indicates whether the DB system is a cluster DB system or not.
    lifecycle_details str
    Additional information about the current lifecycle state.
    stack_monitoring_configs Sequence[GetExternalDbSystemsExternalDbSystemCollectionItemStackMonitoringConfig]
    The configuration details of Stack Monitoring for an external DB system.
    state str
    The current lifecycle state of the external DB system resource.
    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 system was created.
    time_updated str
    The date and time the external DB system was last updated.
    compartmentId String
    The OCID of the compartment.
    databaseManagementConfigs List<Property Map>
    The details required to enable Database Management for an external DB system.
    dbSystemDiscoveryId String
    The OCID of the DB system discovery.
    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"}
    discoveryAgentId String
    The OCID of the management agent used during the discovery of the DB system.
    displayName String
    A filter to only return the resources that match the entire display name.
    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 Oracle Grid home directory in case of cluster-based DB system and Oracle home directory in case of single instance-based DB system.
    id String
    The OCID of the external DB system.
    isCluster Boolean
    Indicates whether the DB system is a cluster DB system or not.
    lifecycleDetails String
    Additional information about the current lifecycle state.
    stackMonitoringConfigs List<Property Map>
    The configuration details of Stack Monitoring for an external DB system.
    state String
    The current lifecycle state of the external DB system resource.
    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 system was created.
    timeUpdated String
    The date and time the external DB system was last updated.

    GetExternalDbSystemsExternalDbSystemCollectionItemDatabaseManagementConfig

    LicenseModel string
    The Oracle license model that applies to the external database.
    LicenseModel string
    The Oracle license model that applies to the external database.
    licenseModel String
    The Oracle license model that applies to the external database.
    licenseModel string
    The Oracle license model that applies to the external database.
    license_model str
    The Oracle license model that applies to the external database.
    licenseModel String
    The Oracle license model that applies to the external database.

    GetExternalDbSystemsExternalDbSystemCollectionItemStackMonitoringConfig

    IsEnabled bool
    The status of the associated service.
    Metadata string
    The associated service-specific inputs in JSON string format, which Database Management can identify.
    IsEnabled bool
    The status of the associated service.
    Metadata string
    The associated service-specific inputs in JSON string format, which Database Management can identify.
    isEnabled Boolean
    The status of the associated service.
    metadata String
    The associated service-specific inputs in JSON string format, which Database Management can identify.
    isEnabled boolean
    The status of the associated service.
    metadata string
    The associated service-specific inputs in JSON string format, which Database Management can identify.
    is_enabled bool
    The status of the associated service.
    metadata str
    The associated service-specific inputs in JSON string format, which Database Management can identify.
    isEnabled Boolean
    The status of the associated service.
    metadata String
    The associated service-specific inputs in JSON string format, which Database Management can identify.

    GetExternalDbSystemsFilter

    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.
    oci logo
    Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
    pulumi/pulumi-oci