Microsoft.Insights components template reference

Template format

To create a Microsoft.Insights/components resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.Insights/components",
  "apiVersion": "2020-02-02-preview",
  "location": "string",
  "tags": {},
  "kind": "string",
  "properties": {
    "Application_Type": "string",
    "Flow_Type": "Bluefield",
    "Request_Source": "rest",
    "HockeyAppId": "string",
    "SamplingPercentage": "number",
    "DisableIpMasking": "boolean",
    "ImmediatePurgeDataOn30Days": "boolean",
    "WorkspaceResourceId": "string",
    "publicNetworkAccessForIngestion": "string",
    "publicNetworkAccessForQuery": "string"
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Insights/components object

Name Type Required Value
name string Yes The name of the Application Insights component resource.
type enum Yes Microsoft.Insights/components
apiVersion enum Yes 2020-02-02-preview
location string Yes Resource location
tags object No Resource tags
kind string Yes The kind of application that this component refers to, used to customize UI. This value is a freeform string, values should typically be one of the following: web, ios, other, store, java, phone.
properties object Yes Properties that define an Application Insights component resource. - ApplicationInsightsComponentProperties object

ApplicationInsightsComponentProperties object

Name Type Required Value
Application_Type enum Yes Type of application being monitored. - web or other
Flow_Type enum No Used by the Application Insights system to determine what kind of flow this component was created by. This is to be set to 'Bluefield' when creating/updating a component via the REST API. - Bluefield
Request_Source enum No Describes what tool created this Application Insights component. Customers using this API should set this to the default 'rest'. - rest
HockeyAppId string No The unique application ID created when a new application is added to HockeyApp, used for communications with HockeyApp.
SamplingPercentage number No Percentage of the data produced by the application being monitored that is being sampled for Application Insights telemetry.
DisableIpMasking boolean No Disable IP masking.
ImmediatePurgeDataOn30Days boolean No Purge data immediately after 30 days.
WorkspaceResourceId string Yes ResourceId of the log analytics workspace which the data will be ingested to.
publicNetworkAccessForIngestion enum No The network access type for accessing Application Insights ingestion. - Enabled or Disabled
publicNetworkAccessForQuery enum No The network access type for accessing Application Insights query. - Enabled or Disabled

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Provision a function app on a Consumption plan

Deploy to Azure
This template provisions a function app on a Consumption plan, which is a dynamic hosting plan. The app runs on demand and you're billed per execution, with no standing resource committment. There are other templates available for provisioning on a dedicated hosting plan.
Deploy an Azure Function Premium plan with vnet integration

Deploy to Azure
This template allows you to deploy an Azure Function Premium plan with regional virtual network integration enabled to a newly created virtual network.
Creates a function app with managed service identity.

Deploy to Azure
Creates a function app with managed service identity enabled with Application Insights set up for logs and metrics.
Create an Azure Machine Learning service workspace.

Deploy to Azure
This template creates an Azure Machine Learning service workspace.
Create AML workspace with multiple Datasets & Datastores

Deploy to Azure
This template creates Azure Machine Learning workspace with multiple datasets & datastores.
Django app

Deploy to Azure
This template allows you to create an App Service for deploying a Django app.
ASP.NET app

Deploy to Azure
This template allows you to create an App Service for deploying a ASP.NET app.
Dynamic Web Test Creation

Deploy to Azure
Create any number of App Insights web (ping) tests.
Create Azure Front Door in front of Azure API Management

Deploy to Azure
This sample demonstrates how to use Azure Front Door as a global load balancer in front of Azure API Management.
Advanced template for Azure Machine Learning workspace

Deploy to Azure
A template that creates Azure Machine Learning workspace with private endpoints and resources behind VNET
Enable encryption at rest for Azure Machine Learning

Deploy to Azure
A template that creates a new Azure Machine Learning workspace. Optionally, you can enable encryption for data at rest in the workspace, and data stored by the workspace in Azure Cosmos DB.
Create an AKS compute target with a Private IP address.

Deploy to Azure
This template creates an AKS compute target in given Azure Machine Learning service workspace with a private IP address.
Provision a Web App with a SQL Database

Deploy to Azure
This template provisions a Web App, a SQL Database, AutoScale settings, Alert rules, and App Insights. It configures a connection string in the web app for the database.
Deploy Application Insight and create alert in it

Deploy to Azure
This template allows you to deploy Application Insight and create alert in it
Web App with a SQL Database, Azure Cosmos DB, Azure Search

Deploy to Azure
This template provisions a Web App, a SQL Database, Azure Cosmos DB, Azure Search and Application Insights.
ILB App Service Environment with Azure Firewall

Deploy to Azure
Resource Manager templates and parameters demonstrating how to deploy App Service environment with Azure Firewall integration
Enterprise Governance-AppService, SQL DB, AD, OMS, Runbooks

Deploy to Azure
Cloud adoption for an Enterprise, small or large, require responsible and efficient governance models to derive value from their cloud deployments. CloudWise (a code-name for the solution), is a composite solution available from Azure Partner QuickStarts, is an adoption enabler for Customers, System Integrators and Partners alike, that delivers a self-serviceable, automated governance and operations solution, focused on Optimizing Your Costs, Improve Your Application(s) Reliability, Reducing Business Risk. The solution highlights the core governance pillars of Visibility and Control.
eShop Website with ILB ASE

Deploy to Azure
An App Service Environment is a Premium service plan option of Azure App Service that provides a fully isolated and dedicated environment for securely running Azure App Service apps at high scale, including Web Apps, Mobile Apps, and API Apps.
Java CI/CD using Jenkins and Azure Web Apps

Deploy to Azure
This is a sample for Java CI/CD using Jenkins and Azure Web Apps.
Kentico MVC

Deploy to Azure
This template facilitates the deployment of resources required to host Kentico MVC environments in Microsoft Azure.
Scalable Umbraco CMS Web App

Deploy to Azure
This template provides a easy way to deploy umbraco CMS web app on Azure App Service Web Apps.
Simple Umbraco CMS Web App

Deploy to Azure
This template provides a easy way to deploy umbraco CMS web app on Azure App Service Web Apps.