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

oci.DatabaseManagement.getExternalAsm

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-oci

This data source provides details about a specific External Asm resource in Oracle Cloud Infrastructure Database Management service.

Gets the details for the external ASM specified by externalAsmId.

Example Usage

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

const testExternalAsm = oci.DatabaseManagement.getExternalAsm({
    externalAsmId: testExternalAsmOciDatabaseManagementExternalAsm.id,
});
Copy
import pulumi
import pulumi_oci as oci

test_external_asm = oci.DatabaseManagement.get_external_asm(external_asm_id=test_external_asm_oci_database_management_external_asm["id"])
Copy
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.GetExternalAsm(ctx, &databasemanagement.GetExternalAsmArgs{
			ExternalAsmId: testExternalAsmOciDatabaseManagementExternalAsm.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testExternalAsm = Oci.DatabaseManagement.GetExternalAsm.Invoke(new()
    {
        ExternalAsmId = testExternalAsmOciDatabaseManagementExternalAsm.Id,
    });

});
Copy
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.GetExternalAsmArgs;
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 testExternalAsm = DatabaseManagementFunctions.getExternalAsm(GetExternalAsmArgs.builder()
            .externalAsmId(testExternalAsmOciDatabaseManagementExternalAsm.id())
            .build());

    }
}
Copy
variables:
  testExternalAsm:
    fn::invoke:
      function: oci:DatabaseManagement:getExternalAsm
      arguments:
        externalAsmId: ${testExternalAsmOciDatabaseManagementExternalAsm.id}
Copy

Using getExternalAsm

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 getExternalAsm(args: GetExternalAsmArgs, opts?: InvokeOptions): Promise<GetExternalAsmResult>
function getExternalAsmOutput(args: GetExternalAsmOutputArgs, opts?: InvokeOptions): Output<GetExternalAsmResult>
Copy
def get_external_asm(external_asm_id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetExternalAsmResult
def get_external_asm_output(external_asm_id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetExternalAsmResult]
Copy
func GetExternalAsm(ctx *Context, args *GetExternalAsmArgs, opts ...InvokeOption) (*GetExternalAsmResult, error)
func GetExternalAsmOutput(ctx *Context, args *GetExternalAsmOutputArgs, opts ...InvokeOption) GetExternalAsmResultOutput
Copy

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

public static class GetExternalAsm 
{
    public static Task<GetExternalAsmResult> InvokeAsync(GetExternalAsmArgs args, InvokeOptions? opts = null)
    public static Output<GetExternalAsmResult> Invoke(GetExternalAsmInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetExternalAsmResult> getExternalAsm(GetExternalAsmArgs args, InvokeOptions options)
public static Output<GetExternalAsmResult> getExternalAsm(GetExternalAsmArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:DatabaseManagement/getExternalAsm:getExternalAsm
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ExternalAsmId This property is required. string
The OCID of the external ASM.
ExternalAsmId This property is required. string
The OCID of the external ASM.
externalAsmId This property is required. String
The OCID of the external ASM.
externalAsmId This property is required. string
The OCID of the external ASM.
external_asm_id This property is required. str
The OCID of the external ASM.
externalAsmId This property is required. String
The OCID of the external ASM.

getExternalAsm Result

The following output properties are available:

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 in which the external database resides.
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
The user-friendly name for the database. The name does not have to be unique.
ExternalAsmId string
ExternalConnectorId string
The OCID of the external connector.
ExternalDbSystemId string
The OCID of the external DB system that the ASM is a part of.
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<GetExternalAsmServicedDatabase>
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 in which the external database resides.
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
The user-friendly name for the database. The name does not have to be unique.
ExternalAsmId string
ExternalConnectorId string
The OCID of the external connector.
ExternalDbSystemId string
The OCID of the external DB system that the ASM is a part of.
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 []GetExternalAsmServicedDatabase
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 in which the external database resides.
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
The user-friendly name for the database. The name does not have to be unique.
externalAsmId String
externalConnectorId String
The OCID of the external connector.
externalDbSystemId String
The OCID of the external DB system that the ASM is a part of.
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<GetExternalAsmServicedDatabase>
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 in which the external database resides.
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
The user-friendly name for the database. The name does not have to be unique.
externalAsmId string
externalConnectorId string
The OCID of the external connector.
externalDbSystemId string
The OCID of the external DB system that the ASM is a part of.
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 GetExternalAsmServicedDatabase[]
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 in which the external database resides.
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
The user-friendly name for the database. The name does not have to be unique.
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 that the ASM is a part of.
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[databasemanagement.GetExternalAsmServicedDatabase]
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 in which the external database resides.
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
The user-friendly name for the database. The name does not have to be unique.
externalAsmId String
externalConnectorId String
The OCID of the external connector.
externalDbSystemId String
The OCID of the external DB system that the ASM is a part of.
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.

Supporting Types

GetExternalAsmServicedDatabase

CompartmentId This property is required. string
The OCID of the compartment in which the external database resides.
DatabaseSubType This property is required. 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 This property is required. string
The type of Oracle Database installation.
DbUniqueName This property is required. string
The unique name of the external database.
DiskGroups This property is required. List<string>
The list of ASM disk groups used by the database.
DisplayName This property is required. string
The user-friendly name for the database. The name does not have to be unique.
Id This property is required. string
The OCID of the external database.
IsManaged This property is required. bool
Indicates whether the database is a Managed Database or not.
CompartmentId This property is required. string
The OCID of the compartment in which the external database resides.
DatabaseSubType This property is required. 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 This property is required. string
The type of Oracle Database installation.
DbUniqueName This property is required. string
The unique name of the external database.
DiskGroups This property is required. []string
The list of ASM disk groups used by the database.
DisplayName This property is required. string
The user-friendly name for the database. The name does not have to be unique.
Id This property is required. string
The OCID of the external database.
IsManaged This property is required. bool
Indicates whether the database is a Managed Database or not.
compartmentId This property is required. String
The OCID of the compartment in which the external database resides.
databaseSubType This property is required. 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 This property is required. String
The type of Oracle Database installation.
dbUniqueName This property is required. String
The unique name of the external database.
diskGroups This property is required. List<String>
The list of ASM disk groups used by the database.
displayName This property is required. String
The user-friendly name for the database. The name does not have to be unique.
id This property is required. String
The OCID of the external database.
isManaged This property is required. Boolean
Indicates whether the database is a Managed Database or not.
compartmentId This property is required. string
The OCID of the compartment in which the external database resides.
databaseSubType This property is required. 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 This property is required. string
The type of Oracle Database installation.
dbUniqueName This property is required. string
The unique name of the external database.
diskGroups This property is required. string[]
The list of ASM disk groups used by the database.
displayName This property is required. string
The user-friendly name for the database. The name does not have to be unique.
id This property is required. string
The OCID of the external database.
isManaged This property is required. boolean
Indicates whether the database is a Managed Database or not.
compartment_id This property is required. str
The OCID of the compartment in which the external database resides.
database_sub_type This property is required. 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 This property is required. str
The type of Oracle Database installation.
db_unique_name This property is required. str
The unique name of the external database.
disk_groups This property is required. Sequence[str]
The list of ASM disk groups used by the database.
display_name This property is required. str
The user-friendly name for the database. The name does not have to be unique.
id This property is required. str
The OCID of the external database.
is_managed This property is required. bool
Indicates whether the database is a Managed Database or not.
compartmentId This property is required. String
The OCID of the compartment in which the external database resides.
databaseSubType This property is required. 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 This property is required. String
The type of Oracle Database installation.
dbUniqueName This property is required. String
The unique name of the external database.
diskGroups This property is required. List<String>
The list of ASM disk groups used by the database.
displayName This property is required. String
The user-friendly name for the database. The name does not have to be unique.
id This property is required. String
The OCID of the external database.
isManaged This property is required. Boolean
Indicates whether the database is a Managed Database or not.

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