oci.DataFlow.getPrivateEndpoints
Explore with Pulumi AI
This data source provides the list of Private Endpoints in Oracle Cloud Infrastructure Data Flow service.
Lists all private endpoints in the specified compartment. The query must include compartmentId. The query may also include one other parameter. If the query does not include compartmentId, or includes compartmentId, but with two or more other parameters, an error is returned.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testPrivateEndpoints = oci.DataFlow.getPrivateEndpoints({
compartmentId: compartmentId,
displayName: privateEndpointDisplayName,
displayNameStartsWith: privateEndpointDisplayNameStartsWith,
ownerPrincipalId: ownerPrincipalId,
state: privateEndpointState,
});
import pulumi
import pulumi_oci as oci
test_private_endpoints = oci.DataFlow.get_private_endpoints(compartment_id=compartment_id,
display_name=private_endpoint_display_name,
display_name_starts_with=private_endpoint_display_name_starts_with,
owner_principal_id=owner_principal_id,
state=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: compartmentId,
DisplayName: pulumi.StringRef(privateEndpointDisplayName),
DisplayNameStartsWith: pulumi.StringRef(privateEndpointDisplayNameStartsWith),
OwnerPrincipalId: pulumi.StringRef(ownerPrincipalId),
State: pulumi.StringRef(privateEndpointState),
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testPrivateEndpoints = Oci.DataFlow.GetPrivateEndpoints.Invoke(new()
{
CompartmentId = compartmentId,
DisplayName = privateEndpointDisplayName,
DisplayNameStartsWith = privateEndpointDisplayNameStartsWith,
OwnerPrincipalId = ownerPrincipalId,
State = privateEndpointState,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DataFlow.DataFlowFunctions;
import com.pulumi.oci.DataFlow.inputs.GetPrivateEndpointsArgs;
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 testPrivateEndpoints = DataFlowFunctions.getPrivateEndpoints(GetPrivateEndpointsArgs.builder()
.compartmentId(compartmentId)
.displayName(privateEndpointDisplayName)
.displayNameStartsWith(privateEndpointDisplayNameStartsWith)
.ownerPrincipalId(ownerPrincipalId)
.state(privateEndpointState)
.build());
}
}
variables:
testPrivateEndpoints:
fn::invoke:
Function: oci:DataFlow:getPrivateEndpoints
Arguments:
compartmentId: ${compartmentId}
displayName: ${privateEndpointDisplayName}
displayNameStartsWith: ${privateEndpointDisplayNameStartsWith}
ownerPrincipalId: ${ownerPrincipalId}
state: ${privateEndpointState}
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:
- Compartment
Id string - The OCID of the compartment.
- Display
Name 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. - Display
Name stringStarts With - The displayName prefix.
- Filters
List<Get
Private Endpoints Filter> - Owner
Principal stringId - The OCID of the user who created the resource.
- State string
- The LifecycleState of the private endpoint.
- Compartment
Id string - The OCID of the compartment.
- Display
Name 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. - Display
Name stringStarts With - The displayName prefix.
- Filters
[]Get
Private Endpoints Filter - Owner
Principal stringId - The OCID of the user who created the resource.
- State string
- The LifecycleState of the private endpoint.
- compartment
Id String - The OCID of the compartment.
- display
Name 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. - display
Name StringStarts With - The displayName prefix.
- filters
List<Get
Private Endpoints Filter> - owner
Principal StringId - The OCID of the user who created the resource.
- state String
- The LifecycleState of the private endpoint.
- compartment
Id string - The OCID of the compartment.
- display
Name 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. - display
Name stringStarts With - The displayName prefix.
- filters
Get
Private Endpoints Filter[] - owner
Principal stringId - 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_ strstarts_ with - The displayName prefix.
- filters
Sequence[dataflow.
Get Private Endpoints Filter] - owner_
principal_ strid - The OCID of the user who created the resource.
- state str
- The LifecycleState of the private endpoint.
- compartment
Id String - The OCID of the compartment.
- display
Name 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. - display
Name StringStarts With - The displayName prefix.
- filters List<Property Map>
- owner
Principal StringId - 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:
- Compartment
Id string - The OCID of a compartment.
- Id string
- The provider-assigned unique ID for this managed resource.
- Private
Endpoint List<GetCollections Private Endpoints Private Endpoint Collection> - The list of private_endpoint_collection.
- Display
Name string - A user-friendly name. It does not have to be unique. Avoid entering confidential information.
- Display
Name stringStarts With - Filters
List<Get
Private Endpoints Filter> - Owner
Principal stringId - The OCID of the user who created the resource.
- State string
- The current state of this private endpoint.
- Compartment
Id string - The OCID of a compartment.
- Id string
- The provider-assigned unique ID for this managed resource.
- Private
Endpoint []GetCollections Private Endpoints Private Endpoint Collection - The list of private_endpoint_collection.
- Display
Name string - A user-friendly name. It does not have to be unique. Avoid entering confidential information.
- Display
Name stringStarts With - Filters
[]Get
Private Endpoints Filter - Owner
Principal stringId - The OCID of the user who created the resource.
- State string
- The current state of this private endpoint.
- compartment
Id String - The OCID of a compartment.
- id String
- The provider-assigned unique ID for this managed resource.
- private
Endpoint List<GetCollections Private Endpoints Private Endpoint Collection> - The list of private_endpoint_collection.
- display
Name String - A user-friendly name. It does not have to be unique. Avoid entering confidential information.
- display
Name StringStarts With - filters
List<Get
Private Endpoints Filter> - owner
Principal StringId - The OCID of the user who created the resource.
- state String
- The current state of this private endpoint.
- compartment
Id string - The OCID of a compartment.
- id string
- The provider-assigned unique ID for this managed resource.
- private
Endpoint GetCollections Private Endpoints Private Endpoint Collection[] - The list of private_endpoint_collection.
- display
Name string - A user-friendly name. It does not have to be unique. Avoid entering confidential information.
- display
Name stringStarts With - filters
Get
Private Endpoints Filter[] - owner
Principal stringId - 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_ Sequence[dataflow.collections Get Private Endpoints Private Endpoint Collection] - 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_ strstarts_ with - filters
Sequence[dataflow.
Get Private Endpoints Filter] - owner_
principal_ strid - The OCID of the user who created the resource.
- state str
- The current state of this private endpoint.
- compartment
Id String - The OCID of a compartment.
- id String
- The provider-assigned unique ID for this managed resource.
- private
Endpoint List<Property Map>Collections - The list of private_endpoint_collection.
- display
Name String - A user-friendly name. It does not have to be unique. Avoid entering confidential information.
- display
Name StringStarts With - filters List<Property Map>
- owner
Principal StringId - The OCID of the user who created the resource.
- state String
- The current state of this private endpoint.
Supporting Types
GetPrivateEndpointsFilter
GetPrivateEndpointsPrivateEndpointCollection
GetPrivateEndpointsPrivateEndpointCollectionItem
- Compartment
Id string - The OCID of the compartment.
- 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.
- Display
Name 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. - Dns
Zones List<string> - An array of DNS zone names. Example:
[ "app.examplecorp.com", "app.examplecorp2.com" ]
- 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.
- Lifecycle
Details string - The detailed messages about the lifecycle state.
- Max
Host intCount - 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 List<string> - An array of network security group OCIDs.
- Owner
Principal stringId - The OCID of the user who created the resource.
- Owner
User stringName - 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. - Scan
Details List<GetPrivate Endpoints Private Endpoint Collection Item Scan Detail> - An array of fqdn/port pairs used to create private endpoint. Each object is a simple key-value pair with FQDN as key and port number as value. [ { fqdn: "scan1.oracle.com", port: "1521"}, { fqdn: "scan2.oracle.com", port: "1521" } ]
- State string
- The LifecycleState of the private endpoint.
- Subnet
Id string - The OCID of a subnet.
- Time
Created string - The date and time the resource was created, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z
- Time
Updated string - The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z
- Compartment
Id string - The OCID of the compartment.
- 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.
- Display
Name 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. - Dns
Zones []string - An array of DNS zone names. Example:
[ "app.examplecorp.com", "app.examplecorp2.com" ]
- 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.
- Lifecycle
Details string - The detailed messages about the lifecycle state.
- Max
Host intCount - 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 []string - An array of network security group OCIDs.
- Owner
Principal stringId - The OCID of the user who created the resource.
- Owner
User stringName - 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. - Scan
Details []GetPrivate Endpoints Private Endpoint Collection Item Scan Detail - An array of fqdn/port pairs used to create private endpoint. Each object is a simple key-value pair with FQDN as key and port number as value. [ { fqdn: "scan1.oracle.com", port: "1521"}, { fqdn: "scan2.oracle.com", port: "1521" } ]
- State string
- The LifecycleState of the private endpoint.
- Subnet
Id string - The OCID of a subnet.
- Time
Created string - The date and time the resource was created, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z
- Time
Updated string - The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z
- compartment
Id String - The OCID of the compartment.
- 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.
- display
Name 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. - dns
Zones List<String> - An array of DNS zone names. Example:
[ "app.examplecorp.com", "app.examplecorp2.com" ]
- 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.
- lifecycle
Details String - The detailed messages about the lifecycle state.
- max
Host IntegerCount - 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 List<String> - An array of network security group OCIDs.
- owner
Principal StringId - The OCID of the user who created the resource.
- owner
User StringName - 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. - scan
Details List<GetPrivate Endpoints Private Endpoint Collection Item Scan Detail> - An array of fqdn/port pairs used to create private endpoint. Each object is a simple key-value pair with FQDN as key and port number as value. [ { fqdn: "scan1.oracle.com", port: "1521"}, { fqdn: "scan2.oracle.com", port: "1521" } ]
- state String
- The LifecycleState of the private endpoint.
- subnet
Id String - The OCID of a subnet.
- time
Created String - The date and time the resource was created, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z
- time
Updated String - The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z
- compartment
Id string - The OCID of the compartment.
- {[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.
- display
Name 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. - dns
Zones string[] - An array of DNS zone names. Example:
[ "app.examplecorp.com", "app.examplecorp2.com" ]
- {[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.
- lifecycle
Details string - The detailed messages about the lifecycle state.
- max
Host numberCount - 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 string[] - An array of network security group OCIDs.
- owner
Principal stringId - The OCID of the user who created the resource.
- owner
User stringName - 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. - scan
Details GetPrivate Endpoints Private Endpoint Collection Item Scan Detail[] - An array of fqdn/port pairs used to create private endpoint. Each object is a simple key-value pair with FQDN as key and port number as value. [ { fqdn: "scan1.oracle.com", port: "1521"}, { fqdn: "scan2.oracle.com", port: "1521" } ]
- state string
- The LifecycleState of the private endpoint.
- subnet
Id string - The OCID of a subnet.
- time
Created string - The date and time the resource was created, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z
- time
Updated string - The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z
- compartment_
id str - The OCID of the compartment.
- 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" ]
- 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_ intcount - 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_ strid - The OCID of the user who created the resource.
- owner_
user_ strname - 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. - scan_
details Sequence[dataflow.Get Private Endpoints Private Endpoint Collection Item Scan Detail] - An array of fqdn/port pairs used to create private endpoint. Each object is a simple key-value pair with FQDN as key and port number as value. [ { fqdn: "scan1.oracle.com", port: "1521"}, { fqdn: "scan2.oracle.com", port: "1521" } ]
- state str
- The LifecycleState of the private endpoint.
- subnet_
id str - The OCID of a subnet.
- time_
created str - The date and time the resource was created, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z
- time_
updated str - The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z
- compartment
Id String - The OCID of the compartment.
- 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.
- display
Name 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. - dns
Zones List<String> - An array of DNS zone names. Example:
[ "app.examplecorp.com", "app.examplecorp2.com" ]
- 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.
- lifecycle
Details String - The detailed messages about the lifecycle state.
- max
Host NumberCount - 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 List<String> - An array of network security group OCIDs.
- owner
Principal StringId - The OCID of the user who created the resource.
- owner
User StringName - 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. - scan
Details List<Property Map> - An array of fqdn/port pairs used to create private endpoint. Each object is a simple key-value pair with FQDN as key and port number as value. [ { fqdn: "scan1.oracle.com", port: "1521"}, { fqdn: "scan2.oracle.com", port: "1521" } ]
- state String
- The LifecycleState of the private endpoint.
- subnet
Id String - The OCID of a subnet.
- time
Created String - The date and time the resource was created, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z
- time
Updated String - The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z
GetPrivateEndpointsPrivateEndpointCollectionItemScanDetail
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.