Microsoft.OperationalInsights workspaces template reference

Template format

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

{
  "name": "string",
  "type": "Microsoft.OperationalInsights/workspaces",
  "apiVersion": "2020-03-01-preview",
  "tags": {},
  "location": "string",
  "properties": {
    "sku": {
      "name": "string"
    },
    "retentionInDays": "integer",
    "publicNetworkAccessForIngestion": "string",
    "publicNetworkAccessForQuery": "string"
  }
}

Property values

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

Microsoft.OperationalInsights/workspaces object

Name Type Required Value
name string Yes The name of the workspace.
type enum Yes Microsoft.OperationalInsights/workspaces
apiVersion enum Yes 2020-03-01-preview
tags object No Resource tags.
location string Yes The geo-location where the resource lives
properties object Yes Workspace properties. - WorkspaceProperties object

WorkspaceProperties object

Name Type Required Value
sku object No The SKU of the workspace. - WorkspaceSku object
retentionInDays integer No The workspace data retention in days. -1 means Unlimited retention for the Unlimited Sku. 730 days is the maximum allowed for all other Skus.
publicNetworkAccessForIngestion enum No The network access type for accessing Log Analytics ingestion. - Enabled or Disabled
publicNetworkAccessForQuery enum No The network access type for accessing Log Analytics query. - Enabled or Disabled

WorkspaceSku object

Name Type Required Value
name enum Yes The name of the SKU. - Free, Standard, Premium, PerNode, PerGB2018, Standalone, CapacityReservation

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create Azure Automation account

Deploy to Azure
This template provides an example of how create an Azure Automation account and links it to a new or existing Azure Monitor Log Analytics workspace.
Log Analytics based Monitoring solution for Azure Backup

Deploy to Azure
Azure backup solution using Log Analytics
Create Recovery Services Vault and Enable Diagnostics

Deploy to Azure
This template creates a Recovery Services Vault and enables diagnostics for Azure Backup. This also deploys storage account and oms workspace.
Azure Web App Monitoring

Deploy to Azure
Azure Web Apps Monitoring with Azure Log Analytics (OMS)
Create and monitor API Management instance with Operations Management Suite (OMS) - Log Analytics

Deploy to Azure
This template creates an instance of Azure API Management service and OMS workspace and sets up monitoring for your API Management service with Operations Management Suite - Log Analytics
Connect to a storage account from a VM via private endpoint

Deploy to Azure
This sample shows how to use connect a virtual network to access a blob storage account via private endpoint.
Connect to a Event Hubs namespace via private endpoint

Deploy to Azure
This sample shows how to use configure a virtual network and private DNS zone to access a Event Hubs namespace via a private endpoint.
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.
Connect to a Key Vault via private endpoint

Deploy to Azure
This sample shows how to use configure a virtual network and private DNS zone to access Key Vault via private endpoint.
Connect to a Service Bus namespace via private endpoint

Deploy to Azure
This sample shows how to use configure a virtual network and private DNS zone to access a Service Bus namespace via private endpoint.
Azure SQL Server with Auditing written to Log Analitics

Deploy to Azure
This template allows you to deploy an Azure SQL server with Auditing enabled to write audit logs to Log Analitics (OMS workspace)
Deploy Application Insight and create alert in it

Deploy to Azure
This template allows you to deploy Application Insight and create alert in it
OMS ASR Solution

Deploy to Azure
Enables the ASR (v2) Solution in OMS
CI/CD using Jenkins on Azure Virtual Machine Scale Sets

Deploy to Azure
This is a CI/CD sample using Jenkins and Terraform on Azure Virtual Machine Scale Sets
OMS Active Directory Security Audit Solution

Deploy to Azure
Active Directory Security Audit Solution
OMS Automation solution

Deploy to Azure
Azure Automation solution for OMS
Azure Network Security Group Analytics

Deploy to Azure
Azure Network Security Group Analytics with Azure Log Analytics (OMS)
OMS - Azure Resource Usage Solution

Deploy to Azure
Solution brings billing infortmation about Azure Resources into OMS. Cost of resources can be displayed in different currency and locale.
OMS - Azure VM Inventory Solution

Deploy to Azure
Enables Azure VM Inventory Solution in OMS. Solution collects Azure VM inventory along with disks, networking components, NSG rules and extensions into OMS workspace.
Add an existing storage account to OMS

Deploy to Azure
This template adds a storage account into OMS Log Analytics and select multiple tables for ingestion.
OMS Solution - Hyper-V Replica

Deploy to Azure
A template for creating an OMS solution to monitor Hyper-V replica.
OMS Kemp Application Delivery

Deploy to Azure
Kemp Application Delivery solution for OMS
OMS SCOM ACS Solution

Deploy to Azure
Adds the SCOM ACS custom Solution into an OMS Workspace
OMS Service Bus Solution

Deploy to Azure
Monitors Azure Service Bus instances
OMS VMM Analytics

Deploy to Azure
Provides a single view of the jobs' status across multiple VMM instances that helps you gain insight about the health & performance of these jobs.
S2D Management Solution

Deploy to Azure
Enables monitoring of S2D clusters with OMS.