Skip to content

Commit 01fb410

Browse files
karravi-msftkarravi-msft
committed
updated help files
1 parent 80c1587 commit 01fb410

13 files changed

+93
-57
lines changed

‎src/ResourceManager/Dns/Commands.Dns/Zones/NewAzureDnsZone.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ public class NewAzureDnsZone : DnsBaseCmdlet
3535
[ValidateNotNullOrEmpty]
3636
public string ResourceGroupName { get; set; }
3737

38-
[Parameter(Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = "The type of the zone, public or private.")]
38+
[Parameter(Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = "The type of the zone, public or private. This property cannot be changed for a zone")]
3939
[ValidateNotNullOrEmpty]
4040
public ZoneType? ZoneType { get; set; }
4141

‎src/ResourceManager/Dns/Commands.Dns/help/Add-AzureRmDnsRecordConfig.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
external help file: Microsoft.Azure.Commands.Dns.dll-Help.xml
3+
Module Name: AzureRM.Dns
34
ms.assetid: CD119EBE-E1A4-4E9D-B3BA-FDAF89BF0DDB
45
online version:
56
schema: 2.0.0

‎src/ResourceManager/Dns/Commands.Dns/help/AzureRM.DNS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
---
2-
Module Name: AzureRM.DNS
2+
Module Name: AzureRM.Dns
33
Module Guid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
44
Download Help Link: {{Please enter FwLink manually}}
55
Help Version: {{Please enter version of help manually (X.X.X.X) format}}
66
Locale: en-US
77
---
88

9-
# AzureRM.DNS Module
9+
# AzureRM.Dns Module
1010
## Description
1111
This topic displays help topics for the Azure DNS Cmdlets.
1212

13-
## AzureRM.DNS Cmdlets
13+
## AzureRM.Dns Cmdlets
1414
### [Add-AzureRmDnsRecordConfig](Add-AzureRmDnsRecordConfig.md)
1515
Adds a DNS record to a local record set object.
1616

‎src/ResourceManager/Dns/Commands.Dns/help/Get-AzureRmDnsRecordSet.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
external help file: Microsoft.Azure.Commands.Dns.dll-Help.xml
3+
Module Name: AzureRM.Dns
34
ms.assetid: 40179CF3-7896-4C45-BC18-4CB653B245B6
45
online version:
56
schema: 2.0.0

‎src/ResourceManager/Dns/Commands.Dns/help/Get-AzureRmDnsZone.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
external help file: Microsoft.Azure.Commands.Dns.dll-Help.xml
3+
Module Name: AzureRM.Dns
34
ms.assetid: B831ABE6-348C-4DD6-9295-18D23A1FDF63
45
online version:
56
schema: 2.0.0

‎src/ResourceManager/Dns/Commands.Dns/help/New-AzureRmDnsRecordConfig.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
external help file: Microsoft.Azure.Commands.Dns.dll-Help.xml
3+
Module Name: AzureRM.Dns
34
ms.assetid: AD97BCAF-69BA-4C16-8B57-AB243D796B71
45
online version:
56
schema: 2.0.0

‎src/ResourceManager/Dns/Commands.Dns/help/New-AzureRmDnsRecordSet.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
external help file: Microsoft.Azure.Commands.Dns.dll-Help.xml
3+
Module Name: AzureRM.Dns
34
ms.assetid: 45DF71E0-77E1-4D20-AD09-2C06680F659F
45
online version:
56
schema: 2.0.0

‎src/ResourceManager/Dns/Commands.Dns/help/New-AzureRmDnsZone.md

Lines changed: 45 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
22
external help file: Microsoft.Azure.Commands.Dns.dll-Help.xml
3+
Module Name: AzureRM.Dns
34
ms.assetid: B78F3E8B-C7D2-458C-AB23-06F584FE97E0
4-
online version:
5+
online version:
56
schema: 2.0.0
67
---
78

@@ -13,7 +14,9 @@ Creates a new DNS zone.
1314
## SYNTAX
1415

1516
```
16-
New-AzureRmDnsZone -Name <String> -ResourceGroupName <String> [-Tag <Hashtable>] [-WhatIf] [-Confirm]
17+
New-AzureRmDnsZone -Name <String> -ResourceGroupName <String> [-ZoneType <ZoneType>] [-Tag <Hashtable>]
18+
[-ResolutionVirtualNetworkIds <System.Collections.Generic.List`1[System.String]>]
19+
[-RegistrationVirtualNetworkIds <System.Collections.Generic.List`1[System.String]>] [-WhatIf] [-Confirm]
1720
[<CommonParameters>]
1821
```
1922

@@ -43,7 +46,7 @@ Specifies the name of the DNS zone to create.
4346
```yaml
4447
Type: String
4548
Parameter Sets: (All)
46-
Aliases:
49+
Aliases:
4750

4851
Required: True
4952
Position: Named
@@ -52,13 +55,39 @@ Accept pipeline input: True (ByPropertyName)
5255
Accept wildcard characters: False
5356
```
5457
58+
### -RegistrationVirtualNetworkIds
59+
The list of virtual networks that will register VM hostnames records in this DNS zone, only available for private zones.```yaml
60+
Type: System.Collections.Generic.List`1[System.String]
61+
Parameter Sets: (All)
62+
Aliases:
63+
64+
Required: False
65+
Position: Named
66+
Default value: None
67+
Accept pipeline input: True (ByPropertyName)
68+
Accept wildcard characters: False
69+
```
70+
71+
### -ResolutionVirtualNetworkIds
72+
The list of virtual networks able to resolve records in this DNS zone, only available for private zones.```yaml
73+
Type: System.Collections.Generic.List`1[System.String]
74+
Parameter Sets: (All)
75+
Aliases:
76+
77+
Required: False
78+
Position: Named
79+
Default value: None
80+
Accept pipeline input: True (ByPropertyName)
81+
Accept wildcard characters: False
82+
```
83+
5584
### -ResourceGroupName
5685
Specifies the resource group in which to create the zone.
5786
5887
```yaml
5988
Type: String
6089
Parameter Sets: (All)
61-
Aliases:
90+
Aliases:
6291

6392
Required: True
6493
Position: Named
@@ -83,28 +112,28 @@ Accept pipeline input: True (ByPropertyName)
83112
Accept wildcard characters: False
84113
```
85114
86-
### -Confirm
87-
Prompts you for confirmation before running the cmdlet.
115+
### -ZoneType
116+
Specifies the type of the DNS zone. Zones without a type or with a type of Public are made available on the public DNS serving plane for use in the DNS hierarcy. Zones with a type of Private are only visible from with the set of associated virtual networks (this is in preview).
88117
89118
```yaml
90-
Type: SwitchParameter
119+
Type: ZoneType
91120
Parameter Sets: (All)
92-
Aliases: cf
121+
Aliases:
93122

94123
Required: False
95124
Position: Named
96125
Default value: False
97-
Accept pipeline input: False
126+
Accept pipeline input: True (ByPropertyName)
98127
Accept wildcard characters: False
99128
```
100129
101-
### -WhatIf
102-
Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.
130+
### -Confirm
131+
Prompts you for confirmation before running the cmdlet.
103132
104133
```yaml
105134
Type: SwitchParameter
106135
Parameter Sets: (All)
107-
Aliases: wi
136+
Aliases: cf
108137

109138
Required: False
110139
Position: Named
@@ -113,13 +142,13 @@ Accept pipeline input: False
113142
Accept wildcard characters: False
114143
```
115144
116-
### -ZoneType
117-
Specifies the type of the DNS zone. Zones without a type or with a type of Public are made available on the public DNS serving plane for use in the DNS hierarcy. Zones with a type of Private are only visible from with the set of associated virtual networks (this is in preview).
145+
### -WhatIf
146+
Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.
118147
119148
```yaml
120-
Type: Microsoft.Azure.Commands.Dns.DnsZone.ZoneType
149+
Type: SwitchParameter
121150
Parameter Sets: (All)
122-
Aliases:
151+
Aliases: wi
123152

124153
Required: False
125154
Position: Named

‎src/ResourceManager/Dns/Commands.Dns/help/Remove-AzureRmDnsRecordConfig.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
external help file: Microsoft.Azure.Commands.Dns.dll-Help.xml
3+
Module Name: AzureRM.Dns
34
ms.assetid: D1A2326C-CD41-45A6-B37A-FC6176193B01
45
online version:
56
schema: 2.0.0

‎src/ResourceManager/Dns/Commands.Dns/help/Remove-AzureRmDnsRecordSet.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
external help file: Microsoft.Azure.Commands.Dns.dll-Help.xml
3+
Module Name: AzureRM.Dns
34
ms.assetid: 505562A4-30BC-44E7-94EF-579763B8D794
45
online version:
56
schema: 2.0.0

‎src/ResourceManager/Dns/Commands.Dns/help/Remove-AzureRmDnsZone.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
external help file: Microsoft.Azure.Commands.Dns.dll-Help.xml
3+
Module Name: AzureRM.Dns
34
ms.assetid: A8E230A0-5057-40BC-81CD-6D397A503A84
45
online version:
56
schema: 2.0.0

‎src/ResourceManager/Dns/Commands.Dns/help/Set-AzureRmDnsRecordSet.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
external help file: Microsoft.Azure.Commands.Dns.dll-Help.xml
3+
Module Name: AzureRM.Dns
34
ms.assetid: 99E6C4DD-11AF-4DC0-848B-39811240BE06
45
online version:
56
schema: 2.0.0

‎src/ResourceManager/Dns/Commands.Dns/help/Set-AzureRmDnsZone.md

Lines changed: 35 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
22
external help file: Microsoft.Azure.Commands.Dns.dll-Help.xml
3+
Module Name: AzureRM.Dns
34
ms.assetid: E37ADC54-A37B-41BF-BE94-9E4052C234BB
4-
online version:
5+
online version:
56
schema: 2.0.0
67
---
78

@@ -14,7 +15,9 @@ Updates the properties of a DNS zone.
1415

1516
### Fields
1617
```
17-
Set-AzureRmDnsZone -Name <String> -ResourceGroupName <String> [-Tag <Hashtable>] [-WhatIf] [-Confirm]
18+
Set-AzureRmDnsZone -Name <String> -ResourceGroupName <String> [-Tag <Hashtable>]
19+
[-ResolutionVirtualNetworkIds <System.Collections.Generic.List`1[System.String]>]
20+
[-RegistrationVirtualNetworkIds <System.Collections.Generic.List`1[System.String]>] [-WhatIf] [-Confirm]
1821
[<CommonParameters>]
1922
```
2023

@@ -73,7 +76,7 @@ Specifies the name of the DNS zone to update.
7376
```yaml
7477
Type: String
7578
Parameter Sets: Fields
76-
Aliases:
79+
Aliases:
7780

7881
Required: True
7982
Position: Named
@@ -90,7 +93,7 @@ You can suppress this behavior with the *Overwrite* parameter, which updates the
9093
```yaml
9194
Type: SwitchParameter
9295
Parameter Sets: Object
93-
Aliases:
96+
Aliases:
9497

9598
Required: False
9699
Position: Named
@@ -99,6 +102,32 @@ Accept pipeline input: False
99102
Accept wildcard characters: False
100103
```
101104
105+
### -RegistrationVirtualNetworkIds
106+
The list of virtual networks that will register VM hostnames records in this DNS zone, only available for private zones.```yaml
107+
Type: System.Collections.Generic.List`1[System.String]
108+
Parameter Sets: Fields
109+
Aliases:
110+
111+
Required: False
112+
Position: Named
113+
Default value: None
114+
Accept pipeline input: True (ByPropertyName)
115+
Accept wildcard characters: False
116+
```
117+
118+
### -ResolutionVirtualNetworkIds
119+
The list of virtual networks able to resolve records in this DNS zone, only available for private zones.```yaml
120+
Type: System.Collections.Generic.List`1[System.String]
121+
Parameter Sets: Fields
122+
Aliases:
123+
124+
Required: False
125+
Position: Named
126+
Default value: None
127+
Accept pipeline input: True (ByPropertyName)
128+
Accept wildcard characters: False
129+
```
130+
102131
### -ResourceGroupName
103132
Specifies the name of the resource group that contains the zone to update.
104133
You must also specify the ZoneName parameter.
@@ -108,7 +137,7 @@ Alternatively, you can specify the zone using a DnsZone object with the *Zone* p
108137
```yaml
109138
Type: String
110139
Parameter Sets: Fields
111-
Aliases:
140+
Aliases:
112141

113142
Required: True
114143
Position: Named
@@ -141,7 +170,7 @@ Alternatively, you can specify the zone using the *ZoneName* and *ResourceGroupN
141170
```yaml
142171
Type: DnsZone
143172
Parameter Sets: Object
144-
Aliases:
173+
Aliases:
145174

146175
Required: True
147176
Position: Named
@@ -180,36 +209,6 @@ Accept pipeline input: False
180209
Accept wildcard characters: False
181210
```
182211
183-
### -AssociatedVnet
184-
Specified the list of virtual networks in which the DNS zone is visible. Only applicable to Private DNS Zones.
185-
186-
```yaml
187-
Type: Array of Virtual Network IDs
188-
Parameter Sets: (All)
189-
Aliases:
190-
191-
Required: False
192-
Position: Named
193-
Default value: False
194-
Accept pipeline input: False
195-
Accept wildcard characters: False
196-
```
197-
198-
### -RegisteringVnet
199-
Specified the list of virtual networks that register hostnames in this DNS zone. Only applicable to Private DNS Zones.
200-
201-
```yaml
202-
Type: Array of Virtual Network IDs
203-
Parameter Sets: (All)
204-
Aliases:
205-
206-
Required: False
207-
Position: Named
208-
Default value: False
209-
Accept pipeline input: False
210-
Accept wildcard characters: False
211-
```
212-
213212
### CommonParameters
214213
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
215214
@@ -230,7 +229,6 @@ By default, the cmdlet prompts you for confirmation if the $ConfirmPreference Wi
230229
If you specify *Confirm* or *Confirm:$True*, this cmdlet prompts you for confirmation before it runs.
231230
If you specify *Confirm:$False*, the cmdlet does not prompt you for confirmation.
232231
233-
234232
## RELATED LINKS
235233
236234
[Get-AzureRmDnsZone](./Get-AzureRmDnsZone.md)

0 commit comments

Comments
 (0)