Skip to content

Commit

Permalink
All readmes (#12580)
Browse files Browse the repository at this point in the history
* linting and yaml

* linting and yaml

* script updates

Co-authored-by: azure-quickstart-templates pipeline <azure-quickstart-templates@noreply.github.com>
  • Loading branch information
bmoore-msft and azure-quickstart-templates pipeline committed Jul 5, 2022
1 parent 724d262 commit 44a99e7
Show file tree
Hide file tree
Showing 1,121 changed files with 14,672 additions and 4,796 deletions.
2 changes: 1 addition & 1 deletion 1-CONTRIBUTION-GUIDE/README.md
Expand Up @@ -113,7 +113,7 @@ To make sure your template is added to Azure.com index, please follow these guid

Samples can be deployed to resourceGroup, subscription, managementGroup and tenant scope. The scope of deployment should match the scope of the workload. For example, while it's possible to deploy resources to a resourceGroup from a subscription scope template, this requires elevated permissions that users may not have. For example, resourceGroups should not be created as part of a resourceGroup workload by requiring deployment to the subscription scope. If the workload targets a resourceGroup, the sample's targetScope should target a resourceGroup.

The target scope itself should not be created by the sample unless the creation of the scope is the sample, for example creating managementGroup hierarchies.
The target scope itself should not be created by the sample unless the creation of the scope is the sample, for example creating managementGroup hierarchies.

## Bicep support

Expand Down
6 changes: 3 additions & 3 deletions 1-CONTRIBUTION-GUIDE/best-practices.md
Expand Up @@ -2,7 +2,7 @@

This document describes the best practices for reviewing and troubleshooting Azure Resource Manager (ARM) Templates, including Azure Applications for the Azure Marketplaces. This document is intended to help you design effective templates or troubleshoot existing templates for getting applications certified for the Azure Marketplace and Azure QuickStart templates.

This repository contains all currently available Azure Resource Manager templates contributed by the community. A searchable template index is maintained at <https://azure.microsoft.com/en-us/documentation/templates/>.
This repository contains all currently available Azure Resource Manager templates contributed by the community. A searchable template index is maintained at <https://azure.microsoft.com/documentation/templates/>.

To contribute a sample to this repo, you must read and follow these best practices as well as the guidelines listed in the [**Contribution guide**](/1-CONTRIBUTION-GUIDE/README.md#contribution-guide).

Expand Down Expand Up @@ -58,7 +58,7 @@ Other resource types are supported but will require support from the on-boarding
* Variables must not be used for apiVersions. The apiVersion affects the shape of the resource and often cannot be updated without updating all the resources that use a particular version.
* Use a copy loop for creating repeating patterns of JSON in variables.
* Remove all unused variables from all templates.
* Avoid concatenating variable names for conditional scenarios – use template language expressions. For more information, see [https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-template-functions](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-template-functions)
* Avoid concatenating variable names for conditional scenarios – use template language expressions. For more information, see [https://docs.microsoft.com/azure/azure-resource-manager/resource-group-template-functions](https://docs.microsoft.com/azure/azure-resource-manager/resource-group-template-functions)

## Parameters

Expand Down Expand Up @@ -250,7 +250,7 @@ The following example shows how to use the reference function for the `storageUr

* All `apiVersion` references for each specific resource type must use the same apiVersion.

To verify the API versions that are supported by a particular `Provider.Namespace/resourceType`, see the [Supported API versions](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services#supported-api-versions) topic.
To verify the API versions that are supported by a particular `Provider.Namespace/resourceType`, see the [Supported API versions](https://docs.microsoft.com/azure/azure-resource-manager/resource-manager-supported-services#supported-api-versions) topic.

### VM Extensions

Expand Down
27 changes: 14 additions & 13 deletions 1-CONTRIBUTION-GUIDE/git-tutorial.md
@@ -1,6 +1,6 @@
# Azure Resource Manager QuickStart Templates

This repo contains all currently available Azure Resource Manager templates contributed by the community. A searchable template index is maintained at https://azure.microsoft.com/en-us/documentation/templates/.
This repo contains all currently available Azure Resource Manager templates contributed by the community. A searchable template index is maintained at https://azure.microsoft.com/documentation/templates/.
The following information is relevant to get started with contributing to this repository.

+ [**Contribution guide**](/1-CONTRIBUTION-GUIDE/README.md#contribution-guide). Describes the minimal guidelines for contributing.
Expand Down Expand Up @@ -28,19 +28,20 @@ You probably heard of Git before, but it's possible that you haven't used it. Wr

This guide assumes you're new to git and that you're using a Windows computer. If you're using Linux OSX, its very similar, with the exception of Windows-specifics such as installation of git.

#### Table of Contents
### Table of Content

- [Git Tutorial for ARM Template Submissions](#git-tutorial-for-the-pct-arm-templates)
- [Get Git](#get-git)
- [Fork the Repository to your Account](#fork-the-repository-to-your-account)
- [Clone the template Repository to your Machine](#clone-the-arm-template-repository-to-your-machine)
- [Creating a new Branch for your template](#creating-a-new-branch-for-your-template)
- [Staging your Changes for a Commit](#staging-your-changes-for-a-commit)
- [Commit your Changes](#commit-your-changes)
- [Push your new Branch to Your Fork on GitHub](#push-your-new-branch-to-your-fork-on-github)
- [Make a Pull Request](#make-a-pull-request)
- [Updating Pull Requests](#updating-pull-requests)
- [Squashing Commits](#squashing-commits)
- [Syncing Your Fork](#syncing-your-fork)
- [Get Git](#get-git)
- [Fork the Repository to your Account](#fork-the-repository-to-your-account)
- [Clone the template Repository to your Machine](#clone-the-arm-template-repository-to-your-machine)
- [Creating a new Branch for your template](#creating-a-new-branch-for-your-template)
- [Staging your Changes for a Commit](#staging-your-changes-for-a-commit)
- [Commit your Changes](#commit-your-changes)
- [Push your new Branch to Your Fork on GitHub](#push-your-new-branch-to-your-fork-on-github)
- [Make a Pull Request](#make-a-pull-request)
- [Updating Pull Requests](#updating-pull-requests)
- [Squashing Commits](#squashing-commits)
- [Syncing Your Fork](#syncing-your-fork)

### Get Git
If you don't have Git installed, head over to the official [Git Download page and download it](https://git-scm.com/download/win). Once installed and downloaded, you might also want to install [Posh Git](https://github.com/dahlbyk/posh-git). If you're already using Chocolatey or Windows 10's package manager to install software, you can simply run the following command from an elevated PowerShell (right click, select 'Run as Administrator'):
Expand Down
6 changes: 3 additions & 3 deletions 1-CONTRIBUTION-GUIDE/useful-tools.md
@@ -1,7 +1,7 @@
Learn more about [Creating and deploying Azure resource groups through Visual Studio](https://azure.microsoft.com/en-us/documentation/articles/vs-azure-tools-resource-groups-deployment-projects-create-deploy)
Learn more about [Creating and deploying Azure resource groups through Visual Studio](https://azure.microsoft.com/documentation/articles/vs-azure-tools-resource-groups-deployment-projects-create-deploy)

Learn more about [Resource manager for VS Code](https://azure.microsoft.com/en-us/documentation/articles/resource-manager-vs-code/)
Learn more about [Resource manager for VS Code](https://azure.microsoft.com/documentation/articles/resource-manager-vs-code/)

Learn more about [Azure SDK and Tools for Visual Studio](https://www.visualstudio.com/features/azure-tools-vs)

Learn more about all the Azure tools: https://azure.microsoft.com/en-us/tools/
Learn more about all the Azure tools: https://azure.microsoft.com/tools/
10 changes: 10 additions & 0 deletions 100-blank-template/README.md
@@ -1,3 +1,13 @@
---
description: A blank template and empty parameters file.
page_type: sample
products:
- azure
- azure-resource-manager
languages:
- json
- bicep
---
# Blank Template

![Azure Public Test Date](https://azurequickstartsservice.blob.core.windows.net/badges/100-blank-template/PublicLastTestDate.svg)
Expand Down
4 changes: 2 additions & 2 deletions README.md
@@ -1,12 +1,12 @@
# Azure Resource Manager QuickStart Templates

This repo contains all currently available Azure Resource Manager templates contributed by the community. A searchable template index is maintained at [azure.com](https://azure.microsoft.com/en-us/documentation/templates).
This repo contains all currently available Azure Resource Manager templates contributed by the community. A searchable template index is maintained at [azure.com](https://azure.microsoft.com/documentation/templates).

See the [**Contribution guide**](/1-CONTRIBUTION-GUIDE/README.md#contribution-guide) for how to use or contribute to this repo.

## NOTE

We have finished migration of the samples to subfolders, see [azure.com](https://azure.microsoft.com/en-us/documentation/templates) if you need help finding a sample. A few obsolete samples were removed in the migration.
We have finished migration of the samples to subfolders, see [azure.com](https://azure.microsoft.com/documentation/templates) if you need help finding a sample. A few obsolete samples were removed in the migration.

### Final Note

Expand Down
@@ -1,4 +1,13 @@
# Create 2 new Windows VMs, a new AD Forest, Domain and 2 DCs in separate availability zones
---
description: This template creates 2 VMs in separate Availability Zones to be AD DCs (primary and backup) for a new Forest and Domain
page_type: sample
products:
- azure
- azure-resource-manager
languages:
- json
---
# Create a new AD Domain with 2 DCs using Availability Zones

![Azure Public Test Date](https://azurequickstartsservice.blob.core.windows.net/badges/application-workloads/active-directory/active-directory-new-domain-ha-2-dc-zones/PublicLastTestDate.svg)
![Azure Public Test Result](https://azurequickstartsservice.blob.core.windows.net/badges/application-workloads/active-directory/active-directory-new-domain-ha-2-dc-zones/PublicDeployment.svg)
Expand All @@ -14,3 +23,5 @@ This template will deploy 2 new VMs and create a new AD forest and domain, each
Click the button below to deploy

[![Deploy To Azure](https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/1-CONTRIBUTION-GUIDE/images/deploytoazure.svg?sanitize=true)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2Fmaster%2Fapplication-workloads%2Factive-directory%2Factive-directory-new-domain-ha-2-dc-zones%2Fazuredeploy.json) [![Visualize](https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/1-CONTRIBUTION-GUIDE/images/visualizebutton.svg?sanitize=true)](http://armviz.io/#/?load=https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2Fmaster%2Fapplication-workloads%2Factive-directory%2Factive-directory-new-domain-ha-2-dc-zones%2Fazuredeploy.json)

`Tags: Microsoft.Network/publicIPAddresses, Microsoft.Resources/deployments, Microsoft.Network/networkInterfaces, Microsoft.Compute/virtualMachines, Microsoft.Compute/virtualMachines/extensions, DSC, Microsoft.Network/virtualNetworks`
@@ -1,4 +1,13 @@
# Create 2 Windows VMs, a new AD Forest, Domain and 2 DCs in an availability set
---
description: This template creates 2 new VMs to be AD DCs (primary and backup) for a new Forest and Domain
page_type: sample
products:
- azure
- azure-resource-manager
languages:
- json
---
# Create an new AD Domain with 2 Domain Controllers

![Azure Public Test Date](https://azurequickstartsservice.blob.core.windows.net/badges/application-workloads/active-directory/active-directory-new-domain-ha-2-dc/PublicLastTestDate.svg)
![Azure Public Test Result](https://azurequickstartsservice.blob.core.windows.net/badges/application-workloads/active-directory/active-directory-new-domain-ha-2-dc/PublicDeployment.svg)
Expand All @@ -18,3 +27,5 @@ Click the button below to deploy
## Known Issues

This template is entirely serial due to some concurrency issues between the platform agent and the DSC extension which cause problems when multiple VM and\or extension resources are deployed concurrently, this will be fixed in the near future

`Tags: Microsoft.Network/publicIPAddresses, Microsoft.Compute/availabilitySets, Microsoft.Resources/deployments, Microsoft.Network/loadBalancers, Microsoft.Network/networkInterfaces, Microsoft.Compute/virtualMachines, extensions, DSC, Microsoft.Compute/virtualMachines/extensions, Microsoft.Network/virtualNetworks`
@@ -1,3 +1,12 @@
---
description: This template creates a new Azure VM, it configures the VM to be an AD DC for a new Forest from a resuable module.
page_type: sample
products:
- azure
- azure-resource-manager
languages:
- json
---
# Create an Azure VM with a new AD Forest (from a module)

![Azure Public Test Date](https://azurequickstartsservice.blob.core.windows.net/badges/application-workloads/active-directory/active-directory-new-domain-module-use/PublicLastTestDate.svg)
Expand All @@ -11,8 +20,10 @@

[![Deploy To Azure](https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/1-CONTRIBUTION-GUIDE/images/deploytoazure.svg?sanitize=true)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2Fmaster%2Fapplication-workloads%2Factive-directory%2Factive-directory-new-domain-module-use%2Fazuredeploy.json)
[![Deploy To Azure US Gov](https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/1-CONTRIBUTION-GUIDE/images/deploytoazuregov.svg?sanitize=true)](https://portal.azure.us/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2Fmaster%2Fapplication-workloads%2Factive-directory%2Factive-directory-new-domain-module-use%2Fazuredeploy.json)
[![Visualize](https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/1-CONTRIBUTION-GUIDE/images/visualizebutton.svg?sanitize=true)](http://armviz.io/#/?load=https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2Fmaster%2Fapplication-workloads%2Factive-directory%2Factive-directory-new-domain-module-use%2Fazuredeploy.json)
[![Visualize](https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/1-CONTRIBUTION-GUIDE/images/visualizebutton.svg?sanitize=true)](http://armviz.io/#/?load=https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2Fmaster%2Fapplication-workloads%2Factive-directory%2Factive-directory-new-domain-module-use%2Fazuredeploy.json)

This template will deploy a new VM (along with a new VNet and Load Balancer) and will configure it as a Domain Controller and create a new forest and domain.

_This sample deploys the controller from a shared module in the modules folder. You can use the sample directly or as an example of how to use a module in a larger template deployment._

`Tags: Microsoft.Resources/deployments`
@@ -1,4 +1,13 @@
# Create a new Windows VM and create a new AD Forest, Domain and DC
---
description: This template creates a new Azure VM, it configures the VM to be an AD DC for a new Forest
page_type: sample
products:
- azure
- azure-resource-manager
languages:
- json
---
# Create an Azure VM with a new AD Forest

![Azure Public Test Date](https://azurequickstartsservice.blob.core.windows.net/badges/application-workloads/active-directory/active-directory-new-domain/PublicLastTestDate.svg)
![Azure Public Test Result](https://azurequickstartsservice.blob.core.windows.net/badges/application-workloads/active-directory/active-directory-new-domain/PublicDeployment.svg)
Expand All @@ -14,3 +23,5 @@ This template will deploy a new VM (along with a new VNet and Load Balancer) and
Click the button below to deploy

[![Deploy To Azure](https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/1-CONTRIBUTION-GUIDE/images/deploytoazure.svg?sanitize=true)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2Fmaster%2Fapplication-workloads%2Factive-directory%2Factive-directory-new-domain%2Fazuredeploy.json) [![Deploy To Azure US Gov](https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/1-CONTRIBUTION-GUIDE/images/deploytoazuregov.svg?sanitize=true)](https://portal.azure.us/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2Fmaster%2Fapplication-workloads%2Factive-directory%2Factive-directory-new-domain%2Fazuredeploy.json) [![Visualize](https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/1-CONTRIBUTION-GUIDE/images/visualizebutton.svg?sanitize=true)](http://armviz.io/#/?load=https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2Fmaster%2Fapplication-workloads%2Factive-directory%2Factive-directory-new-domain%2Fazuredeploy.json)

`Tags: Microsoft.Network/publicIPAddresses, Microsoft.Compute/availabilitySets, Microsoft.Resources/deployments, Microsoft.Network/loadBalancers, Microsoft.Network/networkInterfaces, Microsoft.Compute/virtualMachines, extensions, DSC, Microsoft.Network/virtualNetworks`

0 comments on commit 44a99e7

Please sign in to comment.