Skip to content

Commit 43c4616

Browse files
marcvaneijkmarcvaneijk
authored
Merge pull request #94 from marcvaneijk/SampleReadme_fix
Updated sample based on azure-quickstart
2 parents 9e91c9a + c0fa938 commit 43c4616

File tree

1 file changed

+53
-75
lines changed

1 file changed

+53
-75
lines changed

‎Sample README.md‎

Lines changed: 53 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
1-
# [Solution name]
1+
# Solution name
22

3-
<a href="https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2Fmaster%2F101-vnet-two-subnets%2Fazuredeploy.json" target="_blank">
4-
<img src="http://azuredeploy.net/deploybutton.png"/></a>
3+
<a href="https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2Fmaster%2F100-STARTER-TEMPLATE-with-VALIDATION%2Fazuredeploy.json" target="_blank">
4+
<img src="http://azuredeploy.net/deploybutton.png"/>
5+
</a>
6+
<a href="http://armviz.io/#/?load=https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2Fmaster%2F100-STARTER-TEMPLATE-with-VALIDATION%2Fazuredeploy.json" target="_blank">
7+
<img src="http://armviz.io/visualizebutton.png"/>
8+
</a>
59

6-
This template deploys a [solution name]. The [solution name] is a [description]
10+
This template deploys a **solution name**. The **solution name** is a **description**
711

812
`Tags: [Tag1, Tag2, Tag3]`
913

@@ -12,92 +16,66 @@ This template deploys a [solution name]. The [solution name] is a [description]
1216
| Microsoft Azure | - | no |
1317
| Microsoft Azure Stack | TP1 | no |
1418

15-
## Deployed resources
19+
## Solution overview and deployed resources
20+
21+
This is an overview of the solution
1622

1723
The following resources are deployed as part of the solution
1824

19-
####[Resource provider 1]
20-
[Description Resource Provider 1]
21-
+ **[Resource type 1A]**: [Description Resource type 1A]
22-
+ **[Resource type 1B]**: [Description Resource type 1B]
23-
+ **[Resource type 1C]**: [Description Resource type 1C]
25+
#### Resource provider 1
26+
27+
Description Resource Provider 1
28+
29+
+ **Resource type 1A**: Description Resource type 1A
30+
+ **Resource type 1B**: Description Resource type 1B
31+
+ **Resource type 1C**: Description Resource type 1C
32+
33+
#### Resource provider 2
34+
35+
Description Resource Provider 2
2436

25-
####[Resource provider 2]
26-
[Description Resource Provider 2]
27-
+ **[Resource type 2A]**: [Description Resource type 2A]
37+
+ **Resource type 2A**: Description Resource type 2A
2838

29-
####[Resource provider 3]
30-
[Description Resource Provider 3]
31-
+ **[Resource type 3A]**: [Description Resource type 3A]
32-
+ **[Resource type 3B]**: [Description Resource type 3B]
39+
#### Resource provider 3
40+
41+
Description Resource Provider 3
42+
43+
+ **Resource type 3A**: Description Resource type 3A
44+
+ **Resource type 3B**: Description Resource type 3B
3345

3446
## Prerequisites
3547

36-
[Decscription of the prerequistes for the deployment]
48+
Decscription of the prerequistes for the deployment
3749

3850
## Deployment steps
39-
You can either click the "deploy to Azure" button at the beginning of this document or deploy the solution from PowerShell with the following PowerShell script.
40-
41-
``` PowerShell
42-
## Specify your AzureAD Tenant in a variable.
43-
# If you know the prefix of your <prefix>.onmicrosoft.com AzureAD account use option 1)
44-
# If you do not know the prefix of your <prefix>.onmicrosoft.com AzureAD account use option 2)
45-
46-
# Option 1) If you know the prefix of your <prefix>.onmicrosoft.com AzureAD namespace.
47-
# You need to set that in the $AadTenantId varibale (e.g. contoso.onmicrosoft.com).
48-
$AadTenantId = "contoso"
49-
50-
# Option 2) If you don't know the prefix of your AzureAD namespace, run the following cmdlets.
51-
# Validate with the Azure AD credentials you also use to sign in as a tenant to Microsoft Azure Stack Technical Preview.
52-
$AadTenant = Login-AzureRmAccount
53-
$AadTenantId = $AadTenant.Context.Tenant.TenantId
54-
55-
## Configure the environment with the Add-AzureRmEnvironment cmdlt
56-
Add-AzureRmEnvironment -Name 'Azure Stack' `
57-
-ActiveDirectoryEndpoint ("https://login.windows.net/$AadTenantId/") `
58-
-ActiveDirectoryServiceEndpointResourceId "https://azurestack.local-api/"`
59-
-ResourceManagerEndpoint ("https://api.azurestack.local/") `
60-
-GalleryEndpoint ("https://gallery.azurestack.local/") `
61-
-GraphEndpoint "https://graph.windows.net/"
62-
63-
## Authenticate a user to the environment (you will be prompted during authentication)
64-
$privateEnv = Get-AzureRmEnvironment 'Azure Stack'
65-
$privateAzure = Add-AzureRmAccount -Environment $privateEnv -Verbose
66-
Select-AzureRmProfile -Profile $privateAzure
67-
68-
## Select an existing subscription where the deployment will take place
69-
Get-AzureRmSubscription -SubscriptionName "SUBSCRIPTION_NAME" | Select-AzureRmSubscription
70-
71-
# Set Deployment Variables
72-
$myNum = "001" #Modify this per deployment
73-
$RGName = "myRG$myNum"
74-
$myLocation = "local"
75-
$myBlobStorageEndpoint = "blob.azurestack.local"
76-
77-
# Create Resource Group for Template Deployment
78-
New-AzureRmResourceGroup -Name $RGName -Location $myLocation
79-
80-
# Deploy Template
81-
New-AzureRmResourceGroupDeployment `
82-
-Name "myDeployment$myNum" `
83-
-ResourceGroupName $RGName `
84-
-TemplateFile "azuredeploy-101-simple-windows-vm-withDNS.json" `
85-
-deploymentLocation $myLocation `
86-
-blobStorageEndpoint $myBlobStorageEndpoint `
87-
-newStorageAccountName "mystorage$myNum" `
88-
-dnsNameForPublicIP "mydns$myNum" `
89-
-adminUsername "GEN-UNIQUE-8" `
90-
-adminPassword "GEN-PASSWORD" `
91-
-vmName "myVM$myNum" `
92-
-windowsOSVersion "2012-R2-Datacenter"
51+
52+
You can click the "deploy to Azure" button at the beginning of this document or follow the instructions for command line deployment using the scripts in the root of this repo.
53+
54+
It is also possible to create a storage account in your subscription and perform the deployment from that storage account using the following steps.
55+
To deploy this template using the scripts from the root of this repo: (change the folder name below to match the folder name for this sample)
56+
57+
```PowerShell
58+
.\Deploy-AzureResourceGroup.ps1 -ResourceGroupLocation 'local' -ArtifactsStagingDirectory '[foldername]'
59+
```
60+
61+
If your sample has artifacts that need to be "staged" for deployment (Configuration Scripts, Nested Templates, DSC Packages) then set the upload switch on the command.
62+
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
63+
one will be created by the script (think of this as "temp" storage for AzureRM) and reused by subsequent deployments.
64+
65+
```PowerShell
66+
.\Deploy-AzureResourceGroup.ps1 -ResourceGroupLocation 'local' -ArtifactsStagingDirectory '100-STARTER-TEMPLATE-with-VALIDATION' -UploadArtifacts
9367
```
9468

9569
## Usage
70+
9671
#### Connect
97-
[How to connect to the solution]
72+
73+
How to connect to the solution
74+
9875
#### Management
99-
[How to manage the solution]
76+
77+
How to manage the solution
10078

10179
## Notes
102-
[Solution notes]
10380

81+
Solution notes

0 commit comments

Comments
 (0)