Skip to content
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add generation after additions to readme
  • Loading branch information
jamesvoongms committed Oct 17, 2024
commit 30460ac38bd5995b741556f90b130616b3d76bac
2 changes: 1 addition & 1 deletion src/DnsResolver/DnsResolver.Autorest/Az.DnsResolver.psd1
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
DotNetFrameworkVersion = '4.7.2'
RequiredAssemblies = './bin/Az.DnsResolver.private.dll'
FormatsToProcess = './Az.DnsResolver.format.ps1xml'
FunctionsToExport = 'Get-AzDnsForwardingRuleset', 'Get-AzDnsForwardingRulesetDnsResolverPolicyVirtualNetworkLink', 'Get-AzDnsForwardingRulesetForwardingRule', 'Get-AzDnsForwardingRulesetVirtualNetworkLink', 'Get-AzDnsResolver', 'Get-AzDnsResolverDnsSecurityRule', 'Get-AzDnsResolverDomainList', 'Get-AzDnsResolverInboundEndpoint', 'Get-AzDnsResolverOutboundEndpoint', 'Get-AzDnsResolverPolicy', 'New-AzDnsForwardingRuleset', 'New-AzDnsForwardingRulesetDnsResolverPolicyVirtualNetworkLink', 'New-AzDnsForwardingRulesetForwardingRule', 'New-AzDnsForwardingRulesetVirtualNetworkLink', 'New-AzDnsResolver', 'New-AzDnsResolverDnsSecurityRule', 'New-AzDnsResolverDomainList', 'New-AzDnsResolverInboundEndpoint', 'New-AzDnsResolverIPConfigurationObject', 'New-AzDnsResolverOutboundEndpoint', 'New-AzDnsResolverPolicy', 'New-AzDnsResolverTargetDnsServerObject', 'Remove-AzDnsForwardingRuleset', 'Remove-AzDnsForwardingRulesetDnsResolverPolicyVirtualNetworkLink', 'Remove-AzDnsForwardingRulesetForwardingRule', 'Remove-AzDnsForwardingRulesetVirtualNetworkLink', 'Remove-AzDnsResolver', 'Remove-AzDnsResolverDnsSecurityRule', 'Remove-AzDnsResolverDomainList', 'Remove-AzDnsResolverInboundEndpoint', 'Remove-AzDnsResolverOutboundEndpoint', 'Remove-AzDnsResolverPolicy', 'Update-AzDnsForwardingRuleset', 'Update-AzDnsForwardingRulesetDnsResolverPolicyVirtualNetworkLink', 'Update-AzDnsForwardingRulesetForwardingRule', 'Update-AzDnsForwardingRulesetVirtualNetworkLink', 'Update-AzDnsResolver', 'Update-AzDnsResolverDnsSecurityRule', 'Update-AzDnsResolverDomainList', 'Update-AzDnsResolverInboundEndpoint', 'Update-AzDnsResolverOutboundEndpoint', 'Update-AzDnsResolverPolicy', '*'
FunctionsToExport = 'Get-AzDnsForwardingRuleset', 'Get-AzDnsForwardingRulesetForwardingRule', 'Get-AzDnsForwardingRulesetVirtualNetworkLink', 'Get-AzDnsResolver', 'Get-AzDnsResolverDomainList', 'Get-AzDnsResolverInboundEndpoint', 'Get-AzDnsResolverOutboundEndpoint', 'Get-AzDnsResolverPolicy', 'Get-AzDnsResolverPolicyDnsSecurityRule', 'Get-AzDnsResolverPolicyVirtualNetworkLink', 'New-AzDnsForwardingRuleset', 'New-AzDnsForwardingRulesetForwardingRule', 'New-AzDnsForwardingRulesetVirtualNetworkLink', 'New-AzDnsResolver', 'New-AzDnsResolverDomainList', 'New-AzDnsResolverInboundEndpoint', 'New-AzDnsResolverIPConfigurationObject', 'New-AzDnsResolverOutboundEndpoint', 'New-AzDnsResolverPolicy', 'New-AzDnsResolverPolicyDnsSecurityRule', 'New-AzDnsResolverPolicyVirtualNetworkLink', 'New-AzDnsResolverTargetDnsServerObject', 'Remove-AzDnsForwardingRuleset', 'Remove-AzDnsForwardingRulesetForwardingRule', 'Remove-AzDnsForwardingRulesetVirtualNetworkLink', 'Remove-AzDnsResolver', 'Remove-AzDnsResolverDomainList', 'Remove-AzDnsResolverInboundEndpoint', 'Remove-AzDnsResolverOutboundEndpoint', 'Remove-AzDnsResolverPolicy', 'Remove-AzDnsResolverPolicyDnsSecurityRule', 'Remove-AzDnsResolverPolicyVirtualNetworkLink', 'Update-AzDnsForwardingRuleset', 'Update-AzDnsForwardingRulesetForwardingRule', 'Update-AzDnsForwardingRulesetVirtualNetworkLink', 'Update-AzDnsResolver', 'Update-AzDnsResolverDomainList', 'Update-AzDnsResolverInboundEndpoint', 'Update-AzDnsResolverOutboundEndpoint', 'Update-AzDnsResolverPolicy', 'Update-AzDnsResolverPolicyDnsSecurityRule', 'Update-AzDnsResolverPolicyVirtualNetworkLink', '*'
AliasesToExport = '*'
PrivateData = @{
PSData = @{
Expand Down
18 changes: 17 additions & 1 deletion src/DnsResolver/DnsResolver.Autorest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,23 @@ use-extension:

directive:
- where:
subject: ForwardingRule|VirtualNetworkLink
subject: DnsResolverPolicyVirtualNetworkLink
set:
subject-prefix: ''
- where:
subject: DnsResolverPolicy
set:
subject-prefix: ''
- where:
subject: DnsResolverDomainList
set:
subject-prefix: ''
- where:
subject: DnsSecurityRule
set:
subject-prefix: 'DnsResolverPolicy'
- where:
subject: ^(ForwardingRule|VirtualNetworkLink)$
set:
subject-prefix: DnsForwardingRuleset
- where:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@
},
"commands": [
{
"name": "Get-AzDnsResolverDnsSecurityRule",
"name": "Get-AzDnsResolverPolicyDnsSecurityRule",
"description": "Gets properties of a DNS security rule for a DNS resolver policy.",
"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverPolicies/{dnsResolverPolicyName}/dnsSecurityRules/{dnsSecurityRuleName}",
"help": {
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.dnsresolver/get-azdnsresolverdnssecurityrule"
"url": "https://learn.microsoft.com/powershell/module/az.dnsresolver/get-azdnsresolverpolicydnssecurityrule"
},
"parameterSets": [
{
Expand Down Expand Up @@ -49,12 +49,12 @@
]
},
{
"name": "Remove-AzDnsResolverDnsSecurityRule",
"name": "Remove-AzDnsResolverPolicyDnsSecurityRule",
"description": "Deletes a DNS security rule for a DNS resolver policy.\nWARNING: This operation cannot be undone.",
"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverPolicies/{dnsResolverPolicyName}/dnsSecurityRules/{dnsSecurityRuleName}",
"help": {
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.dnsresolver/remove-azdnsresolverdnssecurityrule"
"url": "https://learn.microsoft.com/powershell/module/az.dnsresolver/remove-azdnsresolverpolicydnssecurityrule"
},
"parameterSets": [
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@
},
"commands": [
{
"name": "Get-AzDnsForwardingRulesetDnsResolverPolicyVirtualNetworkLink",
"name": "Get-AzDnsResolverPolicyVirtualNetworkLink",
"description": "Gets properties of a DNS resolver policy virtual network link.",
"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverPolicies/{dnsResolverPolicyName}/virtualNetworkLinks/{dnsResolverPolicyVirtualNetworkLinkName}",
"help": {
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.dnsresolver/get-azdnsforwardingrulesetdnsresolverpolicyvirtualnetworklink"
"url": "https://learn.microsoft.com/powershell/module/az.dnsresolver/get-azdnsresolverpolicyvirtualnetworklink"
},
"parameterSets": [
{
Expand Down Expand Up @@ -49,12 +49,12 @@
]
},
{
"name": "Remove-AzDnsForwardingRulesetDnsResolverPolicyVirtualNetworkLink",
"name": "Remove-AzDnsResolverPolicyVirtualNetworkLink",
"description": "Deletes a DNS resolver policy virtual network link.\nWARNING: This operation cannot be undone.",
"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverPolicies/{dnsResolverPolicyName}/virtualNetworkLinks/{dnsResolverPolicyVirtualNetworkLinkName}",
"help": {
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.dnsresolver/remove-azdnsforwardingrulesetdnsresolverpolicyvirtualnetworklink"
"url": "https://learn.microsoft.com/powershell/module/az.dnsresolver/remove-azdnsresolverpolicyvirtualnetworklink"
},
"parameterSets": [
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,6 @@ Microsoft Azure PowerShell: DnsResolver cmdlets
### [Get-AzDnsForwardingRuleset](Get-AzDnsForwardingRuleset.md)
Gets a DNS forwarding ruleset properties.

### [Get-AzDnsForwardingRulesetDnsResolverPolicyVirtualNetworkLink](Get-AzDnsForwardingRulesetDnsResolverPolicyVirtualNetworkLink.md)
Gets properties of a DNS resolver policy virtual network link.

### [Get-AzDnsForwardingRulesetForwardingRule](Get-AzDnsForwardingRulesetForwardingRule.md)
Gets properties of a forwarding rule in a DNS forwarding ruleset.

Expand All @@ -26,9 +23,6 @@ Gets properties of a virtual network link to a DNS forwarding ruleset.
### [Get-AzDnsResolver](Get-AzDnsResolver.md)
Gets properties of a DNS resolver.

### [Get-AzDnsResolverDnsSecurityRule](Get-AzDnsResolverDnsSecurityRule.md)
Gets properties of a DNS security rule for a DNS resolver policy.

### [Get-AzDnsResolverDomainList](Get-AzDnsResolverDomainList.md)
Gets properties of a DNS resolver domain list.

Expand All @@ -41,12 +35,15 @@ Gets properties of an outbound endpoint for a DNS resolver.
### [Get-AzDnsResolverPolicy](Get-AzDnsResolverPolicy.md)
Gets properties of a DNS resolver policy.

### [Get-AzDnsResolverPolicyDnsSecurityRule](Get-AzDnsResolverPolicyDnsSecurityRule.md)
Gets properties of a DNS security rule for a DNS resolver policy.

### [Get-AzDnsResolverPolicyVirtualNetworkLink](Get-AzDnsResolverPolicyVirtualNetworkLink.md)
Gets properties of a DNS resolver policy virtual network link.

### [New-AzDnsForwardingRuleset](New-AzDnsForwardingRuleset.md)
Creates or updates a DNS forwarding ruleset.

### [New-AzDnsForwardingRulesetDnsResolverPolicyVirtualNetworkLink](New-AzDnsForwardingRulesetDnsResolverPolicyVirtualNetworkLink.md)
Creates or updates a DNS resolver policy virtual network link.

### [New-AzDnsForwardingRulesetForwardingRule](New-AzDnsForwardingRulesetForwardingRule.md)
Creates or updates a forwarding rule in a DNS forwarding ruleset.

Expand All @@ -56,9 +53,6 @@ Creates or updates a virtual network link to a DNS forwarding ruleset.
### [New-AzDnsResolver](New-AzDnsResolver.md)
Creates or updates a DNS resolver.

### [New-AzDnsResolverDnsSecurityRule](New-AzDnsResolverDnsSecurityRule.md)
Creates or updates a DNS security rule for a DNS resolver policy.

### [New-AzDnsResolverDomainList](New-AzDnsResolverDomainList.md)
Creates or updates a DNS resolver domain list.

Expand All @@ -74,6 +68,12 @@ Creates or updates an outbound endpoint for a DNS resolver.
### [New-AzDnsResolverPolicy](New-AzDnsResolverPolicy.md)
Creates or updates a DNS resolver policy.

### [New-AzDnsResolverPolicyDnsSecurityRule](New-AzDnsResolverPolicyDnsSecurityRule.md)
Creates or updates a DNS security rule for a DNS resolver policy.

### [New-AzDnsResolverPolicyVirtualNetworkLink](New-AzDnsResolverPolicyVirtualNetworkLink.md)
Creates or updates a DNS resolver policy virtual network link.

### [New-AzDnsResolverTargetDnsServerObject](New-AzDnsResolverTargetDnsServerObject.md)
Create a in-memory object for Target DNS server

Expand All @@ -82,10 +82,6 @@ Deletes a DNS forwarding ruleset.
WARNING: This operation cannot be undone.
All forwarding rules within the ruleset will be deleted.

### [Remove-AzDnsForwardingRulesetDnsResolverPolicyVirtualNetworkLink](Remove-AzDnsForwardingRulesetDnsResolverPolicyVirtualNetworkLink.md)
Deletes a DNS resolver policy virtual network link.
WARNING: This operation cannot be undone.

### [Remove-AzDnsForwardingRulesetForwardingRule](Remove-AzDnsForwardingRulesetForwardingRule.md)
Deletes a forwarding rule in a DNS forwarding ruleset.
WARNING: This operation cannot be undone.
Expand All @@ -98,10 +94,6 @@ WARNING: This operation cannot be undone.
Deletes a DNS resolver.
WARNING: This operation cannot be undone.

### [Remove-AzDnsResolverDnsSecurityRule](Remove-AzDnsResolverDnsSecurityRule.md)
Deletes a DNS security rule for a DNS resolver policy.
WARNING: This operation cannot be undone.

### [Remove-AzDnsResolverDomainList](Remove-AzDnsResolverDomainList.md)
Deletes a DNS resolver domain list.
WARNING: This operation cannot be undone.
Expand All @@ -118,12 +110,17 @@ WARNING: This operation cannot be undone.
Deletes a DNS resolver policy.
WARNING: This operation cannot be undone.

### [Remove-AzDnsResolverPolicyDnsSecurityRule](Remove-AzDnsResolverPolicyDnsSecurityRule.md)
Deletes a DNS security rule for a DNS resolver policy.
WARNING: This operation cannot be undone.

### [Remove-AzDnsResolverPolicyVirtualNetworkLink](Remove-AzDnsResolverPolicyVirtualNetworkLink.md)
Deletes a DNS resolver policy virtual network link.
WARNING: This operation cannot be undone.

### [Update-AzDnsForwardingRuleset](Update-AzDnsForwardingRuleset.md)
Updates a DNS forwarding ruleset.

### [Update-AzDnsForwardingRulesetDnsResolverPolicyVirtualNetworkLink](Update-AzDnsForwardingRulesetDnsResolverPolicyVirtualNetworkLink.md)
Updates a DNS resolver policy virtual network link.

### [Update-AzDnsForwardingRulesetForwardingRule](Update-AzDnsForwardingRulesetForwardingRule.md)
Updates a forwarding rule in a DNS forwarding ruleset.

Expand All @@ -133,9 +130,6 @@ Updates a virtual network link to a DNS forwarding ruleset.
### [Update-AzDnsResolver](Update-AzDnsResolver.md)
Updates a DNS resolver.

### [Update-AzDnsResolverDnsSecurityRule](Update-AzDnsResolverDnsSecurityRule.md)
Updates a DNS security rule.

### [Update-AzDnsResolverDomainList](Update-AzDnsResolverDomainList.md)
Updates a DNS resolver domain list.

Expand All @@ -148,3 +142,9 @@ Updates an outbound endpoint for a DNS resolver.
### [Update-AzDnsResolverPolicy](Update-AzDnsResolverPolicy.md)
Updates a DNS resolver policy.

### [Update-AzDnsResolverPolicyDnsSecurityRule](Update-AzDnsResolverPolicyDnsSecurityRule.md)
Updates a DNS security rule.

### [Update-AzDnsResolverPolicyVirtualNetworkLink](Update-AzDnsResolverPolicyVirtualNetworkLink.md)
Updates a DNS resolver policy virtual network link.

Original file line number Diff line number Diff line change
Expand Up @@ -14,26 +14,26 @@ Gets a DNS forwarding ruleset properties.

### List1 (Default)
```
Get-AzDnsForwardingRuleset [-SubscriptionId <String[]>] [-Top <Int32>] [-DefaultProfile <PSObject>] [-Confirm]
[-WhatIf] [<CommonParameters>]
Get-AzDnsForwardingRuleset [-SubscriptionId <String[]>] [-Top <Int32>] [-DefaultProfile <PSObject>]
[<CommonParameters>]
```

### Get
```
Get-AzDnsForwardingRuleset -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>]
[-DefaultProfile <PSObject>] [<CommonParameters>]
```

### GetViaIdentity
```
Get-AzDnsForwardingRuleset -InputObject <IDnsResolverIdentity> [-DefaultProfile <PSObject>] [-Confirm]
[-WhatIf] [<CommonParameters>]
Get-AzDnsForwardingRuleset -InputObject <IDnsResolverIdentity> [-DefaultProfile <PSObject>]
[<CommonParameters>]
```

### List
```
Get-AzDnsForwardingRuleset -ResourceGroupName <String> [-SubscriptionId <String[]>] [-Top <Int32>]
[-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>]
[-DefaultProfile <PSObject>] [<CommonParameters>]
```

### List2
Expand All @@ -48,33 +48,63 @@ Gets a DNS forwarding ruleset properties.

## EXAMPLES

### -------------------------- EXAMPLE 1 --------------------------
### Example 1: List all DNS forwarding rulesets in a subscription
```powershell
Get-AzDnsForwardingRuleset -SubscriptionId 0e5a46b1-de0b-4ec3-a5d7-dda908b4e076
```

```output
Location Name Type Etag
-------- ---- ---- ----
westus2 dnsForwardingRuleset Microsoft.Network/dnsForwardingRulesets "04005592-0000-0800-0000-60e7ec170000"
westus2 pw-dnsForwardingRuleset Microsoft.Network/dnsForwardingRulesets "08009ec9-0000-0800-0000-60e383b70000"
westus2 pw-dnsForwardingRuleset1 Microsoft.Network/dnsForwardingRulesets "08007ccc-0000-0800-0000-60e3846a0000"
eastus2 dnsforwardingruleset-test-eastus2-main-syn-outbound-primary-0 Microsoft.Network/dnsForwardingRulesets "4f006bb2-0000-0200-0000-60e7ef240000"
eastus2 dnsforwardingruleset-test-eastus2-main-syn-outbound-secondary-0 Microsoft.Network/dnsForwardingRulesets "4f006db2-0000-0200-0000-60e7ef240000"
```

This command gets all DNS forwarding ruleset under the subscription.

### -------------------------- EXAMPLE 2 --------------------------
### Example 2: Get single DNS forwarding ruleset by name
```powershell
Get-AzDnsForwardingRuleset -Name dnsForwardingRuleset -ResourceGroupName sampleRG
```

```output
Location Name Type Etag
-------- ---- ---- ----
westus2 dnsForwardingRuleset Microsoft.Network/dnsForwardingRulesets "04005592-0000-0800-0000-60e7ec170000"
```

This command gets single DNS forwarding ruleset by name.

### -------------------------- EXAMPLE 3 --------------------------
### Example 3: List all DNS forwarding ruleset under the resource group
```powershell
Get-AzDnsForwardingRuleset -ResourceGroupName sampleRG
```

```output
Location Name Type Etag
-------- ---- ---- ----
westus2 dnsForwardingRuleset Microsoft.Network/dnsForwardingRulesets "04005592-0000-0800-0000-60e7ec170000"
westus2 pw-dnsForwardingRuleset Microsoft.Network/dnsForwardingRulesets "08009ec9-0000-0800-0000-60e383b70000"
westus2 pw-dnsForwardingRuleset1 Microsoft.Network/dnsForwardingRulesets "08007ccc-0000-0800-0000-60e3846a0000"
```

This command gets all DNS forwarding ruleset under the resource group.

### -------------------------- EXAMPLE 4 --------------------------
### Example 4: List all DNS forwarding ruleset under the virtual network
```powershell
Get-AzDnsForwardingRuleset -ResourceGroupName sampleRG -VirtualNetworkName virtualnetwork-test
```

```output
Location Name Type Etag
-------- ---- ---- ----
westus2 dnsForwardingRuleset Microsoft.Network/dnsForwardingRulesets "04005592-0000-0800-0000-60e7ec170000"
```

This command gets all DNS forwarding ruleset under the virtual network.

## PARAMETERS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,19 +35,32 @@ Gets properties of a forwarding rule in a DNS forwarding ruleset.

## EXAMPLES

### -------------------------- EXAMPLE 1 --------------------------
### Example 1: List all forwarding rule under the resource
```powershell
Get-AzDnsForwardingRulesetForwardingRule -DnsForwardingRulesetName DnsResolverName -ResourceGroupName sampleRG
```

```output
Location Name Type Etag
-------- ---- ---- ----
westus2 dnsForwardingRule Microsoft.Network/dnsForwardingRulesets/forwardingRule "04005592-0000-0800-0000-60e7ec170000"
westus2 pw-dnsForwardingRule Microsoft.Network/dnsForwardingRulesets/forwardingRule "08009ec9-0000-0800-0000-60e383b70000"
```

This command gets all forwarding rule under the resource.

### -------------------------- EXAMPLE 2 --------------------------
### Example 1: Get forwarding rule by name
```powershell
Get-AzDnsForwardingRulesetForwardingRule -DnsForwardingRulesetName DnsResolverName -ResourceGroupName sampleRG -Name forwardingRule
```

```output
Location Name Type Etag
-------- ---- ---- ----
westus2 dnsForwardingRule Microsoft.Network/dnsForwardingRulesets/forwardingRule "04005592-0000-0800-0000-60e7ec170000"
```

This command gets a forwarding rule by name.

## PARAMETERS

Expand Down
Loading