Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
oci.DatabaseManagement.getNamedCredential
Explore with Pulumi AI
This data source provides details about a specific Named Credential resource in Oracle Cloud Infrastructure Database Management service.
Gets the details for the named credential specified by namedCredentialId.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testNamedCredential = oci.DatabaseManagement.getNamedCredential({
    namedCredentialId: testNamedCredentialOciDatabaseManagementNamedCredential.id,
});
import pulumi
import pulumi_oci as oci
test_named_credential = oci.DatabaseManagement.get_named_credential(named_credential_id=test_named_credential_oci_database_management_named_credential["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.GetNamedCredential(ctx, &databasemanagement.GetNamedCredentialArgs{
			NamedCredentialId: testNamedCredentialOciDatabaseManagementNamedCredential.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 testNamedCredential = Oci.DatabaseManagement.GetNamedCredential.Invoke(new()
    {
        NamedCredentialId = testNamedCredentialOciDatabaseManagementNamedCredential.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.GetNamedCredentialArgs;
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 testNamedCredential = DatabaseManagementFunctions.getNamedCredential(GetNamedCredentialArgs.builder()
            .namedCredentialId(testNamedCredentialOciDatabaseManagementNamedCredential.id())
            .build());
    }
}
variables:
  testNamedCredential:
    fn::invoke:
      function: oci:DatabaseManagement:getNamedCredential
      arguments:
        namedCredentialId: ${testNamedCredentialOciDatabaseManagementNamedCredential.id}
Using getNamedCredential
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 getNamedCredential(args: GetNamedCredentialArgs, opts?: InvokeOptions): Promise<GetNamedCredentialResult>
function getNamedCredentialOutput(args: GetNamedCredentialOutputArgs, opts?: InvokeOptions): Output<GetNamedCredentialResult>def get_named_credential(named_credential_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetNamedCredentialResult
def get_named_credential_output(named_credential_id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetNamedCredentialResult]func LookupNamedCredential(ctx *Context, args *LookupNamedCredentialArgs, opts ...InvokeOption) (*LookupNamedCredentialResult, error)
func LookupNamedCredentialOutput(ctx *Context, args *LookupNamedCredentialOutputArgs, opts ...InvokeOption) LookupNamedCredentialResultOutput> Note: This function is named LookupNamedCredential in the Go SDK.
public static class GetNamedCredential 
{
    public static Task<GetNamedCredentialResult> InvokeAsync(GetNamedCredentialArgs args, InvokeOptions? opts = null)
    public static Output<GetNamedCredentialResult> Invoke(GetNamedCredentialInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetNamedCredentialResult> getNamedCredential(GetNamedCredentialArgs args, InvokeOptions options)
public static Output<GetNamedCredentialResult> getNamedCredential(GetNamedCredentialArgs args, InvokeOptions options)
fn::invoke:
  function: oci:DatabaseManagement/getNamedCredential:getNamedCredential
  arguments:
    # arguments dictionaryThe following arguments are supported:
- NamedCredential stringId 
- The OCID of the named credential.
- NamedCredential stringId 
- The OCID of the named credential.
- namedCredential StringId 
- The OCID of the named credential.
- namedCredential stringId 
- The OCID of the named credential.
- named_credential_ strid 
- The OCID of the named credential.
- namedCredential StringId 
- The OCID of the named credential.
getNamedCredential Result
The following output properties are available:
- AssociatedResource string
- The OCID of the resource that is associated to the named credential.
- CompartmentId string
- The OCID of the compartment.
- Contents
List<GetNamed Credential Content> 
- The details of the named credential.
- Dictionary<string, string>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
- Description string
- The information specified by the user about the named credential.
- 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"}
- Id string
- The OCID of the named credential.
- LifecycleDetails string
- The details of the lifecycle state.
- Name string
- The name of the named credential.
- NamedCredential stringId 
- Scope string
- The scope of the named credential.
- State string
- The current lifecycle state of the named credential.
- 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 named credential was created.
- TimeUpdated string
- The date and time the named credential was last updated.
- Type string
- The type of resource associated with the named credential.
- AssociatedResource string
- The OCID of the resource that is associated to the named credential.
- CompartmentId string
- The OCID of the compartment.
- Contents
[]GetNamed Credential Content 
- The details of the named credential.
- map[string]string
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
- Description string
- The information specified by the user about the named credential.
- 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"}
- Id string
- The OCID of the named credential.
- LifecycleDetails string
- The details of the lifecycle state.
- Name string
- The name of the named credential.
- NamedCredential stringId 
- Scope string
- The scope of the named credential.
- State string
- The current lifecycle state of the named credential.
- 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 named credential was created.
- TimeUpdated string
- The date and time the named credential was last updated.
- Type string
- The type of resource associated with the named credential.
- associatedResource String
- The OCID of the resource that is associated to the named credential.
- compartmentId String
- The OCID of the compartment.
- contents
List<GetNamed Credential Content> 
- The details of the named credential.
- Map<String,String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
- description String
- The information specified by the user about the named credential.
- 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"}
- id String
- The OCID of the named credential.
- lifecycleDetails String
- The details of the lifecycle state.
- name String
- The name of the named credential.
- namedCredential StringId 
- scope String
- The scope of the named credential.
- state String
- The current lifecycle state of the named credential.
- 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 named credential was created.
- timeUpdated String
- The date and time the named credential was last updated.
- type String
- The type of resource associated with the named credential.
- associatedResource string
- The OCID of the resource that is associated to the named credential.
- compartmentId string
- The OCID of the compartment.
- contents
GetNamed Credential Content[] 
- The details of the named credential.
- {[key: string]: string}
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
- description string
- The information specified by the user about the named credential.
- {[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"}
- id string
- The OCID of the named credential.
- lifecycleDetails string
- The details of the lifecycle state.
- name string
- The name of the named credential.
- namedCredential stringId 
- scope string
- The scope of the named credential.
- state string
- The current lifecycle state of the named credential.
- {[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 named credential was created.
- timeUpdated string
- The date and time the named credential was last updated.
- type string
- The type of resource associated with the named credential.
- associated_resource str
- The OCID of the resource that is associated to the named credential.
- compartment_id str
- The OCID of the compartment.
- contents
Sequence[GetNamed Credential Content] 
- The details of the named credential.
- Mapping[str, str]
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
- description str
- The information specified by the user about the named credential.
- 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"}
- id str
- The OCID of the named credential.
- lifecycle_details str
- The details of the lifecycle state.
- name str
- The name of the named credential.
- named_credential_ strid 
- scope str
- The scope of the named credential.
- state str
- The current lifecycle state of the named credential.
- 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 named credential was created.
- time_updated str
- The date and time the named credential was last updated.
- type str
- The type of resource associated with the named credential.
- associatedResource String
- The OCID of the resource that is associated to the named credential.
- compartmentId String
- The OCID of the compartment.
- contents List<Property Map>
- The details of the named credential.
- Map<String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
- description String
- The information specified by the user about the named credential.
- 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"}
- id String
- The OCID of the named credential.
- lifecycleDetails String
- The details of the lifecycle state.
- name String
- The name of the named credential.
- namedCredential StringId 
- scope String
- The scope of the named credential.
- state String
- The current lifecycle state of the named credential.
- 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 named credential was created.
- timeUpdated String
- The date and time the named credential was last updated.
- type String
- The type of resource associated with the named credential.
Supporting Types
GetNamedCredentialContent   
- CredentialType string
- The type of named credential. Only 'BASIC' is supported currently.
- PasswordSecret stringAccess Mode 
- The mechanism used to access the password plain text value.
- PasswordSecret stringId 
- The OCID of the Vault service secret that contains the database user password.
- Role string
- The role of the database user.
- UserName string
- The user name used to connect to the database.
- CredentialType string
- The type of named credential. Only 'BASIC' is supported currently.
- PasswordSecret stringAccess Mode 
- The mechanism used to access the password plain text value.
- PasswordSecret stringId 
- The OCID of the Vault service secret that contains the database user password.
- Role string
- The role of the database user.
- UserName string
- The user name used to connect to the database.
- credentialType String
- The type of named credential. Only 'BASIC' is supported currently.
- passwordSecret StringAccess Mode 
- The mechanism used to access the password plain text value.
- passwordSecret StringId 
- The OCID of the Vault service secret that contains the database user password.
- role String
- The role of the database user.
- userName String
- The user name used to connect to the database.
- credentialType string
- The type of named credential. Only 'BASIC' is supported currently.
- passwordSecret stringAccess Mode 
- The mechanism used to access the password plain text value.
- passwordSecret stringId 
- The OCID of the Vault service secret that contains the database user password.
- role string
- The role of the database user.
- userName string
- The user name used to connect to the database.
- credential_type str
- The type of named credential. Only 'BASIC' is supported currently.
- password_secret_ straccess_ mode 
- The mechanism used to access the password plain text value.
- password_secret_ strid 
- The OCID of the Vault service secret that contains the database user password.
- role str
- The role of the database user.
- user_name str
- The user name used to connect to the database.
- credentialType String
- The type of named credential. Only 'BASIC' is supported currently.
- passwordSecret StringAccess Mode 
- The mechanism used to access the password plain text value.
- passwordSecret StringId 
- The OCID of the Vault service secret that contains the database user password.
- role String
- The role of the database user.
- userName String
- The user name used to connect to the database.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the ociTerraform Provider.