Deploy a new Sitecore instance on Azure with Azure Monitoring and Alerts Basic

Before you can deploy a Sitecore environment on Azure with Azure Monitoring and Alerts Basic, you must:

• Work through Getting started with the Sitecore Azure Toolkit.

• Work through Deploy a new Sitecore environment to the Azure App service, Specifically work through the following sections:

  • Plan your environment
  • Prepare WebDeploy packages
  • Download and configure an environment template

• Install the latest version of PowerShell (minimum 6.0.0) – To upgrade your PowerShell module, run:

  Update-Module -Name AzureRM -RequiredVersion 6.0.0 -Force

• (Optional if you require a fully functional application level monitoring solution) Application Insights.

To add the Azure Monitoring and Alerts Basic module, you must inject it into the parameters.json file for your specific topology. To inject the module into the parameters.json file:

1. Ensure you have a parameters.json file for your Sitecore environment.
2. In the parameters.json file, add the modules parameter.
3. Also in the parameters.json file for your Sitecore configuration, insert the configuration snippet, for the Monitoring module, into the modules parameter. Use the snippet from the next section: Configure the Monitoring module.

To integrate the deployment of the Azure Monitoring and Alerts Basic module into the Sitecore environment deployment,

1. In the azuredeploy.parameters.json file, add the following snippet to the modules parameter.

   {… ,
       "modules": {
           "value": {
               "items": [
                   {
                       "name": "monitoring",
                       "templateLink": "<url of Azure Monitoring and Alerts Basic  azuredeploy.json>",
                       "parameters": {
                              "omsWorkspaceMetricsRetentionDays": <days>,
                              "omsWorkspaceAlertRecipients": "<email address for alert recipient>",
                              "omsWorkspaceLocation": "<supported location>",
                              "applicationInsightsLocation": "<supported location>"
   
                       }
                   }
               ]
           }
       }
   }

2. Populate the parameters for the Azure Monitoring and Alerts Basic module.

   Parameter	Instructions
   templateLink	In Github, go to the Monitoringmodule, and use the URL of the Azure Monitoring and Alerts Basic template, azuredeploy.json. Alternatively, you can download the Azure Monitoring and Alerts Basic ARM templates and upload them to your storage account.
   OmsWorkspaceMetricsRetentionDays	Enter the custom metrics retention days. The value in days = between 30 to 730.
   OmsWorkspaceAlertRecipients	To receive alerts, enter your email address. If you want to use more than one email address, then use a semi colon ";" as a separator.
   OmsWorkspaceLocation	Specify the location where you want to provision your log analytics. First check which regions are supported.
   applicationInsightsLocation	Specify the location where you want to provision your Application Insights. First check which regions are supported.

To invoke the PowerShell deployment command and initiate provisioning:

1. In PowerShell, open the Azure Toolkit folder, and load the Azure Toolkit module: Import-Module.\tools\Sitecore.Cloud.Cmdlets.psm1-Verbose.

2. Use the command Add-AzureRMAccount, to add an Azure account to your PowerShell session.

3. If you have access to multiple subscriptions, select the subscription that you want to deploy into. For example: Set-AzureRMContext -SubscriptionName "<name of your subscription>".

4. To start provisioning, use the Start-SitecoreAzureDeployment commandlet:

   Start-SitecoreAzureDeployment [-location] <String> [-Name] <String> [-ArmTemplateUrl] <String> [-ArmParametersPath] <String> [-LicenseXmlPath] <String> [-SetKeyValue] <Hashtable>

   The Start-SitecoreAzureDeployment commandlet uses the following parameters:

   • Parameter: Description
   • Location: The Azure datacenter where you want to deploy your resources from. The Azure datacenter compatibility table lists the Microsoft Azure datacenters that the Sitecore Experience Platform supports deployment to.
   • Name: The name of the resource group for your new environment. The name can refer to a new or existing resource group, and is usually the same as the deployment ID.
   • ArmTemplateUrl: The URL of the ARM template file for the environment configuration that you want to deploy.
   • ArmParametersPath: The local path to the populated parameters.json file for the template that you selected.
   • LicenseXmlPath: The path to the Sitecore license file that you want to deploy to the environment.
   • SetKeyValue: (Optional) Use this parameter in a script to deploy several environments
     a common set of default parameter values in the azuredeploy.parameters.json file.Supply environment specific parameter values in the command line.The value of this parameter is a hashtable that contains a subset of parameters described in the azuredeploy.parameters.json file. Any values that you specify in the command line for this parameter override the values specified in the azuredeploy.parameters.json file For example, to set or override the value in the deploymentIdparameter, enter:

   -SetKeyValue @{ "deploymentId" = "<new value>" }

# Deployment joson file path
$ArmTemplateUrl = "<azuredeploy.json URI>"

# Azure template parameters path
$ArmParametersPath = "<Local Path for *.parameters.json>"

# Sitecore Azure toolkit Path
$SCSDK = "<Directory path to Azure Toolkit>"

# Name of resource group
$Name = "< Resource group name>"

# Sitecore License File
$LicenseFile = "< LicenseFile >"

#Azure Subscriptionid
$SubscriptionId = "< AzureSubscriptionId >"

# Location of deployment
$Region = "< Location of deployment >"

# Import Sitecore SDK module
Import-Module $SCSDK\Sitecore.Cloud.Cmdlets.psm1

# Select Azure Account
Add-AzureRMAccount
Set-AzureRMContext -SubscriptionId $SubscriptionId

# Deploy Sitecore
Start-SitecoreAzureDeployment -Name $Name -Region $Region -ArmTemplateUrl $ArmTemplateUrl -ArmParametersPath $ArmParametersPath -LicenseXmlPath $LicenseFile

If you no longer require Azure Azure Monitor you can remove it.

If you are using a Solr search provider with your Sitecore deployment, you must also delete the Search Services Performance view. To delete the Search Services Performance overview:

1. In your OMS workspace, click the Performance Overview tile.

   

2. In Performance Overview, click Edit.

   

3. In View dashboard, click on the Search Services Performance overview, then click Delete view.