Oracle Cloud Infrastructure v3.10.0 published on Wednesday, Nov 5, 2025 by Pulumi
oci.DatabaseTools.getDatabaseToolsEndpointServices
Start a Neo task
Explain and create an oci.DatabaseTools.getDatabaseToolsEndpointServices resource
This data source provides the list of Database Tools Endpoint Services in Oracle Cloud Infrastructure Database Tools service.
Returns a list of Database Tools endpoint services.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testDatabaseToolsEndpointServices = oci.DatabaseTools.getDatabaseToolsEndpointServices({
compartmentId: compartmentId,
displayName: databaseToolsEndpointServiceDisplayName,
name: databaseToolsEndpointServiceName,
state: databaseToolsEndpointServiceState,
});
import pulumi
import pulumi_oci as oci
test_database_tools_endpoint_services = oci.DatabaseTools.get_database_tools_endpoint_services(compartment_id=compartment_id,
display_name=database_tools_endpoint_service_display_name,
name=database_tools_endpoint_service_name,
state=database_tools_endpoint_service_state)
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v3/go/oci/databasetools"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := databasetools.GetDatabaseToolsEndpointServices(ctx, &databasetools.GetDatabaseToolsEndpointServicesArgs{
CompartmentId: compartmentId,
DisplayName: pulumi.StringRef(databaseToolsEndpointServiceDisplayName),
Name: pulumi.StringRef(databaseToolsEndpointServiceName),
State: pulumi.StringRef(databaseToolsEndpointServiceState),
}, 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 testDatabaseToolsEndpointServices = Oci.DatabaseTools.GetDatabaseToolsEndpointServices.Invoke(new()
{
CompartmentId = compartmentId,
DisplayName = databaseToolsEndpointServiceDisplayName,
Name = databaseToolsEndpointServiceName,
State = databaseToolsEndpointServiceState,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DatabaseTools.DatabaseToolsFunctions;
import com.pulumi.oci.DatabaseTools.inputs.GetDatabaseToolsEndpointServicesArgs;
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 testDatabaseToolsEndpointServices = DatabaseToolsFunctions.getDatabaseToolsEndpointServices(GetDatabaseToolsEndpointServicesArgs.builder()
.compartmentId(compartmentId)
.displayName(databaseToolsEndpointServiceDisplayName)
.name(databaseToolsEndpointServiceName)
.state(databaseToolsEndpointServiceState)
.build());
}
}
variables:
testDatabaseToolsEndpointServices:
fn::invoke:
function: oci:DatabaseTools:getDatabaseToolsEndpointServices
arguments:
compartmentId: ${compartmentId}
displayName: ${databaseToolsEndpointServiceDisplayName}
name: ${databaseToolsEndpointServiceName}
state: ${databaseToolsEndpointServiceState}
Using getDatabaseToolsEndpointServices
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 getDatabaseToolsEndpointServices(args: GetDatabaseToolsEndpointServicesArgs, opts?: InvokeOptions): Promise<GetDatabaseToolsEndpointServicesResult>
function getDatabaseToolsEndpointServicesOutput(args: GetDatabaseToolsEndpointServicesOutputArgs, opts?: InvokeOptions): Output<GetDatabaseToolsEndpointServicesResult>def get_database_tools_endpoint_services(compartment_id: Optional[str] = None,
display_name: Optional[str] = None,
filters: Optional[Sequence[GetDatabaseToolsEndpointServicesFilter]] = None,
name: Optional[str] = None,
state: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetDatabaseToolsEndpointServicesResult
def get_database_tools_endpoint_services_output(compartment_id: Optional[pulumi.Input[str]] = None,
display_name: Optional[pulumi.Input[str]] = None,
filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetDatabaseToolsEndpointServicesFilterArgs]]]] = None,
name: Optional[pulumi.Input[str]] = None,
state: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetDatabaseToolsEndpointServicesResult]func GetDatabaseToolsEndpointServices(ctx *Context, args *GetDatabaseToolsEndpointServicesArgs, opts ...InvokeOption) (*GetDatabaseToolsEndpointServicesResult, error)
func GetDatabaseToolsEndpointServicesOutput(ctx *Context, args *GetDatabaseToolsEndpointServicesOutputArgs, opts ...InvokeOption) GetDatabaseToolsEndpointServicesResultOutput> Note: This function is named GetDatabaseToolsEndpointServices in the Go SDK.
public static class GetDatabaseToolsEndpointServices
{
public static Task<GetDatabaseToolsEndpointServicesResult> InvokeAsync(GetDatabaseToolsEndpointServicesArgs args, InvokeOptions? opts = null)
public static Output<GetDatabaseToolsEndpointServicesResult> Invoke(GetDatabaseToolsEndpointServicesInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetDatabaseToolsEndpointServicesResult> getDatabaseToolsEndpointServices(GetDatabaseToolsEndpointServicesArgs args, InvokeOptions options)
public static Output<GetDatabaseToolsEndpointServicesResult> getDatabaseToolsEndpointServices(GetDatabaseToolsEndpointServicesArgs args, InvokeOptions options)
fn::invoke:
function: oci:DatabaseTools/getDatabaseToolsEndpointServices:getDatabaseToolsEndpointServices
arguments:
# arguments dictionaryThe following arguments are supported:
- Compartment
Id string - The OCID of the compartment in which to list resources.
- Display
Name string - A filter to return only resources that match the entire specified display name.
- Filters
List<Get
Database Tools Endpoint Services Filter> - Name string
- A filter to return only resources that match the entire specified name.
- State string
- A filter to return only resources their
lifecycleStatematches the specifiedlifecycleState.
- Compartment
Id string - The OCID of the compartment in which to list resources.
- Display
Name string - A filter to return only resources that match the entire specified display name.
- Filters
[]Get
Database Tools Endpoint Services Filter - Name string
- A filter to return only resources that match the entire specified name.
- State string
- A filter to return only resources their
lifecycleStatematches the specifiedlifecycleState.
- compartment
Id String - The OCID of the compartment in which to list resources.
- display
Name String - A filter to return only resources that match the entire specified display name.
- filters
List<Get
Endpoint Services Filter> - name String
- A filter to return only resources that match the entire specified name.
- state String
- A filter to return only resources their
lifecycleStatematches the specifiedlifecycleState.
- compartment
Id string - The OCID of the compartment in which to list resources.
- display
Name string - A filter to return only resources that match the entire specified display name.
- filters
Get
Database Tools Endpoint Services Filter[] - name string
- A filter to return only resources that match the entire specified name.
- state string
- A filter to return only resources their
lifecycleStatematches the specifiedlifecycleState.
- compartment_
id str - The OCID of the compartment in which to list resources.
- display_
name str - A filter to return only resources that match the entire specified display name.
- filters
Sequence[Get
Database Tools Endpoint Services Filter] - name str
- A filter to return only resources that match the entire specified name.
- state str
- A filter to return only resources their
lifecycleStatematches the specifiedlifecycleState.
- compartment
Id String - The OCID of the compartment in which to list resources.
- display
Name String - A filter to return only resources that match the entire specified display name.
- filters List<Property Map>
- name String
- A filter to return only resources that match the entire specified name.
- state String
- A filter to return only resources their
lifecycleStatematches the specifiedlifecycleState.
getDatabaseToolsEndpointServices Result
The following output properties are available:
- Compartment
Id string - The OCID of the compartment containing the Database Tools Endpoint Service.
- Database
Tools List<GetEndpoint Service Collections Database Tools Endpoint Services Database Tools Endpoint Service Collection> - The list of database_tools_endpoint_service_collection.
- Id string
- The provider-assigned unique ID for this managed resource.
- Display
Name string - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Filters
List<Get
Database Tools Endpoint Services Filter> - Name string
- A unique, non-changeable resource name.
- State string
- The current state of the Database Tools Endpoint Service.
- Compartment
Id string - The OCID of the compartment containing the Database Tools Endpoint Service.
- Database
Tools []GetEndpoint Service Collections Database Tools Endpoint Services Database Tools Endpoint Service Collection - The list of database_tools_endpoint_service_collection.
- Id string
- The provider-assigned unique ID for this managed resource.
- Display
Name string - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Filters
[]Get
Database Tools Endpoint Services Filter - Name string
- A unique, non-changeable resource name.
- State string
- The current state of the Database Tools Endpoint Service.
- compartment
Id String - The OCID of the compartment containing the Database Tools Endpoint Service.
- database
Tools List<GetEndpoint Service Collections Endpoint Services Endpoint Service Collection> - The list of database_tools_endpoint_service_collection.
- id String
- The provider-assigned unique ID for this managed resource.
- display
Name String - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- filters
List<Get
Endpoint Services Filter> - name String
- A unique, non-changeable resource name.
- state String
- The current state of the Database Tools Endpoint Service.
- compartment
Id string - The OCID of the compartment containing the Database Tools Endpoint Service.
- database
Tools GetEndpoint Service Collections Database Tools Endpoint Services Database Tools Endpoint Service Collection[] - The list of database_tools_endpoint_service_collection.
- id string
- The provider-assigned unique ID for this managed resource.
- display
Name string - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- filters
Get
Database Tools Endpoint Services Filter[] - name string
- A unique, non-changeable resource name.
- state string
- The current state of the Database Tools Endpoint Service.
- compartment_
id str - The OCID of the compartment containing the Database Tools Endpoint Service.
- database_
tools_ Sequence[Getendpoint_ service_ collections Database Tools Endpoint Services Database Tools Endpoint Service Collection] - The list of database_tools_endpoint_service_collection.
- id str
- The provider-assigned unique ID for this managed resource.
- display_
name str - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- filters
Sequence[Get
Database Tools Endpoint Services Filter] - name str
- A unique, non-changeable resource name.
- state str
- The current state of the Database Tools Endpoint Service.
- compartment
Id String - The OCID of the compartment containing the Database Tools Endpoint Service.
- database
Tools List<Property Map>Endpoint Service Collections - The list of database_tools_endpoint_service_collection.
- id String
- The provider-assigned unique ID for this managed resource.
- display
Name String - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- filters List<Property Map>
- name String
- A unique, non-changeable resource name.
- state String
- The current state of the Database Tools Endpoint Service.
Supporting Types
GetDatabaseToolsEndpointServicesDatabaseToolsEndpointServiceCollection
GetDatabaseToolsEndpointServicesDatabaseToolsEndpointServiceCollectionItem
- Compartment
Id string - The OCID of the compartment in which to list resources.
- Dictionary<string, string>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - Description string
- A description of the Database Tools Endpoint Service.
- Display
Name string - A filter to return only resources that match the entire specified display name.
- 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
- The OCID of the Database Tools Endpoint Service.
- Lifecycle
Details string - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- Name string
- A filter to return only resources that match the entire specified name.
- State string
- A filter to return only resources their
lifecycleStatematches the specifiedlifecycleState. - Dictionary<string, string>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - Time
Created string - The time the Database Tools Endpoint Service was created. An RFC3339 formatted datetime string
- Time
Updated string - The time the Database Tools Endpoint Service was updated. An RFC3339 formatted datetime string
- Compartment
Id string - The OCID of the compartment in which to list resources.
- map[string]string
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - Description string
- A description of the Database Tools Endpoint Service.
- Display
Name string - A filter to return only resources that match the entire specified display name.
- 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
- The OCID of the Database Tools Endpoint Service.
- Lifecycle
Details string - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- Name string
- A filter to return only resources that match the entire specified name.
- State string
- A filter to return only resources their
lifecycleStatematches the specifiedlifecycleState. - map[string]string
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - Time
Created string - The time the Database Tools Endpoint Service was created. An RFC3339 formatted datetime string
- Time
Updated string - The time the Database Tools Endpoint Service was updated. An RFC3339 formatted datetime string
- compartment
Id String - The OCID of the compartment in which to list resources.
- Map<String,String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - description String
- A description of the Database Tools Endpoint Service.
- display
Name String - A filter to return only resources that match the entire specified display name.
- 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
- The OCID of the Database Tools Endpoint Service.
- lifecycle
Details String - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- name String
- A filter to return only resources that match the entire specified name.
- state String
- A filter to return only resources their
lifecycleStatematches the specifiedlifecycleState. - Map<String,String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - time
Created String - The time the Database Tools Endpoint Service was created. An RFC3339 formatted datetime string
- time
Updated String - The time the Database Tools Endpoint Service was updated. An RFC3339 formatted datetime string
- compartment
Id string - The OCID of the compartment in which to list resources.
- {[key: string]: string}
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - description string
- A description of the Database Tools Endpoint Service.
- display
Name string - A filter to return only resources that match the entire specified display name.
- {[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
- The OCID of the Database Tools Endpoint Service.
- lifecycle
Details string - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- name string
- A filter to return only resources that match the entire specified name.
- state string
- A filter to return only resources their
lifecycleStatematches the specifiedlifecycleState. - {[key: string]: string}
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - time
Created string - The time the Database Tools Endpoint Service was created. An RFC3339 formatted datetime string
- time
Updated string - The time the Database Tools Endpoint Service was updated. An RFC3339 formatted datetime string
- compartment_
id str - The OCID of the compartment in which to list resources.
- Mapping[str, str]
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - description str
- A description of the Database Tools Endpoint Service.
- display_
name str - A filter to return only resources that match the entire specified display name.
- 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
- The OCID of the Database Tools Endpoint Service.
- lifecycle_
details str - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- name str
- A filter to return only resources that match the entire specified name.
- state str
- A filter to return only resources their
lifecycleStatematches the specifiedlifecycleState. - 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 time the Database Tools Endpoint Service was created. An RFC3339 formatted datetime string
- time_
updated str - The time the Database Tools Endpoint Service was updated. An RFC3339 formatted datetime string
- compartment
Id String - The OCID of the compartment in which to list resources.
- Map<String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - description String
- A description of the Database Tools Endpoint Service.
- display
Name String - A filter to return only resources that match the entire specified display name.
- 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
- The OCID of the Database Tools Endpoint Service.
- lifecycle
Details String - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- name String
- A filter to return only resources that match the entire specified name.
- state String
- A filter to return only resources their
lifecycleStatematches the specifiedlifecycleState. - Map<String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - time
Created String - The time the Database Tools Endpoint Service was created. An RFC3339 formatted datetime string
- time
Updated String - The time the Database Tools Endpoint Service was updated. An RFC3339 formatted datetime string
GetDatabaseToolsEndpointServicesFilter
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
ociTerraform Provider.
