1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Oda
  5. getOdaPrivateEndpoints
Oracle Cloud Infrastructure v1.24.0 published on Thursday, Feb 22, 2024 by Pulumi

oci.Oda.getOdaPrivateEndpoints

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.24.0 published on Thursday, Feb 22, 2024 by Pulumi

    This data source provides the list of Oda Private Endpoints in Oracle Cloud Infrastructure Digital Assistant service.

    Returns a page of ODA Private Endpoints that belong to the specified compartment.

    If the opc-next-page header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header’s value as the page query parameter.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testOdaPrivateEndpoints = Oci.Oda.GetOdaPrivateEndpoints.Invoke(new()
        {
            CompartmentId = @var.Compartment_id,
            DisplayName = @var.Oda_private_endpoint_display_name,
            State = @var.Oda_private_endpoint_state,
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/go/oci/Oda"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Oda.GetOdaPrivateEndpoints(ctx, &oda.GetOdaPrivateEndpointsArgs{
    			CompartmentId: _var.Compartment_id,
    			DisplayName:   pulumi.StringRef(_var.Oda_private_endpoint_display_name),
    			State:         pulumi.StringRef(_var.Oda_private_endpoint_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.Oda.OdaFunctions;
    import com.pulumi.oci.Oda.inputs.GetOdaPrivateEndpointsArgs;
    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 testOdaPrivateEndpoints = OdaFunctions.getOdaPrivateEndpoints(GetOdaPrivateEndpointsArgs.builder()
                .compartmentId(var_.compartment_id())
                .displayName(var_.oda_private_endpoint_display_name())
                .state(var_.oda_private_endpoint_state())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_oci as oci
    
    test_oda_private_endpoints = oci.Oda.get_oda_private_endpoints(compartment_id=var["compartment_id"],
        display_name=var["oda_private_endpoint_display_name"],
        state=var["oda_private_endpoint_state"])
    
    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testOdaPrivateEndpoints = oci.Oda.getOdaPrivateEndpoints({
        compartmentId: _var.compartment_id,
        displayName: _var.oda_private_endpoint_display_name,
        state: _var.oda_private_endpoint_state,
    });
    
    variables:
      testOdaPrivateEndpoints:
        fn::invoke:
          Function: oci:Oda:getOdaPrivateEndpoints
          Arguments:
            compartmentId: ${var.compartment_id}
            displayName: ${var.oda_private_endpoint_display_name}
            state: ${var.oda_private_endpoint_state}
    

    Using getOdaPrivateEndpoints

    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 getOdaPrivateEndpoints(args: GetOdaPrivateEndpointsArgs, opts?: InvokeOptions): Promise<GetOdaPrivateEndpointsResult>
    function getOdaPrivateEndpointsOutput(args: GetOdaPrivateEndpointsOutputArgs, opts?: InvokeOptions): Output<GetOdaPrivateEndpointsResult>
    def get_oda_private_endpoints(compartment_id: Optional[str] = None,
                                  display_name: Optional[str] = None,
                                  filters: Optional[Sequence[_oda.GetOdaPrivateEndpointsFilter]] = None,
                                  state: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetOdaPrivateEndpointsResult
    def get_oda_private_endpoints_output(compartment_id: Optional[pulumi.Input[str]] = None,
                                  display_name: Optional[pulumi.Input[str]] = None,
                                  filters: Optional[pulumi.Input[Sequence[pulumi.Input[_oda.GetOdaPrivateEndpointsFilterArgs]]]] = None,
                                  state: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetOdaPrivateEndpointsResult]
    func GetOdaPrivateEndpoints(ctx *Context, args *GetOdaPrivateEndpointsArgs, opts ...InvokeOption) (*GetOdaPrivateEndpointsResult, error)
    func GetOdaPrivateEndpointsOutput(ctx *Context, args *GetOdaPrivateEndpointsOutputArgs, opts ...InvokeOption) GetOdaPrivateEndpointsResultOutput

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

    public static class GetOdaPrivateEndpoints 
    {
        public static Task<GetOdaPrivateEndpointsResult> InvokeAsync(GetOdaPrivateEndpointsArgs args, InvokeOptions? opts = null)
        public static Output<GetOdaPrivateEndpointsResult> Invoke(GetOdaPrivateEndpointsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetOdaPrivateEndpointsResult> getOdaPrivateEndpoints(GetOdaPrivateEndpointsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:Oda/getOdaPrivateEndpoints:getOdaPrivateEndpoints
      arguments:
        # arguments dictionary

    The following arguments are supported:

    CompartmentId string
    List the ODA Private Endpoints that belong to this compartment.
    DisplayName string
    List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change. Example: My new resource
    Filters List<GetOdaPrivateEndpointsFilter>
    State string
    List only the ODA Private Endpoints that are in this lifecycle state.
    CompartmentId string
    List the ODA Private Endpoints that belong to this compartment.
    DisplayName string
    List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change. Example: My new resource
    Filters []GetOdaPrivateEndpointsFilter
    State string
    List only the ODA Private Endpoints that are in this lifecycle state.
    compartmentId String
    List the ODA Private Endpoints that belong to this compartment.
    displayName String
    List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change. Example: My new resource
    filters List<GetPrivateEndpointsFilter>
    state String
    List only the ODA Private Endpoints that are in this lifecycle state.
    compartmentId string
    List the ODA Private Endpoints that belong to this compartment.
    displayName string
    List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change. Example: My new resource
    filters GetOdaPrivateEndpointsFilter[]
    state string
    List only the ODA Private Endpoints that are in this lifecycle state.
    compartment_id str
    List the ODA Private Endpoints that belong to this compartment.
    display_name str
    List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change. Example: My new resource
    filters GetOdaPrivateEndpointsFilter]
    state str
    List only the ODA Private Endpoints that are in this lifecycle state.
    compartmentId String
    List the ODA Private Endpoints that belong to this compartment.
    displayName String
    List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change. Example: My new resource
    filters List<Property Map>
    state String
    List only the ODA Private Endpoints that are in this lifecycle state.

    getOdaPrivateEndpoints Result

    The following output properties are available:

    CompartmentId string
    The OCID of the compartment that the ODA private endpoint belongs to.
    Id string
    The provider-assigned unique ID for this managed resource.
    OdaPrivateEndpointCollections List<GetOdaPrivateEndpointsOdaPrivateEndpointCollection>
    The list of oda_private_endpoint_collection.
    DisplayName string
    User-defined name for the ODA private endpoint. Avoid entering confidential information. You can change this value.
    Filters List<GetOdaPrivateEndpointsFilter>
    State string
    The current state of the ODA private endpoint.
    CompartmentId string
    The OCID of the compartment that the ODA private endpoint belongs to.
    Id string
    The provider-assigned unique ID for this managed resource.
    OdaPrivateEndpointCollections []GetOdaPrivateEndpointsOdaPrivateEndpointCollection
    The list of oda_private_endpoint_collection.
    DisplayName string
    User-defined name for the ODA private endpoint. Avoid entering confidential information. You can change this value.
    Filters []GetOdaPrivateEndpointsFilter
    State string
    The current state of the ODA private endpoint.
    compartmentId String
    The OCID of the compartment that the ODA private endpoint belongs to.
    id String
    The provider-assigned unique ID for this managed resource.
    odaPrivateEndpointCollections List<GetPrivateEndpointsPrivateEndpointCollection>
    The list of oda_private_endpoint_collection.
    displayName String
    User-defined name for the ODA private endpoint. Avoid entering confidential information. You can change this value.
    filters List<GetPrivateEndpointsFilter>
    state String
    The current state of the ODA private endpoint.
    compartmentId string
    The OCID of the compartment that the ODA private endpoint belongs to.
    id string
    The provider-assigned unique ID for this managed resource.
    odaPrivateEndpointCollections GetOdaPrivateEndpointsOdaPrivateEndpointCollection[]
    The list of oda_private_endpoint_collection.
    displayName string
    User-defined name for the ODA private endpoint. Avoid entering confidential information. You can change this value.
    filters GetOdaPrivateEndpointsFilter[]
    state string
    The current state of the ODA private endpoint.
    compartment_id str
    The OCID of the compartment that the ODA private endpoint belongs to.
    id str
    The provider-assigned unique ID for this managed resource.
    oda_private_endpoint_collections GetOdaPrivateEndpointsOdaPrivateEndpointCollection]
    The list of oda_private_endpoint_collection.
    display_name str
    User-defined name for the ODA private endpoint. Avoid entering confidential information. You can change this value.
    filters GetOdaPrivateEndpointsFilter]
    state str
    The current state of the ODA private endpoint.
    compartmentId String
    The OCID of the compartment that the ODA private endpoint belongs to.
    id String
    The provider-assigned unique ID for this managed resource.
    odaPrivateEndpointCollections List<Property Map>
    The list of oda_private_endpoint_collection.
    displayName String
    User-defined name for the ODA private endpoint. Avoid entering confidential information. You can change this value.
    filters List<Property Map>
    state String
    The current state of the ODA private endpoint.

    Supporting Types

    GetOdaPrivateEndpointsFilter

    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

    GetOdaPrivateEndpointsOdaPrivateEndpointCollection

    GetOdaPrivateEndpointsOdaPrivateEndpointCollectionItem

    CompartmentId string
    List the ODA Private Endpoints that belong to this compartment.
    DefinedTags Dictionary<string, object>
    Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    Description string
    Description of the ODA private endpoint.
    DisplayName string
    List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change. Example: My new resource
    FreeformTags Dictionary<string, object>
    Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"}
    Id string
    The OCID that was assigned when the ODA private endpoint was created.
    NsgIds List<string>
    List of OCIDs of network security groups
    State string
    List only the ODA Private Endpoints that are in this lifecycle state.
    SubnetId string
    The OCID of the subnet that the private endpoint belongs to.
    TimeCreated string
    When the resource was created. A date-time string as described in RFC 3339, section 14.29.
    TimeUpdated string
    When the resource was last updated. A date-time string as described in RFC 3339, section 14.29.
    CompartmentId string
    List the ODA Private Endpoints that belong to this compartment.
    DefinedTags map[string]interface{}
    Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    Description string
    Description of the ODA private endpoint.
    DisplayName string
    List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change. Example: My new resource
    FreeformTags map[string]interface{}
    Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"}
    Id string
    The OCID that was assigned when the ODA private endpoint was created.
    NsgIds []string
    List of OCIDs of network security groups
    State string
    List only the ODA Private Endpoints that are in this lifecycle state.
    SubnetId string
    The OCID of the subnet that the private endpoint belongs to.
    TimeCreated string
    When the resource was created. A date-time string as described in RFC 3339, section 14.29.
    TimeUpdated string
    When the resource was last updated. A date-time string as described in RFC 3339, section 14.29.
    compartmentId String
    List the ODA Private Endpoints that belong to this compartment.
    definedTags Map<String,Object>
    Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    description String
    Description of the ODA private endpoint.
    displayName String
    List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change. Example: My new resource
    freeformTags Map<String,Object>
    Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"}
    id String
    The OCID that was assigned when the ODA private endpoint was created.
    nsgIds List<String>
    List of OCIDs of network security groups
    state String
    List only the ODA Private Endpoints that are in this lifecycle state.
    subnetId String
    The OCID of the subnet that the private endpoint belongs to.
    timeCreated String
    When the resource was created. A date-time string as described in RFC 3339, section 14.29.
    timeUpdated String
    When the resource was last updated. A date-time string as described in RFC 3339, section 14.29.
    compartmentId string
    List the ODA Private Endpoints that belong to this compartment.
    definedTags {[key: string]: any}
    Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    description string
    Description of the ODA private endpoint.
    displayName string
    List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change. Example: My new resource
    freeformTags {[key: string]: any}
    Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"}
    id string
    The OCID that was assigned when the ODA private endpoint was created.
    nsgIds string[]
    List of OCIDs of network security groups
    state string
    List only the ODA Private Endpoints that are in this lifecycle state.
    subnetId string
    The OCID of the subnet that the private endpoint belongs to.
    timeCreated string
    When the resource was created. A date-time string as described in RFC 3339, section 14.29.
    timeUpdated string
    When the resource was last updated. A date-time string as described in RFC 3339, section 14.29.
    compartment_id str
    List the ODA Private Endpoints that belong to this compartment.
    defined_tags Mapping[str, Any]
    Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    description str
    Description of the ODA private endpoint.
    display_name str
    List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change. Example: My new resource
    freeform_tags Mapping[str, Any]
    Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"}
    id str
    The OCID that was assigned when the ODA private endpoint was created.
    nsg_ids Sequence[str]
    List of OCIDs of network security groups
    state str
    List only the ODA Private Endpoints that are in this lifecycle state.
    subnet_id str
    The OCID of the subnet that the private endpoint belongs to.
    time_created str
    When the resource was created. A date-time string as described in RFC 3339, section 14.29.
    time_updated str
    When the resource was last updated. A date-time string as described in RFC 3339, section 14.29.
    compartmentId String
    List the ODA Private Endpoints that belong to this compartment.
    definedTags Map<Any>
    Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    description String
    Description of the ODA private endpoint.
    displayName String
    List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change. Example: My new resource
    freeformTags Map<Any>
    Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"}
    id String
    The OCID that was assigned when the ODA private endpoint was created.
    nsgIds List<String>
    List of OCIDs of network security groups
    state String
    List only the ODA Private Endpoints that are in this lifecycle state.
    subnetId String
    The OCID of the subnet that the private endpoint belongs to.
    timeCreated String
    When the resource was created. A date-time string as described in RFC 3339, section 14.29.
    timeUpdated String
    When the resource was last updated. A date-time string as described in RFC 3339, section 14.29.

    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 v1.24.0 published on Thursday, Feb 22, 2024 by Pulumi