Skip to content

Commit 040ac7c

Browse files
New help.
1 parent b0958e9 commit 040ac7c

File tree

2 files changed

+192
-5
lines changed

2 files changed

+192
-5
lines changed
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
Module Name: AzureRM.Compute.Experiments
3+
Module Guid: {{ Update Module Guid }}
4+
Download Help Link: {{ Update Download Link }}
5+
Help Version: {{ Update Help Version }}
6+
Locale: {{ Update Locale }}
7+
---
8+
9+
# AzureRM.Compute.Experiments Module
10+
## Description
11+
{{Manually Enter Description Here}}
12+
13+
## AzureRM.Compute.Experiments Cmdlets
14+
### [New-AzVm](New-AzVm.md)
15+
Creates a virtual machine and all required resources.
16+

experiments/Compute.Experiments/help/New-AzVm.md

Lines changed: 176 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,11 @@ Creates a virtual machine and all required resources.
1313
## SYNTAX
1414

1515
```
16-
New-AzVm [-Name] <String> [[-Credential] <PSCredential>] [[-ImageName] <String>]
17-
[[-ResourceGroupName] <String>] [[-Location] <String>] [[-VirtualNetworkName] <String>]
18-
[[-PublicIpAddressName] <String>] [[-SecurityGroupName] <String>]
16+
New-AzVm [-Name] <String> [-Credential] <PSCredential> [[-ResourceGroupName] <String>] [[-Location] <String>]
17+
[[-VirtualNetworkName] <String>] [-AddressPrefix <String>] [-SubnetName <String>]
18+
[-SubnetAddressPrefix <String>] [[-PublicIpAddressName] <String>] [-DomainNameLabel <String>]
19+
[-AllocationMethod <String>] [[-SecurityGroupName] <String>] [-OpenPorts <Int32[]>] [[-ImageName] <String>]
20+
[-Size <String>] [-AzureRmContext <Object>] [-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>]
1921
```
2022

2123
## DESCRIPTION
@@ -32,21 +34,98 @@ Creates a virtual machine with name `MyCoolVM`.
3234

3335
## PARAMETERS
3436

37+
### -AddressPrefix
38+
Specifies a range of IP addresses for a virtual network.
39+
40+
```yaml
41+
Type: String
42+
Parameter Sets: (All)
43+
Aliases:
44+
45+
Required: False
46+
Position: Named
47+
Default value: None
48+
Accept pipeline input: False
49+
Accept wildcard characters: False
50+
```
51+
52+
### -AllocationMethod
53+
Specifies the method with which to allocate the public IP address. The acceptable values for this parameter are: Static or Dynamic.
54+
55+
```yaml
56+
Type: String
57+
Parameter Sets: (All)
58+
Aliases:
59+
60+
Required: False
61+
Position: Named
62+
Default value: None
63+
Accept pipeline input: False
64+
Accept wildcard characters: False
65+
```
66+
67+
### -AsJob
68+
Specifies the cmdlet executes as a job.
69+
70+
```yaml
71+
Type: SwitchParameter
72+
Parameter Sets: (All)
73+
Aliases:
74+
75+
Required: False
76+
Position: Named
77+
Default value: None
78+
Accept pipeline input: False
79+
Accept wildcard characters: False
80+
```
81+
82+
### -AzureRmContext
83+
Azure context.
84+
85+
```yaml
86+
Type: Object
87+
Parameter Sets: (All)
88+
Aliases:
89+
90+
Required: False
91+
Position: Named
92+
Default value: None
93+
Accept pipeline input: False
94+
Accept wildcard characters: False
95+
```
96+
3597
### -Credential
98+
3699
Specifies the user name and password for the virtual machine as a PSCredential object.
37100
38101
```yaml
39102
Type: PSCredential
40103
Parameter Sets: (All)
41104
Aliases:
42105

43-
Required: False
106+
Required: True
44107
Position: 1
45108
Default value: None
46109
Accept pipeline input: False
47110
Accept wildcard characters: False
48111
```
49112
113+
### -DomainNameLabel
114+
115+
Specifies the relative DNS name for a public IP address.
116+
117+
```yaml
118+
Type: String
119+
Parameter Sets: (All)
120+
Aliases:
121+
122+
Required: False
123+
Position: Named
124+
Default value: None
125+
Accept pipeline input: False
126+
Accept wildcard characters: False
127+
```
128+
50129
### -ImageName
51130
A name of virtual machine image.
52131
@@ -92,6 +171,21 @@ Accept pipeline input: False
92171
Accept wildcard characters: False
93172
```
94173
174+
### -OpenPorts
175+
Ports.
176+
177+
```yaml
178+
Type: Int32[]
179+
Parameter Sets: (All)
180+
Aliases:
181+
182+
Required: False
183+
Position: Named
184+
Default value: None
185+
Accept pipeline input: False
186+
Accept wildcard characters: False
187+
```
188+
95189
### -PublicIpAddressName
96190
Specifies a name of PublicIPAddress object to assign to a network interface.
97191
@@ -137,6 +231,51 @@ Accept pipeline input: False
137231
Accept wildcard characters: False
138232
```
139233
234+
### -Size
235+
Specifies the size for the virtual machine.
236+
237+
```yaml
238+
Type: String
239+
Parameter Sets: (All)
240+
Aliases:
241+
242+
Required: False
243+
Position: Named
244+
Default value: None
245+
Accept pipeline input: False
246+
Accept wildcard characters: False
247+
```
248+
249+
### -SubnetAddressPrefix
250+
Specifies a range of IP addresses for a subnet configuration.
251+
252+
```yaml
253+
Type: String
254+
Parameter Sets: (All)
255+
Aliases:
256+
257+
Required: False
258+
Position: Named
259+
Default value: None
260+
Accept pipeline input: False
261+
Accept wildcard characters: False
262+
```
263+
264+
### -SubnetName
265+
Specifies the name of the subnet configuration to create.
266+
267+
```yaml
268+
Type: String
269+
Parameter Sets: (All)
270+
Aliases:
271+
272+
Required: False
273+
Position: Named
274+
Default value: None
275+
Accept pipeline input: False
276+
Accept wildcard characters: False
277+
```
278+
140279
### -VirtualNetworkName
141280
Specifies a Virtual Network name.
142281
@@ -152,11 +291,43 @@ Accept pipeline input: False
152291
Accept wildcard characters: False
153292
```
154293
294+
### -Confirm
295+
Prompts you for confirmation before running the cmdlet.
296+
297+
```yaml
298+
Type: SwitchParameter
299+
Parameter Sets: (All)
300+
Aliases: cf
301+
302+
Required: False
303+
Position: Named
304+
Default value: None
305+
Accept pipeline input: False
306+
Accept wildcard characters: False
307+
```
308+
309+
### -WhatIf
310+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
311+
312+
```yaml
313+
Type: SwitchParameter
314+
Parameter Sets: (All)
315+
Aliases: wi
316+
317+
Required: False
318+
Position: Named
319+
Default value: None
320+
Accept pipeline input: False
321+
Accept wildcard characters: False
322+
```
323+
324+
### CommonParameters
325+
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).
326+
155327
## INPUTS
156328
157329
### None
158330
159-
160331
## OUTPUTS
161332
162333
### System.Object

0 commit comments

Comments
 (0)