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

oci.DatabaseManagement.getExternalAsms

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 Asms in Oracle Cloud Infrastructure Database Management service.

    Lists the ASMs in the specified external DB system.

    Example Usage

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

const testExternalAsms = oci.DatabaseManagement.getExternalAsms({
    compartmentId: compartmentId,
    displayName: externalAsmDisplayName,
    externalDbSystemId: testExternalDbSystem.id,
});

    import pulumi
import pulumi_oci as oci

test_external_asms = oci.DatabaseManagement.get_external_asms(compartment_id=compartment_id,
    display_name=external_asm_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.GetExternalAsms(ctx, &databasemanagement.GetExternalAsmsArgs{
			CompartmentId:      pulumi.StringRef(compartmentId),
			DisplayName:        pulumi.StringRef(externalAsmDisplayName),
			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 testExternalAsms = Oci.DatabaseManagement.GetExternalAsms.Invoke(new()
    {
        CompartmentId = compartmentId,
        DisplayName = externalAsmDisplayName,
        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.GetExternalAsmsArgs;
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 testExternalAsms = DatabaseManagementFunctions.getExternalAsms(GetExternalAsmsArgs.builder()
            .compartmentId(compartmentId)
            .displayName(externalAsmDisplayName)
            .externalDbSystemId(testExternalDbSystem.id())
            .build());

    }
}

    variables:
  testExternalAsms:
    fn::invoke:
      function: oci:DatabaseManagement:getExternalAsms
      arguments:
        compartmentId: ${compartmentId}
        displayName: ${externalAsmDisplayName}
        externalDbSystemId: ${testExternalDbSystem.id}

    Using getExternalAsms

    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 getExternalAsms(args: GetExternalAsmsArgs, opts?: InvokeOptions): Promise<GetExternalAsmsResult>
function getExternalAsmsOutput(args: GetExternalAsmsOutputArgs, opts?: InvokeOptions): Output<GetExternalAsmsResult>
    def get_external_asms(compartment_id: Optional[str] = None,
                      display_name: Optional[str] = None,
                      external_db_system_id: Optional[str] = None,
                      filters: Optional[Sequence[GetExternalAsmsFilter]] = None,
                      opts: Optional[InvokeOptions] = None) -> GetExternalAsmsResult
def get_external_asms_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[GetExternalAsmsFilterArgs]]]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetExternalAsmsResult]
    func GetExternalAsms(ctx *Context, args *GetExternalAsmsArgs, opts ...InvokeOption) (*GetExternalAsmsResult, error)
func GetExternalAsmsOutput(ctx *Context, args *GetExternalAsmsOutputArgs, opts ...InvokeOption) GetExternalAsmsResultOutput

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

    public static class GetExternalAsms 
{
    public static Task<GetExternalAsmsResult> InvokeAsync(GetExternalAsmsArgs args, InvokeOptions? opts = null)
    public static Output<GetExternalAsmsResult> Invoke(GetExternalAsmsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetExternalAsmsResult> getExternalAsms(GetExternalAsmsArgs args, InvokeOptions options)
public static Output<GetExternalAsmsResult> getExternalAsms(GetExternalAsmsArgs args, InvokeOptions options)

    fn::invoke:
  function: oci:DatabaseManagement/getExternalAsms:getExternalAsms
  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<GetExternalAsmsFilter>
    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 []GetExternalAsmsFilter
    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<GetExternalAsmsFilter>
    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 GetExternalAsmsFilter[]
    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[GetExternalAsmsFilter]
    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>

    getExternalAsms Result

    The following output properties are available:

    ExternalAsmCollections List<GetExternalAsmsExternalAsmCollection>
    The list of external_asm_collection.
    Id string
    The provider-assigned unique ID for this managed resource.
    CompartmentId string
    The OCID of the compartment in which the external database resides.
    DisplayName string
    The user-friendly name for the database. The name does not have to be unique.
    ExternalDbSystemId string
    The OCID of the external DB system that the ASM is a part of.
    Filters List<GetExternalAsmsFilter>
    ExternalAsmCollections []GetExternalAsmsExternalAsmCollection
    The list of external_asm_collection.
    Id string
    The provider-assigned unique ID for this managed resource.
    CompartmentId string
    The OCID of the compartment in which the external database resides.
    DisplayName string
    The user-friendly name for the database. The name does not have to be unique.
    ExternalDbSystemId string
    The OCID of the external DB system that the ASM is a part of.
    Filters []GetExternalAsmsFilter
    externalAsmCollections List<GetExternalAsmsExternalAsmCollection>
    The list of external_asm_collection.
    id String
    The provider-assigned unique ID for this managed resource.
    compartmentId String
    The OCID of the compartment in which the external database resides.
    displayName String
    The user-friendly name for the database. The name does not have to be unique.
    externalDbSystemId String
    The OCID of the external DB system that the ASM is a part of.
    filters List<GetExternalAsmsFilter>
    externalAsmCollections GetExternalAsmsExternalAsmCollection[]
    The list of external_asm_collection.
    id string
    The provider-assigned unique ID for this managed resource.
    compartmentId string
    The OCID of the compartment in which the external database resides.
    displayName string
    The user-friendly name for the database. The name does not have to be unique.
    externalDbSystemId string
    The OCID of the external DB system that the ASM is a part of.
    filters GetExternalAsmsFilter[]
    external_asm_collections Sequence[GetExternalAsmsExternalAsmCollection]
    The list of external_asm_collection.
    id str
    The provider-assigned unique ID for this managed resource.
    compartment_id str
    The OCID of the compartment in which the external database resides.
    display_name str
    The user-friendly name for the database. The name does not have to be unique.
    external_db_system_id str
    The OCID of the external DB system that the ASM is a part of.
    filters Sequence[GetExternalAsmsFilter]
    externalAsmCollections List<Property Map>
    The list of external_asm_collection.
    id String
    The provider-assigned unique ID for this managed resource.
    compartmentId String
    The OCID of the compartment in which the external database resides.
    displayName String
    The user-friendly name for the database. The name does not have to be unique.
    externalDbSystemId String
    The OCID of the external DB system that the ASM is a part of.
    filters List<Property Map>

    Supporting Types

    GetExternalAsmsExternalAsmCollection

    GetExternalAsmsExternalAsmCollectionItem

    AdditionalDetails Dictionary<string, string>
    The additional details of the external ASM defined in {"key": "value"} format. Example: {"bar-key": "value"}
    CompartmentId string
    The OCID of the compartment.
    ComponentName string
    The name of the external ASM.
    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.
    ExternalAsmId string
    ExternalConnectorId string
    The OCID of the external connector.
    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"}
    GridHome string
    The directory in which ASM is installed. This is the same directory in which Oracle Grid Infrastructure is installed.
    Id string
    The OCID of the external database.
    IsCluster bool
    Indicates whether the ASM is a cluster ASM or not.
    IsFlexEnabled bool
    Indicates whether Oracle Flex ASM is enabled or not.
    LifecycleDetails string
    Additional information about the current lifecycle state.
    ServicedDatabases List<GetExternalAsmsExternalAsmCollectionItemServicedDatabase>
    The list of databases that are serviced by the ASM.
    State string
    The current lifecycle state of the external ASM.
    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 ASM was created.
    TimeUpdated string
    The date and time the external ASM was last updated.
    Version string
    The ASM version.
    AdditionalDetails map[string]string
    The additional details of the external ASM defined in {"key": "value"} format. Example: {"bar-key": "value"}
    CompartmentId string
    The OCID of the compartment.
    ComponentName string
    The name of the external ASM.
    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.
    ExternalAsmId string
    ExternalConnectorId string
    The OCID of the external connector.
    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"}
    GridHome string
    The directory in which ASM is installed. This is the same directory in which Oracle Grid Infrastructure is installed.
    Id string
    The OCID of the external database.
    IsCluster bool
    Indicates whether the ASM is a cluster ASM or not.
    IsFlexEnabled bool
    Indicates whether Oracle Flex ASM is enabled or not.
    LifecycleDetails string
    Additional information about the current lifecycle state.
    ServicedDatabases []GetExternalAsmsExternalAsmCollectionItemServicedDatabase
    The list of databases that are serviced by the ASM.
    State string
    The current lifecycle state of the external ASM.
    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 ASM was created.
    TimeUpdated string
    The date and time the external ASM was last updated.
    Version string
    The ASM version.
    additionalDetails Map<String,String>
    The additional details of the external ASM defined in {"key": "value"} format. Example: {"bar-key": "value"}
    compartmentId String
    The OCID of the compartment.
    componentName String
    The name of the external ASM.
    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.
    externalAsmId String
    externalConnectorId String
    The OCID of the external connector.
    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"}
    gridHome String
    The directory in which ASM is installed. This is the same directory in which Oracle Grid Infrastructure is installed.
    id String
    The OCID of the external database.
    isCluster Boolean
    Indicates whether the ASM is a cluster ASM or not.
    isFlexEnabled Boolean
    Indicates whether Oracle Flex ASM is enabled or not.
    lifecycleDetails String
    Additional information about the current lifecycle state.
    servicedDatabases List<GetExternalAsmsExternalAsmCollectionItemServicedDatabase>
    The list of databases that are serviced by the ASM.
    state String
    The current lifecycle state of the external ASM.
    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 ASM was created.
    timeUpdated String
    The date and time the external ASM was last updated.
    version String
    The ASM version.
    additionalDetails {[key: string]: string}
    The additional details of the external ASM defined in {"key": "value"} format. Example: {"bar-key": "value"}
    compartmentId string
    The OCID of the compartment.
    componentName string
    The name of the external ASM.
    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.
    externalAsmId string
    externalConnectorId string
    The OCID of the external connector.
    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"}
    gridHome string
    The directory in which ASM is installed. This is the same directory in which Oracle Grid Infrastructure is installed.
    id string
    The OCID of the external database.
    isCluster boolean
    Indicates whether the ASM is a cluster ASM or not.
    isFlexEnabled boolean
    Indicates whether Oracle Flex ASM is enabled or not.
    lifecycleDetails string
    Additional information about the current lifecycle state.
    servicedDatabases GetExternalAsmsExternalAsmCollectionItemServicedDatabase[]
    The list of databases that are serviced by the ASM.
    state string
    The current lifecycle state of the external ASM.
    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 ASM was created.
    timeUpdated string
    The date and time the external ASM was last updated.
    version string
    The ASM version.
    additional_details Mapping[str, str]
    The additional details of the external ASM 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 ASM.
    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_asm_id str
    external_connector_id str
    The OCID of the external connector.
    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"}
    grid_home str
    The directory in which ASM is installed. This is the same directory in which Oracle Grid Infrastructure is installed.
    id str
    The OCID of the external database.
    is_cluster bool
    Indicates whether the ASM is a cluster ASM or not.
    is_flex_enabled bool
    Indicates whether Oracle Flex ASM is enabled or not.
    lifecycle_details str
    Additional information about the current lifecycle state.
    serviced_databases Sequence[GetExternalAsmsExternalAsmCollectionItemServicedDatabase]
    The list of databases that are serviced by the ASM.
    state str
    The current lifecycle state of the external ASM.
    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 ASM was created.
    time_updated str
    The date and time the external ASM was last updated.
    version str
    The ASM version.
    additionalDetails Map<String>
    The additional details of the external ASM defined in {"key": "value"} format. Example: {"bar-key": "value"}
    compartmentId String
    The OCID of the compartment.
    componentName String
    The name of the external ASM.
    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.
    externalAsmId String
    externalConnectorId String
    The OCID of the external connector.
    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"}
    gridHome String
    The directory in which ASM is installed. This is the same directory in which Oracle Grid Infrastructure is installed.
    id String
    The OCID of the external database.
    isCluster Boolean
    Indicates whether the ASM is a cluster ASM or not.
    isFlexEnabled Boolean
    Indicates whether Oracle Flex ASM is enabled or not.
    lifecycleDetails String
    Additional information about the current lifecycle state.
    servicedDatabases List<Property Map>
    The list of databases that are serviced by the ASM.
    state String
    The current lifecycle state of the external ASM.
    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 ASM was created.
    timeUpdated String
    The date and time the external ASM was last updated.
    version String
    The ASM version.

    GetExternalAsmsExternalAsmCollectionItemServicedDatabase

    CompartmentId string
    The OCID of the compartment.
    DatabaseSubType string
    The subtype of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database.
    DatabaseType string
    The type of Oracle Database installation.
    DbUniqueName string
    The unique name of the external database.
    DiskGroups List<string>
    The list of ASM disk groups used by the database.
    DisplayName string
    A filter to only return the resources that match the entire display name.
    Id string
    The OCID of the external database.
    IsManaged bool
    Indicates whether the database is a Managed Database or not.
    CompartmentId string
    The OCID of the compartment.
    DatabaseSubType string
    The subtype of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database.
    DatabaseType string
    The type of Oracle Database installation.
    DbUniqueName string
    The unique name of the external database.
    DiskGroups []string
    The list of ASM disk groups used by the database.
    DisplayName string
    A filter to only return the resources that match the entire display name.
    Id string
    The OCID of the external database.
    IsManaged bool
    Indicates whether the database is a Managed Database or not.
    compartmentId String
    The OCID of the compartment.
    databaseSubType String
    The subtype of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database.
    databaseType String
    The type of Oracle Database installation.
    dbUniqueName String
    The unique name of the external database.
    diskGroups List<String>
    The list of ASM disk groups used by the database.
    displayName String
    A filter to only return the resources that match the entire display name.
    id String
    The OCID of the external database.
    isManaged Boolean
    Indicates whether the database is a Managed Database or not.
    compartmentId string
    The OCID of the compartment.
    databaseSubType string
    The subtype of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database.
    databaseType string
    The type of Oracle Database installation.
    dbUniqueName string
    The unique name of the external database.
    diskGroups string[]
    The list of ASM disk groups used by the database.
    displayName string
    A filter to only return the resources that match the entire display name.
    id string
    The OCID of the external database.
    isManaged boolean
    Indicates whether the database is a Managed Database or not.
    compartment_id str
    The OCID of the compartment.
    database_sub_type str
    The subtype of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database.
    database_type str
    The type of Oracle Database installation.
    db_unique_name str
    The unique name of the external database.
    disk_groups Sequence[str]
    The list of ASM disk groups used by the database.
    display_name str
    A filter to only return the resources that match the entire display name.
    id str
    The OCID of the external database.
    is_managed bool
    Indicates whether the database is a Managed Database or not.
    compartmentId String
    The OCID of the compartment.
    databaseSubType String
    The subtype of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database.
    databaseType String
    The type of Oracle Database installation.
    dbUniqueName String
    The unique name of the external database.
    diskGroups List<String>
    The list of ASM disk groups used by the database.
    displayName String
    A filter to only return the resources that match the entire display name.
    id String
    The OCID of the external database.
    isManaged Boolean
    Indicates whether the database is a Managed Database or not.

    GetExternalAsmsFilter

    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