Skip to content

Commit b9a0810

Browse files
committed
In help file, provide default parameter values, fix syntax error, and fix syntax parameter order
1 parent dd831c0 commit b9a0810

File tree

1 file changed

+35
-39
lines changed

1 file changed

+35
-39
lines changed

src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmVmss.md

Lines changed: 35 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,13 @@ New-AzureRmVmss [-ResourceGroupName] <String> [-VMScaleSetName] <String>
2222

2323
### SimpleParameterSet
2424
```
25-
New-AzureRmVmss [-AsJob] [[-ResourceGroupName] <String>] [-VMScaleSetName] <String> [-ImageName <String>]
25+
New-AzureRmVmss [[-ResourceGroupName] <String>] [-VMScaleSetName] <String> [-ImageName <String>]
2626
-Credential <PSCredential> [-InstanceCount <Int32>] [-VirtualNetworkName <String>] [-SubnetName <String>]
2727
[-PublicIpAddressName <String>] [-DomainNameLabel <String>] [-SecurityGroupName <String>]
2828
[-LoadBalancerName <String>] [-BackendPort <Int32[]>] [-Location <String>] [-VmSize <String>]
2929
[-UpgradePolicyMode <UpgradeMode>] [-AllocationMethod <String>] [-VnetAddressPrefix <String>]
3030
[-SubnetAddressPrefix <String>] [-FrontendPoolName <String>] [-BackendPoolName <String>]
31-
[-Zone <System.Collections.Generic.List`1[System.String]>] [-DefaultProfile <IAzureContextContainer>]
31+
[-Zone <System.Collections.Generic.List`1[System.String]>] [-AsJob] [-DefaultProfile <IAzureContextContainer>]
3232
[-WhatIf] [-Confirm] [<CommonParameters>]
3333
```
3434

@@ -143,29 +143,29 @@ The nineteenth command uses the **New-AzureRmVmss** cmdlet to create the VMSS.
143143

144144
## PARAMETERS
145145

146-
### -AsJob
147-
Run cmdlet in the background and return a Job to track progress.
146+
### -AllocationMethod
147+
Allocation method for the Public IP Address of the Scale Set (Static or Dynamic). If no value is supplied, allocation will be static.
148148

149149
```yaml
150-
Type: SwitchParameter
151-
Parameter Sets: (All)
150+
Type: String
151+
Parameter Sets: SimpleParameterSet
152152
Aliases:
153+
Accepted values: Static, Dynamic
153154

154155
Required: False
155156
Position: Named
156-
Default value: None
157+
Default value: Static
157158
Accept pipeline input: False
158159
Accept wildcard characters: False
159160
```
160161
161-
### -AllocationMethod
162-
Allocation method for the Public IP Address of the Scale Set (Static or Dynamic).
162+
### -AsJob
163+
Run cmdlet in the background and return a Job to track progress.
163164
164165
```yaml
165-
Type: String
166-
Parameter Sets: SimpleParameterSet
166+
Type: SwitchParameter
167+
Parameter Sets: (All)
167168
Aliases:
168-
Accepted values: Static, Dynamic
169169

170170
Required: False
171171
Position: Named
@@ -175,7 +175,7 @@ Accept wildcard characters: False
175175
```
176176
177177
### -BackendPoolName
178-
The name of the backend address pool to use in the load balancer for this Scale Set.
178+
The name of the backend address pool to use in the load balancer for this Scale Set. If no value is provided, a new backend pool will be created, with the same name as the Scale Set.
179179
180180
```yaml
181181
Type: String
@@ -190,7 +190,7 @@ Accept wildcard characters: False
190190
```
191191
192192
### -BackendPort
193-
Backend port numer used by the Scale Set load balancer to communicate with VMs in the Scale Set.
193+
Backend port numbers used by the Scale Set load balancer to communicate with VMs in the Scale Set. If no values are specified, ports 3389 and 5985 will be used for Windows VMS, and port 22 will be used for Linux VMs.
194194
195195
```yaml
196196
Type: Int32[]
@@ -235,9 +235,7 @@ Accept wildcard characters: False
235235
```
236236
237237
### -DomainNameLabel
238-
The domain name label for the public Fully-Qualified domain name (FQDN) for this Scale Set.
239-
This is the first component of the domain name that is automatically assiged to the Scale Set.
240-
Automatically assigned Domain names use the form (<DomainNameLabel>.<Location>.cloudapp.azure.com).
238+
The domain name label for the public Fully-Qualified domain name (FQDN) for this Scale Set. This is the first component of the domain name that is automatically assiged to the Scale Set. Automatically assigned Domain names use the form (<DomainNameLabel>.<Location>.cloudapp.azure.com). If no value is supplied, the default domain name label will be the concatenation of <ScaleSetName> and <ResourceGroupName>.
241239
242240
```yaml
243241
Type: String
@@ -252,7 +250,7 @@ Accept wildcard characters: False
252250
```
253251
254252
### -FrontendPoolName
255-
The name of the frontend address pool to usein the Scale Set locad balancer.
253+
The name of the frontend address pool to usein the Scale Set locad balancer. If no value is supplied, a new Frontend Address Pool will be created, with the same name as the scale set.
256254
257255
```yaml
258256
Type: String
@@ -267,7 +265,7 @@ Accept wildcard characters: False
267265
```
268266
269267
### -ImageName
270-
The name of the image for VMs in this Scale Set.
268+
The name of the image for VMs in this Scale Set. If no value is provided, the "Windows Server 2016 DataCenter" image will be used.
271269
272270
```yaml
273271
Type: String
@@ -282,7 +280,7 @@ Accept wildcard characters: False
282280
```
283281
284282
### -InstanceCount
285-
The number of VM images in the Scale Set.
283+
The number of VM images in the Scale Set. If no value is provided, 2 instances will be created.
286284
287285
```yaml
288286
Type: Int32
@@ -291,14 +289,13 @@ Aliases:
291289

292290
Required: False
293291
Position: Named
294-
Default value: None
292+
Default value: 2
295293
Accept pipeline input: False
296294
Accept wildcard characters: False
297295
```
298296
299297
### -LoadBalancerName
300-
The name of the load balancer to use with this Scale Set. A new load balancer
301-
will be created if no value is specified.
298+
The name of the load balancer to use with this Scale Set. A new load balancer using the same name as the Scale Set will be created if no value is specified.
302299
303300
```yaml
304301
Type: String
@@ -313,8 +310,7 @@ Accept wildcard characters: False
313310
```
314311
315312
### -Location
316-
The Azure location where this Scale Set will be created. A default location will be
317-
used if no value is specified.
313+
The Azure location where this Scale Set will be created. If no value is specified, the location will be inferredf from the location of other resources referenced in the parameters.
318314
319315
```yaml
320316
Type: String
@@ -329,8 +325,7 @@ Accept wildcard characters: False
329325
```
330326
331327
### -PublicIpAddressName
332-
The name of the public IP Address to use with this scale set. A new Public IPAddress will be
333-
created if no value is provided.
328+
The name of the public IP Address to use with this scale set. A new Public IPAddress with the same name as the Scale Set will be created if no value is provided.
334329
335330
```yaml
336331
Type: String
@@ -345,7 +340,7 @@ Accept wildcard characters: False
345340
```
346341
347342
### -ResourceGroupName
348-
Specifies the name of the resource group of the VMSS.
343+
Specifies the name of the resource group of the VMSS. If no value is specified, a new ResourceGroup will be created using the same name as the Scale Set.
349344
350345
```yaml
351346
Type: String
@@ -372,8 +367,7 @@ Accept wildcard characters: False
372367
```
373368
374369
### -SecurityGroupName
375-
The name of the network security group to apply to this Scale Set. If no value is provided,
376-
a default network security group will be created and applied to the Scale Set.
370+
The name of the network security group to apply to this Scale Set. If no value is provided, a default network security group with the same name as the Scale Set will be created and applied to the Scale Set.
377371
378372
```yaml
379373
Type: String
@@ -388,7 +382,7 @@ Accept wildcard characters: False
388382
```
389383
390384
### -SubnetAddressPrefix
391-
The address prefix of the Subnet this ScaleSet will use. Default Subnet settings will be applied if no value is provided.
385+
The address prefix of the Subnet this ScaleSet will use. Default Subnet settings (192.168.1.0/24) will be applied if no value is provided.
392386
393387
```yaml
394388
Type: String
@@ -397,13 +391,13 @@ Aliases:
397391

398392
Required: False
399393
Position: Named
400-
Default value: None
394+
Default value: 192.168.1.0/24
401395
Accept pipeline input: False
402396
Accept wildcard characters: False
403397
```
404398
405399
### -SubnetName
406-
The name of the subnet to use with this Scale Set. A new Subnet will be created if no bvalue is provided.
400+
The name of the subnet to use with this Scale Set. A new Subnet will be created with the same name as the Scale Set if no value is provided.
407401
408402
```yaml
409403
Type: String
@@ -449,7 +443,7 @@ Accept wildcard characters: False
449443
```
450444
451445
### -VirtualNetworkName
452-
The name fo the Virtual Network to use with this scale set. If no value is supplied, a new virtual network will be created.
446+
The name fo the Virtual Network to use with this scale set. If no value is supplied, a new virtual network with the same name as the Scale Set will be created.
453447
454448
```yaml
455449
Type: String
@@ -491,7 +485,7 @@ Accept wildcard characters: False
491485
```
492486
493487
### -VmSize
494-
The size of the VM instances in this scale set. A default size will be used if no Size is specified.
488+
The size of the VM instances in this scale set. A default size (Standard_DS1_v2) will be used if no Size is specified.
495489
496490
```yaml
497491
Type: String
@@ -500,13 +494,13 @@ Aliases:
500494

501495
Required: False
502496
Position: Named
503-
Default value: None
497+
Default value: Standard_DS1_v2
504498
Accept pipeline input: False
505499
Accept wildcard characters: False
506500
```
507501
508502
### -VnetAddressPrefix
509-
The address prefix for the virtual network used with this Scale Set. Default virtual network address prefix settings will be used if no value is supplied.
503+
The address prefix for the virtual network used with this Scale Set. Default virtual network address prefix settings (192.168.0.0/16) will be used if no value is supplied.
510504
511505
```yaml
512506
Type: String
@@ -515,13 +509,15 @@ Aliases:
515509

516510
Required: False
517511
Position: Named
518-
Default value: None
512+
Default value: 192.168.0.0/16
519513
Accept pipeline input: False
520514
Accept wildcard characters: False
521515
```
522516
523517
### -Zone
524-
A list of availability zones denoting the IP allocated for the resource needs to come from.```yaml
518+
A list of availability zones denoting the IP allocated for the resource needs to come from.
519+
520+
```yaml
525521
Type: System.Collections.Generic.List`1[System.String]
526522
Parameter Sets: SimpleParameterSet
527523
Aliases:

0 commit comments

Comments
 (0)