Improve code formatting and usability of New-AzServiceFabricCluster examples (#11447)

* Fix markdown formatting errors

* Descriptive variable names

* Add changelog entry for code cleanup

Author: erikadoyle

src/ServiceFabric/ServiceFabric/ChangeLog.md

@@ -18,6 +18,7 @@
         - Additional information about change #1
 -->
 ## Upcoming Release
+* Improved code formatting and usability of New-AzServiceFabricCluster examples
 
 ## Version 2.0.1
 * Update references in .psd1 to use relative path

src/ServiceFabric/ServiceFabric/help/New-AzServiceFabricCluster.md

@@ -8,12 +8,14 @@ schema: 2.0.0
 # New-AzServiceFabricCluster
 
 ## SYNOPSIS
-This command uses certificates that you provide or system generated self-signed certificates to set up a new service fabric cluster. It can use a default template or a custom template that you provide. You have the option of specifying a folder to export the self-signed certificates to or fetching them later from the key vault. 
+
+This command uses certificates that you provide or system generated self-signed certificates to set up a new service fabric cluster. It can use a default template or a custom template that you provide. You have the option of specifying a folder to export the self-signed certificates to or fetching them later from the key vault.
 
 ## SYNTAX
 
 ### ByDefaultArmTemplate (Default)
-```
+
+```powershell
 New-AzServiceFabricCluster [-ResourceGroupName] <String> [-CertificateOutputFolder <String>]
  [-CertificatePassword <SecureString>] [-KeyVaultResourceGroupName <String>] [-KeyVaultName <String>]
  -Location <String> [-Name <String>] [-VmUserName <String>] [-ClusterSize <Int32>]
@@ -22,15 +24,17 @@ New-AzServiceFabricCluster [-ResourceGroupName] <String> [-CertificateOutputFold
 ```
 
 ### ByExistingKeyVault
-```
+
+```powershell
 New-AzServiceFabricCluster [-ResourceGroupName] <String> -TemplateFile <String> -ParameterFile <String>
  [-CertificateCommonName <String>] [-CertificateIssuerThumbprint <String>] [-VmPassword <SecureString>]
  -SecretIdentifier <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
  [<CommonParameters>]
 ```
 
 ### ByNewPfxAndVaultName
-```
+
+```powershell
 New-AzServiceFabricCluster [-ResourceGroupName] <String> -TemplateFile <String> -ParameterFile <String>
  [-CertificateOutputFolder <String>] [-CertificatePassword <SecureString>]
  [-KeyVaultResourceGroupName <String>] [-KeyVaultName <String>] [-CertificateSubjectName <String>]
@@ -39,7 +43,8 @@ New-AzServiceFabricCluster [-ResourceGroupName] <String> -TemplateFile <String>
 ```
 
 ### ByExistingPfxAndVaultName
-```
+
+```powershell
 New-AzServiceFabricCluster [-ResourceGroupName] <String> -TemplateFile <String> -ParameterFile <String>
  -CertificateFile <String> [-CertificatePassword <SecureString>] [-SecondaryCertificateFile <String>]
  [-SecondaryCertificatePassword <SecureString>] [-KeyVaultResourceGroupName <String>] [-KeyVaultName <String>]
@@ -48,74 +53,80 @@ New-AzServiceFabricCluster [-ResourceGroupName] <String> -TemplateFile <String>
 ```
 
 ## DESCRIPTION
+
 The **New-AzServiceFabricCluster** command uses certificates that you provide or system generated self-signed certificates to set up a new service fabric cluster. The template used can be a default template or a custom template that you provide. You have the option of specifying a folder to export the self-signed certificates or fetching them later from the key vault.
 If you are specifying a custom template and parameter file, you don't need to provide the certificate information in the parameter file, the system will populate these parameters.
 The four options are detailed below. Scroll down for explanations of each of the parameters.
 
 ## EXAMPLES
 
-### Example 1: Specify only the cluster size, the cert subject name, and the OS to deploy a cluster.
-```
-$pass="Password#1234" | ConvertTo-SecureString -AsPlainText -Force
-$RGname="test01"
-$clusterloc="SouthCentralUS"
-$subname="{0}.{1}.cloudapp.azure.com" -f $RGname, $clusterloc
-$pfxfolder="c:\certs"
+### Example 1: Specify only the cluster size, the cert subject name, and the OS to deploy a cluster
 
-Write-Output "Create cluster in '$clusterloc' with cert subject name '$subname' and cert output path '$pfxfolder'"
+```powershell
+$password = "Password#1234" | ConvertTo-SecureString -AsPlainText -Force
+$resourceGroupName = "quickstart-sf-group"
+$azureRegion = "southcentralus"
+$clusterDnsName = "{0}.{1}.cloudapp.azure.com" -f $resourceGroupName, $azureRegion
+$localCertificateFolder = "c:\certs"
 
-New-AzServiceFabricCluster -ResourceGroupName $RGname -Location $clusterloc -ClusterSize 5 -VmPassword $pass -CertificateSubjectName $subname -CertificateOutputFolder $pfxfolder -CertificatePassword $pass -OS WindowsServer2016Datacenter
+Write-Output "Create cluster in '$azureRegion' with cert subject name '$clusterDnsName' and cert output path '$localCertificateFolder'"
+
+New-AzServiceFabricCluster -ResourceGroupName $resourceGroupName -Location $azureRegion -ClusterSize 5 -VmPassword $password -CertificateSubjectName $clusterDnsName -CertificateOutputFolder $localCertificateFolder -CertificatePassword $pass -OS WindowsServer2016Datacenter
 ```
 
 This command specifies only the cluster size, the cert subject name, and the OS to deploy a cluster.
 
 ### Example 2: Specify an existing Certificate resource in a key vault and a custom template to deploy a cluster
-```
-$RGname="test20"
-$templateParmfile="C:\service-fabric-secure-nsg-cluster-65-node-3-nodetype\azuredeploytest.parameters.json"
-$templateFile="C:\azure-quickstart-templates\service-fabric-secure-nsg-cluster-65-node-3-nodetype\azuredeploy.json"
-$secretId="https://test1.vault.azure.net:443/secrets/testcertificate4/56ec774dc61a462bbc645ffc9b4b225f"
 
-New-AzServiceFabricCluster -ResourceGroupName $RGname -TemplateFile $templateFile -ParameterFile $templateParmfile -SecretIdentifier $secretId
+```powershell
+$resourceGroupName = "test20"
+$templateParameterFile = "C:\service-fabric-secure-nsg-cluster-65-node-3-nodetype\azuredeploytest.parameters.json"
+$templateFile = "C:\azure-quickstart-templates\service-fabric-secure-nsg-cluster-65-node-3-nodetype\azuredeploy.json"
+$secretId = "https://test1.vault.azure.net:443/secrets/testcertificate4/56ec774dc61a462bbc645ffc9b4b225f"
+
+New-AzServiceFabricCluster -ResourceGroupName $resourceGroupName -TemplateFile $templateFile -ParameterFile $templateParameterFile -SecretIdentifier $secretId
 ```
 
 This command specifies an existing Certificate resource in a key vault and a custom template to deploy a cluster.
 
 ### Example 3: Create a new cluster using a custom template. Specify a different resource group name for the key vault and have the system upload a new certificate to it
-```
-$pass="Password#1234" | ConvertTo-SecureString -AsPlainText -Force
-$RGname="test20"
-$keyVaultRG="test20kvrg"
-$keyVault="test20kv"
-$clusterloc="SouthCentralUS"
-$subname="{0}.{1}.$clusterloc.cloudapp.azure.com" -f $RGName, $clusterloc
-$pfxfolder="~\Documents"
-$templateParmfile="C:\service-fabric-secure-nsg-cluster-65-node-3-nodetype\azuredeploytest.parameters.json"
-$templateFile="C:\service-fabric-secure-nsg-cluster-65-node-3-nodetype\azuredeploy.json"
 
-New-AzServiceFabricCluster -ResourceGroupName $RGname -TemplateFile $templateFile -ParameterFile $templateParmfile -CertificateOutputFolder $pfxfolder -CertificatePassword $pass -KeyVaultResourceGroupName $keyVaultRG  -KeyVaultName $keyVault -CertificateSubjectName $subname
+```powershell
+$password = "Password#1234" | ConvertTo-SecureString -AsPlainText -Force
+$resourceGroupName = "quickstart-sf-group"
+$keyVaultResourceGroupName = " quickstart-kv-group"
+$keyVaultName = "quickstart-kv"
+$azureRegion = "southcentralus"
+$clusterDnsName = "{0}.{1}.cloudapp.azure.com" -F $resourceGroupName, $azureRegion
+$localCertificateFolder = "~\Documents"
+$templateParameterFile = "C:\service-fabric-secure-nsg-cluster-65-node-3-nodetype\azuredeploytest.parameters.json"
+$templateFile = "C:\service-fabric-secure-nsg-cluster-65-node-3-nodetype\azuredeploy.json"
+
+New-AzServiceFabricCluster -ResourceGroupName $resourceGroupName -TemplateFile $templateFile -ParameterFile $templateParameterFile -CertificateOutputFolder $localCertificateFolder -CertificatePassword $password -KeyVaultResourceGroupName $keyVaultResourceGroupName  -KeyVaultName $keyVaultName -CertificateSubjectName $clusterDnsName
 ```
 
 This command creates a new cluster using a custom template. Specify a different resource group name for the key vault and have the system upload a new certificate to it
 
 ### Example 4: Bring your own Certificate and custom template and create a new cluster
-```
-$pass="Password#1234" | ConvertTo-SecureString -AsPlainText -Force
-$RGname="test20"
-$keyVaultRG="test20kvrg"
-$keyVault="test20kv"
-$pfxsourcefile="c:\Mycertificates\my2017Prodcert.pfx"
-$templateParmfile="~\Documents\GitHub\azure-quickstart-templates-parms\service-fabric-secure-nsg-cluster-65-node-3-nodetype\azuredeploytest.parameters.json"
-$templateFile="~\GitHub\azure-quickstart-templates\service-fabric-secure-nsg-cluster-65-node-3-nodetype\azuredeploy.json"
 
-New-AzServiceFabricCluster -ResourceGroupName $RGname -TemplateFile $templateFile -ParameterFile $templateParmfile -CertificateFile $pfxsourcefile -CertificatePassword $pass -KeyVaultResourceGroupName $keyVaultRG -KeyVaultName $keyVault
+```powershell
+$password = "Password#1234" | ConvertTo-SecureString -AsPlainText -Force
+$resourceGroupName = "test20"
+$keyVaultResourceGroupName = "test20kvrg"
+$keyVaultName = "test20kv"
+$localCertificateFile = "c:\Mycertificates\my2017Prodcert.pfx"
+$templateParameterFile = "~\Documents\GitHub\azure-quickstart-templates-parms\service-fabric-secure-nsg-cluster-65-node-3-nodetype\azuredeploytest.parameters.json"
+$templateFile = "~\GitHub\azure-quickstart-templates\service-fabric-secure-nsg-cluster-65-node-3-nodetype\azuredeploy.json"
+
+New-AzServiceFabricCluster -ResourceGroupName $resourceGroupName -TemplateFile $templateFile -ParameterFile $templateParameterFile -CertificateFile $localCertificateFile -CertificatePassword $password -KeyVaultResourceGroupName $keyVaultResourceGroupName -KeyVaultName $keyVaultName
 ```
 
 This command will let you bring your own Certificate and custom template and create a new cluster.
 
 ## PARAMETERS
 
 ### -CertificateCommonName
+
 Certificate common name
 
 ```yaml
@@ -131,6 +142,7 @@ Accept wildcard characters: False
 ```
 
 ### -CertificateFile
+
 The existing certificate file path for the primary cluster certificate
 
 ```yaml
@@ -146,6 +158,7 @@ Accept wildcard characters: False
 ```
 
 ### -CertificateIssuerThumbprint
+
 Certificate issuer thumbprint, separated by commas if more than one
 
 ```yaml
@@ -161,6 +174,7 @@ Accept wildcard characters: False
 ```
 
 ### -CertificateOutputFolder
+
 The folder of the new certificate file to be created
 
 ```yaml
@@ -176,6 +190,7 @@ Accept wildcard characters: False
 ```
 
 ### -CertificatePassword
+
 The password of the certificate file
 
 ```yaml
@@ -191,6 +206,7 @@ Accept wildcard characters: False
 ```
 
 ### -CertificateSubjectName
+
 The subject name of the certificate to be created
 
 ```yaml
@@ -206,6 +222,7 @@ Accept wildcard characters: False
 ```
 
 ### -ClusterSize
+
 The number of nodes in the cluster.
 Default are 5 nodes
 
@@ -222,6 +239,7 @@ Accept wildcard characters: False
 ```
 
 ### -DefaultProfile
+
 The credentials, account, tenant, and subscription used for communication with Azure.
 
 ```yaml
@@ -237,6 +255,7 @@ Accept wildcard characters: False
 ```
 
 ### -KeyVaultName
+
 Azure key vault name, if not given it will be defaulted to the resource group name
 
 ```yaml
@@ -252,6 +271,7 @@ Accept wildcard characters: False
 ```
 
 ### -KeyVaultResourceGroupName
+
 Azure key vault resource group name, if not given it will be defaulted to resource group name
 
 ```yaml
@@ -267,6 +287,7 @@ Accept wildcard characters: False
 ```
 
 ### -Location
+
 The resource group location
 
 ```yaml
@@ -282,6 +303,7 @@ Accept wildcard characters: False
 ```
 
 ### -Name
+
 Specify the name of the cluster, if not given it will be same as resource group name
 
 ```yaml
@@ -297,6 +319,7 @@ Accept wildcard characters: False
 ```
 
 ### -OS
+
 The Operating System of the VMs that make up the cluster.
 
 ```yaml
@@ -313,6 +336,7 @@ Accept wildcard characters: False
 ```
 
 ### -ParameterFile
+
 The path to the template parameter file.
 
 ```yaml
@@ -328,6 +352,7 @@ Accept wildcard characters: False
 ```
 
 ### -ResourceGroupName
+
 Specify the name of the resource group.
 
 ```yaml
@@ -343,6 +368,7 @@ Accept wildcard characters: False
 ```
 
 ### -SecondaryCertificateFile
+
 The existing certificate file path for the secondary cluster certificate
 
 ```yaml
@@ -358,6 +384,7 @@ Accept wildcard characters: False
 ```
 
 ### -SecondaryCertificatePassword
+
 The password of the certificate file
 
 ```yaml
@@ -373,6 +400,7 @@ Accept wildcard characters: False
 ```
 
 ### -SecretIdentifier
+
 The existing Azure key vault secret URL, for example 'https://mykv.vault.azure.net:443/secrets/mysecrets/55ec7c4dc61a462bbc645ffc9b4b225f'
 
 ```yaml
@@ -388,6 +416,7 @@ Accept wildcard characters: False
 ```
 
 ### -TemplateFile
+
 The path to the template file.
 
 ```yaml
@@ -403,6 +432,7 @@ Accept wildcard characters: False
 ```
 
 ### -VmPassword
+
 The password of the Vm.
 
 ```yaml
@@ -430,6 +460,7 @@ Accept wildcard characters: False
 ```
 
 ### -VmSku
+
 The Vm Sku
 
 ```yaml
@@ -445,6 +476,7 @@ Accept wildcard characters: False
 ```
 
 ### -VmUserName
+
 The user name for logging to Vm
 
 ```yaml
@@ -460,6 +492,7 @@ Accept wildcard characters: False
 ```
 
 ### -Confirm
+
 Prompts you for confirmation before running the cmdlet.
 
 ```yaml
@@ -475,6 +508,7 @@ Accept wildcard characters: False
 ```
 
 ### -WhatIf
+
 Shows what would happen if the cmdlet runs.
 The cmdlet is not run.
 
@@ -491,7 +525,8 @@ Accept wildcard characters: False
 ```
 
 ### CommonParameters
-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).
+
+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).
 
 ## INPUTS