Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. privatedns
  5. getPrivateRecordSet
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.privatedns.getPrivateRecordSet

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

    Gets a record set.

    Uses Azure REST API version 2024-06-01.

    Other available API versions: 2018-09-01, 2020-01-01, 2020-06-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native privatedns [ApiVersion]. See the version guide for details.

    Using getPrivateRecordSet

    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 getPrivateRecordSet(args: GetPrivateRecordSetArgs, opts?: InvokeOptions): Promise<GetPrivateRecordSetResult>
function getPrivateRecordSetOutput(args: GetPrivateRecordSetOutputArgs, opts?: InvokeOptions): Output<GetPrivateRecordSetResult>
    def get_private_record_set(private_zone_name: Optional[str] = None,
                           record_type: Optional[str] = None,
                           relative_record_set_name: Optional[str] = None,
                           resource_group_name: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetPrivateRecordSetResult
def get_private_record_set_output(private_zone_name: Optional[pulumi.Input[str]] = None,
                           record_type: Optional[pulumi.Input[str]] = None,
                           relative_record_set_name: Optional[pulumi.Input[str]] = None,
                           resource_group_name: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetPrivateRecordSetResult]
    func LookupPrivateRecordSet(ctx *Context, args *LookupPrivateRecordSetArgs, opts ...InvokeOption) (*LookupPrivateRecordSetResult, error)
func LookupPrivateRecordSetOutput(ctx *Context, args *LookupPrivateRecordSetOutputArgs, opts ...InvokeOption) LookupPrivateRecordSetResultOutput

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

    public static class GetPrivateRecordSet 
{
    public static Task<GetPrivateRecordSetResult> InvokeAsync(GetPrivateRecordSetArgs args, InvokeOptions? opts = null)
    public static Output<GetPrivateRecordSetResult> Invoke(GetPrivateRecordSetInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPrivateRecordSetResult> getPrivateRecordSet(GetPrivateRecordSetArgs args, InvokeOptions options)
public static Output<GetPrivateRecordSetResult> getPrivateRecordSet(GetPrivateRecordSetArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:privatedns:getPrivateRecordSet
  arguments:
    # arguments dictionary

    The following arguments are supported:

    PrivateZoneName string
    The name of the Private DNS zone (without a terminating dot).
    RecordType string
    The type of DNS record in this record set.
    RelativeRecordSetName string
    The name of the record set, relative to the name of the zone.
    ResourceGroupName string
    The name of the resource group.
    PrivateZoneName string
    The name of the Private DNS zone (without a terminating dot).
    RecordType string
    The type of DNS record in this record set.
    RelativeRecordSetName string
    The name of the record set, relative to the name of the zone.
    ResourceGroupName string
    The name of the resource group.
    privateZoneName String
    The name of the Private DNS zone (without a terminating dot).
    recordType String
    The type of DNS record in this record set.
    relativeRecordSetName String
    The name of the record set, relative to the name of the zone.
    resourceGroupName String
    The name of the resource group.
    privateZoneName string
    The name of the Private DNS zone (without a terminating dot).
    recordType string
    The type of DNS record in this record set.
    relativeRecordSetName string
    The name of the record set, relative to the name of the zone.
    resourceGroupName string
    The name of the resource group.
    private_zone_name str
    The name of the Private DNS zone (without a terminating dot).
    record_type str
    The type of DNS record in this record set.
    relative_record_set_name str
    The name of the record set, relative to the name of the zone.
    resource_group_name str
    The name of the resource group.
    privateZoneName String
    The name of the Private DNS zone (without a terminating dot).
    recordType String
    The type of DNS record in this record set.
    relativeRecordSetName String
    The name of the record set, relative to the name of the zone.
    resourceGroupName String
    The name of the resource group.

    getPrivateRecordSet Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Fqdn string
    Fully qualified domain name of the record set.
    Id string
    Fully qualified resource Id for the resource. Example - '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateDnsZoneName}'.
    IsAutoRegistered bool
    Is the record set auto-registered in the Private DNS zone through a virtual network link?
    Name string
    The name of the resource
    Type string
    The type of the resource. Example - 'Microsoft.Network/privateDnsZones'.
    ARecords List<Pulumi.AzureNative.PrivateDns.Outputs.ARecordResponse>
    The list of A records in the record set.
    AaaaRecords List<Pulumi.AzureNative.PrivateDns.Outputs.AaaaRecordResponse>
    The list of AAAA records in the record set.
    CnameRecord Pulumi.AzureNative.PrivateDns.Outputs.CnameRecordResponse
    The CNAME record in the record set.
    Etag string
    The ETag of the record set.
    Metadata Dictionary<string, string>
    The metadata attached to the record set.
    MxRecords List<Pulumi.AzureNative.PrivateDns.Outputs.MxRecordResponse>
    The list of MX records in the record set.
    PtrRecords List<Pulumi.AzureNative.PrivateDns.Outputs.PtrRecordResponse>
    The list of PTR records in the record set.
    SoaRecord Pulumi.AzureNative.PrivateDns.Outputs.SoaRecordResponse
    The SOA record in the record set.
    SrvRecords List<Pulumi.AzureNative.PrivateDns.Outputs.SrvRecordResponse>
    The list of SRV records in the record set.
    Ttl double
    The TTL (time-to-live) of the records in the record set.
    TxtRecords List<Pulumi.AzureNative.PrivateDns.Outputs.TxtRecordResponse>
    The list of TXT records in the record set.
    AzureApiVersion string
    The Azure API version of the resource.
    Fqdn string
    Fully qualified domain name of the record set.
    Id string
    Fully qualified resource Id for the resource. Example - '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateDnsZoneName}'.
    IsAutoRegistered bool
    Is the record set auto-registered in the Private DNS zone through a virtual network link?
    Name string
    The name of the resource
    Type string
    The type of the resource. Example - 'Microsoft.Network/privateDnsZones'.
    ARecords []ARecordResponse
    The list of A records in the record set.
    AaaaRecords []AaaaRecordResponse
    The list of AAAA records in the record set.
    CnameRecord CnameRecordResponse
    The CNAME record in the record set.
    Etag string
    The ETag of the record set.
    Metadata map[string]string
    The metadata attached to the record set.
    MxRecords []MxRecordResponse
    The list of MX records in the record set.
    PtrRecords []PtrRecordResponse
    The list of PTR records in the record set.
    SoaRecord SoaRecordResponse
    The SOA record in the record set.
    SrvRecords []SrvRecordResponse
    The list of SRV records in the record set.
    Ttl float64
    The TTL (time-to-live) of the records in the record set.
    TxtRecords []TxtRecordResponse
    The list of TXT records in the record set.
    azureApiVersion String
    The Azure API version of the resource.
    fqdn String
    Fully qualified domain name of the record set.
    id String
    Fully qualified resource Id for the resource. Example - '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateDnsZoneName}'.
    isAutoRegistered Boolean
    Is the record set auto-registered in the Private DNS zone through a virtual network link?
    name String
    The name of the resource
    type String
    The type of the resource. Example - 'Microsoft.Network/privateDnsZones'.
    aRecords List<ARecordResponse>
    The list of A records in the record set.
    aaaaRecords List<AaaaRecordResponse>
    The list of AAAA records in the record set.
    cnameRecord CnameRecordResponse
    The CNAME record in the record set.
    etag String
    The ETag of the record set.
    metadata Map<String,String>
    The metadata attached to the record set.
    mxRecords List<MxRecordResponse>
    The list of MX records in the record set.
    ptrRecords List<PtrRecordResponse>
    The list of PTR records in the record set.
    soaRecord SoaRecordResponse
    The SOA record in the record set.
    srvRecords List<SrvRecordResponse>
    The list of SRV records in the record set.
    ttl Double
    The TTL (time-to-live) of the records in the record set.
    txtRecords List<TxtRecordResponse>
    The list of TXT records in the record set.
    azureApiVersion string
    The Azure API version of the resource.
    fqdn string
    Fully qualified domain name of the record set.
    id string
    Fully qualified resource Id for the resource. Example - '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateDnsZoneName}'.
    isAutoRegistered boolean
    Is the record set auto-registered in the Private DNS zone through a virtual network link?
    name string
    The name of the resource
    type string
    The type of the resource. Example - 'Microsoft.Network/privateDnsZones'.
    aRecords ARecordResponse[]
    The list of A records in the record set.
    aaaaRecords AaaaRecordResponse[]
    The list of AAAA records in the record set.
    cnameRecord CnameRecordResponse
    The CNAME record in the record set.
    etag string
    The ETag of the record set.
    metadata {[key: string]: string}
    The metadata attached to the record set.
    mxRecords MxRecordResponse[]
    The list of MX records in the record set.
    ptrRecords PtrRecordResponse[]
    The list of PTR records in the record set.
    soaRecord SoaRecordResponse
    The SOA record in the record set.
    srvRecords SrvRecordResponse[]
    The list of SRV records in the record set.
    ttl number
    The TTL (time-to-live) of the records in the record set.
    txtRecords TxtRecordResponse[]
    The list of TXT records in the record set.
    azure_api_version str
    The Azure API version of the resource.
    fqdn str
    Fully qualified domain name of the record set.
    id str
    Fully qualified resource Id for the resource. Example - '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateDnsZoneName}'.
    is_auto_registered bool
    Is the record set auto-registered in the Private DNS zone through a virtual network link?
    name str
    The name of the resource
    type str
    The type of the resource. Example - 'Microsoft.Network/privateDnsZones'.
    a_records Sequence[ARecordResponse]
    The list of A records in the record set.
    aaaa_records Sequence[AaaaRecordResponse]
    The list of AAAA records in the record set.
    cname_record CnameRecordResponse
    The CNAME record in the record set.
    etag str
    The ETag of the record set.
    metadata Mapping[str, str]
    The metadata attached to the record set.
    mx_records Sequence[MxRecordResponse]
    The list of MX records in the record set.
    ptr_records Sequence[PtrRecordResponse]
    The list of PTR records in the record set.
    soa_record SoaRecordResponse
    The SOA record in the record set.
    srv_records Sequence[SrvRecordResponse]
    The list of SRV records in the record set.
    ttl float
    The TTL (time-to-live) of the records in the record set.
    txt_records Sequence[TxtRecordResponse]
    The list of TXT records in the record set.
    azureApiVersion String
    The Azure API version of the resource.
    fqdn String
    Fully qualified domain name of the record set.
    id String
    Fully qualified resource Id for the resource. Example - '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateDnsZoneName}'.
    isAutoRegistered Boolean
    Is the record set auto-registered in the Private DNS zone through a virtual network link?
    name String
    The name of the resource
    type String
    The type of the resource. Example - 'Microsoft.Network/privateDnsZones'.
    aRecords List<Property Map>
    The list of A records in the record set.
    aaaaRecords List<Property Map>
    The list of AAAA records in the record set.
    cnameRecord Property Map
    The CNAME record in the record set.
    etag String
    The ETag of the record set.
    metadata Map<String>
    The metadata attached to the record set.
    mxRecords List<Property Map>
    The list of MX records in the record set.
    ptrRecords List<Property Map>
    The list of PTR records in the record set.
    soaRecord Property Map
    The SOA record in the record set.
    srvRecords List<Property Map>
    The list of SRV records in the record set.
    ttl Number
    The TTL (time-to-live) of the records in the record set.
    txtRecords List<Property Map>
    The list of TXT records in the record set.

    Supporting Types

    ARecordResponse

    Ipv4Address string
    The IPv4 address of this A record.
    Ipv4Address string
    The IPv4 address of this A record.
    ipv4Address String
    The IPv4 address of this A record.
    ipv4Address string
    The IPv4 address of this A record.
    ipv4_address str
    The IPv4 address of this A record.
    ipv4Address String
    The IPv4 address of this A record.

    AaaaRecordResponse

    Ipv6Address string
    The IPv6 address of this AAAA record.
    Ipv6Address string
    The IPv6 address of this AAAA record.
    ipv6Address String
    The IPv6 address of this AAAA record.
    ipv6Address string
    The IPv6 address of this AAAA record.
    ipv6_address str
    The IPv6 address of this AAAA record.
    ipv6Address String
    The IPv6 address of this AAAA record.

    CnameRecordResponse

    Cname string
    The canonical name for this CNAME record.
    Cname string
    The canonical name for this CNAME record.
    cname String
    The canonical name for this CNAME record.
    cname string
    The canonical name for this CNAME record.
    cname str
    The canonical name for this CNAME record.
    cname String
    The canonical name for this CNAME record.

    MxRecordResponse

    Exchange string
    The domain name of the mail host for this MX record.
    Preference int
    The preference value for this MX record.
    Exchange string
    The domain name of the mail host for this MX record.
    Preference int
    The preference value for this MX record.
    exchange String
    The domain name of the mail host for this MX record.
    preference Integer
    The preference value for this MX record.
    exchange string
    The domain name of the mail host for this MX record.
    preference number
    The preference value for this MX record.
    exchange str
    The domain name of the mail host for this MX record.
    preference int
    The preference value for this MX record.
    exchange String
    The domain name of the mail host for this MX record.
    preference Number
    The preference value for this MX record.

    PtrRecordResponse

    Ptrdname string
    The PTR target domain name for this PTR record.
    Ptrdname string
    The PTR target domain name for this PTR record.
    ptrdname String
    The PTR target domain name for this PTR record.
    ptrdname string
    The PTR target domain name for this PTR record.
    ptrdname str
    The PTR target domain name for this PTR record.
    ptrdname String
    The PTR target domain name for this PTR record.

    SoaRecordResponse

    Email string
    The email contact for this SOA record.
    ExpireTime double
    The expire time for this SOA record.
    Host string
    The domain name of the authoritative name server for this SOA record.
    MinimumTtl double
    The minimum value for this SOA record. By convention this is used to determine the negative caching duration.
    RefreshTime double
    The refresh value for this SOA record.
    RetryTime double
    The retry time for this SOA record.
    SerialNumber double
    The serial number for this SOA record.
    Email string
    The email contact for this SOA record.
    ExpireTime float64
    The expire time for this SOA record.
    Host string
    The domain name of the authoritative name server for this SOA record.
    MinimumTtl float64
    The minimum value for this SOA record. By convention this is used to determine the negative caching duration.
    RefreshTime float64
    The refresh value for this SOA record.
    RetryTime float64
    The retry time for this SOA record.
    SerialNumber float64
    The serial number for this SOA record.
    email String
    The email contact for this SOA record.
    expireTime Double
    The expire time for this SOA record.
    host String
    The domain name of the authoritative name server for this SOA record.
    minimumTtl Double
    The minimum value for this SOA record. By convention this is used to determine the negative caching duration.
    refreshTime Double
    The refresh value for this SOA record.
    retryTime Double
    The retry time for this SOA record.
    serialNumber Double
    The serial number for this SOA record.
    email string
    The email contact for this SOA record.
    expireTime number
    The expire time for this SOA record.
    host string
    The domain name of the authoritative name server for this SOA record.
    minimumTtl number
    The minimum value for this SOA record. By convention this is used to determine the negative caching duration.
    refreshTime number
    The refresh value for this SOA record.
    retryTime number
    The retry time for this SOA record.
    serialNumber number
    The serial number for this SOA record.
    email str
    The email contact for this SOA record.
    expire_time float
    The expire time for this SOA record.
    host str
    The domain name of the authoritative name server for this SOA record.
    minimum_ttl float
    The minimum value for this SOA record. By convention this is used to determine the negative caching duration.
    refresh_time float
    The refresh value for this SOA record.
    retry_time float
    The retry time for this SOA record.
    serial_number float
    The serial number for this SOA record.
    email String
    The email contact for this SOA record.
    expireTime Number
    The expire time for this SOA record.
    host String
    The domain name of the authoritative name server for this SOA record.
    minimumTtl Number
    The minimum value for this SOA record. By convention this is used to determine the negative caching duration.
    refreshTime Number
    The refresh value for this SOA record.
    retryTime Number
    The retry time for this SOA record.
    serialNumber Number
    The serial number for this SOA record.

    SrvRecordResponse

    Port int
    The port value for this SRV record.
    Priority int
    The priority value for this SRV record.
    Target string
    The target domain name for this SRV record.
    Weight int
    The weight value for this SRV record.
    Port int
    The port value for this SRV record.
    Priority int
    The priority value for this SRV record.
    Target string
    The target domain name for this SRV record.
    Weight int
    The weight value for this SRV record.
    port Integer
    The port value for this SRV record.
    priority Integer
    The priority value for this SRV record.
    target String
    The target domain name for this SRV record.
    weight Integer
    The weight value for this SRV record.
    port number
    The port value for this SRV record.
    priority number
    The priority value for this SRV record.
    target string
    The target domain name for this SRV record.
    weight number
    The weight value for this SRV record.
    port int
    The port value for this SRV record.
    priority int
    The priority value for this SRV record.
    target str
    The target domain name for this SRV record.
    weight int
    The weight value for this SRV record.
    port Number
    The port value for this SRV record.
    priority Number
    The priority value for this SRV record.
    target String
    The target domain name for this SRV record.
    weight Number
    The weight value for this SRV record.

    TxtRecordResponse

    Value List<string>
    The text value of this TXT record.
    Value []string
    The text value of this TXT record.
    value List<String>
    The text value of this TXT record.
    value string[]
    The text value of this TXT record.
    value Sequence[str]
    The text value of this TXT record.
    value List<String>
    The text value of this TXT record.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
    pulumi/pulumi-azure-native