en-US/about_DnsRecordTxtScoped.help.txt

.NAME
    DnsRecordTxtScoped
 
.SYNOPSIS
    The DnsRecordTxtScoped DSC resource manages TXT DNS records against a specific zone and zone scope on a Domain Name System (DNS) server.
 
.DESCRIPTION
    The DnsRecordTxtScoped DSC resource manages TXT DNS records against a specific zone and zone scope on a Domain Name System (DNS) server.
 
.PARAMETER ZoneScope
    Key - System.String
    Specifies the name of a zone scope. (Key Parameter)
 
.EXAMPLE 1
 
This configuration will ensure a DNS TXT scoped record exists when only the mandatory properties are specified.
 
Configuration DnsRecordTxtScoped_Mandatory_config
{
    Import-DscResource -ModuleName 'DnsServerDsc'
 
    Node localhost
    {
        DnsRecordTxtScoped 'TestRecord'
        {
            ZoneName = 'contoso.com'
            ZoneScope = 'external'
            Name = 'test'
            DescriptiveText = 'Example text for test.contoso.com TXT record.'
            Ensure = 'Present'
        }
    }
}
 
.EXAMPLE 2
 
This configuration will ensure a DNS TXT scoped record exists when all properties are specified.
 
Example presents creation of multiline DNS TXT scoped record with DKIM.
 
Configuration DnsRecordTxtScoped_Full_config
{
    Import-DscResource -ModuleName 'DnsServerDsc'
 
    Node localhost
    {
        DnsRecordTxtScoped 'TestRecord Multiline Full'
        {
            ZoneName = 'contoso.com'
            ZoneScope = 'external'
            Name = 'sea2048._domainkey'
            DescriptiveText = 'Example text for test.contoso.com TXT record.'
            TimeToLive = '01:00:00'
            DnsServer = 'localhost'
            Ensure = 'Present'
        }
    }
}
 
.EXAMPLE 3
 
This configuration will ensure a DNS TXT record does not exist when mandatory properties are specified.
 
Note that not all mandatory properties are necessarily key properties. Non-key property values will be ignored when determining whether the record is to be removed.
 
Configuration DnsRecordTxtScoped_Remove_config
{
    Import-DscResource -ModuleName 'DnsServerDsc'
 
    Node localhost
    {
        DnsRecordTxtScoped 'TestRecord'
        {
            ZoneName = 'contoso.com'
            ZoneScope = 'external'
            Name = 'test'
            DescriptiveText = 'Example text for test.contoso.com TXT record.'
            Ensure = 'Absent'
        }
    }
}