Docs Packages
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. ResourceManager
  5. getPrivateEndpoint
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
pulumi/pulumi-oci

oci.ResourceManager.getPrivateEndpoint

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
pulumi/pulumi-oci

    This data source provides details about a specific Private Endpoint resource in Oracle Cloud Infrastructure Resource Manager service.

    Gets the specified private endpoint.

    Example Usage

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

const testPrivateEndpoint = oci.ResourceManager.getPrivateEndpoint({
    privateEndpointId: testPrivateEndpointOciResourcemanagerPrivateEndpoint.id,
});

    import pulumi
import pulumi_oci as oci

test_private_endpoint = oci.ResourceManager.get_private_endpoint(private_endpoint_id=test_private_endpoint_oci_resourcemanager_private_endpoint["id"])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ResourceManager.GetPrivateEndpoint(ctx, &resourcemanager.GetPrivateEndpointArgs{
			PrivateEndpointId: testPrivateEndpointOciResourcemanagerPrivateEndpoint.Id,
		}, 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 testPrivateEndpoint = Oci.ResourceManager.GetPrivateEndpoint.Invoke(new()
    {
        PrivateEndpointId = testPrivateEndpointOciResourcemanagerPrivateEndpoint.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.ResourceManager.ResourceManagerFunctions;
import com.pulumi.oci.ResourceManager.inputs.GetPrivateEndpointArgs;
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 testPrivateEndpoint = ResourceManagerFunctions.getPrivateEndpoint(GetPrivateEndpointArgs.builder()
            .privateEndpointId(testPrivateEndpointOciResourcemanagerPrivateEndpoint.id())
            .build());

    }
}

    variables:
  testPrivateEndpoint:
    fn::invoke:
      Function: oci:ResourceManager:getPrivateEndpoint
      Arguments:
        privateEndpointId: ${testPrivateEndpointOciResourcemanagerPrivateEndpoint.id}

    Using getPrivateEndpoint

    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 getPrivateEndpoint(args: GetPrivateEndpointArgs, opts?: InvokeOptions): Promise<GetPrivateEndpointResult>
function getPrivateEndpointOutput(args: GetPrivateEndpointOutputArgs, opts?: InvokeOptions): Output<GetPrivateEndpointResult>
    def get_private_endpoint(private_endpoint_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetPrivateEndpointResult
def get_private_endpoint_output(private_endpoint_id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetPrivateEndpointResult]
    func GetPrivateEndpoint(ctx *Context, args *GetPrivateEndpointArgs, opts ...InvokeOption) (*GetPrivateEndpointResult, error)
func GetPrivateEndpointOutput(ctx *Context, args *GetPrivateEndpointOutputArgs, opts ...InvokeOption) GetPrivateEndpointResultOutput

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

    public static class GetPrivateEndpoint 
{
    public static Task<GetPrivateEndpointResult> InvokeAsync(GetPrivateEndpointArgs args, InvokeOptions? opts = null)
    public static Output<GetPrivateEndpointResult> Invoke(GetPrivateEndpointInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPrivateEndpointResult> getPrivateEndpoint(GetPrivateEndpointArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: oci:ResourceManager/getPrivateEndpoint:getPrivateEndpoint
  arguments:
    # arguments dictionary

    The following arguments are supported:

    PrivateEndpointId string
    The OCID of the private endpoint.
    PrivateEndpointId string
    The OCID of the private endpoint.
    privateEndpointId String
    The OCID of the private endpoint.
    privateEndpointId string
    The OCID of the private endpoint.
    private_endpoint_id str
    The OCID of the private endpoint.
    privateEndpointId String
    The OCID of the private endpoint.

    getPrivateEndpoint Result

    The following output properties are available:

    CompartmentId string
    The OCID of the compartment containing this private endpoint details.
    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
    Description of the private endpoint. Avoid entering confidential information.
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    DnsZones List<string>
    DNS Proxy forwards any DNS FQDN queries over into the consumer DNS resolver if the DNS FQDN is included in the dns zones list otherwise it goes to service provider VCN resolver.
    FreeformTags Dictionary<string, object>
    Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    Unique identifier (OCID) of the private endpoint details.
    IsUsedWithConfigurationSourceProvider bool
    When true, allows the private endpoint to be used with a configuration source provider.
    NsgIdLists List<string>
    An array of network security groups (NSG) that the customer can optionally provide.
    PrivateEndpointId string
    SourceIps List<string>
    The source IPs which resource manager service will use to connect to customer's network. Automatically assigned by Resource Manager Service.
    State string
    The current lifecycle state of the private endpoint.
    SubnetId string
    The OCID of the subnet within the VCN for the private endpoint.
    TimeCreated string
    The date and time at which the private endpoint was created. Format is defined by RFC3339. Example: 2020-11-25T21:10:29.600Z
    VcnId string
    The OCID of the VCN for the private endpoint.
    CompartmentId string
    The OCID of the compartment containing this private endpoint details.
    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
    Description of the private endpoint. Avoid entering confidential information.
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    DnsZones []string
    DNS Proxy forwards any DNS FQDN queries over into the consumer DNS resolver if the DNS FQDN is included in the dns zones list otherwise it goes to service provider VCN resolver.
    FreeformTags map[string]interface{}
    Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    Unique identifier (OCID) of the private endpoint details.
    IsUsedWithConfigurationSourceProvider bool
    When true, allows the private endpoint to be used with a configuration source provider.
    NsgIdLists []string
    An array of network security groups (NSG) that the customer can optionally provide.
    PrivateEndpointId string
    SourceIps []string
    The source IPs which resource manager service will use to connect to customer's network. Automatically assigned by Resource Manager Service.
    State string
    The current lifecycle state of the private endpoint.
    SubnetId string
    The OCID of the subnet within the VCN for the private endpoint.
    TimeCreated string
    The date and time at which the private endpoint was created. Format is defined by RFC3339. Example: 2020-11-25T21:10:29.600Z
    VcnId string
    The OCID of the VCN for the private endpoint.
    compartmentId String
    The OCID of the compartment containing this private endpoint details.
    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
    Description of the private endpoint. Avoid entering confidential information.
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    dnsZones List<String>
    DNS Proxy forwards any DNS FQDN queries over into the consumer DNS resolver if the DNS FQDN is included in the dns zones list otherwise it goes to service provider VCN resolver.
    freeformTags Map<String,Object>
    Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    Unique identifier (OCID) of the private endpoint details.
    isUsedWithConfigurationSourceProvider Boolean
    When true, allows the private endpoint to be used with a configuration source provider.
    nsgIdLists List<String>
    An array of network security groups (NSG) that the customer can optionally provide.
    privateEndpointId String
    sourceIps List<String>
    The source IPs which resource manager service will use to connect to customer's network. Automatically assigned by Resource Manager Service.
    state String
    The current lifecycle state of the private endpoint.
    subnetId String
    The OCID of the subnet within the VCN for the private endpoint.
    timeCreated String
    The date and time at which the private endpoint was created. Format is defined by RFC3339. Example: 2020-11-25T21:10:29.600Z
    vcnId String
    The OCID of the VCN for the private endpoint.
    compartmentId string
    The OCID of the compartment containing this private endpoint details.
    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
    Description of the private endpoint. Avoid entering confidential information.
    displayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    dnsZones string[]
    DNS Proxy forwards any DNS FQDN queries over into the consumer DNS resolver if the DNS FQDN is included in the dns zones list otherwise it goes to service provider VCN resolver.
    freeformTags {[key: string]: any}
    Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id string
    Unique identifier (OCID) of the private endpoint details.
    isUsedWithConfigurationSourceProvider boolean
    When true, allows the private endpoint to be used with a configuration source provider.
    nsgIdLists string[]
    An array of network security groups (NSG) that the customer can optionally provide.
    privateEndpointId string
    sourceIps string[]
    The source IPs which resource manager service will use to connect to customer's network. Automatically assigned by Resource Manager Service.
    state string
    The current lifecycle state of the private endpoint.
    subnetId string
    The OCID of the subnet within the VCN for the private endpoint.
    timeCreated string
    The date and time at which the private endpoint was created. Format is defined by RFC3339. Example: 2020-11-25T21:10:29.600Z
    vcnId string
    The OCID of the VCN for the private endpoint.
    compartment_id str
    The OCID of the compartment containing this private endpoint details.
    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
    Description of the private endpoint. Avoid entering confidential information.
    display_name str
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    dns_zones Sequence[str]
    DNS Proxy forwards any DNS FQDN queries over into the consumer DNS resolver if the DNS FQDN is included in the dns zones list otherwise it goes to service provider VCN resolver.
    freeform_tags Mapping[str, Any]
    Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id str
    Unique identifier (OCID) of the private endpoint details.
    is_used_with_configuration_source_provider bool
    When true, allows the private endpoint to be used with a configuration source provider.
    nsg_id_lists Sequence[str]
    An array of network security groups (NSG) that the customer can optionally provide.
    private_endpoint_id str
    source_ips Sequence[str]
    The source IPs which resource manager service will use to connect to customer's network. Automatically assigned by Resource Manager Service.
    state str
    The current lifecycle state of the private endpoint.
    subnet_id str
    The OCID of the subnet within the VCN for the private endpoint.
    time_created str
    The date and time at which the private endpoint was created. Format is defined by RFC3339. Example: 2020-11-25T21:10:29.600Z
    vcn_id str
    The OCID of the VCN for the private endpoint.
    compartmentId String
    The OCID of the compartment containing this private endpoint details.
    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
    Description of the private endpoint. Avoid entering confidential information.
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    dnsZones List<String>
    DNS Proxy forwards any DNS FQDN queries over into the consumer DNS resolver if the DNS FQDN is included in the dns zones list otherwise it goes to service provider VCN resolver.
    freeformTags Map<Any>
    Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    Unique identifier (OCID) of the private endpoint details.
    isUsedWithConfigurationSourceProvider Boolean
    When true, allows the private endpoint to be used with a configuration source provider.
    nsgIdLists List<String>
    An array of network security groups (NSG) that the customer can optionally provide.
    privateEndpointId String
    sourceIps List<String>
    The source IPs which resource manager service will use to connect to customer's network. Automatically assigned by Resource Manager Service.
    state String
    The current lifecycle state of the private endpoint.
    subnetId String
    The OCID of the subnet within the VCN for the private endpoint.
    timeCreated String
    The date and time at which the private endpoint was created. Format is defined by RFC3339. Example: 2020-11-25T21:10:29.600Z
    vcnId String
    The OCID of the VCN for the private endpoint.

    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.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
    pulumi/pulumi-oci