-
Notifications
You must be signed in to change notification settings - Fork 627
Add DNS over HTTPS cmdlets documentation #4061
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
sruthytv1988
wants to merge
6
commits into
MicrosoftDocs:main
Choose a base branch
from
sruthytv1988:dohgethelp
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+472
−0
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
dca945c
Add DNS over HTTPS cmdlets documentation
sruthytv1988 519e375
updated new cmdlets
sruthytv1988 2cab018
updated get help files of doh
sruthytv1988 f48d997
Merge branch 'main' into dohgethelp
sruthytv1988 1c9af45
Minor editorial changes
robinharwood 5a95721
addressed review comments
sruthytv1988 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
182 changes: 182 additions & 0 deletions
182
docset/winserver2025-ps/DnsServer/Get-DnsServerEncryptionProtocol.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,182 @@ | ||||||||||||
| --- | ||||||||||||
| description: Learn how to retrieve DNS over HTTPS (DoH) settings using the Get-DnsServerEncryptionProtocol cmdlet in Windows PowerShell for Windows Server 2025 and later. | ||||||||||||
| external help file: PS_DnsServerEncryptionProtocol_v1.0.0.cdxml-help.xml | ||||||||||||
| Module Name: DnsServer | ||||||||||||
| ms.date: 01/14/2026 | ||||||||||||
| online version: https://learn.microsoft.com/powershell/module/dnsserver/get-dnsserverencryptionprotocol?view=windowsserver2025-ps&wt.mc_id=ps-gethelp | ||||||||||||
| schema: 2.0.0 | ||||||||||||
| title: Get-DnsServerEncryptionProtocol | ||||||||||||
| --- | ||||||||||||
|
|
||||||||||||
| # Get-DnsServerEncryptionProtocol | ||||||||||||
|
|
||||||||||||
| ## SYNOPSIS | ||||||||||||
| Retrieves DNS server encryption protocol settings for DNS over HTTPS (DoH) on Windows Server 2025 or later. | ||||||||||||
|
|
||||||||||||
| ## SYNTAX | ||||||||||||
|
|
||||||||||||
| ``` | ||||||||||||
| Get-DnsServerEncryptionProtocol [-ComputerName <String>] [-PassThru <Boolean>] [-CimSession <CimSession[]>] | ||||||||||||
| [-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>] | ||||||||||||
| ``` | ||||||||||||
|
|
||||||||||||
| ## DESCRIPTION | ||||||||||||
|
|
||||||||||||
| The `Get-DnsServerEncryptionProtocol` cmdlet can be used to verify the current DoH configuration | ||||||||||||
| on a DNS server. The cmdlet retrieves the current settings as an object with the properties | ||||||||||||
| **EnableDoh** and **UriTemplate** to indicate whether DoH is enabled and the configured URI | ||||||||||||
| templates for DNS queries over HTTPS. | ||||||||||||
|
|
||||||||||||
| > [!IMPORTANT] | ||||||||||||
| > The `Get-DnsServerEncryptionProtocol` cmdlet is available on Windows Server 2025 or | ||||||||||||
| > later beginning with 2026-02 Security Update. | ||||||||||||
|
|
||||||||||||
| ## EXAMPLES | ||||||||||||
|
|
||||||||||||
| ### Example 1: Retrieve encryption settings from local DNS server | ||||||||||||
|
|
||||||||||||
| In this example, the command retrieves the current encryption settings from the local DNS server. | ||||||||||||
|
|
||||||||||||
| ```powershell | ||||||||||||
| Get-DnsServerEncryptionProtocol | ||||||||||||
| ``` | ||||||||||||
|
|
||||||||||||
| ```Output | ||||||||||||
| EnableDoh : True | ||||||||||||
| UriTemplate : https://dnsserver.example.net/dns-query | ||||||||||||
| ``` | ||||||||||||
|
|
||||||||||||
| The output shows that DNS over HTTPS (DoH) is enabled with a configured URI template. | ||||||||||||
|
|
||||||||||||
| ### Example 2: Retrieve encryption settings from remote DNS server | ||||||||||||
sruthytv1988 marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||||
|
|
||||||||||||
| In this example, the command retrieves the encryption settings from a remote DNS server named | ||||||||||||
| "dns1.contoso.com". | ||||||||||||
|
|
||||||||||||
| ```powershell | ||||||||||||
| Get-DnsServerEncryptionProtocol -ComputerName "dns1.contoso.com" | ||||||||||||
| ``` | ||||||||||||
|
|
||||||||||||
| ```Output | ||||||||||||
| EnableDoh : False | ||||||||||||
| UriTemplate : | ||||||||||||
| ``` | ||||||||||||
|
|
||||||||||||
| The output shows that DNS over HTTPS (DoH) is currently disabled for the specified remote DNS | ||||||||||||
| server. | ||||||||||||
|
|
||||||||||||
| ## PARAMETERS | ||||||||||||
|
|
||||||||||||
| ### -AsJob | ||||||||||||
|
|
||||||||||||
| Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. | ||||||||||||
|
|
||||||||||||
| The cmdlet immediately returns an object that represents the job and then displays the command prompt. | ||||||||||||
| You can continue to work in the session while the job completes. | ||||||||||||
| To manage the job, use the `*-Job` cmdlets. | ||||||||||||
| To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. | ||||||||||||
|
|
||||||||||||
| For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). | ||||||||||||
|
|
||||||||||||
| ```yaml | ||||||||||||
| Type: SwitchParameter | ||||||||||||
| Parameter Sets: (All) | ||||||||||||
| Aliases: | ||||||||||||
|
|
||||||||||||
| Required: False | ||||||||||||
| Position: Named | ||||||||||||
| Default value: None | ||||||||||||
| Accept pipeline input: False | ||||||||||||
| Accept wildcard characters: False | ||||||||||||
| ``` | ||||||||||||
|
|
||||||||||||
| ### -CimSession | ||||||||||||
|
|
||||||||||||
| Runs the cmdlet in a remote session or on a remote computer. | ||||||||||||
| Enter a computer name or a session object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. | ||||||||||||
| The default is the current session on the local computer. | ||||||||||||
|
|
||||||||||||
| ```yaml | ||||||||||||
| Type: CimSession[] | ||||||||||||
| Parameter Sets: (All) | ||||||||||||
| Aliases: Session | ||||||||||||
|
|
||||||||||||
| Required: False | ||||||||||||
| Position: Named | ||||||||||||
| Default value: None | ||||||||||||
| Accept pipeline input: False | ||||||||||||
| Accept wildcard characters: False | ||||||||||||
| ``` | ||||||||||||
|
|
||||||||||||
| ### -ComputerName | ||||||||||||
|
|
||||||||||||
| Specifies a DNS server. The acceptable values for this parameter are: | ||||||||||||
|
|
||||||||||||
| - An IP V4 address | ||||||||||||
| - An IP V6 address | ||||||||||||
| - Any other value that resolves to an IP address, such as a fully qualified domain name (FQDN), host | ||||||||||||
| name, or NETBIOS name. | ||||||||||||
|
|
||||||||||||
| ```yaml | ||||||||||||
| Type: String | ||||||||||||
| Parameter Sets: (All) | ||||||||||||
| Aliases: Cn | ||||||||||||
|
|
||||||||||||
| Required: False | ||||||||||||
| Position: Named | ||||||||||||
| Default value: None | ||||||||||||
| Accept pipeline input: False | ||||||||||||
| Accept wildcard characters: False | ||||||||||||
| ``` | ||||||||||||
|
|
||||||||||||
| ### -PassThru | ||||||||||||
|
|
||||||||||||
| Returns an object representing the item with which you are working. By default, this cmdlet doesn't generate any output. | ||||||||||||
|
|
||||||||||||
| ```yaml | ||||||||||||
| Type: Boolean | ||||||||||||
| Parameter Sets: (All) | ||||||||||||
| Aliases: | ||||||||||||
|
|
||||||||||||
| Required: False | ||||||||||||
| Position: Named | ||||||||||||
| Default value: None | ||||||||||||
| Accept pipeline input: True (ByPropertyName) | ||||||||||||
| Accept wildcard characters: False | ||||||||||||
| ``` | ||||||||||||
|
|
||||||||||||
| ### -ThrottleLimit | ||||||||||||
|
|
||||||||||||
| Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of `0` is entered, then Windows PowerShell calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer. | ||||||||||||
|
|
||||||||||||
| ```yaml | ||||||||||||
| Type: Int32 | ||||||||||||
| Parameter Sets: (All) | ||||||||||||
| Aliases: | ||||||||||||
|
|
||||||||||||
| Required: False | ||||||||||||
| Position: Named | ||||||||||||
| Default value: None | ||||||||||||
| Accept pipeline input: False | ||||||||||||
| Accept wildcard characters: False | ||||||||||||
| ``` | ||||||||||||
|
|
||||||||||||
| ### CommonParameters | ||||||||||||
|
|
||||||||||||
| This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). | ||||||||||||
|
|
||||||||||||
| ## INPUTS | ||||||||||||
|
|
||||||||||||
| ### None | ||||||||||||
|
|
||||||||||||
| You cannot pipe objects to this cmdlet. | ||||||||||||
|
|
||||||||||||
| ## OUTPUTS | ||||||||||||
|
|
||||||||||||
| ### Microsoft.Management.Infrastructure.CimInstance#DnsServerEncryptionProtocol | ||||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do we need this? All other help pages has this section empty |
||||||||||||
|
|
||||||||||||
| ## NOTES | ||||||||||||
|
|
||||||||||||
| ## RELATED LINKS | ||||||||||||
|
|
||||||||||||
| [Set-DnsServerEncryptionProtocol](./Set-DnsServerEncryptionProtocol.md) | ||||||||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.