Help Docs

Azure VM Extension

To add Azure VM Extension you can use one of the following methods:

Note

Prerequisites for installation are .NET 3.0 & above and IIS 7.0 & above.

Azure UI Portal

  1. Go to the webpage portal.azure.com and enter your login details.
  2. Create a new VM, navigate to New > Virtual Machines > select any of the Windows apps listed for adding APM Insight.
     
    Note

    You can also add a new VM by navigating to Resource Groups > Add (+) > Select any of the Windows Server apps listed.

  3. In case you already have an existing VM in Azure, navigate to Virtual Machines >select the VM to which you want to add the extension.
  4. Choose the deployment model (Classic/resource) > click create.
  5. Configure basic settings, size of VM and other optional features.
  6. Under Settings tab, go to extensions > Add Extension(+) > APM Insight .NET agent.
  7. To authenticate the .NET agent, a license key is required. Login to Site24x7 and navigate to APM > Add APM Insight > .NET Agent > License key in your Site24x7 client. Sign up if you are a new user.
  8. Click Create.
  9. Enter the obtained license key in the field provided. Click OK.
  10. You can now view your monitor on your dashboard and start monitoring all your critical metrics.

Powershell CmdLet:

Prerequisite:

Make sure the Azure PowerShell SDK is installed and supported from version 2.6 and above

Note

Currently adding a Classic VM Extension via the portal has some technical issues. We are working with Microsoft to get it resolved. In the meantime, you can use the powershell command given below to add the extension.

Using Powersehell CmdLet you can add Azure VM Extension for:

Please follow the below steps to add a VM extension for Classic VMs via PowerShell:

  1. Login to Microsoft Azure portal by entering the command
    Login-AzureAccount
  2. After logging in, execute the command

    PS>$vm = (Get-AzureVM -ServiceName <cloudservicename> -Name) Set-AzureVMExtension -ExtensionName

    PS>Site24x7ApmInsightExtn -Publisher Site24x7 -Version 1.3 -VM $vm -PublicConfiguration '{"site24x7licensekey":"enter your licensekey"}' -ReferenceName Site24x7ApmInsight

    PS>$vm | Update-AzureVM

Note

  • "site24x7licensekey" is the License key that can be obtained from APM > Add APM Insight > .NET Agent > License key.
  • The Publisher, ExtensionName and the Version in the command string should not be changed.
  • The user can modify -ReferenceName that will be visible in the Extension portal (Settings > Extensions).

To remove a Classic VM extension:

Remove-AzureVMExtension -ExtensionName Site24x7APMInsightExtn -Publisher Site24x7 -VM $vm;

Please follow the below steps to add a VM extension for Resource Managers VMs via PowerShell:

  1. Login to Microsoft Azure portal by entering the command
    Login-AzureRmAccount
  2. After logging in, execute the command
    Set-AzureRmVMExtension -SettingString '{"site24x7AgentType":"azurevmextnapminsight"}' -ProtectedSettings '{"site24x7LicenseKey":"enter your licensekey"}' -Publisher Site24x7 -ExtensionType Site24x7APMInsightExtn -Version 1.3 -Name -ResourceGroupName -Location -VMName
Note

  • "site24x7licensekey" is the License key that can be obtained from APM > Add APM Insight > .NET Agent > License key.
  • The SettingString, Publisher, ExtensionType and the Version in the command string should not be changed.
  • The user can modify -Name that will be visible in the Extension portal (Settings > Extensions).

To remove a Resource Manager VM extension:

Remove -AzureRmVMExtension -VMName <vm name> -Name Site24x7APMInsightExtn -ResourceGroupName <resourcegroup name>

To get version and other properties of the extension (both Classic and Resource Manager):

Get-AzureVMAvailableExtension -ExtensionName Site24x7APMInsightExtn

To get the list of locations (both Classic and Resource Manager):

Get -AzureLocation

Was this document helpful?

Would you like to help us improve our documents? Tell us what you think we could do better.


We're sorry to hear that you're not satisfied with the document. We'd love to learn what we could do to improve the experience.


Thanks for taking the time to share your feedback. We'll use your feedback to improve our online help resources.

Shortlink has been copied!