Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Dns
  5. getRecords
Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-oci

oci.Dns.getRecords

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-oci

Deprecated. Use oci.Dns.getRrsets instead.

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

Gets all records in the specified zone.

The results are sorted by domain in alphabetical order by default. For more information about records, see Resource Record (RR) TYPEs. When the zone name is provided as a path parameter and PRIVATE is used for the scope query parameter then the viewId query parameter is required.

Example Usage

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

const testRecords = oci.Dns.getRecords({
    zoneNameOrId: testZoneNameOr.id,
    domain: recordDomain,
    domainContains: recordDomainContains,
    rtype: recordRtype,
    zoneVersion: recordZoneVersion,
});
Copy
import pulumi
import pulumi_oci as oci

test_records = oci.Dns.get_records(zone_name_or_id=test_zone_name_or["id"],
    domain=record_domain,
    domain_contains=record_domain_contains,
    rtype=record_rtype,
    zone_version=record_zone_version)
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dns.GetRecords(ctx, &dns.GetRecordsArgs{
			ZoneNameOrId:   testZoneNameOr.Id,
			Domain:         pulumi.StringRef(recordDomain),
			DomainContains: pulumi.StringRef(recordDomainContains),
			Rtype:          pulumi.StringRef(recordRtype),
			ZoneVersion:    pulumi.StringRef(recordZoneVersion),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testRecords = Oci.Dns.GetRecords.Invoke(new()
    {
        ZoneNameOrId = testZoneNameOr.Id,
        Domain = recordDomain,
        DomainContains = recordDomainContains,
        Rtype = recordRtype,
        ZoneVersion = recordZoneVersion,
    });

});
Copy
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.GetRecordsArgs;
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 testRecords = DnsFunctions.getRecords(GetRecordsArgs.builder()
            .zoneNameOrId(testZoneNameOr.id())
            .domain(recordDomain)
            .domainContains(recordDomainContains)
            .rtype(recordRtype)
            .zoneVersion(recordZoneVersion)
            .build());

    }
}
Copy
variables:
  testRecords:
    fn::invoke:
      function: oci:Dns:getRecords
      arguments:
        zoneNameOrId: ${testZoneNameOr.id}
        domain: ${recordDomain}
        domainContains: ${recordDomainContains}
        rtype: ${recordRtype}
        zoneVersion: ${recordZoneVersion}
Copy

Using getRecords

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 getRecords(args: GetRecordsArgs, opts?: InvokeOptions): Promise<GetRecordsResult>
function getRecordsOutput(args: GetRecordsOutputArgs, opts?: InvokeOptions): Output<GetRecordsResult>
Copy
def get_records(compartment_id: Optional[str] = None,
                domain: Optional[str] = None,
                domain_contains: Optional[str] = None,
                filters: Optional[Sequence[_dns.GetRecordsFilter]] = None,
                rtype: Optional[str] = None,
                sort_by: Optional[str] = None,
                sort_order: Optional[str] = None,
                zone_name_or_id: Optional[str] = None,
                zone_version: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetRecordsResult
def get_records_output(compartment_id: Optional[pulumi.Input[str]] = None,
                domain: Optional[pulumi.Input[str]] = None,
                domain_contains: Optional[pulumi.Input[str]] = None,
                filters: Optional[pulumi.Input[Sequence[pulumi.Input[_dns.GetRecordsFilterArgs]]]] = None,
                rtype: Optional[pulumi.Input[str]] = None,
                sort_by: Optional[pulumi.Input[str]] = None,
                sort_order: Optional[pulumi.Input[str]] = None,
                zone_name_or_id: Optional[pulumi.Input[str]] = None,
                zone_version: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetRecordsResult]
Copy
func GetRecords(ctx *Context, args *GetRecordsArgs, opts ...InvokeOption) (*GetRecordsResult, error)
func GetRecordsOutput(ctx *Context, args *GetRecordsOutputArgs, opts ...InvokeOption) GetRecordsResultOutput
Copy

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

public static class GetRecords 
{
    public static Task<GetRecordsResult> InvokeAsync(GetRecordsArgs args, InvokeOptions? opts = null)
    public static Output<GetRecordsResult> Invoke(GetRecordsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetRecordsResult> getRecords(GetRecordsArgs args, InvokeOptions options)
public static Output<GetRecordsResult> getRecords(GetRecordsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:Dns/getRecords:getRecords
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ZoneNameOrId This property is required. string
The name or OCID of the target zone.

Deprecated: The 'oci_dns_records' resource has been deprecated. Please use 'oci_dns_rrsets' instead.

CompartmentId string

The OCID of the compartment the zone belongs to.

This parameter is deprecated and should be omitted.

Domain string
Search by domain. Will match any record whose domain (case-insensitive) equals the provided value.
DomainContains string
Search by domain. Will match any record whose domain (case-insensitive) contains the provided value.
Filters Changes to this property will trigger replacement. List<GetRecordsFilter>
Rtype string
Search by record type. Will match any record whose type (case-insensitive) equals the provided value.
SortBy string
The field by which to sort records. Allowed values are: domain|rtype|ttl
SortOrder string
The order to sort the resources. Allowed values are: ASC|DESC
ZoneVersion string
The version of the zone for which data is requested.
ZoneNameOrId This property is required. string
The name or OCID of the target zone.

Deprecated: The 'oci_dns_records' resource has been deprecated. Please use 'oci_dns_rrsets' instead.

CompartmentId string

The OCID of the compartment the zone belongs to.

This parameter is deprecated and should be omitted.

Domain string
Search by domain. Will match any record whose domain (case-insensitive) equals the provided value.
DomainContains string
Search by domain. Will match any record whose domain (case-insensitive) contains the provided value.
Filters Changes to this property will trigger replacement. []GetRecordsFilter
Rtype string
Search by record type. Will match any record whose type (case-insensitive) equals the provided value.
SortBy string
The field by which to sort records. Allowed values are: domain|rtype|ttl
SortOrder string
The order to sort the resources. Allowed values are: ASC|DESC
ZoneVersion string
The version of the zone for which data is requested.
zoneNameOrId This property is required. String
The name or OCID of the target zone.

Deprecated: The 'oci_dns_records' resource has been deprecated. Please use 'oci_dns_rrsets' instead.

compartmentId String

The OCID of the compartment the zone belongs to.

This parameter is deprecated and should be omitted.

domain String
Search by domain. Will match any record whose domain (case-insensitive) equals the provided value.
domainContains String
Search by domain. Will match any record whose domain (case-insensitive) contains the provided value.
filters Changes to this property will trigger replacement. List<GetRecordsFilter>
rtype String
Search by record type. Will match any record whose type (case-insensitive) equals the provided value.
sortBy String
The field by which to sort records. Allowed values are: domain|rtype|ttl
sortOrder String
The order to sort the resources. Allowed values are: ASC|DESC
zoneVersion String
The version of the zone for which data is requested.
zoneNameOrId This property is required. string
The name or OCID of the target zone.

Deprecated: The 'oci_dns_records' resource has been deprecated. Please use 'oci_dns_rrsets' instead.

compartmentId string

The OCID of the compartment the zone belongs to.

This parameter is deprecated and should be omitted.

domain string
Search by domain. Will match any record whose domain (case-insensitive) equals the provided value.
domainContains string
Search by domain. Will match any record whose domain (case-insensitive) contains the provided value.
filters Changes to this property will trigger replacement. GetRecordsFilter[]
rtype string
Search by record type. Will match any record whose type (case-insensitive) equals the provided value.
sortBy string
The field by which to sort records. Allowed values are: domain|rtype|ttl
sortOrder string
The order to sort the resources. Allowed values are: ASC|DESC
zoneVersion string
The version of the zone for which data is requested.
zone_name_or_id This property is required. str
The name or OCID of the target zone.

Deprecated: The 'oci_dns_records' resource has been deprecated. Please use 'oci_dns_rrsets' instead.

compartment_id str

The OCID of the compartment the zone belongs to.

This parameter is deprecated and should be omitted.

domain str
Search by domain. Will match any record whose domain (case-insensitive) equals the provided value.
domain_contains str
Search by domain. Will match any record whose domain (case-insensitive) contains the provided value.
filters Changes to this property will trigger replacement. Sequence[dns.GetRecordsFilter]
rtype str
Search by record type. Will match any record whose type (case-insensitive) equals the provided value.
sort_by str
The field by which to sort records. Allowed values are: domain|rtype|ttl
sort_order str
The order to sort the resources. Allowed values are: ASC|DESC
zone_version str
The version of the zone for which data is requested.
zoneNameOrId This property is required. String
The name or OCID of the target zone.

Deprecated: The 'oci_dns_records' resource has been deprecated. Please use 'oci_dns_rrsets' instead.

compartmentId String

The OCID of the compartment the zone belongs to.

This parameter is deprecated and should be omitted.

domain String
Search by domain. Will match any record whose domain (case-insensitive) equals the provided value.
domainContains String
Search by domain. Will match any record whose domain (case-insensitive) contains the provided value.
filters Changes to this property will trigger replacement. List<Property Map>
rtype String
Search by record type. Will match any record whose type (case-insensitive) equals the provided value.
sortBy String
The field by which to sort records. Allowed values are: domain|rtype|ttl
sortOrder String
The order to sort the resources. Allowed values are: ASC|DESC
zoneVersion String
The version of the zone for which data is requested.

getRecords Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
Records List<GetRecordsRecord>
The list of records.
ZoneNameOrId string
The name or OCID of the target zone.

Deprecated: The 'oci_dns_records' resource has been deprecated. Please use 'oci_dns_rrsets' instead.

CompartmentId string
Domain string
The fully qualified domain name where the record can be located.
DomainContains string
Filters List<GetRecordsFilter>
Rtype string
The type of DNS record, such as A or CNAME. For more information, see Resource Record (RR) TYPEs.
SortBy string
SortOrder string
ZoneVersion string
Id string
The provider-assigned unique ID for this managed resource.
Records []GetRecordsRecord
The list of records.
ZoneNameOrId string
The name or OCID of the target zone.

Deprecated: The 'oci_dns_records' resource has been deprecated. Please use 'oci_dns_rrsets' instead.

CompartmentId string
Domain string
The fully qualified domain name where the record can be located.
DomainContains string
Filters []GetRecordsFilter
Rtype string
The type of DNS record, such as A or CNAME. For more information, see Resource Record (RR) TYPEs.
SortBy string
SortOrder string
ZoneVersion string
id String
The provider-assigned unique ID for this managed resource.
records List<GetRecordsRecord>
The list of records.
zoneNameOrId String
The name or OCID of the target zone.

Deprecated: The 'oci_dns_records' resource has been deprecated. Please use 'oci_dns_rrsets' instead.

compartmentId String
domain String
The fully qualified domain name where the record can be located.
domainContains String
filters List<GetRecordsFilter>
rtype String
The type of DNS record, such as A or CNAME. For more information, see Resource Record (RR) TYPEs.
sortBy String
sortOrder String
zoneVersion String
id string
The provider-assigned unique ID for this managed resource.
records GetRecordsRecord[]
The list of records.
zoneNameOrId string
The name or OCID of the target zone.

Deprecated: The 'oci_dns_records' resource has been deprecated. Please use 'oci_dns_rrsets' instead.

compartmentId string
domain string
The fully qualified domain name where the record can be located.
domainContains string
filters GetRecordsFilter[]
rtype string
The type of DNS record, such as A or CNAME. For more information, see Resource Record (RR) TYPEs.
sortBy string
sortOrder string
zoneVersion string
id str
The provider-assigned unique ID for this managed resource.
records Sequence[dns.GetRecordsRecord]
The list of records.
zone_name_or_id str
The name or OCID of the target zone.

Deprecated: The 'oci_dns_records' resource has been deprecated. Please use 'oci_dns_rrsets' instead.

compartment_id str
domain str
The fully qualified domain name where the record can be located.
domain_contains str
filters Sequence[dns.GetRecordsFilter]
rtype str
The type of DNS record, such as A or CNAME. For more information, see Resource Record (RR) TYPEs.
sort_by str
sort_order str
zone_version str
id String
The provider-assigned unique ID for this managed resource.
records List<Property Map>
The list of records.
zoneNameOrId String
The name or OCID of the target zone.

Deprecated: The 'oci_dns_records' resource has been deprecated. Please use 'oci_dns_rrsets' instead.

compartmentId String
domain String
The fully qualified domain name where the record can be located.
domainContains String
filters List<Property Map>
rtype String
The type of DNS record, such as A or CNAME. For more information, see Resource Record (RR) TYPEs.
sortBy String
sortOrder String
zoneVersion String

Supporting Types

GetRecordsFilter

Name This property is required. string
Values This property is required. List<string>
Regex bool
Name This property is required. string
Values This property is required. []string
Regex bool
name This property is required. String
values This property is required. List<String>
regex Boolean
name This property is required. string
values This property is required. string[]
regex boolean
name This property is required. str
values This property is required. Sequence[str]
regex bool
name This property is required. String
values This property is required. List<String>
regex Boolean

GetRecordsRecord

Domain This property is required. string
Search by domain. Will match any record whose domain (case-insensitive) equals the provided value.

Deprecated: The 'oci_dns_record' resource has been deprecated. Please use 'oci_dns_rrset' instead.

IsProtected This property is required. bool
A Boolean flag indicating whether or not parts of the record are unable to be explicitly managed.
RecordHash This property is required. string
A unique identifier for the record within its zone.
RrsetVersion This property is required. string
The latest version of the record's zone in which its RRSet differs from the preceding version.
Rtype This property is required. string
Search by record type. Will match any record whose type (case-insensitive) equals the provided value.

Deprecated: The 'oci_dns_record' resource has been deprecated. Please use 'oci_dns_rrset' instead.

ZoneNameOrId This property is required. string
The name or OCID of the target zone.

Deprecated: The 'oci_dns_record' resource has been deprecated. Please use 'oci_dns_rrset' instead.

CompartmentId string

The OCID of the compartment the zone belongs to.

This parameter is deprecated and should be omitted.

Rdata string
The record's data, as whitespace-delimited tokens in type-specific presentation format. All RDATA is normalized and the returned presentation of your RDATA may differ from its initial input. For more information about RDATA, see Supported DNS Resource Record Types
Ttl int
The Time To Live for the record, in seconds. Using a TTL lower than 30 seconds is not recommended.
Domain This property is required. string
Search by domain. Will match any record whose domain (case-insensitive) equals the provided value.

Deprecated: The 'oci_dns_record' resource has been deprecated. Please use 'oci_dns_rrset' instead.

IsProtected This property is required. bool
A Boolean flag indicating whether or not parts of the record are unable to be explicitly managed.
RecordHash This property is required. string
A unique identifier for the record within its zone.
RrsetVersion This property is required. string
The latest version of the record's zone in which its RRSet differs from the preceding version.
Rtype This property is required. string
Search by record type. Will match any record whose type (case-insensitive) equals the provided value.

Deprecated: The 'oci_dns_record' resource has been deprecated. Please use 'oci_dns_rrset' instead.

ZoneNameOrId This property is required. string
The name or OCID of the target zone.

Deprecated: The 'oci_dns_record' resource has been deprecated. Please use 'oci_dns_rrset' instead.

CompartmentId string

The OCID of the compartment the zone belongs to.

This parameter is deprecated and should be omitted.

Rdata string
The record's data, as whitespace-delimited tokens in type-specific presentation format. All RDATA is normalized and the returned presentation of your RDATA may differ from its initial input. For more information about RDATA, see Supported DNS Resource Record Types
Ttl int
The Time To Live for the record, in seconds. Using a TTL lower than 30 seconds is not recommended.
domain This property is required. String
Search by domain. Will match any record whose domain (case-insensitive) equals the provided value.

Deprecated: The 'oci_dns_record' resource has been deprecated. Please use 'oci_dns_rrset' instead.

isProtected This property is required. Boolean
A Boolean flag indicating whether or not parts of the record are unable to be explicitly managed.
recordHash This property is required. String
A unique identifier for the record within its zone.
rrsetVersion This property is required. String
The latest version of the record's zone in which its RRSet differs from the preceding version.
rtype This property is required. String
Search by record type. Will match any record whose type (case-insensitive) equals the provided value.

Deprecated: The 'oci_dns_record' resource has been deprecated. Please use 'oci_dns_rrset' instead.

zoneNameOrId This property is required. String
The name or OCID of the target zone.

Deprecated: The 'oci_dns_record' resource has been deprecated. Please use 'oci_dns_rrset' instead.

compartmentId String

The OCID of the compartment the zone belongs to.

This parameter is deprecated and should be omitted.

rdata String
The record's data, as whitespace-delimited tokens in type-specific presentation format. All RDATA is normalized and the returned presentation of your RDATA may differ from its initial input. For more information about RDATA, see Supported DNS Resource Record Types
ttl Integer
The Time To Live for the record, in seconds. Using a TTL lower than 30 seconds is not recommended.
domain This property is required. string
Search by domain. Will match any record whose domain (case-insensitive) equals the provided value.

Deprecated: The 'oci_dns_record' resource has been deprecated. Please use 'oci_dns_rrset' instead.

isProtected This property is required. boolean
A Boolean flag indicating whether or not parts of the record are unable to be explicitly managed.
recordHash This property is required. string
A unique identifier for the record within its zone.
rrsetVersion This property is required. string
The latest version of the record's zone in which its RRSet differs from the preceding version.
rtype This property is required. string
Search by record type. Will match any record whose type (case-insensitive) equals the provided value.

Deprecated: The 'oci_dns_record' resource has been deprecated. Please use 'oci_dns_rrset' instead.

zoneNameOrId This property is required. string
The name or OCID of the target zone.

Deprecated: The 'oci_dns_record' resource has been deprecated. Please use 'oci_dns_rrset' instead.

compartmentId string

The OCID of the compartment the zone belongs to.

This parameter is deprecated and should be omitted.

rdata string
The record's data, as whitespace-delimited tokens in type-specific presentation format. All RDATA is normalized and the returned presentation of your RDATA may differ from its initial input. For more information about RDATA, see Supported DNS Resource Record Types
ttl number
The Time To Live for the record, in seconds. Using a TTL lower than 30 seconds is not recommended.
domain This property is required. str
Search by domain. Will match any record whose domain (case-insensitive) equals the provided value.

Deprecated: The 'oci_dns_record' resource has been deprecated. Please use 'oci_dns_rrset' instead.

is_protected This property is required. bool
A Boolean flag indicating whether or not parts of the record are unable to be explicitly managed.
record_hash This property is required. str
A unique identifier for the record within its zone.
rrset_version This property is required. str
The latest version of the record's zone in which its RRSet differs from the preceding version.
rtype This property is required. str
Search by record type. Will match any record whose type (case-insensitive) equals the provided value.

Deprecated: The 'oci_dns_record' resource has been deprecated. Please use 'oci_dns_rrset' instead.

zone_name_or_id This property is required. str
The name or OCID of the target zone.

Deprecated: The 'oci_dns_record' resource has been deprecated. Please use 'oci_dns_rrset' instead.

compartment_id str

The OCID of the compartment the zone belongs to.

This parameter is deprecated and should be omitted.

rdata str
The record's data, as whitespace-delimited tokens in type-specific presentation format. All RDATA is normalized and the returned presentation of your RDATA may differ from its initial input. For more information about RDATA, see Supported DNS Resource Record Types
ttl int
The Time To Live for the record, in seconds. Using a TTL lower than 30 seconds is not recommended.
domain This property is required. String
Search by domain. Will match any record whose domain (case-insensitive) equals the provided value.

Deprecated: The 'oci_dns_record' resource has been deprecated. Please use 'oci_dns_rrset' instead.

isProtected This property is required. Boolean
A Boolean flag indicating whether or not parts of the record are unable to be explicitly managed.
recordHash This property is required. String
A unique identifier for the record within its zone.
rrsetVersion This property is required. String
The latest version of the record's zone in which its RRSet differs from the preceding version.
rtype This property is required. String
Search by record type. Will match any record whose type (case-insensitive) equals the provided value.

Deprecated: The 'oci_dns_record' resource has been deprecated. Please use 'oci_dns_rrset' instead.

zoneNameOrId This property is required. String
The name or OCID of the target zone.

Deprecated: The 'oci_dns_record' resource has been deprecated. Please use 'oci_dns_rrset' instead.

compartmentId String

The OCID of the compartment the zone belongs to.

This parameter is deprecated and should be omitted.

rdata String
The record's data, as whitespace-delimited tokens in type-specific presentation format. All RDATA is normalized and the returned presentation of your RDATA may differ from its initial input. For more information about RDATA, see Supported DNS Resource Record Types
ttl Number
The Time To Live for the record, in seconds. Using a TTL lower than 30 seconds is not recommended.

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes
This Pulumi package is based on the oci Terraform Provider.
Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-oci