Microsoft.OperationalInsights workspaces 2020-08-01
The workspaces resource type can be deployed to: Resource groups.
To learn about resource group deployments, see Bicep or ARM template.
Template format
To create a Microsoft.OperationalInsights/workspaces resource, add the following Bicep or JSON to your template.
resource symbolicname 'Microsoft.OperationalInsights/workspaces@2020-08-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
eTag: 'string'
properties: {
features: {}
forceCmkForQuery: bool
provisioningState: 'string'
publicNetworkAccessForIngestion: 'string'
publicNetworkAccessForQuery: 'string'
retentionInDays: int
sku: {
capacityReservationLevel: int
name: 'string'
}
workspaceCapping: {
dailyQuotaGb: int
}
}
}
Property values
workspaces
Name | Description | Value |
---|---|---|
type | The resource type For Bicep, set this value in the resource declaration. |
'Microsoft.OperationalInsights/workspaces' |
apiVersion | The resource api version For Bicep, set this value in the resource declaration. |
'2020-08-01' |
name | The resource name | string (required) Character limit: 4-63 Valid characters: Alphanumerics and hyphens. Start and end with alphanumeric. |
location | The geo-location where the resource lives | string (required) |
tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
eTag | The ETag of the workspace. | string |
properties | Workspace properties. | WorkspaceProperties |
WorkspaceProperties
Name | Description | Value |
---|---|---|
features | Workspace features. | object |
forceCmkForQuery | Indicates whether customer managed storage is mandatory for query management. | bool |
provisioningState | The provisioning state of the workspace. | 'Canceled' 'Creating' 'Deleting' 'Failed' 'ProvisioningAccount' 'Succeeded' 'Updating' |
publicNetworkAccessForIngestion | The network access type for operating on the Log Analytics Workspace. By default it is Enabled | 'Disabled' 'Enabled' |
publicNetworkAccessForQuery | The network access type for operating on the Log Analytics Workspace. By default it is Enabled | 'Disabled' 'Enabled' |
retentionInDays | The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. | int |
sku | The SKU (tier) of a workspace. | WorkspaceSku |
workspaceCapping | The daily volume cap for ingestion. | WorkspaceCapping |
WorkspaceSku
Name | Description | Value |
---|---|---|
capacityReservationLevel | The capacity reservation level for this workspace, when CapacityReservation sku is selected. | int |
name | The name of the SKU. | 'CapacityReservation' 'Free' 'LACluster' 'PerGB2018' 'PerNode' 'Premium' 'Standalone' 'Standard' |
WorkspaceCapping
Name | Description | Value |
---|---|---|
dailyQuotaGb | The workspace daily quota for ingestion. | int |
Quickstart templates
The following quickstart templates deploy this resource type.
Template | Description |
---|---|
CI/CD using Jenkins on Azure Virtual Machine Scale Sets |
This is a CI/CD sample using Jenkins and Terraform on Azure Virtual Machine Scale Sets |
Deploy Solace PubSub+ message broker onto Azure Linux VM(s) |
This template allows you to deploy either a standalone Solace PubSub+ message broker or a three node High Availability cluster of Solace PubSub+ message brokers onto Azure Linux VM(s). |
AKS Cluster with a NAT Gateway and an Application Gateway |
This sample shows how to a deploy an AKS cluster with NAT Gateway for outbound connections and an Application Gateway for inbound connections. |
OMS ASR Solution |
Enables the ASR (v2) Solution in OMS |
Log Analytics based Monitoring solution for Azure Backup |
Azure backup solution using Log Analytics |
OMS Active Directory Security Audit Solution |
Active Directory Security Audit Solution |
OMS Automation solution |
Azure Automation solution for OMS |
OMS - Azure Resource Usage Solution |
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 |
Enables Azure VM Inventory Solution in OMS. Solution collects Azure VM inventory along with disks, networking components, NSG rules and extensions into OMS workspace. |
Azure Network Security Group Analytics |
Azure Network Security Group Analytics with Azure Log Analytics (OMS) |
Add an existing storage account to OMS |
This template adds a storage account into OMS Log Analytics and select multiple tables for ingestion. |
OMS Solution - Hyper-V Replica |
A template for creating an OMS solution to monitor Hyper-V replica. |
OMS Kemp Application Delivery |
Kemp Application Delivery solution for OMS |
OMS SCOM ACS Solution |
Adds the SCOM ACS custom Solution into an OMS Workspace |
OMS Service Bus Solution |
Monitors Azure Service Bus instances |
OMS VMM Analytics |
Provides a single view of the jobs' status across multiple VMM instances that helps you gain insight about the health & performance of these jobs. |
Create a Private AKS Cluster |
This sample shows how to create a private AKS cluster in a virtual network along with a jumpbox virtual machine. |
Create a Private AKS Cluster with a Public DNS Zone |
This sample shows how to a deploy a private AKS cluster with a Public DNS Zone. |
S2D Management Solution |
Enables monitoring of S2D clusters with OMS. |
Create and monitor API Management instance |
This template creates an instance of Azure API Management service and Log Analytics workspace and sets up monitoring for your API Management service with Log Analytics |
Creates a two Container App with a Container App Environment |
Create a two Container App Environment with a basic Container App. It also deploys a Log Analytics Workspace to store logs. |
Creates a Container App within a Container App Environment. |
Create a Container App Environment with a basic Container App. It also deploys a Log Analytics Workspace to store logs. |
Create Azure Automation account |
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. |
Front Door Premium with WAF and Microsoft-managed rule sets |
This template creates a Front Door Premium including a web application firewall with the Microsoft-managed default and bot protection rule sets. |
Front Door Standard/Premium with WAF and custom rule |
This template creates a Front Door Standard/Premium including a web application firewall with a custom rule. |
Connect to a Event Hubs namespace via private endpoint |
This sample shows how to use configure a virtual network and private DNS zone to access a Event Hubs namespace via a private endpoint. |
Deploy Application Insight and create alert in it |
This template allows you to deploy Application Insight and create alert in it |
Log Analytics workspace with solutions and data sources |
Deploys a Log Analytics workspace with specified solutions and data sources |
Log Analytics workspace with VM Insights, Container Insights |
Deploys a Log Analytics workspace with VM Insights, Container Insights solutions and diagnostics. |
Connect to a Key Vault via private endpoint |
This sample shows how to use configure a virtual network and private DNS zone to access Key Vault via private endpoint. |
AKS cluster with the Application Gateway Ingress Controller |
This sample shows how to deploy an AKS cluster with Application Gateway, Application Gateway Ingress Controller, Azure Container Registry, Log Analytics and Key Vault |
Use Azure Firewall as a DNS Proxy in a Hub & Spoke topology |
This sample show how to deploy a hub-spoke topology in Azure using the Azure Firewall. The hub virtual network acts as a central point of connectivity to many spoke virtual networks that are connected to hub virtual network via virtual network peering. |
Create Azure Front Door in front of Azure API Management |
This sample demonstrates how to use Azure Front Door as a global load balancer in front of Azure API Management. |
Enable Microsoft Sentinel |
Enable Microsoft Sentinel, a scalable, cloud-native, security information event management (SIEM) and security orchestration automated response (SOAR) solution. |
Create Recovery Services Vault and Enable Diagnostics |
This template creates a Recovery Services Vault and enables diagnostics for Azure Backup. This also deploys storage account and oms workspace. |
Connect to a Service Bus namespace via private endpoint |
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 Analytics |
This template allows you to deploy an Azure SQL server with Auditing enabled to write audit logs to Log Analytics (OMS workspace) |
Create SQL MI with configured sending of logs and metrics. |
This template allows you to deploy SQL MI and additional resources used for storing logs and metrics (diagnostic workspace, storage account, event hub). |
Connect to a storage account from a VM via private endpoint |
This sample shows how to use connect a virtual network to access a blob storage account via private endpoint. |
Connect to an Azure File Share via a Private Endpoint |
This sample shows how to use configure a virtual network and private DNS zone to access an Azure File Share via a private endpoint. |
Application Gateway with internal API Management and Web App |
Application Gateway routing Internet traffic to a virtual network (internal mode) API Management instance which services a web API hosted in an Azure Web App. |
Web App w/ Application Insights sending to Log Analytics |
This template will is to help support the new API versions of microsoft.insights/components. Starting with 2020-02-02-preview WorkspaceID will be required when creating Application Inisghts.This template will deploy the App Service Plan, App Service, Application Insights, Log Analytics Workspace and hook it all together. |
Azure Web App Monitoring |
Azure Web Apps Monitoring with Azure Log Analytics (OMS) |