Oracle Cloud Infrastructure v0.12.0, Mar 17 23

oci.DatabaseTools.getDatabaseToolsEndpointServices

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

using System.Collections.Generic;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testDatabaseToolsEndpointServices = Oci.DatabaseTools.GetDatabaseToolsEndpointServices.Invoke(new()
    {
        CompartmentId = @var.Compartment_id,
        DisplayName = @var.Database_tools_endpoint_service_display_name,
        Name = @var.Database_tools_endpoint_service_name,
        State = @var.Database_tools_endpoint_service_state,
    });

});

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/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: _var.Compartment_id,
			DisplayName:   pulumi.StringRef(_var.Database_tools_endpoint_service_display_name),
			Name:          pulumi.StringRef(_var.Database_tools_endpoint_service_name),
			State:         pulumi.StringRef(_var.Database_tools_endpoint_service_state),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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(var_.compartment_id())
            .displayName(var_.database_tools_endpoint_service_display_name())
            .name(var_.database_tools_endpoint_service_name())
            .state(var_.database_tools_endpoint_service_state())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_database_tools_endpoint_services = oci.DatabaseTools.get_database_tools_endpoint_services(compartment_id=var["compartment_id"],
    display_name=var["database_tools_endpoint_service_display_name"],
    name=var["database_tools_endpoint_service_name"],
    state=var["database_tools_endpoint_service_state"])

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

const testDatabaseToolsEndpointServices = oci.DatabaseTools.getDatabaseToolsEndpointServices({
    compartmentId: _var.compartment_id,
    displayName: _var.database_tools_endpoint_service_display_name,
    name: _var.database_tools_endpoint_service_name,
    state: _var.database_tools_endpoint_service_state,
});

variables:
  testDatabaseToolsEndpointServices:
    fn::invoke:
      Function: oci:DatabaseTools:getDatabaseToolsEndpointServices
      Arguments:
        compartmentId: ${var.compartment_id}
        displayName: ${var.database_tools_endpoint_service_display_name}
        name: ${var.database_tools_endpoint_service_name}
        state: ${var.database_tools_endpoint_service_state}

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[_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]

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)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:DatabaseTools/getDatabaseToolsEndpointServices:getDatabaseToolsEndpointServices
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId 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 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 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 []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 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 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 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 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 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 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 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 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 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 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 List<GetDatabaseToolsEndpointServicesDatabaseToolsEndpointServiceCollectionItem>

Items []GetDatabaseToolsEndpointServicesDatabaseToolsEndpointServiceCollectionItem

items List<GetEndpointServicesEndpointServiceCollectionItem>

items GetDatabaseToolsEndpointServicesDatabaseToolsEndpointServiceCollectionItem[]

items GetDatabaseToolsEndpointServicesDatabaseToolsEndpointServiceCollectionItem]

items List<Property Map>

GetDatabaseToolsEndpointServicesDatabaseToolsEndpointServiceCollectionItem

CompartmentId string: The ID of the compartment in which to list resources.
DefinedTags Dictionary<string, object>: 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.
DisplayName string: A filter to return only resources that match the entire specified display name.
FreeformTags Dictionary<string, object>: 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.
LifecycleDetails 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 lifecycleState matches the specified lifecycleState.
SystemTags Dictionary<string, object>: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: The time the Database Tools Endpoint Service was created. An RFC3339 formatted datetime string
TimeUpdated string: The time the Database Tools Endpoint Service was updated. An RFC3339 formatted datetime string

CompartmentId string: The ID of the compartment in which to list resources.
DefinedTags map[string]interface{}: 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.
DisplayName string: A filter to return only resources that match the entire specified display name.
FreeformTags map[string]interface{}: 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.
LifecycleDetails 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 lifecycleState matches the specified lifecycleState.
SystemTags map[string]interface{}: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: The time the Database Tools Endpoint Service was created. An RFC3339 formatted datetime string
TimeUpdated string: The time the Database Tools Endpoint Service was updated. An RFC3339 formatted datetime string

compartmentId String: The ID of the compartment in which to list resources.
definedTags Map<String,Object>: 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.
displayName String: A filter to return only resources that match the entire specified display name.
freeformTags Map<String,Object>: 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.
lifecycleDetails 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 lifecycleState matches the specified lifecycleState.
systemTags Map<String,Object>: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: The time the Database Tools Endpoint Service was created. An RFC3339 formatted datetime string
timeUpdated String: The time the Database Tools Endpoint Service was updated. An RFC3339 formatted datetime string

compartmentId string: The ID of the compartment in which to list resources.
definedTags {[key: string]: any}: 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.
displayName string: A filter to return only resources that match the entire specified display name.
freeformTags {[key: string]: any}: 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.
lifecycleDetails 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 lifecycleState matches the specified lifecycleState.
systemTags {[key: string]: any}: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated string: The time the Database Tools Endpoint Service was created. An RFC3339 formatted datetime string
timeUpdated string: The time the Database Tools Endpoint Service was updated. An RFC3339 formatted datetime string

compartment_id str: The ID of the compartment in which to list resources.
defined_tags Mapping[str, Any]: 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.
freeform_tags Mapping[str, Any]: 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 lifecycleState matches the specified lifecycleState.
system_tags Mapping[str, Any]: 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

compartmentId String: The ID of the compartment in which to list resources.
definedTags Map<Any>: 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.
displayName String: A filter to return only resources that match the entire specified display name.
freeformTags Map<Any>: 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.
lifecycleDetails 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 lifecycleState matches the specified lifecycleState.
systemTags Map<Any>: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: The time the Database Tools Endpoint Service was created. An RFC3339 formatted datetime string
timeUpdated String: The time the Database Tools Endpoint Service was updated. An RFC3339 formatted datetime string

GetDatabaseToolsEndpointServicesFilter

Name string: A filter to return only resources that match the entire specified name.
Values List<string>
Regex bool

Name string: A filter to return only resources that match the entire specified name.
Values []string
Regex bool

name String: A filter to return only resources that match the entire specified name.
values List<String>
regex Boolean

name string: A filter to return only resources that match the entire specified name.
values string[]
regex boolean

name str: A filter to return only resources that match the entire specified name.
values Sequence[str]
regex bool

name String: A filter to return only resources that match the entire specified name.
values 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.