Oracle Cloud Infrastructure

Pulumi Official
Package maintained by Pulumi
v0.1.1 published on Tuesday, May 3, 2022 by Pulumi

getPrivateEndpoints

This data source provides the list of Private Endpoints in Oracle Cloud Infrastructure Data Flow service.

Lists all private endpoints in the specified compartment.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testPrivateEndpoints = Output.Create(Oci.DataFlow.GetPrivateEndpoints.InvokeAsync(new Oci.DataFlow.GetPrivateEndpointsArgs
        {
            CompartmentId = @var.Compartment_id,
            DisplayName = @var.Private_endpoint_display_name,
            DisplayNameStartsWith = @var.Private_endpoint_display_name_starts_with,
            OwnerPrincipalId = @var.Owner_principal_id,
            State = @var.Private_endpoint_state,
        }));
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := DataFlow.GetPrivateEndpoints(ctx, &dataflow.GetPrivateEndpointsArgs{
			CompartmentId:         _var.Compartment_id,
			DisplayName:           pulumi.StringRef(_var.Private_endpoint_display_name),
			DisplayNameStartsWith: pulumi.StringRef(_var.Private_endpoint_display_name_starts_with),
			OwnerPrincipalId:      pulumi.StringRef(_var.Owner_principal_id),
			State:                 pulumi.StringRef(_var.Private_endpoint_state),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_private_endpoints = oci.DataFlow.get_private_endpoints(compartment_id=var["compartment_id"],
    display_name=var["private_endpoint_display_name"],
    display_name_starts_with=var["private_endpoint_display_name_starts_with"],
    owner_principal_id=var["owner_principal_id"],
    state=var["private_endpoint_state"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testPrivateEndpoints = oci.DataFlow.getPrivateEndpoints({
    compartmentId: _var.compartment_id,
    displayName: _var.private_endpoint_display_name,
    displayNameStartsWith: _var.private_endpoint_display_name_starts_with,
    ownerPrincipalId: _var.owner_principal_id,
    state: _var.private_endpoint_state,
});

Coming soon!

Using getPrivateEndpoints

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 getPrivateEndpoints(args: GetPrivateEndpointsArgs, opts?: InvokeOptions): Promise<GetPrivateEndpointsResult>
function getPrivateEndpointsOutput(args: GetPrivateEndpointsOutputArgs, opts?: InvokeOptions): Output<GetPrivateEndpointsResult>
def get_private_endpoints(compartment_id: Optional[str] = None,
                          display_name: Optional[str] = None,
                          display_name_starts_with: Optional[str] = None,
                          filters: Optional[Sequence[_dataflow.GetPrivateEndpointsFilter]] = None,
                          owner_principal_id: Optional[str] = None,
                          state: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetPrivateEndpointsResult
def get_private_endpoints_output(compartment_id: Optional[pulumi.Input[str]] = None,
                          display_name: Optional[pulumi.Input[str]] = None,
                          display_name_starts_with: Optional[pulumi.Input[str]] = None,
                          filters: Optional[pulumi.Input[Sequence[pulumi.Input[_dataflow.GetPrivateEndpointsFilterArgs]]]] = None,
                          owner_principal_id: Optional[pulumi.Input[str]] = None,
                          state: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetPrivateEndpointsResult]
func GetPrivateEndpoints(ctx *Context, args *GetPrivateEndpointsArgs, opts ...InvokeOption) (*GetPrivateEndpointsResult, error)
func GetPrivateEndpointsOutput(ctx *Context, args *GetPrivateEndpointsOutputArgs, opts ...InvokeOption) GetPrivateEndpointsResultOutput

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

public static class GetPrivateEndpoints 
{
    public static Task<GetPrivateEndpointsResult> InvokeAsync(GetPrivateEndpointsArgs args, InvokeOptions? opts = null)
    public static Output<GetPrivateEndpointsResult> Invoke(GetPrivateEndpointsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetPrivateEndpointsResult> getPrivateEndpoints(GetPrivateEndpointsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: oci:DataFlow/getPrivateEndpoints:getPrivateEndpoints
  Arguments:
    # Arguments dictionary

The following arguments are supported:

CompartmentId string

The OCID of the compartment.

DisplayName string

The query parameter for the Spark application name. Note: At a time only one optional filter can be used with compartment_id to get the list of Private Endpoint resources.

DisplayNameStartsWith string

The displayName prefix.

Filters List<GetPrivateEndpointsFilter>
OwnerPrincipalId string

The OCID of the user who created the resource.

State string

The LifecycleState of the private endpoint.

CompartmentId string

The OCID of the compartment.

DisplayName string

The query parameter for the Spark application name. Note: At a time only one optional filter can be used with compartment_id to get the list of Private Endpoint resources.

DisplayNameStartsWith string

The displayName prefix.

Filters []GetPrivateEndpointsFilter
OwnerPrincipalId string

The OCID of the user who created the resource.

State string

The LifecycleState of the private endpoint.

compartmentId String

The OCID of the compartment.

displayName String

The query parameter for the Spark application name. Note: At a time only one optional filter can be used with compartment_id to get the list of Private Endpoint resources.

displayNameStartsWith String

The displayName prefix.

filters List<GetPrivateEndpointsFilter>
ownerPrincipalId String

The OCID of the user who created the resource.

state String

The LifecycleState of the private endpoint.

compartmentId string

The OCID of the compartment.

displayName string

The query parameter for the Spark application name. Note: At a time only one optional filter can be used with compartment_id to get the list of Private Endpoint resources.

displayNameStartsWith string

The displayName prefix.

filters GetPrivateEndpointsFilter[]
ownerPrincipalId string

The OCID of the user who created the resource.

state string

The LifecycleState of the private endpoint.

compartment_id str

The OCID of the compartment.

display_name str

The query parameter for the Spark application name. Note: At a time only one optional filter can be used with compartment_id to get the list of Private Endpoint resources.

display_name_starts_with str

The displayName prefix.

filters GetPrivateEndpointsFilter]
owner_principal_id str

The OCID of the user who created the resource.

state str

The LifecycleState of the private endpoint.

compartmentId String

The OCID of the compartment.

displayName String

The query parameter for the Spark application name. Note: At a time only one optional filter can be used with compartment_id to get the list of Private Endpoint resources.

displayNameStartsWith String

The displayName prefix.

filters List<Property Map>
ownerPrincipalId String

The OCID of the user who created the resource.

state String

The LifecycleState of the private endpoint.

getPrivateEndpoints Result

The following output properties are available:

CompartmentId string

The OCID of a compartment.

Id string

The provider-assigned unique ID for this managed resource.

PrivateEndpointCollections List<GetPrivateEndpointsPrivateEndpointCollection>

The list of private_endpoint_collection.

DisplayName string

A user-friendly name. It does not have to be unique. Avoid entering confidential information.

DisplayNameStartsWith string
Filters List<GetPrivateEndpointsFilter>
OwnerPrincipalId string

The OCID of the user who created the resource.

State string

The current state of this private endpoint.

CompartmentId string

The OCID of a compartment.

Id string

The provider-assigned unique ID for this managed resource.

PrivateEndpointCollections []GetPrivateEndpointsPrivateEndpointCollection

The list of private_endpoint_collection.

DisplayName string

A user-friendly name. It does not have to be unique. Avoid entering confidential information.

DisplayNameStartsWith string
Filters []GetPrivateEndpointsFilter
OwnerPrincipalId string

The OCID of the user who created the resource.

State string

The current state of this private endpoint.

compartmentId String

The OCID of a compartment.

id String

The provider-assigned unique ID for this managed resource.

privateEndpointCollections List<GetPrivateEndpointsPrivateEndpointCollection>

The list of private_endpoint_collection.

displayName String

A user-friendly name. It does not have to be unique. Avoid entering confidential information.

displayNameStartsWith String
filters List<GetPrivateEndpointsFilter>
ownerPrincipalId String

The OCID of the user who created the resource.

state String

The current state of this private endpoint.

compartmentId string

The OCID of a compartment.

id string

The provider-assigned unique ID for this managed resource.

privateEndpointCollections GetPrivateEndpointsPrivateEndpointCollection[]

The list of private_endpoint_collection.

displayName string

A user-friendly name. It does not have to be unique. Avoid entering confidential information.

displayNameStartsWith string
filters GetPrivateEndpointsFilter[]
ownerPrincipalId string

The OCID of the user who created the resource.

state string

The current state of this private endpoint.

compartment_id str

The OCID of a compartment.

id str

The provider-assigned unique ID for this managed resource.

private_endpoint_collections GetPrivateEndpointsPrivateEndpointCollection]

The list of private_endpoint_collection.

display_name str

A user-friendly name. It does not have to be unique. Avoid entering confidential information.

display_name_starts_with str
filters GetPrivateEndpointsFilter]
owner_principal_id str

The OCID of the user who created the resource.

state str

The current state of this private endpoint.

compartmentId String

The OCID of a compartment.

id String

The provider-assigned unique ID for this managed resource.

privateEndpointCollections List<Property Map>

The list of private_endpoint_collection.

displayName String

A user-friendly name. It does not have to be unique. Avoid entering confidential information.

displayNameStartsWith String
filters List<Property Map>
ownerPrincipalId String

The OCID of the user who created the resource.

state String

The current state of this private endpoint.

Supporting Types

GetPrivateEndpointsFilter

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

GetPrivateEndpointsPrivateEndpointCollection

GetPrivateEndpointsPrivateEndpointCollectionItem

CompartmentId string

The OCID of the compartment.

DefinedTags Dictionary<string, object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

Description string

A user-friendly description. Avoid entering confidential information.

DisplayName string

The query parameter for the Spark application name. Note: At a time only one optional filter can be used with compartment_id to get the list of Private Endpoint resources.

DnsZones List<string>

An array of DNS zone names. Example: [ "app.examplecorp.com", "app.examplecorp2.com" ]

FreeformTags Dictionary<string, object>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

Id string

The OCID of a private endpoint.

LifecycleDetails string

The detailed messages about the lifecycle state.

MaxHostCount int

The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.

NsgIds List<string>

An array of network security group OCIDs.

OwnerPrincipalId string

The OCID of the user who created the resource.

OwnerUserName string

The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.

State string

The LifecycleState of the private endpoint.

SubnetId string

The OCID of a subnet.

TimeCreated string

The date and time a application was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

TimeUpdated string

The date and time a application was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

CompartmentId string

The OCID of the compartment.

DefinedTags map[string]interface{}

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

Description string

A user-friendly description. Avoid entering confidential information.

DisplayName string

The query parameter for the Spark application name. Note: At a time only one optional filter can be used with compartment_id to get the list of Private Endpoint resources.

DnsZones []string

An array of DNS zone names. Example: [ "app.examplecorp.com", "app.examplecorp2.com" ]

FreeformTags map[string]interface{}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

Id string

The OCID of a private endpoint.

LifecycleDetails string

The detailed messages about the lifecycle state.

MaxHostCount int

The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.

NsgIds []string

An array of network security group OCIDs.

OwnerPrincipalId string

The OCID of the user who created the resource.

OwnerUserName string

The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.

State string

The LifecycleState of the private endpoint.

SubnetId string

The OCID of a subnet.

TimeCreated string

The date and time a application was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

TimeUpdated string

The date and time a application was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

compartmentId String

The OCID of the compartment.

definedTags Map<String,Object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

description String

A user-friendly description. Avoid entering confidential information.

displayName String

The query parameter for the Spark application name. Note: At a time only one optional filter can be used with compartment_id to get the list of Private Endpoint resources.

dnsZones List<String>

An array of DNS zone names. Example: [ "app.examplecorp.com", "app.examplecorp2.com" ]

freeformTags Map<String,Object>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

id String

The OCID of a private endpoint.

lifecycleDetails String

The detailed messages about the lifecycle state.

maxHostCount Integer

The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.

nsgIds List<String>

An array of network security group OCIDs.

ownerPrincipalId String

The OCID of the user who created the resource.

ownerUserName String

The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.

state String

The LifecycleState of the private endpoint.

subnetId String

The OCID of a subnet.

timeCreated String

The date and time a application was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

timeUpdated String

The date and time a application was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

compartmentId string

The OCID of the compartment.

definedTags {[key: string]: any}

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

description string

A user-friendly description. Avoid entering confidential information.

displayName string

The query parameter for the Spark application name. Note: At a time only one optional filter can be used with compartment_id to get the list of Private Endpoint resources.

dnsZones string[]

An array of DNS zone names. Example: [ "app.examplecorp.com", "app.examplecorp2.com" ]

freeformTags {[key: string]: any}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

id string

The OCID of a private endpoint.

lifecycleDetails string

The detailed messages about the lifecycle state.

maxHostCount number

The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.

nsgIds string[]

An array of network security group OCIDs.

ownerPrincipalId string

The OCID of the user who created the resource.

ownerUserName string

The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.

state string

The LifecycleState of the private endpoint.

subnetId string

The OCID of a subnet.

timeCreated string

The date and time a application was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

timeUpdated string

The date and time a application was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

compartment_id str

The OCID of the compartment.

defined_tags Mapping[str, Any]

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

description str

A user-friendly description. Avoid entering confidential information.

display_name str

The query parameter for the Spark application name. Note: At a time only one optional filter can be used with compartment_id to get the list of Private Endpoint resources.

dns_zones Sequence[str]

An array of DNS zone names. Example: [ "app.examplecorp.com", "app.examplecorp2.com" ]

freeform_tags Mapping[str, Any]

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

id str

The OCID of a private endpoint.

lifecycle_details str

The detailed messages about the lifecycle state.

max_host_count int

The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.

nsg_ids Sequence[str]

An array of network security group OCIDs.

owner_principal_id str

The OCID of the user who created the resource.

owner_user_name str

The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.

state str

The LifecycleState of the private endpoint.

subnet_id str

The OCID of a subnet.

time_created str

The date and time a application was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

time_updated str

The date and time a application was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

compartmentId String

The OCID of the compartment.

definedTags Map<Any>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

description String

A user-friendly description. Avoid entering confidential information.

displayName String

The query parameter for the Spark application name. Note: At a time only one optional filter can be used with compartment_id to get the list of Private Endpoint resources.

dnsZones List<String>

An array of DNS zone names. Example: [ "app.examplecorp.com", "app.examplecorp2.com" ]

freeformTags Map<Any>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

id String

The OCID of a private endpoint.

lifecycleDetails String

The detailed messages about the lifecycle state.

maxHostCount Number

The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.

nsgIds List<String>

An array of network security group OCIDs.

ownerPrincipalId String

The OCID of the user who created the resource.

ownerUserName String

The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.

state String

The LifecycleState of the private endpoint.

subnetId String

The OCID of a subnet.

timeCreated String

The date and time a application was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

timeUpdated String

The date and time a application was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.