Skip to content

Commit e819645

Browse files
hyonholeehyonholee
committed
Update help and markdown files.
1 parent 2316a7a commit e819645

File tree

56 files changed

+4686
-351
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+4686
-351
lines changed

‎src/ResourceManager/Compute/Commands.Compute/Microsoft.Azure.Commands.Compute.dll-Help.xml

Lines changed: 2599 additions & 201 deletions
Large diffs are not rendered by default.

‎src/ResourceManager/Compute/Commands.Compute/help/Add-AzureRmContainerServiceAgentPoolProfile.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Adds a container service agent pool profile.
1414

1515
```
1616
Add-AzureRmContainerServiceAgentPoolProfile [-ContainerService] <ContainerService> [[-Name] <String>]
17-
[[-Count] <Int32>] [[-VmSize] <String>] [[-DnsPrefix] <String>] [<CommonParameters>]
17+
[[-Count] <Int32>] [[-VmSize] <String>] [[-DnsPrefix] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
1818
```
1919

2020
## DESCRIPTION
@@ -110,6 +110,36 @@ Accept pipeline input: True (ByPropertyName)
110110
Accept wildcard characters: False
111111
```
112112
113+
### -Confirm
114+
Prompts you for confirmation before running the cmdlet.
115+
116+
```yaml
117+
Type: SwitchParameter
118+
Parameter Sets: (All)
119+
Aliases: cf
120+
121+
Required: False
122+
Position: Named
123+
Default value: None
124+
Accept pipeline input: False
125+
Accept wildcard characters: False
126+
```
127+
128+
### -WhatIf
129+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
130+
131+
```yaml
132+
Type: SwitchParameter
133+
Parameter Sets: (All)
134+
Aliases: wi
135+
136+
Required: False
137+
Position: Named
138+
Default value: None
139+
Accept pipeline input: False
140+
Accept wildcard characters: False
141+
```
142+
113143
### CommonParameters
114144
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).
115145

‎src/ResourceManager/Compute/Commands.Compute/help/Add-AzureRmImageDataDisk.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ Adds a data disk to an image obejct.
1313

1414
```
1515
Add-AzureRmImageDataDisk [-Image] <Image> [[-Lun] <Int32>] [[-BlobUri] <String>] [[-Caching] <CachingTypes>]
16-
[[-DiskSizeGB] <Int32>] [[-SnapshotId] <String>] [[-ManagedDiskId] <String>] [<CommonParameters>]
16+
[[-DiskSizeGB] <Int32>] [[-SnapshotId] <String>] [[-ManagedDiskId] <String>] [-WhatIf] [-Confirm]
17+
[<CommonParameters>]
1718
```
1819

1920
## DESCRIPTION
@@ -151,6 +152,36 @@ Accept pipeline input: True (ByPropertyName)
151152
Accept wildcard characters: False
152153
```
153154
155+
### -Confirm
156+
Prompts you for confirmation before running the cmdlet.
157+
158+
```yaml
159+
Type: SwitchParameter
160+
Parameter Sets: (All)
161+
Aliases: cf
162+
163+
Required: False
164+
Position: Named
165+
Default value: None
166+
Accept pipeline input: False
167+
Accept wildcard characters: False
168+
```
169+
170+
### -WhatIf
171+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
172+
173+
```yaml
174+
Type: SwitchParameter
175+
Parameter Sets: (All)
176+
Aliases: wi
177+
178+
Required: False
179+
Position: Named
180+
Default value: None
181+
Accept pipeline input: False
182+
Accept wildcard characters: False
183+
```
184+
154185
### CommonParameters
155186
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).
156187

‎src/ResourceManager/Compute/Commands.Compute/help/Add-AzureRmVmssAdditionalUnattendContent.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Adds information to the unattended Windows Setup answer file.
1515
```
1616
Add-AzureRmVmssAdditionalUnattendContent [-VirtualMachineScaleSet] <VirtualMachineScaleSet>
1717
[[-PassName] <PassNames>] [[-ComponentName] <ComponentNames>] [[-SettingName] <SettingNames>]
18-
[[-Content] <String>] [<CommonParameters>]
18+
[[-Content] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
1919
```
2020

2121
## DESCRIPTION
@@ -114,6 +114,36 @@ Accept pipeline input: True (ByPropertyName, ByValue)
114114
Accept wildcard characters: False
115115
```
116116
117+
### -Confirm
118+
Prompts you for confirmation before running the cmdlet.
119+
120+
```yaml
121+
Type: SwitchParameter
122+
Parameter Sets: (All)
123+
Aliases: cf
124+
125+
Required: False
126+
Position: Named
127+
Default value: None
128+
Accept pipeline input: False
129+
Accept wildcard characters: False
130+
```
131+
132+
### -WhatIf
133+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
134+
135+
```yaml
136+
Type: SwitchParameter
137+
Parameter Sets: (All)
138+
Aliases: wi
139+
140+
Required: False
141+
Position: Named
142+
Default value: None
143+
Accept pipeline input: False
144+
Accept wildcard characters: False
145+
```
146+
117147
### CommonParameters
118148
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).
119149

‎src/ResourceManager/Compute/Commands.Compute/help/Add-AzureRmVmssDataDisk.md

Lines changed: 195 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,195 @@
1+
---
2+
external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml
3+
online version:
4+
schema: 2.0.0
5+
---
6+
7+
# Add-AzureRmVmssDataDisk
8+
9+
## SYNOPSIS
10+
Adds a data disk to the VMSS.
11+
12+
## SYNTAX
13+
14+
```
15+
Add-AzureRmVmssDataDisk [-VirtualMachineScaleSet] <VirtualMachineScaleSet> [[-Name] <String>] [[-Lun] <Int32>]
16+
[[-Caching] <CachingTypes>] [[-CreateOption] <DiskCreateOptionTypes>] [[-DiskSizeGB] <Int32>]
17+
[[-StorageAccountType] <StorageAccountTypes>] [-WhatIf] [-Confirm] [<CommonParameters>]
18+
```
19+
20+
## DESCRIPTION
21+
The **Add-AzureRmVmssDataDisk** cmdlet adds a data disk to the Virtual Machine Scale Set (VMSS) instance.
22+
23+
## EXAMPLES
24+
25+
### Example 1: Add a data disk
26+
```
27+
PS C:\> $vmss = New-AzureRmVmssConfig -Location $Loc -SkuCapacity 2 -SkuName "Standard_A0" -UpgradePolicyMode "Automatic"
28+
PS C:\> $vmss = Add-AzureRmVmssDataDisk -VirtualMachineScaleSet $vmss -Name 'DataDisk1' -Lun 0 -Caching 'ReadOnly' -CreateOption Empty -DiskSizeGB 10 -StorageAccountType StandardLRS
29+
```
30+
31+
This command adds an empty data disk to the VMSS object.
32+
33+
## PARAMETERS
34+
35+
### -Caching
36+
Specifies the caching type of the disk.
37+
38+
```yaml
39+
Type: CachingTypes
40+
Parameter Sets: (All)
41+
Aliases:
42+
Accepted values: None, ReadOnly, ReadWrite
43+
44+
Required: False
45+
Position: 3
46+
Default value: None
47+
Accept pipeline input: True (ByPropertyName)
48+
Accept wildcard characters: False
49+
```
50+
51+
### -CreateOption
52+
Specifies the create option of the disk.
53+
54+
```yaml
55+
Type: DiskCreateOptionTypes
56+
Parameter Sets: (All)
57+
Aliases:
58+
Accepted values: FromImage, Empty, Attach
59+
60+
Required: False
61+
Position: 4
62+
Default value: None
63+
Accept pipeline input: True (ByPropertyName)
64+
Accept wildcard characters: False
65+
```
66+
67+
### -DiskSizeGB
68+
Specifies the size of the disk in GB.
69+
70+
```yaml
71+
Type: Int32
72+
Parameter Sets: (All)
73+
Aliases:
74+
75+
Required: False
76+
Position: 5
77+
Default value: None
78+
Accept pipeline input: True (ByPropertyName)
79+
Accept wildcard characters: False
80+
```
81+
82+
### -Lun
83+
Specifies the logical unit number of the disk.
84+
85+
```yaml
86+
Type: Int32
87+
Parameter Sets: (All)
88+
Aliases:
89+
90+
Required: False
91+
Position: 2
92+
Default value: None
93+
Accept pipeline input: True (ByPropertyName)
94+
Accept wildcard characters: False
95+
```
96+
97+
### -Name
98+
Specifies the name of the disk.
99+
100+
```yaml
101+
Type: String
102+
Parameter Sets: (All)
103+
Aliases:
104+
105+
Required: False
106+
Position: 1
107+
Default value: None
108+
Accept pipeline input: True (ByPropertyName)
109+
Accept wildcard characters: False
110+
```
111+
112+
### -StorageAccountType
113+
Specifies the storage account type of the disk.
114+
115+
```yaml
116+
Type: StorageAccountTypes
117+
Parameter Sets: (All)
118+
Aliases:
119+
Accepted values: StandardLRS, PremiumLRS
120+
121+
Required: False
122+
Position: 6
123+
Default value: None
124+
Accept pipeline input: True (ByPropertyName)
125+
Accept wildcard characters: False
126+
```
127+
128+
### -VirtualMachineScaleSet
129+
Specify the VMSS object.
130+
You can use the New-AzureRmVmssConfig cmdlet to create the object.
131+
132+
```yaml
133+
Type: VirtualMachineScaleSet
134+
Parameter Sets: (All)
135+
Aliases:
136+
137+
Required: True
138+
Position: 0
139+
Default value: None
140+
Accept pipeline input: True (ByPropertyName, ByValue)
141+
Accept wildcard characters: False
142+
```
143+
144+
### -Confirm
145+
Prompts you for confirmation before running the cmdlet.
146+
147+
```yaml
148+
Type: SwitchParameter
149+
Parameter Sets: (All)
150+
Aliases: cf
151+
152+
Required: False
153+
Position: Named
154+
Default value: None
155+
Accept pipeline input: False
156+
Accept wildcard characters: False
157+
```
158+
159+
### -WhatIf
160+
Shows what would happen if the cmdlet runs.
161+
The cmdlet is not run.
162+
163+
```yaml
164+
Type: SwitchParameter
165+
Parameter Sets: (All)
166+
Aliases: wi
167+
168+
Required: False
169+
Position: Named
170+
Default value: None
171+
Accept pipeline input: False
172+
Accept wildcard characters: False
173+
```
174+
175+
### CommonParameters
176+
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).
177+
178+
## INPUTS
179+
180+
### Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSet
181+
System.String
182+
System.Int32
183+
System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.CachingTypes, Microsoft.Azure.Management.Compute, Version=14.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]
184+
System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.DiskCreateOptionTypes, Microsoft.Azure.Management.Compute, Version=14.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]
185+
System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
186+
System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.StorageAccountTypes, Microsoft.Azure.Management.Compute, Version=14.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]
187+
188+
## OUTPUTS
189+
190+
### Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSet
191+
192+
## NOTES
193+
194+
## RELATED LINKS
195+

‎src/ResourceManager/Compute/Commands.Compute/help/Add-AzureRmVmssExtension.md

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ Adds an extension to the VMSS.
1515
```
1616
Add-AzureRmVmssExtension [-VirtualMachineScaleSet] <VirtualMachineScaleSet> [[-Name] <String>]
1717
[[-Publisher] <String>] [[-Type] <String>] [[-TypeHandlerVersion] <String>]
18-
[[-AutoUpgradeMinorVersion] <Boolean>] [[-Setting] <Object>] [[-ProtectedSetting] <Object>]
19-
[<CommonParameters>]
18+
[[-AutoUpgradeMinorVersion] <Boolean>] [[-Setting] <Object>] [[-ProtectedSetting] <Object>] [-WhatIf]
19+
[-Confirm] [<CommonParameters>]
2020
```
2121

2222
## DESCRIPTION
@@ -160,6 +160,36 @@ Accept pipeline input: True (ByPropertyName, ByValue)
160160
Accept wildcard characters: False
161161
```
162162
163+
### -Confirm
164+
Prompts you for confirmation before running the cmdlet.
165+
166+
```yaml
167+
Type: SwitchParameter
168+
Parameter Sets: (All)
169+
Aliases: cf
170+
171+
Required: False
172+
Position: Named
173+
Default value: None
174+
Accept pipeline input: False
175+
Accept wildcard characters: False
176+
```
177+
178+
### -WhatIf
179+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
180+
181+
```yaml
182+
Type: SwitchParameter
183+
Parameter Sets: (All)
184+
Aliases: wi
185+
186+
Required: False
187+
Position: Named
188+
Default value: None
189+
Accept pipeline input: False
190+
Accept wildcard characters: False
191+
```
192+
163193
### CommonParameters
164194
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).
165195

0 commit comments

Comments
 (0)