From e1b37254f3298323e0ade2149fee3abbf7d61789 Mon Sep 17 00:00:00 2001 From: markcowl Date: Fri, 15 Sep 2017 11:49:53 -0700 Subject: [PATCH] Update help and add maml help for website cmdlets --- .../AzureRM.Websites.Experiments.psm1 | 6 + ...Azure.Commands.Websites.Experiments.csproj | 5 + .../AzureRM.Websites.Experiments-help.xml | 306 ++++++++++++++++++ .../help/New-AzWebAppGrayParam.md | 4 +- 4 files changed, 319 insertions(+), 2 deletions(-) create mode 100644 experiments/Websites.Experiments/help/AzureRM.Websites.Experiments-help.xml diff --git a/experiments/Websites.Experiments/AzureRM.Websites.Experiments.psm1 b/experiments/Websites.Experiments/AzureRM.Websites.Experiments.psm1 index fac68bd64d25..f9145faa767c 100644 --- a/experiments/Websites.Experiments/AzureRM.Websites.Experiments.psm1 +++ b/experiments/Websites.Experiments/AzureRM.Websites.Experiments.psm1 @@ -124,6 +124,9 @@ function New-AzWebAppJustDoIt END {} } +<# +.ExternalHelp help\AzureRM.Websites.Experiments-help.xml +#> function New-AzWebApp { [CmdletBinding()] @@ -561,6 +564,9 @@ function Get-WebSitesClient return $client } +<# +.ExternalHelp help\AzureRM.Websites.Experiments-help.xml +#> function New-AzWebAppGrayParam { [CmdletBinding()] diff --git a/experiments/Websites.Experiments/Microsoft.Azure.Commands.Websites.Experiments.csproj b/experiments/Websites.Experiments/Microsoft.Azure.Commands.Websites.Experiments.csproj index b39fc7933570..6950cad000d6 100644 --- a/experiments/Websites.Experiments/Microsoft.Azure.Commands.Websites.Experiments.csproj +++ b/experiments/Websites.Experiments/Microsoft.Azure.Commands.Websites.Experiments.csproj @@ -85,5 +85,10 @@ + + + Always + + \ No newline at end of file diff --git a/experiments/Websites.Experiments/help/AzureRM.Websites.Experiments-help.xml b/experiments/Websites.Experiments/help/AzureRM.Websites.Experiments-help.xml new file mode 100644 index 000000000000..45cc7e06d8cd --- /dev/null +++ b/experiments/Websites.Experiments/help/AzureRM.Websites.Experiments-help.xml @@ -0,0 +1,306 @@ + + + + +New-AzWebApp +New +AzWebApp +Create a new Azure AppService website and attach it to a git repository. + + + +Create a new Azure AppService website and attach it to a git repository. + + +New-AzWebApp +WebAppName +The name of the Website. The website will automatically use this value as the subdomain for the created website. + + +String +String + +None + +ResourceGroupName +The name of the resource group for the Website. + + +String +String + +None + +AppServicePlan +The name or id of the AppService Plan to use with this WebApp. + + +String +String + +None + +GitRepositoryPath +The path to a github repository where remotes should be added. + + +String +String + +None + +AddRemote +Add a remote to local github repo. + + +SwitchParameter + +False + +Auto +Accept default values for all settings not provided, withotu prompting. + + +SwitchParameter + +False + + + +AddRemote +Add a remote to local github repo. + + +SwitchParameter +SwitchParameter + +False + +AppServicePlan +The name or id of the AppService Plan to use with this WebApp. + + +String +String + +None + +Auto +Accept default values for all settings not provided, withotu prompting. + + +SwitchParameter +SwitchParameter + +False + +GitRepositoryPath +The path to a github repository where remotes should be added. + + +String +String + +None + +ResourceGroupName +The name of the resource group for the Website. + + +String +String + +None + +WebAppName +The name of the Website. The website will automatically use this value as the subdomain for the created website. + + +String +String + +None + + +None + + + + + + +Microsoft.Azure.Management.WebSites.Models.Site + +Details about the created website, including URL and github repo url. + + + + + + + + +Example 1: Create a website with prompts for settings +PS C:\> New-AzWebApp contosoWebApp +Creates a web application. The user will be prompted for the appservice to use and other settings. + + + +Example 2: Create a website with default settings +PS C:\> New-AzWebApp contosoWebApp -Auto +Creates a web application using default settings. + + + + + + + +New-AzWebAppGrayParam +New +AzWebAppGrayParam +Create an Azure Website using Azure App Service. + + + +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. + + +New-AzWebAppGrayParam +WebAppName +The name of the website. + + +String +String + +None + +ResourceGroupName +The name of the resource group to create the website in. + + +String +String + +None + +AppServicePlan +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. + + +String +String + +None + +GitRepositoryPath +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. + + +String +String + +None + +AddRemote +Add a remote github repository to the given github repo. + + +SwitchParameter + +False + +Auto +Skip parameter prompting for remaining parameters. + + +SwitchParameter + +False + + + +AddRemote +Add a remote github repository to the given github repo. + + +SwitchParameter +SwitchParameter + +False + +AppServicePlan +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. + + +String +String + +None + +Auto +Skip parameter prompting for remaining parameters. + + +SwitchParameter +SwitchParameter + +False + +GitRepositoryPath +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. + + +String +String + +None + +ResourceGroupName +The name of the resource group to create the website in. + + +String +String + +None + +WebAppName +The name of the website. + + +String +String + +None + + +None + + + + + + +Microsoft.Azure.Management.WebSites.Models.Site + +Details about the created website, including its URL. + + + + + + + + +Example 1 +PS C:\> New-AzWebAppGrayParam -Location "East US" +Create a web application with detailed prompts for parameter values that are not provided, including simple defaults. + + + + + + + diff --git a/experiments/Websites.Experiments/help/New-AzWebAppGrayParam.md b/experiments/Websites.Experiments/help/New-AzWebAppGrayParam.md index 85bf913eecad..e7c1d5c8677a 100644 --- a/experiments/Websites.Experiments/help/New-AzWebAppGrayParam.md +++ b/experiments/Websites.Experiments/help/New-AzWebAppGrayParam.md @@ -25,10 +25,10 @@ values for parameters that are not provided. Using -Auto indicates that further ### Example 1 ``` -PS C:\> New-AzWebAppGrayParam +PS C:\> New-AzWebAppGrayParam -Location "East US" ``` -Create a web application using defaults for all values, including name +Create a web application with detailed prompts for parameter values that are not provided, including simple defaults. ## PARAMETERS