Merge pull request #1 from Azure/master

merging latest commits

Author: rbitia

.beautifyrc

@@ -1,9 +1,10 @@
 {
   "js": {
-      "indentChar": " ",
-      "indentLevel": 0,
-      "indentSize": 2,
-      "indentWithTabs": false,
+      "end_with_newline": true,
+      "indent_char": " ",
+      "indent_level": 0,
+      "indent_size": 2,
+      "indent_with_tabs": false,
       "space_after_anon_function": "true"
   }
 }

.github/CONTRIBUTING.md

@@ -43,22 +43,23 @@ To make sure your template is added to Azure.com index, please follow these guid
 9. Name **variables** using this scheme **templateScenarioResourceName** (e.g. simpleLinuxVMVNET, userRoutesNSG, elasticsearchPublicIP etc.) that describe the scenario rather. This ensures when a user browses all the resources in the Portal there aren't a bunch of resources with the same name (e.g. myVNET, myPublicIP, myNSG)
 10. **Storage account names** need to be lower case and can't contain hyphens (-) in addition to other domain name restrictions. These also need to be globally unique.
 11. **Passwords** must be passed into parameters of type `securestring`.
-    * Passwords must also be passed to customScriptExtension using the `commandToExecute` property in `protectedSettings`. This will look like below
+    * Passwords must also be passed to Custom Script Extension using the `commandToExecute` property in `protectedSettings`. This will look like below:
 
     ```
-     "properties": {
-       "publisher": "Microsoft.OSTCExtensions",
-       "type": "CustomScriptForLinux",
-       "typeHandlerVersion": "1.4",
-       "settings": {
-       "fileUris": [
-     	   "https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/lamp-app/install_lamp.sh"
-       ]
-     },
-     "protectedSettings": {
-       "commandToExecute": "[concat('sh install_lamp.sh ', parameters('mySqlPassword'))]"
-       }
-     }
+    "properties": {
+      "publisher": "Microsoft.Azure.Extensions",
+      "type": "CustomScript",
+      "typeHandlerVersion": "2.0",
+	  "autoUpgradeMinorVersion": true,
+      "settings": {
+        "fileUris": [
+          "https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/lamp-app/install_lamp.sh"
+        ]
+      },
+      "protectedSettings": {
+        "commandToExecute": "[concat('sh install_lamp.sh ', parameters('mySqlPassword'))]"
+      }
+    }
     ```
 
 12. Every parameter in the template must have the **lower-case description** tag specified using the metadata property. This looks like below
@@ -269,4 +270,4 @@ Server Error:{
         }
     }
 }
-```
+```

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,11 +1,23 @@
-### Contributing guide
-https://github.com/Azure/azure-quickstart-templates/blob/master/1-CONTRIBUTION-GUIDE/README.md
+### Best Practice Checklist
+Check these items before submitting a PR... See the Contribution Guide for the full detail: https://github.com/Azure/azure-quickstart-templates/blob/master/1-CONTRIBUTION-GUIDE/README.md 
+
+1. uri's compatible with all clouds (Stack, China, Government)
+1. Staged artifacts use _artifactsLocation & _artifactsLocationSasToken
+1. Use resourceGroup().location for resource locations
+1. Folder names for artifacts (nestedtemplates, scripts, DSC)
+1. Use literal values for apiVersion (no variables)
+1. Parameter files (GEN-UNIQUE for value generation and no "changemeplease" values
+1. $schema and other uris use https
+1. Use uniqueString() whenever possible to generate names for resources.  While this is not required, it's one of the most common failure points in a deployment. 
+1. Update the metadata.json with the current date
+
+For details: https://github.com/Azure/azure-quickstart-templates/blob/master/1-CONTRIBUTION-GUIDE/bp-checklist.md
+
+- [ ] - Please check this box once you've submitted the PR if you've read through the Contribution Guide and best practices checklist.
 
 ### Changelog
-*
-*
+
 *
 *
 *
 
-### Description of the change

.gitignore

@@ -21,5 +21,6 @@ org-mode-config.el
 .DS_Store
 org-clock-save.el
 emacs-config.el
-.vscode/settings.json
-
+.vscode
+node_modules
+Nese_OMS_NEstedforOMSWS.json

1-CONTRIBUTION-GUIDE/README.md

@@ -6,12 +6,13 @@ The following information is relevant to get started with contributing to this r
 + [**Contribution guide**](/1-CONTRIBUTION-GUIDE/README.md#contribution-guide). Describes the minimal guidelines for contributing.
 + [**Best practices**](/1-CONTRIBUTION-GUIDE/best-practices.md#best-practices). Best practices for improving the quality of your template design.
 + [**Git tutorial**](/1-CONTRIBUTION-GUIDE/git-tutorial.md#git-tutorial). Step by step to get you started with Git.
++ [**Useful Tools**](/1-CONTRIBUTION-GUIDE/useful-tools.md#useful-tools). Useful resources and tools for Azure development.
 
 ## Deploying Samples
 
 You can deploy these samples directly through the Azure Portal or by using the scripts supplied in the root of the repo.
 
-To deploy a sammple using the Azure Portal, click the **Deploy to Azure** button found in the README.md of each sample.
+To deploy a sample using the Azure Portal, click the **Deploy to Azure** button found in the README.md of each sample.
 
 To deploy the sample via the command line (using [Azure PowerShell or the Azure CLI](https://azure.microsoft.com/en-us/downloads/)) you can use the scripts.
 
@@ -21,7 +22,7 @@ Simple execute the script and pass in the folder name of the sample you want to
 .\Deploy-AzureResourceGroup.ps1 -ResourceGroupLocation 'eastus' -ArtifactsStagingDirectory '[foldername]'
 ```
 ```bash
-azure-group-deploy.sh -a [foldername] -l eastus -u
+azure-group-deploy.sh -a [foldername] -l eastus
 ```
 If the sample has artifacts that need to be "staged" for deployment (Configuration Scripts, Nested Templates, DSC Packages) then set the upload switch on the command.
 You can optionally specify a storage account to use, if so the storage account must already exist within the subscription.  If you don't want to specify a storage account
@@ -65,7 +66,7 @@ The README.md describes your deployment. A good description helps other communit
 + Deploy to Azure button
 + Visualize button
 + Description of what the template will deploy
-+ Tags, that can be used for seach. Specify the tags comma seperated and enclosed between two back-ticks (e.g Tags: `cluster, ha, sql`)
++ Tags, that can be used for search. Specify the tags comma separated and enclosed between two back-ticks (e.g Tags: `cluster, ha, sql`)
 + *Optional: Prerequisites
 + *Optional: Description on how to use the application
 + *Optional: Notes
@@ -258,3 +259,7 @@ Server Error:{
     }
 }
 ```
+
+```
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
+```

1-CONTRIBUTION-GUIDE/best-practices.md

@@ -13,7 +13,6 @@ You are currently reading the best practices.
 
 + It is a good practice to pass your template through a JSON linter to remove extraneous commas, parenthesis, brackets that may break the "Deploy to Azure" experience. Try http://jsonlint.com/ or a linter package for your favorite editing environment (Visual Studio Code, Atom, Sublime Text, Visual Studio etc.)
 + It's also a good idea to format your JSON for better readability. You can use a JSON formatter package for your local editor or [format online using this link](https://www.bing.com/search?q=json+formatter).
-+ A starter template is provided [here](/100-STARTER-TEMPLATE-with-VALIDATION) for you to follow.
 
 The following guidelines are relevant to the main deployment template and nested templates (if used).
 
@@ -129,8 +128,10 @@ The following guidelines are relevant to the main deployment template and nested
 
  ```
  "properties": {
- 	"publisher": "Microsoft.OSTCExtensions",
- 	"type": "CustomScriptForLinux",
+ 	"publisher": "Microsoft.Azure.Extensions",
+ 	"type": "CustomScript",
+	"version": "2.0",
+	"autoUpgradeMinorVersion": true,
  	"settings": {
  		"fileUris": [
  			"[concat(variables('template').assets, '/lamp-app/install_lamp.sh')]"
@@ -172,7 +173,7 @@ The following guidelines are relevant to the main deployment template and nested
 
  Note: A complex object cannot contain an expression that references a value from a complex object. Define a separate variable for this purpose.
 
-13. The **domainNameLabel** property for publicIPAddresses must be **unique**. domainNameLabel is required to be betweeen 3 and 63 characters long and to follow the rules specified by this regular expression ^[a-z][a-z0-9-]{1,61}[a-z0-9]$. As the uniqueString function will generate a string that is 13 characters long in the example below it is presumed that the dnsPrefixString prefix string has been checked to be no more than 50 characters long and to conform to those rules.
+13. The **domainNameLabel** property for publicIPAddresses must be **unique**. domainNameLabel is required to be between 3 and 63 characters long and to follow the rules specified by this regular expression ^[a-z][a-z0-9-]{1,61}[a-z0-9]$. As the uniqueString function will generate a string that is 13 characters long in the example below it is presumed that the dnsPrefixString prefix string has been checked to be no more than 50 characters long and to conform to those rules.
 
  ```
  "parameters": {
@@ -194,11 +195,11 @@ The following guidelines are relevant to the main deployment template and nested
  ```
  "outputs": {
  "fqdn": {
- 	"value": "[reference(resourceId('Microsoft.Network/publicIPAddresses',parameters('publicIPAddressName')),providers('Microsoft.Network', 'publicIPAddresses').apiVersions[0]).dnsSettings.fqdn]",
+ 	"value": "[reference(resourceId('Microsoft.Network/publicIPAddresses',parameters('publicIPAddressName')),'2016-10-01').dnsSettings.fqdn]",
  	"type": "string"
  },
  "ipaddress": {
- 	"value": "[reference(resourceId('Microsoft.Network/publicIPAddresses',parameters('publicIPAddressName')),providers('Microsoft.Network', 'publicIPAddresses').apiVersions[0]).ipAddress]",
+ 	"value": "[reference(resourceId('Microsoft.Network/publicIPAddresses',parameters('publicIPAddressName')),'2016-10-01').dnsSettings.fqdn]",
   	"type": "string"
  }
 }
@@ -211,7 +212,7 @@ The following guidelines are relevant to the main deployment template and nested
 It is obvious to create a single deployment template for deploying a single resource. Nested templates are common for more advanced scenarios. The following section is by no means a hard requirement, but more of a guidance to help you decide between a single template or a decomposed nested template design. 
 
 * Create a single template for a single tier application
-* Create a nested templates deployment for a multitier application
+* Create a nested templates deployment for a multi-tier application
 * Use nested templates for conditional deployment
 
 ### Samples that contain extra artifacts (Custom Scripts, nested templates, etc)
@@ -221,7 +222,7 @@ When samples contain scripts, templates or other artifacts that need to be made
 First, define two standard parameters:
 
 * _artifactsLocation - this is the base URI where all artifacts for the deployment will be staged.  The default value should be the samples folder so that the sample can be easily deployed in scenarios where a private location is not required.
-* _artifactsocationSasToken - this is the sasToken required to access _artifactsLocation.  The default value should be "" for scenarios where the _artifactsLocation is not secured, for example, the raw GitHub URI.
+* _artifactsLocationSasToken - this is the sasToken required to access _artifactsLocation.  The default value should be "" for scenarios where the _artifactsLocation is not secured, for example, the raw GitHub URI.
 
 ```
   "parameters": {
@@ -310,15 +311,15 @@ When authoring a template that references another sample, define a complex objec
 _**Note:** Using this approach will still require pulling the dependent artifact from the raw GitHub location.  The sample scripts do not privately stage artifacts from adjacent solutions.  In practice, it is expected that this technique would be rarely used because the main template being deployed has a dependency on a shared template that may have a different lifecycle, resulting in unexpected changes in the configuration.  In a real-world scenario, all the templates that make up the deployment should be under the same span of control and could be staged together.  Simply put share the same parent.  This will work for a shared environment of the repository, but a best practice would be to refactor these samples to ensure a proper configuration is maintained._
 
 
-It is possible to deploy a nested template based on parameter input. The parameter input is used to concatenate the relative path to a nested template. Based on the user input a different template is deployed. This enables a conditional nested template deployment. The paramater is used to define the name of the template. Ensure the allowedValues of the input parameter match the names of the nested templates.
+It is possible to deploy a nested template based on parameter input. The parameter input is used to concatenate the relative path to a nested template. Based on the user input a different template is deployed. This enables a conditional nested template deployment. The parameter is used to define the name of the template. Ensure the allowedValues of the input parameter match the names of the nested templates.
 
 ### Nested templates design for more advanced scenarios
 
 When you decide to decompose your template design into multiple nested templates, the following guidelines will help to standardize the design. These guidelines are based on the [best practices for designing Azure Resource Manager templates](https://azure.microsoft.com/en-us/documentation/articles/best-practices-resource-manager-design-templates/) documentation.
 For this guidance a deployment of a SharePoint farm is used as an example. The SharePoint farm consists of multiple tiers. Each tier can be created with high availability. The recommended design consists of the following templates.
 
 + **Main template** (azuredeploy.json). Used for the input parameters.
-+ **Shared resouces template**. Deploys the shared resources that all other resources use (e.g. virtual network, availability sets). The expression dependsOn enforces that this template is deployed before the other templates.
++ **Shared resources template**. Deploys the shared resources that all other resources use (e.g. virtual network, availability sets). The expression dependsOn enforces that this template is deployed before the other templates.
 + **Optional resources template**. Conditionally deploys resources based on a parameter (e.g. a jumpbox)
 + **Member resources templates**. Each within an application tier within has its own configuration. Within a tier different instance types can be defined. (e.g. first instance creates a new cluster, additional instances are added to the existing cluster). Each instance type will have its own deployment template.
 + **Scripts**. Widely reusable scripts are applicable for each instance type (e.g. initialize and format additional disks). Custom scripts are created for specific customization purpose are different per instance type.

1-CONTRIBUTION-GUIDE/bp-checklist.md

@@ -0,0 +1,37 @@
+# Azure Resource Manager Templates - Best Practice Checklist
+
+Use this as a quick checklist to ensure your sample meets the minimum set of guidelines for samples in this repository.  For the full set and a detailed explanation see the [**Best Practices Guide**](/1-CONTRIBUTION-GUIDE/best-practices.md#best-practices). 
+
+These practices ensure your sample provides a consistent, reliable experience across all Azure Clouds.
+
+## Checklist
+
+1. All uri's should be compatible with all clouds (Stack, China, Government)
+	+ See #9 in [**Best practices**](/1-CONTRIBUTION-GUIDE/best-practices.md#best-practices) 
+
+2. For staging artifacts (scripts, templates, etc) use paramters named _artifactsLocation & _artifactsLocationSasToken - see:
+	+ [**Samples that contain artifacts**](https://github.com/Azure/azure-quickstart-templates/blob/master/1-CONTRIBUTION-GUIDE/best-practices.md#samples-that-contain-extra-artifacts-custom-scripts-nested-templates-etc)
+	
+3. Use resourceGroup().location for resource locations to be compatible with all clouds
+	+ Exceptions for resources that are available on only a few locations (which is not the same as !global)
+	+ If a location param is needed do not use parameters named "location", instead resourceLocation or storageLocation, etc.
+
+4. Folder names for artifacts:
+	+ nestedtemplates
+	+ scripts
+	+ DSC
+
+5. Use literal values for apiVersion (do not variables so schema validation can be done)
+
+6. Parameter files must not contain values like "changemeplease" - use default values when appropriate in the template file and leave them out of param files
+
+7. Check whether $schema entries in templates and parameter files are the latest (2015-01-01) and using https
+
+8. Update the metadata.json with the current date
+
+9. Use uniqueString() whenever possible to generate names for resources.  While this is not required, it's one of the most common failure points in a deployment. 
+
+---
+
+### Final Note
+If you're submitting a developer sample (101/201/301 level template), use the full best practice guide to ensure the full list of practices have been followed.