Docs
Packagesoci.Dns.getRecords
Explore with Pulumi AI
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.
For private zones, the scope query parameter is required with a value of PRIVATE. 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
Coming soon!
Coming soon!
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(oci_dns_zone_name_or.test_zone_name_or().id())
.compartmentId(var_.compartment_id())
.domain(var_.record_domain())
.domainContains(var_.record_domain_contains())
.rtype(var_.record_rtype())
.scope(var_.record_scope())
.viewId(oci_dns_view.test_view().id())
.zoneVersion(var_.record_zone_version())
.build());
}
}
Coming soon!
Coming soon!
variables:
testRecords:
fn::invoke:
Function: oci:Dns:getRecords
Arguments:
zoneNameOrId: ${oci_dns_zone_name_or.test_zone_name_or.id}
compartmentId: ${var.compartment_id}
domain: ${var.record_domain}
domainContains: ${var.record_domain_contains}
rtype: ${var.record_rtype}
scope: ${var.record_scope}
viewId: ${oci_dns_view.test_view.id}
zoneVersion: ${var.record_zone_version}
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>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]func GetRecords(ctx *Context, args *GetRecordsArgs, opts ...InvokeOption) (*GetRecordsResult, error)
func GetRecordsOutput(ctx *Context, args *GetRecordsOutputArgs, opts ...InvokeOption) GetRecordsResultOutput> 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)
}public static CompletableFuture<GetRecordsResult> getRecords(GetRecordsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: oci:Dns/getRecords:getRecords
arguments:
# arguments dictionaryThe following arguments are supported:
- Zone
Name stringOr Id The name or OCID of the target zone.
The 'oci_dns_records' resource has been deprecated. Please use 'oci_dns_rrsets' instead.
- Compartment
Id string The OCID of the compartment the resource belongs to.
- Domain string
Search by domain. Will match any record whose domain (case-insensitive) equals the provided value.
- Domain
Contains string Search by domain. Will match any record whose domain (case-insensitive) contains the provided value.
- Filters
List<Get
Records Filter> - Rtype string
Search by record type. Will match any record whose type (case-insensitive) equals the provided value.
- Sort
By string The field by which to sort records. Allowed values are: domain|rtype|ttl
- Sort
Order string The order to sort the resources. Allowed values are: ASC|DESC
- Zone
Version string The version of the zone for which data is requested.
- Zone
Name stringOr Id The name or OCID of the target zone.
The 'oci_dns_records' resource has been deprecated. Please use 'oci_dns_rrsets' instead.
- Compartment
Id string The OCID of the compartment the resource belongs to.
- Domain string
Search by domain. Will match any record whose domain (case-insensitive) equals the provided value.
- Domain
Contains string Search by domain. Will match any record whose domain (case-insensitive) contains the provided value.
- Filters
[]Get
Records Filter - Rtype string
Search by record type. Will match any record whose type (case-insensitive) equals the provided value.
- Sort
By string The field by which to sort records. Allowed values are: domain|rtype|ttl
- Sort
Order string The order to sort the resources. Allowed values are: ASC|DESC
- Zone
Version string The version of the zone for which data is requested.
- zone
Name StringOr Id The name or OCID of the target zone.
The 'oci_dns_records' resource has been deprecated. Please use 'oci_dns_rrsets' instead.
- compartment
Id String The OCID of the compartment the resource belongs to.
- domain String
Search by domain. Will match any record whose domain (case-insensitive) equals the provided value.
- domain
Contains String Search by domain. Will match any record whose domain (case-insensitive) contains the provided value.
- filters
List<Get
Records Filter> - rtype String
Search by record type. Will match any record whose type (case-insensitive) equals the provided value.
- sort
By String The field by which to sort records. Allowed values are: domain|rtype|ttl
- sort
Order String The order to sort the resources. Allowed values are: ASC|DESC
- zone
Version String The version of the zone for which data is requested.
- zone
Name stringOr Id The name or OCID of the target zone.
The 'oci_dns_records' resource has been deprecated. Please use 'oci_dns_rrsets' instead.
- compartment
Id string The OCID of the compartment the resource belongs to.
- domain string
Search by domain. Will match any record whose domain (case-insensitive) equals the provided value.
- domain
Contains string Search by domain. Will match any record whose domain (case-insensitive) contains the provided value.
- filters
Get
Records Filter[] - rtype string
Search by record type. Will match any record whose type (case-insensitive) equals the provided value.
- sort
By string The field by which to sort records. Allowed values are: domain|rtype|ttl
- sort
Order string The order to sort the resources. Allowed values are: ASC|DESC
- zone
Version string The version of the zone for which data is requested.
- zone_
name_ stror_ id The name or OCID of the target zone.
The 'oci_dns_records' resource has been deprecated. Please use 'oci_dns_rrsets' instead.
- compartment_
id str The OCID of the compartment the resource belongs to.
- 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
Get
Records Filter] - 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.
- zone
Name StringOr Id The name or OCID of the target zone.
The 'oci_dns_records' resource has been deprecated. Please use 'oci_dns_rrsets' instead.
- compartment
Id String The OCID of the compartment the resource belongs to.
- domain String
Search by domain. Will match any record whose domain (case-insensitive) equals the provided value.
- domain
Contains String Search by domain. Will match any record whose domain (case-insensitive) contains the provided value.
- filters List<Property Map>
- rtype String
Search by record type. Will match any record whose type (case-insensitive) equals the provided value.
- sort
By String The field by which to sort records. Allowed values are: domain|rtype|ttl
- sort
Order String The order to sort the resources. Allowed values are: ASC|DESC
- zone
Version 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<Get
Records Record> The list of records.
- Zone
Name stringOr Id The name or OCID of the target zone.
The 'oci_dns_records' resource has been deprecated. Please use 'oci_dns_rrsets' instead.
- Compartment
Id string - Domain string
The fully qualified domain name where the record can be located.
- Domain
Contains string - Filters
List<Get
Records Filter> - Rtype string
The canonical name for the record's type, such as A or CNAME. For more information, see Resource Record (RR) TYPEs.
- Sort
By string - Sort
Order string - Zone
Version string
- Id string
The provider-assigned unique ID for this managed resource.
- Records
[]Get
Records Record The list of records.
- Zone
Name stringOr Id The name or OCID of the target zone.
The 'oci_dns_records' resource has been deprecated. Please use 'oci_dns_rrsets' instead.
- Compartment
Id string - Domain string
The fully qualified domain name where the record can be located.
- Domain
Contains string - Filters
[]Get
Records Filter - Rtype string
The canonical name for the record's type, such as A or CNAME. For more information, see Resource Record (RR) TYPEs.
- Sort
By string - Sort
Order string - Zone
Version string
- id String
The provider-assigned unique ID for this managed resource.
- records
List<Get
Records Record> The list of records.
- zone
Name StringOr Id The name or OCID of the target zone.
The 'oci_dns_records' resource has been deprecated. Please use 'oci_dns_rrsets' instead.
- compartment
Id String - domain String
The fully qualified domain name where the record can be located.
- domain
Contains String - filters
List<Get
Records Filter> - rtype String
The canonical name for the record's type, such as A or CNAME. For more information, see Resource Record (RR) TYPEs.
- sort
By String - sort
Order String - zone
Version String
- id string
The provider-assigned unique ID for this managed resource.
- records
Get
Records Record[] The list of records.
- zone
Name stringOr Id The name or OCID of the target zone.
The 'oci_dns_records' resource has been deprecated. Please use 'oci_dns_rrsets' instead.
- compartment
Id string - domain string
The fully qualified domain name where the record can be located.
- domain
Contains string - filters
Get
Records Filter[] - rtype string
The canonical name for the record's type, such as A or CNAME. For more information, see Resource Record (RR) TYPEs.
- sort
By string - sort
Order string - zone
Version string
- id str
The provider-assigned unique ID for this managed resource.
- records
Get
Records Record] The list of records.
- zone_
name_ stror_ id The name or OCID of the target zone.
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
Get
Records Filter] - rtype str
The canonical name for the record's type, 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.
- zone
Name StringOr Id The name or OCID of the target zone.
The 'oci_dns_records' resource has been deprecated. Please use 'oci_dns_rrsets' instead.
- compartment
Id String - domain String
The fully qualified domain name where the record can be located.
- domain
Contains String - filters List<Property Map>
- rtype String
The canonical name for the record's type, such as A or CNAME. For more information, see Resource Record (RR) TYPEs.
- sort
By String - sort
Order String - zone
Version String
Supporting Types
GetRecordsFilter
GetRecordsRecord
- Domain string
Search by domain. Will match any record whose domain (case-insensitive) equals the provided value.
The 'oci_dns_record' resource has been deprecated. Please use 'oci_dns_rrset' instead.
- Is
Protected bool A Boolean flag indicating whether or not parts of the record are unable to be explicitly managed.
- Record
Hash string A unique identifier for the record within its zone.
- Rrset
Version string The latest version of the record's zone in which its RRSet differs from the preceding version.
- Rtype string
Search by record type. Will match any record whose type (case-insensitive) equals the provided value.
The 'oci_dns_record' resource has been deprecated. Please use 'oci_dns_rrset' instead.
- Zone
Name stringOr Id The name or OCID of the target zone.
The 'oci_dns_record' resource has been deprecated. Please use 'oci_dns_rrset' instead.
- Compartment
Id string The OCID of the compartment the resource belongs to.
- 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.
- Domain string
Search by domain. Will match any record whose domain (case-insensitive) equals the provided value.
The 'oci_dns_record' resource has been deprecated. Please use 'oci_dns_rrset' instead.
- Is
Protected bool A Boolean flag indicating whether or not parts of the record are unable to be explicitly managed.
- Record
Hash string A unique identifier for the record within its zone.
- Rrset
Version string The latest version of the record's zone in which its RRSet differs from the preceding version.
- Rtype string
Search by record type. Will match any record whose type (case-insensitive) equals the provided value.
The 'oci_dns_record' resource has been deprecated. Please use 'oci_dns_rrset' instead.
- Zone
Name stringOr Id The name or OCID of the target zone.
The 'oci_dns_record' resource has been deprecated. Please use 'oci_dns_rrset' instead.
- Compartment
Id string The OCID of the compartment the resource belongs to.
- 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.
- domain String
Search by domain. Will match any record whose domain (case-insensitive) equals the provided value.
The 'oci_dns_record' resource has been deprecated. Please use 'oci_dns_rrset' instead.
- is
Protected Boolean A Boolean flag indicating whether or not parts of the record are unable to be explicitly managed.
- record
Hash String A unique identifier for the record within its zone.
- rrset
Version String The latest version of the record's zone in which its RRSet differs from the preceding version.
- rtype String
Search by record type. Will match any record whose type (case-insensitive) equals the provided value.
The 'oci_dns_record' resource has been deprecated. Please use 'oci_dns_rrset' instead.
- zone
Name StringOr Id The name or OCID of the target zone.
The 'oci_dns_record' resource has been deprecated. Please use 'oci_dns_rrset' instead.
- compartment
Id String The OCID of the compartment the resource belongs to.
- 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.
- domain string
Search by domain. Will match any record whose domain (case-insensitive) equals the provided value.
The 'oci_dns_record' resource has been deprecated. Please use 'oci_dns_rrset' instead.
- is
Protected boolean A Boolean flag indicating whether or not parts of the record are unable to be explicitly managed.
- record
Hash string A unique identifier for the record within its zone.
- rrset
Version string The latest version of the record's zone in which its RRSet differs from the preceding version.
- rtype string
Search by record type. Will match any record whose type (case-insensitive) equals the provided value.
The 'oci_dns_record' resource has been deprecated. Please use 'oci_dns_rrset' instead.
- zone
Name stringOr Id The name or OCID of the target zone.
The 'oci_dns_record' resource has been deprecated. Please use 'oci_dns_rrset' instead.
- compartment
Id string The OCID of the compartment the resource belongs to.
- 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.
- domain str
Search by domain. Will match any record whose domain (case-insensitive) equals the provided value.
The 'oci_dns_record' resource has been deprecated. Please use 'oci_dns_rrset' instead.
- is_
protected bool A Boolean flag indicating whether or not parts of the record are unable to be explicitly managed.
- record_
hash str A unique identifier for the record within its zone.
- rrset_
version str The latest version of the record's zone in which its RRSet differs from the preceding version.
- rtype str
Search by record type. Will match any record whose type (case-insensitive) equals the provided value.
The 'oci_dns_record' resource has been deprecated. Please use 'oci_dns_rrset' instead.
- zone_
name_ stror_ id The name or OCID of the target zone.
The 'oci_dns_record' resource has been deprecated. Please use 'oci_dns_rrset' instead.
- compartment_
id str The OCID of the compartment the resource belongs to.
- 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.
- domain String
Search by domain. Will match any record whose domain (case-insensitive) equals the provided value.
The 'oci_dns_record' resource has been deprecated. Please use 'oci_dns_rrset' instead.
- is
Protected Boolean A Boolean flag indicating whether or not parts of the record are unable to be explicitly managed.
- record
Hash String A unique identifier for the record within its zone.
- rrset
Version String The latest version of the record's zone in which its RRSet differs from the preceding version.
- rtype String
Search by record type. Will match any record whose type (case-insensitive) equals the provided value.
The 'oci_dns_record' resource has been deprecated. Please use 'oci_dns_rrset' instead.
- zone
Name StringOr Id The name or OCID of the target zone.
The 'oci_dns_record' resource has been deprecated. Please use 'oci_dns_rrset' instead.
- compartment
Id String The OCID of the compartment the resource belongs to.
- 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.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
ociTerraform Provider.