oci logo
Oracle Cloud Infrastructure v0.6.0, Jan 23 23

oci.Dns.getResolverEndpoints

This data source provides the list of Resolver Endpoints in Oracle Cloud Infrastructure DNS service.

Gets a list of all endpoints within a resolver. The collection can be filtered by name or lifecycle state. It can be sorted on creation time or name both in ASC or DESC order. Note that when no lifecycleState query parameter is provided, the collection does not include resolver endpoints in the DELETED lifecycle state to be consistent with other operations of the API. Requires a PRIVATE scope query parameter.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testResolverEndpoints = Oci.Dns.GetResolverEndpoints.Invoke(new()
    {
        ResolverId = oci_dns_resolver.Test_resolver.Id,
        Scope = "PRIVATE",
        Name = @var.Resolver_endpoint_name,
        State = @var.Resolver_endpoint_state,
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Dns.GetResolverEndpoints(ctx, &dns.GetResolverEndpointsArgs{
			ResolverId: oci_dns_resolver.Test_resolver.Id,
			Scope:      "PRIVATE",
			Name:       pulumi.StringRef(_var.Resolver_endpoint_name),
			State:      pulumi.StringRef(_var.Resolver_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.Dns.DnsFunctions;
import com.pulumi.oci.Dns.inputs.GetResolverEndpointsArgs;
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 testResolverEndpoints = DnsFunctions.getResolverEndpoints(GetResolverEndpointsArgs.builder()
            .resolverId(oci_dns_resolver.test_resolver().id())
            .scope("PRIVATE")
            .name(var_.resolver_endpoint_name())
            .state(var_.resolver_endpoint_state())
            .build());

    }
}
import pulumi
import pulumi_oci as oci

test_resolver_endpoints = oci.Dns.get_resolver_endpoints(resolver_id=oci_dns_resolver["test_resolver"]["id"],
    scope="PRIVATE",
    name=var["resolver_endpoint_name"],
    state=var["resolver_endpoint_state"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testResolverEndpoints = oci.Dns.getResolverEndpoints({
    resolverId: oci_dns_resolver.test_resolver.id,
    scope: "PRIVATE",
    name: _var.resolver_endpoint_name,
    state: _var.resolver_endpoint_state,
});
variables:
  testResolverEndpoints:
    fn::invoke:
      Function: oci:Dns:getResolverEndpoints
      Arguments:
        resolverId: ${oci_dns_resolver.test_resolver.id}
        scope: PRIVATE
        name: ${var.resolver_endpoint_name}
        state: ${var.resolver_endpoint_state}

Using getResolverEndpoints

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 getResolverEndpoints(args: GetResolverEndpointsArgs, opts?: InvokeOptions): Promise<GetResolverEndpointsResult>
function getResolverEndpointsOutput(args: GetResolverEndpointsOutputArgs, opts?: InvokeOptions): Output<GetResolverEndpointsResult>
def get_resolver_endpoints(filters: Optional[Sequence[_dns.GetResolverEndpointsFilter]] = None,
                           name: Optional[str] = None,
                           resolver_id: Optional[str] = None,
                           scope: Optional[str] = None,
                           state: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetResolverEndpointsResult
def get_resolver_endpoints_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[_dns.GetResolverEndpointsFilterArgs]]]] = None,
                           name: Optional[pulumi.Input[str]] = None,
                           resolver_id: Optional[pulumi.Input[str]] = None,
                           scope: Optional[pulumi.Input[str]] = None,
                           state: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetResolverEndpointsResult]
func GetResolverEndpoints(ctx *Context, args *GetResolverEndpointsArgs, opts ...InvokeOption) (*GetResolverEndpointsResult, error)
func GetResolverEndpointsOutput(ctx *Context, args *GetResolverEndpointsOutputArgs, opts ...InvokeOption) GetResolverEndpointsResultOutput

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

public static class GetResolverEndpoints 
{
    public static Task<GetResolverEndpointsResult> InvokeAsync(GetResolverEndpointsArgs args, InvokeOptions? opts = null)
    public static Output<GetResolverEndpointsResult> Invoke(GetResolverEndpointsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetResolverEndpointsResult> getResolverEndpoints(GetResolverEndpointsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: oci:Dns/getResolverEndpoints:getResolverEndpoints
  arguments:
    # arguments dictionary

The following arguments are supported:

ResolverId string

The OCID of the target resolver.

Scope string

Value must be PRIVATE when listing private name resolver endpoints.

Filters List<GetResolverEndpointsFilter>
Name string

The name of a resource.

State string

The state of a resource.

ResolverId string

The OCID of the target resolver.

Scope string

Value must be PRIVATE when listing private name resolver endpoints.

Filters []GetResolverEndpointsFilter
Name string

The name of a resource.

State string

The state of a resource.

resolverId String

The OCID of the target resolver.

scope String

Value must be PRIVATE when listing private name resolver endpoints.

filters List<GetResolverEndpointsFilter>
name String

The name of a resource.

state String

The state of a resource.

resolverId string

The OCID of the target resolver.

scope string

Value must be PRIVATE when listing private name resolver endpoints.

filters GetResolverEndpointsFilter[]
name string

The name of a resource.

state string

The state of a resource.

resolver_id str

The OCID of the target resolver.

scope str

Value must be PRIVATE when listing private name resolver endpoints.

filters GetResolverEndpointsFilter]
name str

The name of a resource.

state str

The state of a resource.

resolverId String

The OCID of the target resolver.

scope String

Value must be PRIVATE when listing private name resolver endpoints.

filters List<Property Map>
name String

The name of a resource.

state String

The state of a resource.

getResolverEndpoints Result

The following output properties are available:

Id string

The provider-assigned unique ID for this managed resource.

ResolverEndpoints List<GetResolverEndpointsResolverEndpoint>

The list of resolver_endpoints.

ResolverId string
Scope string
Filters List<GetResolverEndpointsFilter>
Name string

The name of the resolver endpoint. Must be unique, case-insensitive, within the resolver.

State string

The current state of the resource.

Id string

The provider-assigned unique ID for this managed resource.

ResolverEndpoints []GetResolverEndpointsResolverEndpoint

The list of resolver_endpoints.

ResolverId string
Scope string
Filters []GetResolverEndpointsFilter
Name string

The name of the resolver endpoint. Must be unique, case-insensitive, within the resolver.

State string

The current state of the resource.

id String

The provider-assigned unique ID for this managed resource.

resolverEndpoints List<GetResolverEndpointsResolverEndpoint>

The list of resolver_endpoints.

resolverId String
scope String
filters List<GetResolverEndpointsFilter>
name String

The name of the resolver endpoint. Must be unique, case-insensitive, within the resolver.

state String

The current state of the resource.

id string

The provider-assigned unique ID for this managed resource.

resolverEndpoints GetResolverEndpointsResolverEndpoint[]

The list of resolver_endpoints.

resolverId string
scope string
filters GetResolverEndpointsFilter[]
name string

The name of the resolver endpoint. Must be unique, case-insensitive, within the resolver.

state string

The current state of the resource.

id str

The provider-assigned unique ID for this managed resource.

resolver_endpoints GetResolverEndpointsResolverEndpoint]

The list of resolver_endpoints.

resolver_id str
scope str
filters GetResolverEndpointsFilter]
name str

The name of the resolver endpoint. Must be unique, case-insensitive, within the resolver.

state str

The current state of the resource.

id String

The provider-assigned unique ID for this managed resource.

resolverEndpoints List<Property Map>

The list of resolver_endpoints.

resolverId String
scope String
filters List<Property Map>
name String

The name of the resolver endpoint. Must be unique, case-insensitive, within the resolver.

state String

The current state of the resource.

Supporting Types

GetResolverEndpointsFilter

Name string

The name of a resource.

Values List<string>
Regex bool
Name string

The name of a resource.

Values []string
Regex bool
name String

The name of a resource.

values List<String>
regex Boolean
name string

The name of a resource.

values string[]
regex boolean
name str

The name of a resource.

values Sequence[str]
regex bool
name String

The name of a resource.

values List<String>
regex Boolean

GetResolverEndpointsResolverEndpoint

CompartmentId string

The OCID of the owning compartment. This will match the resolver that the resolver endpoint is under and will be updated if the resolver's compartment is changed.

EndpointType string

The type of resolver endpoint. VNIC is currently the only supported type.

ForwardingAddress string

An IP address from which forwarded queries may be sent. For VNIC endpoints, this IP address must be part of the subnet and will be assigned by the system if unspecified when isForwarding is true.

IsForwarding bool

A Boolean flag indicating whether or not the resolver endpoint is for forwarding.

IsListening bool

A Boolean flag indicating whether or not the resolver endpoint is for listening.

ListeningAddress string

An IP address to listen to queries on. For VNIC endpoints this IP address must be part of the subnet and will be assigned by the system if unspecified when isListening is true.

Name string

The name of a resource.

ResolverId string

The OCID of the target resolver.

Self string

The canonical absolute URL of the resource.

State string

The state of a resource.

SubnetId string

The OCID of a subnet. Must be part of the VCN that the resolver is attached to.

TimeCreated string

The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339.

TimeUpdated string

The date and time the resource was last updated in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339.

NsgIds List<string>

An array of network security group OCIDs for the resolver endpoint. These must be part of the VCN that the resolver endpoint is a part of.

Scope string

Value must be PRIVATE when listing private name resolver endpoints.

CompartmentId string

The OCID of the owning compartment. This will match the resolver that the resolver endpoint is under and will be updated if the resolver's compartment is changed.

EndpointType string

The type of resolver endpoint. VNIC is currently the only supported type.

ForwardingAddress string

An IP address from which forwarded queries may be sent. For VNIC endpoints, this IP address must be part of the subnet and will be assigned by the system if unspecified when isForwarding is true.

IsForwarding bool

A Boolean flag indicating whether or not the resolver endpoint is for forwarding.

IsListening bool

A Boolean flag indicating whether or not the resolver endpoint is for listening.

ListeningAddress string

An IP address to listen to queries on. For VNIC endpoints this IP address must be part of the subnet and will be assigned by the system if unspecified when isListening is true.

Name string

The name of a resource.

ResolverId string

The OCID of the target resolver.

Self string

The canonical absolute URL of the resource.

State string

The state of a resource.

SubnetId string

The OCID of a subnet. Must be part of the VCN that the resolver is attached to.

TimeCreated string

The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339.

TimeUpdated string

The date and time the resource was last updated in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339.

NsgIds []string

An array of network security group OCIDs for the resolver endpoint. These must be part of the VCN that the resolver endpoint is a part of.

Scope string

Value must be PRIVATE when listing private name resolver endpoints.

compartmentId String

The OCID of the owning compartment. This will match the resolver that the resolver endpoint is under and will be updated if the resolver's compartment is changed.

endpointType String

The type of resolver endpoint. VNIC is currently the only supported type.

forwardingAddress String

An IP address from which forwarded queries may be sent. For VNIC endpoints, this IP address must be part of the subnet and will be assigned by the system if unspecified when isForwarding is true.

isForwarding Boolean

A Boolean flag indicating whether or not the resolver endpoint is for forwarding.

isListening Boolean

A Boolean flag indicating whether or not the resolver endpoint is for listening.

listeningAddress String

An IP address to listen to queries on. For VNIC endpoints this IP address must be part of the subnet and will be assigned by the system if unspecified when isListening is true.

name String

The name of a resource.

resolverId String

The OCID of the target resolver.

self String

The canonical absolute URL of the resource.

state String

The state of a resource.

subnetId String

The OCID of a subnet. Must be part of the VCN that the resolver is attached to.

timeCreated String

The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339.

timeUpdated String

The date and time the resource was last updated in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339.

nsgIds List<String>

An array of network security group OCIDs for the resolver endpoint. These must be part of the VCN that the resolver endpoint is a part of.

scope String

Value must be PRIVATE when listing private name resolver endpoints.

compartmentId string

The OCID of the owning compartment. This will match the resolver that the resolver endpoint is under and will be updated if the resolver's compartment is changed.

endpointType string

The type of resolver endpoint. VNIC is currently the only supported type.

forwardingAddress string

An IP address from which forwarded queries may be sent. For VNIC endpoints, this IP address must be part of the subnet and will be assigned by the system if unspecified when isForwarding is true.

isForwarding boolean

A Boolean flag indicating whether or not the resolver endpoint is for forwarding.

isListening boolean

A Boolean flag indicating whether or not the resolver endpoint is for listening.

listeningAddress string

An IP address to listen to queries on. For VNIC endpoints this IP address must be part of the subnet and will be assigned by the system if unspecified when isListening is true.

name string

The name of a resource.

resolverId string

The OCID of the target resolver.

self string

The canonical absolute URL of the resource.

state string

The state of a resource.

subnetId string

The OCID of a subnet. Must be part of the VCN that the resolver is attached to.

timeCreated string

The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339.

timeUpdated string

The date and time the resource was last updated in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339.

nsgIds string[]

An array of network security group OCIDs for the resolver endpoint. These must be part of the VCN that the resolver endpoint is a part of.

scope string

Value must be PRIVATE when listing private name resolver endpoints.

compartment_id str

The OCID of the owning compartment. This will match the resolver that the resolver endpoint is under and will be updated if the resolver's compartment is changed.

endpoint_type str

The type of resolver endpoint. VNIC is currently the only supported type.

forwarding_address str

An IP address from which forwarded queries may be sent. For VNIC endpoints, this IP address must be part of the subnet and will be assigned by the system if unspecified when isForwarding is true.

is_forwarding bool

A Boolean flag indicating whether or not the resolver endpoint is for forwarding.

is_listening bool

A Boolean flag indicating whether or not the resolver endpoint is for listening.

listening_address str

An IP address to listen to queries on. For VNIC endpoints this IP address must be part of the subnet and will be assigned by the system if unspecified when isListening is true.

name str

The name of a resource.

resolver_id str

The OCID of the target resolver.

self str

The canonical absolute URL of the resource.

state str

The state of a resource.

subnet_id str

The OCID of a subnet. Must be part of the VCN that the resolver is attached to.

time_created str

The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339.

time_updated str

The date and time the resource was last updated in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339.

nsg_ids Sequence[str]

An array of network security group OCIDs for the resolver endpoint. These must be part of the VCN that the resolver endpoint is a part of.

scope str

Value must be PRIVATE when listing private name resolver endpoints.

compartmentId String

The OCID of the owning compartment. This will match the resolver that the resolver endpoint is under and will be updated if the resolver's compartment is changed.

endpointType String

The type of resolver endpoint. VNIC is currently the only supported type.

forwardingAddress String

An IP address from which forwarded queries may be sent. For VNIC endpoints, this IP address must be part of the subnet and will be assigned by the system if unspecified when isForwarding is true.

isForwarding Boolean

A Boolean flag indicating whether or not the resolver endpoint is for forwarding.

isListening Boolean

A Boolean flag indicating whether or not the resolver endpoint is for listening.

listeningAddress String

An IP address to listen to queries on. For VNIC endpoints this IP address must be part of the subnet and will be assigned by the system if unspecified when isListening is true.

name String

The name of a resource.

resolverId String

The OCID of the target resolver.

self String

The canonical absolute URL of the resource.

state String

The state of a resource.

subnetId String

The OCID of a subnet. Must be part of the VCN that the resolver is attached to.

timeCreated String

The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339.

timeUpdated String

The date and time the resource was last updated in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339.

nsgIds List<String>

An array of network security group OCIDs for the resolver endpoint. These must be part of the VCN that the resolver endpoint is a part of.

scope String

Value must be PRIVATE when listing private name resolver endpoints.

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.