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

oci.Adm.getKnowledgebases

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 Knowledge Bases in Oracle Cloud Infrastructure ADM service.

    Returns a list of KnowledgeBases based on the specified query parameters. At least id or compartmentId query parameter must be provided.

    Example Usage

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

const testKnowledgeBases = oci.Adm.getKnowledgebases({
    compartmentId: compartmentId,
    displayName: knowledgeBaseDisplayName,
    id: knowledgeBaseId,
    state: knowledgeBaseState,
});

    import pulumi
import pulumi_oci as oci

test_knowledge_bases = oci.Adm.get_knowledgebases(compartment_id=compartment_id,
    display_name=knowledge_base_display_name,
    id=knowledge_base_id,
    state=knowledge_base_state)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := adm.GetKnowledgebases(ctx, &adm.GetKnowledgebasesArgs{
			CompartmentId: pulumi.StringRef(compartmentId),
			DisplayName:   pulumi.StringRef(knowledgeBaseDisplayName),
			Id:            pulumi.StringRef(knowledgeBaseId),
			State:         pulumi.StringRef(knowledgeBaseState),
		}, 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 testKnowledgeBases = Oci.Adm.GetKnowledgebases.Invoke(new()
    {
        CompartmentId = compartmentId,
        DisplayName = knowledgeBaseDisplayName,
        Id = knowledgeBaseId,
        State = knowledgeBaseState,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Adm.AdmFunctions;
import com.pulumi.oci.Adm.inputs.GetKnowledgebasesArgs;
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 testKnowledgeBases = AdmFunctions.getKnowledgebases(GetKnowledgebasesArgs.builder()
            .compartmentId(compartmentId)
            .displayName(knowledgeBaseDisplayName)
            .id(knowledgeBaseId)
            .state(knowledgeBaseState)
            .build());

    }
}

    variables:
  testKnowledgeBases:
    fn::invoke:
      function: oci:Adm:getKnowledgebases
      arguments:
        compartmentId: ${compartmentId}
        displayName: ${knowledgeBaseDisplayName}
        id: ${knowledgeBaseId}
        state: ${knowledgeBaseState}

    Using getKnowledgebases

    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 getKnowledgebases(args: GetKnowledgebasesArgs, opts?: InvokeOptions): Promise<GetKnowledgebasesResult>
function getKnowledgebasesOutput(args: GetKnowledgebasesOutputArgs, opts?: InvokeOptions): Output<GetKnowledgebasesResult>
    def get_knowledgebases(compartment_id: Optional[str] = None,
                       display_name: Optional[str] = None,
                       filters: Optional[Sequence[GetKnowledgebasesFilter]] = None,
                       id: Optional[str] = None,
                       state: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetKnowledgebasesResult
def get_knowledgebases_output(compartment_id: Optional[pulumi.Input[str]] = None,
                       display_name: Optional[pulumi.Input[str]] = None,
                       filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetKnowledgebasesFilterArgs]]]] = None,
                       id: Optional[pulumi.Input[str]] = None,
                       state: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetKnowledgebasesResult]
    func GetKnowledgebases(ctx *Context, args *GetKnowledgebasesArgs, opts ...InvokeOption) (*GetKnowledgebasesResult, error)
func GetKnowledgebasesOutput(ctx *Context, args *GetKnowledgebasesOutputArgs, opts ...InvokeOption) GetKnowledgebasesResultOutput

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

    public static class GetKnowledgebases 
{
    public static Task<GetKnowledgebasesResult> InvokeAsync(GetKnowledgebasesArgs args, InvokeOptions? opts = null)
    public static Output<GetKnowledgebasesResult> Invoke(GetKnowledgebasesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetKnowledgebasesResult> getKnowledgebases(GetKnowledgebasesArgs args, InvokeOptions options)
public static Output<GetKnowledgebasesResult> getKnowledgebases(GetKnowledgebasesArgs args, InvokeOptions options)

    fn::invoke:
  function: oci:Adm/getKnowledgebases:getKnowledgebases
  arguments:
    # arguments dictionary

    The following arguments are supported:

    CompartmentId string
    A filter to return only resources that belong to the specified compartment identifier. Required only if the id query param is not specified.
    DisplayName string
    A filter to return only resources that match the entire display name given.
    Filters List<GetKnowledgebasesFilter>
    Id string
    A filter to return only resources that match the specified identifier. Required only if the compartmentId query parameter is not specified.
    State string
    A filter to return only Knowledge Bases that match the specified lifecycleState.
    CompartmentId string
    A filter to return only resources that belong to the specified compartment identifier. Required only if the id query param is not specified.
    DisplayName string
    A filter to return only resources that match the entire display name given.
    Filters []GetKnowledgebasesFilter
    Id string
    A filter to return only resources that match the specified identifier. Required only if the compartmentId query parameter is not specified.
    State string
    A filter to return only Knowledge Bases that match the specified lifecycleState.
    compartmentId String
    A filter to return only resources that belong to the specified compartment identifier. Required only if the id query param is not specified.
    displayName String
    A filter to return only resources that match the entire display name given.
    filters List<GetKnowledgebasesFilter>
    id String
    A filter to return only resources that match the specified identifier. Required only if the compartmentId query parameter is not specified.
    state String
    A filter to return only Knowledge Bases that match the specified lifecycleState.
    compartmentId string
    A filter to return only resources that belong to the specified compartment identifier. Required only if the id query param is not specified.
    displayName string
    A filter to return only resources that match the entire display name given.
    filters GetKnowledgebasesFilter[]
    id string
    A filter to return only resources that match the specified identifier. Required only if the compartmentId query parameter is not specified.
    state string
    A filter to return only Knowledge Bases that match the specified lifecycleState.
    compartment_id str
    A filter to return only resources that belong to the specified compartment identifier. Required only if the id query param is not specified.
    display_name str
    A filter to return only resources that match the entire display name given.
    filters Sequence[GetKnowledgebasesFilter]
    id str
    A filter to return only resources that match the specified identifier. Required only if the compartmentId query parameter is not specified.
    state str
    A filter to return only Knowledge Bases that match the specified lifecycleState.
    compartmentId String
    A filter to return only resources that belong to the specified compartment identifier. Required only if the id query param is not specified.
    displayName String
    A filter to return only resources that match the entire display name given.
    filters List<Property Map>
    id String
    A filter to return only resources that match the specified identifier. Required only if the compartmentId query parameter is not specified.
    state String
    A filter to return only Knowledge Bases that match the specified lifecycleState.

    getKnowledgebases Result

    The following output properties are available:

    KnowledgeBaseCollections List<GetKnowledgebasesKnowledgeBaseCollection>
    The list of knowledge_base_collection.
    CompartmentId string
    The compartment Oracle Cloud Identifier (OCID) of the knowledge base.
    DisplayName string
    The name of the knowledge base.
    Filters List<GetKnowledgebasesFilter>
    Id string
    The Oracle Cloud Identifier (OCID) of the knowledge base.
    State string
    The current lifecycle state of the knowledge base.
    KnowledgeBaseCollections []GetKnowledgebasesKnowledgeBaseCollection
    The list of knowledge_base_collection.
    CompartmentId string
    The compartment Oracle Cloud Identifier (OCID) of the knowledge base.
    DisplayName string
    The name of the knowledge base.
    Filters []GetKnowledgebasesFilter
    Id string
    The Oracle Cloud Identifier (OCID) of the knowledge base.
    State string
    The current lifecycle state of the knowledge base.
    knowledgeBaseCollections List<GetKnowledgebasesKnowledgeBaseCollection>
    The list of knowledge_base_collection.
    compartmentId String
    The compartment Oracle Cloud Identifier (OCID) of the knowledge base.
    displayName String
    The name of the knowledge base.
    filters List<GetKnowledgebasesFilter>
    id String
    The Oracle Cloud Identifier (OCID) of the knowledge base.
    state String
    The current lifecycle state of the knowledge base.
    knowledgeBaseCollections GetKnowledgebasesKnowledgeBaseCollection[]
    The list of knowledge_base_collection.
    compartmentId string
    The compartment Oracle Cloud Identifier (OCID) of the knowledge base.
    displayName string
    The name of the knowledge base.
    filters GetKnowledgebasesFilter[]
    id string
    The Oracle Cloud Identifier (OCID) of the knowledge base.
    state string
    The current lifecycle state of the knowledge base.
    knowledge_base_collections Sequence[GetKnowledgebasesKnowledgeBaseCollection]
    The list of knowledge_base_collection.
    compartment_id str
    The compartment Oracle Cloud Identifier (OCID) of the knowledge base.
    display_name str
    The name of the knowledge base.
    filters Sequence[GetKnowledgebasesFilter]
    id str
    The Oracle Cloud Identifier (OCID) of the knowledge base.
    state str
    The current lifecycle state of the knowledge base.
    knowledgeBaseCollections List<Property Map>
    The list of knowledge_base_collection.
    compartmentId String
    The compartment Oracle Cloud Identifier (OCID) of the knowledge base.
    displayName String
    The name of the knowledge base.
    filters List<Property Map>
    id String
    The Oracle Cloud Identifier (OCID) of the knowledge base.
    state String
    The current lifecycle state of the knowledge base.

    Supporting Types

    GetKnowledgebasesFilter

    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

    GetKnowledgebasesKnowledgeBaseCollection

    GetKnowledgebasesKnowledgeBaseCollectionItem

    CompartmentId string
    A filter to return only resources that belong to the specified compartment identifier. Required only if the id query param is not specified.
    DefinedTags Dictionary<string, string>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    A filter to return only resources that match the entire display name given.
    FreeformTags Dictionary<string, string>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Id string
    A filter to return only resources that match the specified identifier. Required only if the compartmentId query parameter is not specified.
    State string
    A filter to return only Knowledge Bases that match the specified lifecycleState.
    SystemTags Dictionary<string, string>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The creation date and time of the knowledge base (formatted according to RFC3339).
    TimeUpdated string
    The date and time the knowledge base was last updated (formatted according to RFC3339).
    CompartmentId string
    A filter to return only resources that belong to the specified compartment identifier. Required only if the id query param is not specified.
    DefinedTags map[string]string
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    A filter to return only resources that match the entire display name given.
    FreeformTags map[string]string
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Id string
    A filter to return only resources that match the specified identifier. Required only if the compartmentId query parameter is not specified.
    State string
    A filter to return only Knowledge Bases that match the specified lifecycleState.
    SystemTags map[string]string
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The creation date and time of the knowledge base (formatted according to RFC3339).
    TimeUpdated string
    The date and time the knowledge base was last updated (formatted according to RFC3339).
    compartmentId String
    A filter to return only resources that belong to the specified compartment identifier. Required only if the id query param is not specified.
    definedTags Map<String,String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    A filter to return only resources that match the entire display name given.
    freeformTags Map<String,String>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id String
    A filter to return only resources that match the specified identifier. Required only if the compartmentId query parameter is not specified.
    state String
    A filter to return only Knowledge Bases that match the specified lifecycleState.
    systemTags Map<String,String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The creation date and time of the knowledge base (formatted according to RFC3339).
    timeUpdated String
    The date and time the knowledge base was last updated (formatted according to RFC3339).
    compartmentId string
    A filter to return only resources that belong to the specified compartment identifier. Required only if the id query param is not specified.
    definedTags {[key: string]: string}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName string
    A filter to return only resources that match the entire display name given.
    freeformTags {[key: string]: string}
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id string
    A filter to return only resources that match the specified identifier. Required only if the compartmentId query parameter is not specified.
    state string
    A filter to return only Knowledge Bases that match the specified lifecycleState.
    systemTags {[key: string]: string}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The creation date and time of the knowledge base (formatted according to RFC3339).
    timeUpdated string
    The date and time the knowledge base was last updated (formatted according to RFC3339).
    compartment_id str
    A filter to return only resources that belong to the specified compartment identifier. Required only if the id query param is not specified.
    defined_tags Mapping[str, str]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    display_name str
    A filter to return only resources that match the entire display name given.
    freeform_tags Mapping[str, str]
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id str
    A filter to return only resources that match the specified identifier. Required only if the compartmentId query parameter is not specified.
    state str
    A filter to return only Knowledge Bases that match the specified lifecycleState.
    system_tags Mapping[str, str]
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The creation date and time of the knowledge base (formatted according to RFC3339).
    time_updated str
    The date and time the knowledge base was last updated (formatted according to RFC3339).
    compartmentId String
    A filter to return only resources that belong to the specified compartment identifier. Required only if the id query param is not specified.
    definedTags Map<String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    A filter to return only resources that match the entire display name given.
    freeformTags Map<String>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id String
    A filter to return only resources that match the specified identifier. Required only if the compartmentId query parameter is not specified.
    state String
    A filter to return only Knowledge Bases that match the specified lifecycleState.
    systemTags Map<String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The creation date and time of the knowledge base (formatted according to RFC3339).
    timeUpdated String
    The date and time the knowledge base was last updated (formatted according to RFC3339).

    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