Skip to content

Commit e1b3725

Browse files
markcowlmarkcowl
committed
Update help and add maml help for website cmdlets
1 parent e2cfbc1 commit e1b3725

File tree

4 files changed

+319
-2
lines changed

4 files changed

+319
-2
lines changed

‎experiments/Websites.Experiments/AzureRM.Websites.Experiments.psm1

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,9 @@ function New-AzWebAppJustDoIt
124124
END {}
125125
}
126126

127+
<#
128+
.ExternalHelp help\AzureRM.Websites.Experiments-help.xml
129+
#>
127130
function New-AzWebApp
128131
{
129132
[CmdletBinding()]
@@ -561,6 +564,9 @@ function Get-WebSitesClient
561564
return $client
562565
}
563566

567+
<#
568+
.ExternalHelp help\AzureRM.Websites.Experiments-help.xml
569+
#>
564570
function New-AzWebAppGrayParam
565571
{
566572
[CmdletBinding()]

‎experiments/Websites.Experiments/Microsoft.Azure.Commands.Websites.Experiments.csproj

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,5 +85,10 @@
8585
<ItemGroup>
8686
<Service Include="{82A7F48D-3B50-4B1E-B82E-3ADA8210C358}" />
8787
</ItemGroup>
88+
<ItemGroup>
89+
<Content Include="help\AzureRM.Websites.Experiments-help.xml">
90+
<CopyToOutputDirectory>Always</CopyToOutputDirectory>
91+
</Content>
92+
</ItemGroup>
8893
<Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
8994
</Project>

‎experiments/Websites.Experiments/help/AzureRM.Websites.Experiments-help.xml

Lines changed: 306 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,306 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<helpItems xmlns="http://msh" schema="maml">
3+
4+
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
5+
<command:details><command:name>New-AzWebApp</command:name>
6+
<command:verb>New</command:verb>
7+
<command:noun>AzWebApp</command:noun>
8+
<maml:description><maml:para>Create a new Azure AppService website and attach it to a git repository.
9+
</maml:para>
10+
</maml:description>
11+
</command:details>
12+
<maml:description><maml:para>Create a new Azure AppService website and attach it to a git repository.
13+
</maml:para>
14+
</maml:description>
15+
<command:syntax><command:syntaxItem><maml:name>New-AzWebApp</maml:name>
16+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="Name"><maml:name>WebAppName</maml:name>
17+
<maml:Description><maml:para>The name of the Website. The website will automatically use this value as the subdomain for the created website.
18+
</maml:para>
19+
</maml:Description>
20+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
21+
<dev:type><maml:name>String</maml:name>
22+
<maml:uri /></dev:type>
23+
<dev:defaultValue>None</dev:defaultValue>
24+
</command:parameter>
25+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="Group"><maml:name>ResourceGroupName</maml:name>
26+
<maml:Description><maml:para>The name of the resource group for the Website.
27+
</maml:para>
28+
</maml:Description>
29+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
30+
<dev:type><maml:name>String</maml:name>
31+
<maml:uri /></dev:type>
32+
<dev:defaultValue>None</dev:defaultValue>
33+
</command:parameter>
34+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="Plan"><maml:name>AppServicePlan</maml:name>
35+
<maml:Description><maml:para>The name or id of the AppService Plan to use with this WebApp.
36+
</maml:para>
37+
</maml:Description>
38+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
39+
<dev:type><maml:name>String</maml:name>
40+
<maml:uri /></dev:type>
41+
<dev:defaultValue>None</dev:defaultValue>
42+
</command:parameter>
43+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>GitRepositoryPath</maml:name>
44+
<maml:Description><maml:para>The path to a github repository where remotes should be added.
45+
</maml:para>
46+
</maml:Description>
47+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
48+
<dev:type><maml:name>String</maml:name>
49+
<maml:uri /></dev:type>
50+
<dev:defaultValue>None</dev:defaultValue>
51+
</command:parameter>
52+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AddRemote</maml:name>
53+
<maml:Description><maml:para>Add a remote to local github repo.
54+
</maml:para>
55+
</maml:Description>
56+
<dev:type><maml:name>SwitchParameter</maml:name>
57+
<maml:uri /></dev:type>
58+
<dev:defaultValue>False</dev:defaultValue>
59+
</command:parameter>
60+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Auto</maml:name>
61+
<maml:Description><maml:para>Accept default values for all settings not provided, withotu prompting.
62+
</maml:para>
63+
</maml:Description>
64+
<dev:type><maml:name>SwitchParameter</maml:name>
65+
<maml:uri /></dev:type>
66+
<dev:defaultValue>False</dev:defaultValue>
67+
</command:parameter>
68+
</command:syntaxItem>
69+
</command:syntax>
70+
<command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AddRemote</maml:name>
71+
<maml:Description><maml:para>Add a remote to local github repo.
72+
</maml:para>
73+
</maml:Description>
74+
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
75+
<dev:type><maml:name>SwitchParameter</maml:name>
76+
<maml:uri /></dev:type>
77+
<dev:defaultValue>False</dev:defaultValue>
78+
</command:parameter>
79+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="Plan"><maml:name>AppServicePlan</maml:name>
80+
<maml:Description><maml:para>The name or id of the AppService Plan to use with this WebApp.
81+
</maml:para>
82+
</maml:Description>
83+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
84+
<dev:type><maml:name>String</maml:name>
85+
<maml:uri /></dev:type>
86+
<dev:defaultValue>None</dev:defaultValue>
87+
</command:parameter>
88+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Auto</maml:name>
89+
<maml:Description><maml:para>Accept default values for all settings not provided, withotu prompting.
90+
</maml:para>
91+
</maml:Description>
92+
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
93+
<dev:type><maml:name>SwitchParameter</maml:name>
94+
<maml:uri /></dev:type>
95+
<dev:defaultValue>False</dev:defaultValue>
96+
</command:parameter>
97+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>GitRepositoryPath</maml:name>
98+
<maml:Description><maml:para>The path to a github repository where remotes should be added.
99+
</maml:para>
100+
</maml:Description>
101+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
102+
<dev:type><maml:name>String</maml:name>
103+
<maml:uri /></dev:type>
104+
<dev:defaultValue>None</dev:defaultValue>
105+
</command:parameter>
106+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="Group"><maml:name>ResourceGroupName</maml:name>
107+
<maml:Description><maml:para>The name of the resource group for the Website.
108+
</maml:para>
109+
</maml:Description>
110+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
111+
<dev:type><maml:name>String</maml:name>
112+
<maml:uri /></dev:type>
113+
<dev:defaultValue>None</dev:defaultValue>
114+
</command:parameter>
115+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="Name"><maml:name>WebAppName</maml:name>
116+
<maml:Description><maml:para>The name of the Website. The website will automatically use this value as the subdomain for the created website.
117+
</maml:para>
118+
</maml:Description>
119+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
120+
<dev:type><maml:name>String</maml:name>
121+
<maml:uri /></dev:type>
122+
<dev:defaultValue>None</dev:defaultValue>
123+
</command:parameter>
124+
</command:parameters>
125+
<command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name>
126+
</dev:type>
127+
<maml:description><maml:para>
128+
</maml:para>
129+
</maml:description>
130+
</command:inputType>
131+
</command:inputTypes>
132+
<command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Management.WebSites.Models.Site</maml:name>
133+
</dev:type>
134+
<maml:description><maml:para>Details about the created website, including URL and github repo url.
135+
</maml:para>
136+
</maml:description>
137+
</command:returnValue>
138+
</command:returnValues>
139+
<maml:alertSet><maml:alert><maml:para>
140+
</maml:para>
141+
</maml:alert>
142+
</maml:alertSet>
143+
<command:examples><command:example><maml:title>Example 1: Create a website with prompts for settings</maml:title>
144+
<dev:code>PS C:\&gt; New-AzWebApp contosoWebApp</dev:code>
145+
<dev:remarks><maml:para>Creates a web application. The user will be prompted for the appservice to use and other settings.
146+
</maml:para>
147+
</dev:remarks>
148+
</command:example>
149+
<command:example><maml:title>Example 2: Create a website with default settings</maml:title>
150+
<dev:code>PS C:\&gt; New-AzWebApp contosoWebApp -Auto</dev:code>
151+
<dev:remarks><maml:para>Creates a web application using default settings.
152+
</maml:para>
153+
</dev:remarks>
154+
</command:example>
155+
</command:examples>
156+
<command:relatedLinks></command:relatedLinks>
157+
</command:command>
158+
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
159+
<command:details><command:name>New-AzWebAppGrayParam</command:name>
160+
<command:verb>New</command:verb>
161+
<command:noun>AzWebAppGrayParam</command:noun>
162+
<maml:description><maml:para>Create an Azure Website using Azure App Service.
163+
</maml:para>
164+
</maml:description>
165+
</command:details>
166+
<maml:description><maml:para>Create an Azure Website using Azure App Service. This cmdlet uses the 'Gray Parameter' experience, which will prompt the user with default values for parameters that are not provided. Using -Auto indicates that further prompting for defaults should not occur.
167+
</maml:para>
168+
</maml:description>
169+
<command:syntax><command:syntaxItem><maml:name>New-AzWebAppGrayParam</maml:name>
170+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="Name"><maml:name>WebAppName</maml:name>
171+
<maml:Description><maml:para>The name of the website.
172+
</maml:para>
173+
</maml:Description>
174+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
175+
<dev:type><maml:name>String</maml:name>
176+
<maml:uri /></dev:type>
177+
<dev:defaultValue>None</dev:defaultValue>
178+
</command:parameter>
179+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="Group"><maml:name>ResourceGroupName</maml:name>
180+
<maml:Description><maml:para>The name of the resource group to create the website in.
181+
</maml:para>
182+
</maml:Description>
183+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
184+
<dev:type><maml:name>String</maml:name>
185+
<maml:uri /></dev:type>
186+
<dev:defaultValue>None</dev:defaultValue>
187+
</command:parameter>
188+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="Plan"><maml:name>AppServicePlan</maml:name>
189+
<maml:Description><maml:para>The AppService Plan to use for thsi website. If not provided, the website will create an app service plan, or join an existing free AppService plan.
190+
</maml:para>
191+
</maml:Description>
192+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
193+
<dev:type><maml:name>String</maml:name>
194+
<maml:uri /></dev:type>
195+
<dev:defaultValue>None</dev:defaultValue>
196+
</command:parameter>
197+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>GitRepositoryPath</maml:name>
198+
<maml:Description><maml:para>The path to a github repository containingg the application for the website. A remote for pushign to the website will be added to this repository.
199+
</maml:para>
200+
</maml:Description>
201+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
202+
<dev:type><maml:name>String</maml:name>
203+
<maml:uri /></dev:type>
204+
<dev:defaultValue>None</dev:defaultValue>
205+
</command:parameter>
206+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AddRemote</maml:name>
207+
<maml:Description><maml:para>Add a remote github repository to the given github repo.
208+
</maml:para>
209+
</maml:Description>
210+
<dev:type><maml:name>SwitchParameter</maml:name>
211+
<maml:uri /></dev:type>
212+
<dev:defaultValue>False</dev:defaultValue>
213+
</command:parameter>
214+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Auto</maml:name>
215+
<maml:Description><maml:para>Skip parameter prompting for remaining parameters.
216+
</maml:para>
217+
</maml:Description>
218+
<dev:type><maml:name>SwitchParameter</maml:name>
219+
<maml:uri /></dev:type>
220+
<dev:defaultValue>False</dev:defaultValue>
221+
</command:parameter>
222+
</command:syntaxItem>
223+
</command:syntax>
224+
<command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AddRemote</maml:name>
225+
<maml:Description><maml:para>Add a remote github repository to the given github repo.
226+
</maml:para>
227+
</maml:Description>
228+
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
229+
<dev:type><maml:name>SwitchParameter</maml:name>
230+
<maml:uri /></dev:type>
231+
<dev:defaultValue>False</dev:defaultValue>
232+
</command:parameter>
233+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="Plan"><maml:name>AppServicePlan</maml:name>
234+
<maml:Description><maml:para>The AppService Plan to use for thsi website. If not provided, the website will create an app service plan, or join an existing free AppService plan.
235+
</maml:para>
236+
</maml:Description>
237+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
238+
<dev:type><maml:name>String</maml:name>
239+
<maml:uri /></dev:type>
240+
<dev:defaultValue>None</dev:defaultValue>
241+
</command:parameter>
242+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Auto</maml:name>
243+
<maml:Description><maml:para>Skip parameter prompting for remaining parameters.
244+
</maml:para>
245+
</maml:Description>
246+
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
247+
<dev:type><maml:name>SwitchParameter</maml:name>
248+
<maml:uri /></dev:type>
249+
<dev:defaultValue>False</dev:defaultValue>
250+
</command:parameter>
251+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>GitRepositoryPath</maml:name>
252+
<maml:Description><maml:para>The path to a github repository containingg the application for the website. A remote for pushign to the website will be added to this repository.
253+
</maml:para>
254+
</maml:Description>
255+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
256+
<dev:type><maml:name>String</maml:name>
257+
<maml:uri /></dev:type>
258+
<dev:defaultValue>None</dev:defaultValue>
259+
</command:parameter>
260+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="Group"><maml:name>ResourceGroupName</maml:name>
261+
<maml:Description><maml:para>The name of the resource group to create the website in.
262+
</maml:para>
263+
</maml:Description>
264+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
265+
<dev:type><maml:name>String</maml:name>
266+
<maml:uri /></dev:type>
267+
<dev:defaultValue>None</dev:defaultValue>
268+
</command:parameter>
269+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="Name"><maml:name>WebAppName</maml:name>
270+
<maml:Description><maml:para>The name of the website.
271+
</maml:para>
272+
</maml:Description>
273+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
274+
<dev:type><maml:name>String</maml:name>
275+
<maml:uri /></dev:type>
276+
<dev:defaultValue>None</dev:defaultValue>
277+
</command:parameter>
278+
</command:parameters>
279+
<command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name>
280+
</dev:type>
281+
<maml:description><maml:para>
282+
</maml:para>
283+
</maml:description>
284+
</command:inputType>
285+
</command:inputTypes>
286+
<command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Management.WebSites.Models.Site</maml:name>
287+
</dev:type>
288+
<maml:description><maml:para>Details about the created website, including its URL.
289+
</maml:para>
290+
</maml:description>
291+
</command:returnValue>
292+
</command:returnValues>
293+
<maml:alertSet><maml:alert><maml:para>
294+
</maml:para>
295+
</maml:alert>
296+
</maml:alertSet>
297+
<command:examples><command:example><maml:title>Example 1</maml:title>
298+
<dev:code>PS C:\&gt; New-AzWebAppGrayParam -Location "East US"</dev:code>
299+
<dev:remarks><maml:para>Create a web application with detailed prompts for parameter values that are not provided, including simple defaults.
300+
</maml:para>
301+
</dev:remarks>
302+
</command:example>
303+
</command:examples>
304+
<command:relatedLinks></command:relatedLinks>
305+
</command:command>
306+
</helpItems>

‎experiments/Websites.Experiments/help/New-AzWebAppGrayParam.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@ values for parameters that are not provided. Using -Auto indicates that further
2525

2626
### Example 1
2727
```
28-
PS C:\> New-AzWebAppGrayParam
28+
PS C:\> New-AzWebAppGrayParam -Location "East US"
2929
```
3030

31-
Create a web application using defaults for all values, including name
31+
Create a web application with detailed prompts for parameter values that are not provided, including simple defaults.
3232

3333
## PARAMETERS
3434

0 commit comments

Comments
 (0)