1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DatabaseTools
  5. getDatabaseToolsEndpointServices
Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi

oci.DatabaseTools.getDatabaseToolsEndpointServices

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi

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,
});
Copy
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)
Copy
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/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
	})
}
Copy
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,
    });

});
Copy
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());

    }
}
Copy
variables:
  testDatabaseToolsEndpointServices:
    fn::invoke:
      function: oci:DatabaseTools:getDatabaseToolsEndpointServices
      arguments:
        compartmentId: ${compartmentId}
        displayName: ${databaseToolsEndpointServiceDisplayName}
        name: ${databaseToolsEndpointServiceName}
        state: ${databaseToolsEndpointServiceState}
Copy

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>
Copy
def get_database_tools_endpoint_services(compartment_id: Optional[str] = None,
                                         display_name: Optional[str] = None,
                                         filters: Optional[Sequence[_databasetools.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[_databasetools.GetDatabaseToolsEndpointServicesFilterArgs]]]] = None,
                                         name: Optional[pulumi.Input[str]] = None,
                                         state: Optional[pulumi.Input[str]] = None,
                                         opts: Optional[InvokeOptions] = None) -> Output[GetDatabaseToolsEndpointServicesResult]
Copy
func GetDatabaseToolsEndpointServices(ctx *Context, args *GetDatabaseToolsEndpointServicesArgs, opts ...InvokeOption) (*GetDatabaseToolsEndpointServicesResult, error)
func GetDatabaseToolsEndpointServicesOutput(ctx *Context, args *GetDatabaseToolsEndpointServicesOutputArgs, opts ...InvokeOption) GetDatabaseToolsEndpointServicesResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetDatabaseToolsEndpointServicesResult> getDatabaseToolsEndpointServices(GetDatabaseToolsEndpointServicesArgs args, InvokeOptions options)
public static Output<GetDatabaseToolsEndpointServicesResult> getDatabaseToolsEndpointServices(GetDatabaseToolsEndpointServicesArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:DatabaseTools/getDatabaseToolsEndpointServices:getDatabaseToolsEndpointServices
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CompartmentId This property is required. string
The ID of the compartment in which to list resources.
DisplayName string
A filter to return only resources that match the entire specified display name.
Filters Changes to this property will trigger replacement. List<GetDatabaseToolsEndpointServicesFilter>
Name string
A filter to return only resources that match the entire specified name.
State string
A filter to return only resources their lifecycleState matches the specified lifecycleState.
CompartmentId This property is required. string
The ID of the compartment in which to list resources.
DisplayName string
A filter to return only resources that match the entire specified display name.
Filters Changes to this property will trigger replacement. []GetDatabaseToolsEndpointServicesFilter
Name string
A filter to return only resources that match the entire specified name.
State string
A filter to return only resources their lifecycleState matches the specified lifecycleState.
compartmentId This property is required. String
The ID of the compartment in which to list resources.
displayName String
A filter to return only resources that match the entire specified display name.
filters Changes to this property will trigger replacement. List<GetEndpointServicesFilter>
name String
A filter to return only resources that match the entire specified name.
state String
A filter to return only resources their lifecycleState matches the specified lifecycleState.
compartmentId This property is required. string
The ID of the compartment in which to list resources.
displayName string
A filter to return only resources that match the entire specified display name.
filters Changes to this property will trigger replacement. GetDatabaseToolsEndpointServicesFilter[]
name string
A filter to return only resources that match the entire specified name.
state string
A filter to return only resources their lifecycleState matches the specified lifecycleState.
compartment_id This property is required. str
The ID 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 Changes to this property will trigger replacement. Sequence[databasetools.GetDatabaseToolsEndpointServicesFilter]
name str
A filter to return only resources that match the entire specified name.
state str
A filter to return only resources their lifecycleState matches the specified lifecycleState.
compartmentId This property is required. String
The ID of the compartment in which to list resources.
displayName String
A filter to return only resources that match the entire specified display name.
filters Changes to this property will trigger replacement. 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 lifecycleState matches the specified lifecycleState.

getDatabaseToolsEndpointServices Result

The following output properties are available:

CompartmentId string
The OCID of the compartment containing the Database Tools Endpoint Service.
DatabaseToolsEndpointServiceCollections List<GetDatabaseToolsEndpointServicesDatabaseToolsEndpointServiceCollection>
The list of database_tools_endpoint_service_collection.
Id string
The provider-assigned unique ID for this managed resource.
DisplayName string
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Filters List<GetDatabaseToolsEndpointServicesFilter>
Name string
A unique, non-changeable resource name.
State string
The current state of the Database Tools Endpoint Service.
CompartmentId string
The OCID of the compartment containing the Database Tools Endpoint Service.
DatabaseToolsEndpointServiceCollections []GetDatabaseToolsEndpointServicesDatabaseToolsEndpointServiceCollection
The list of database_tools_endpoint_service_collection.
Id string
The provider-assigned unique ID for this managed resource.
DisplayName string
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Filters []GetDatabaseToolsEndpointServicesFilter
Name string
A unique, non-changeable resource name.
State string
The current state of the Database Tools Endpoint Service.
compartmentId String
The OCID of the compartment containing the Database Tools Endpoint Service.
databaseToolsEndpointServiceCollections List<GetEndpointServicesEndpointServiceCollection>
The list of database_tools_endpoint_service_collection.
id String
The provider-assigned unique ID for this managed resource.
displayName String
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
filters List<GetEndpointServicesFilter>
name String
A unique, non-changeable resource name.
state String
The current state of the Database Tools Endpoint Service.
compartmentId string
The OCID of the compartment containing the Database Tools Endpoint Service.
databaseToolsEndpointServiceCollections GetDatabaseToolsEndpointServicesDatabaseToolsEndpointServiceCollection[]
The list of database_tools_endpoint_service_collection.
id string
The provider-assigned unique ID for this managed resource.
displayName string
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
filters GetDatabaseToolsEndpointServicesFilter[]
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_endpoint_service_collections Sequence[databasetools.GetDatabaseToolsEndpointServicesDatabaseToolsEndpointServiceCollection]
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[databasetools.GetDatabaseToolsEndpointServicesFilter]
name str
A unique, non-changeable resource name.
state str
The current state of the Database Tools Endpoint Service.
compartmentId String
The OCID of the compartment containing the Database Tools Endpoint Service.
databaseToolsEndpointServiceCollections List<Property Map>
The list of database_tools_endpoint_service_collection.
id String
The provider-assigned unique ID for this managed resource.
displayName 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

items This property is required. List<Property Map>

GetDatabaseToolsEndpointServicesDatabaseToolsEndpointServiceCollectionItem

CompartmentId This property is required. string
The ID of the compartment in which to list resources.
DefinedTags This property is required. Dictionary<string, string>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
Description This property is required. string
A description of the Database Tools Endpoint Service.
DisplayName This property is required. string
A filter to return only resources that match the entire specified display name.
FreeformTags This property is required. 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 This property is required. string
The OCID of the Database Tools Endpoint Service.
LifecycleDetails This property is required. 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 This property is required. string
A filter to return only resources that match the entire specified name.
State This property is required. string
A filter to return only resources their lifecycleState matches the specified lifecycleState.
SystemTags This property is required. Dictionary<string, string>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated This property is required. string
The time the Database Tools Endpoint Service was created. An RFC3339 formatted datetime string
TimeUpdated This property is required. string
The time the Database Tools Endpoint Service was updated. An RFC3339 formatted datetime string
CompartmentId This property is required. string
The ID of the compartment in which to list resources.
DefinedTags This property is required. map[string]string
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
Description This property is required. string
A description of the Database Tools Endpoint Service.
DisplayName This property is required. string
A filter to return only resources that match the entire specified display name.
FreeformTags This property is required. 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 This property is required. string
The OCID of the Database Tools Endpoint Service.
LifecycleDetails This property is required. 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 This property is required. string
A filter to return only resources that match the entire specified name.
State This property is required. string
A filter to return only resources their lifecycleState matches the specified lifecycleState.
SystemTags This property is required. map[string]string
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated This property is required. string
The time the Database Tools Endpoint Service was created. An RFC3339 formatted datetime string
TimeUpdated This property is required. string
The time the Database Tools Endpoint Service was updated. An RFC3339 formatted datetime string
compartmentId This property is required. String
The ID of the compartment in which to list resources.
definedTags This property is required. Map<String,String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description This property is required. String
A description of the Database Tools Endpoint Service.
displayName This property is required. String
A filter to return only resources that match the entire specified display name.
freeformTags This property is required. 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 This property is required. String
The OCID of the Database Tools Endpoint Service.
lifecycleDetails This property is required. 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 This property is required. String
A filter to return only resources that match the entire specified name.
state This property is required. String
A filter to return only resources their lifecycleState matches the specified lifecycleState.
systemTags This property is required. Map<String,String>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated This property is required. String
The time the Database Tools Endpoint Service was created. An RFC3339 formatted datetime string
timeUpdated This property is required. String
The time the Database Tools Endpoint Service was updated. An RFC3339 formatted datetime string
compartmentId This property is required. string
The ID of the compartment in which to list resources.
definedTags This property is required. {[key: string]: string}
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description This property is required. string
A description of the Database Tools Endpoint Service.
displayName This property is required. string
A filter to return only resources that match the entire specified display name.
freeformTags This property is required. {[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 This property is required. string
The OCID of the Database Tools Endpoint Service.
lifecycleDetails This property is required. 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 This property is required. string
A filter to return only resources that match the entire specified name.
state This property is required. string
A filter to return only resources their lifecycleState matches the specified lifecycleState.
systemTags This property is required. {[key: string]: string}
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated This property is required. string
The time the Database Tools Endpoint Service was created. An RFC3339 formatted datetime string
timeUpdated This property is required. string
The time the Database Tools Endpoint Service was updated. An RFC3339 formatted datetime string
compartment_id This property is required. str
The ID of the compartment in which to list resources.
defined_tags This property is required. Mapping[str, str]
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description This property is required. str
A description of the Database Tools Endpoint Service.
display_name This property is required. str
A filter to return only resources that match the entire specified display name.
freeform_tags This property is required. 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 This property is required. str
The OCID of the Database Tools Endpoint Service.
lifecycle_details This property is required. 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 This property is required. str
A filter to return only resources that match the entire specified name.
state This property is required. str
A filter to return only resources their lifecycleState matches the specified lifecycleState.
system_tags This property is required. Mapping[str, str]
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
time_created This property is required. str
The time the Database Tools Endpoint Service was created. An RFC3339 formatted datetime string
time_updated This property is required. str
The time the Database Tools Endpoint Service was updated. An RFC3339 formatted datetime string
compartmentId This property is required. String
The ID of the compartment in which to list resources.
definedTags This property is required. Map<String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description This property is required. String
A description of the Database Tools Endpoint Service.
displayName This property is required. String
A filter to return only resources that match the entire specified display name.
freeformTags This property is required. 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 This property is required. String
The OCID of the Database Tools Endpoint Service.
lifecycleDetails This property is required. 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 This property is required. String
A filter to return only resources that match the entire specified name.
state This property is required. String
A filter to return only resources their lifecycleState matches the specified lifecycleState.
systemTags This property is required. Map<String>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated This property is required. String
The time the Database Tools Endpoint Service was created. An RFC3339 formatted datetime string
timeUpdated This property is required. String
The time the Database Tools Endpoint Service was updated. An RFC3339 formatted datetime string

GetDatabaseToolsEndpointServicesFilter

Name This property is required. string
A filter to return only resources that match the entire specified name.
Values This property is required. List<string>
Regex bool
Name This property is required. string
A filter to return only resources that match the entire specified name.
Values This property is required. []string
Regex bool
name This property is required. String
A filter to return only resources that match the entire specified name.
values This property is required. List<String>
regex Boolean
name This property is required. string
A filter to return only resources that match the entire specified name.
values This property is required. string[]
regex boolean
name This property is required. str
A filter to return only resources that match the entire specified name.
values This property is required. Sequence[str]
regex bool
name This property is required. String
A filter to return only resources that match the entire specified name.
values This property is required. 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.
Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi