Microsoft.OperationsManagement solutions

Article
12/28/2022

Bicep resource definition

The solutions resource type can be deployed to:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.OperationsManagement/solutions resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.OperationsManagement/solutions@2015-11-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  plan: {
    name: 'string'
    product: 'string'
    promotionCode: 'string'
    publisher: 'string'
  }
  properties: {
    containedResources: [
      'string'
    ]
    referencedResources: [
      'string'
    ]
    workspaceResourceId: 'string'
  }
}

Property values

solutions

Name	Description	Value
name	The resource name	string (required) Character limit: N/A Valid characters: For solutions authored by Microsoft, the name must be in the pattern: `SolutionType(WorkspaceName)` For solutions authored by third parties, the name must be in the pattern: `SolutionType[WorkspaceName]` For example, a valid name is: `AntiMalware(contoso-IT)` The solution type is case-sensitive.
location	Resource location	string
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
plan	Plan for solution object supported by the OperationsManagement resource provider.	SolutionPlan
properties	Properties for solution object supported by the OperationsManagement resource provider.	SolutionProperties

SolutionPlan

Name	Description	Value
name	name of the solution to be created. For Microsoft published solution it should be in the format of solutionType(workspaceName). SolutionType part is case sensitive. For third party solution, it can be anything.	string
product	name of the solution to enabled/add. For Microsoft published gallery solution it should be in the format of OMSGallery/{solutionType}. This is case sensitive	string
promotionCode	promotionCode, Not really used now, can you left as empty	string
publisher	Publisher name. For gallery solution, it is Microsoft.	string

SolutionProperties

Name	Description	Value
containedResources	The azure resources that will be contained within the solutions. They will be locked and gets deleted automatically when the solution is deleted.	string[]
referencedResources	The resources that will be referenced from this solution. Deleting any of those solution out of band will break the solution.	string[]
workspaceResourceId	The azure resourceId for the workspace where the solution will be deployed/enabled.	string (required)

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
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.
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 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.
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.
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.
Enable Microsoft Sentinel	Enable Microsoft Sentinel, a scalable, cloud-native, security information event management (SIEM) and security orchestration automated response (SOAR) solution.
Azure Web App Monitoring	Azure Web Apps Monitoring with Azure Log Analytics (OMS)

ARM template resource definition

The solutions resource type can be deployed to:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.OperationsManagement/solutions resource, add the following JSON to your template.

{
  "type": "Microsoft.OperationsManagement/solutions",
  "apiVersion": "2015-11-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "plan": {
    "name": "string",
    "product": "string",
    "promotionCode": "string",
    "publisher": "string"
  },
  "properties": {
    "containedResources": [ "string" ],
    "referencedResources": [ "string" ],
    "workspaceResourceId": "string"
  }
}

Property values

solutions

Name	Description	Value
type	The resource type	'Microsoft.OperationsManagement/solutions'
apiVersion	The resource api version	'2015-11-01-preview'
name	The resource name	string (required) Character limit: N/A Valid characters: For solutions authored by Microsoft, the name must be in the pattern: `SolutionType(WorkspaceName)` For solutions authored by third parties, the name must be in the pattern: `SolutionType[WorkspaceName]` For example, a valid name is: `AntiMalware(contoso-IT)` The solution type is case-sensitive.
location	Resource location	string
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
plan	Plan for solution object supported by the OperationsManagement resource provider.	SolutionPlan
properties	Properties for solution object supported by the OperationsManagement resource provider.	SolutionProperties

SolutionPlan

Name	Description	Value
name	name of the solution to be created. For Microsoft published solution it should be in the format of solutionType(workspaceName). SolutionType part is case sensitive. For third party solution, it can be anything.	string
product	name of the solution to enabled/add. For Microsoft published gallery solution it should be in the format of OMSGallery/{solutionType}. This is case sensitive	string
promotionCode	promotionCode, Not really used now, can you left as empty	string
publisher	Publisher name. For gallery solution, it is Microsoft.	string

SolutionProperties

Name	Description	Value
containedResources	The azure resources that will be contained within the solutions. They will be locked and gets deleted automatically when the solution is deleted.	string[]
referencedResources	The resources that will be referenced from this solution. Deleting any of those solution out of band will break the solution.	string[]
workspaceResourceId	The azure resourceId for the workspace where the solution will be deployed/enabled.	string (required)

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
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.
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 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.
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.
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.
Enable Microsoft Sentinel	Enable Microsoft Sentinel, a scalable, cloud-native, security information event management (SIEM) and security orchestration automated response (SOAR) solution.
Azure Web App Monitoring	Azure Web Apps Monitoring with Azure Log Analytics (OMS)

Terraform (AzAPI provider) resource definition

The solutions resource type can be deployed to:

Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.OperationsManagement/solutions resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.OperationsManagement/solutions@2015-11-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      containedResources = [
        "string"
      ]
      referencedResources = [
        "string"
      ]
      workspaceResourceId = "string"
    }
    plan = {
      name = "string"
      product = "string"
      promotionCode = "string"
      publisher = "string"
    }
  })
}

Property values

solutions

Name	Description	Value
type	The resource type	"Microsoft.OperationsManagement/solutions@2015-11-01-preview"
name	The resource name	string (required) Character limit: N/A Valid characters: For solutions authored by Microsoft, the name must be in the pattern: `SolutionType(WorkspaceName)` For solutions authored by third parties, the name must be in the pattern: `SolutionType[WorkspaceName]` For example, a valid name is: `AntiMalware(contoso-IT)` The solution type is case-sensitive.
location	Resource location	string
parent_id	To deploy to a resource group, use the ID of that resource group.	string (required)
tags	Resource tags	Dictionary of tag names and values.
plan	Plan for solution object supported by the OperationsManagement resource provider.	SolutionPlan
properties	Properties for solution object supported by the OperationsManagement resource provider.	SolutionProperties

SolutionPlan

Name	Description	Value
name	name of the solution to be created. For Microsoft published solution it should be in the format of solutionType(workspaceName). SolutionType part is case sensitive. For third party solution, it can be anything.	string
product	name of the solution to enabled/add. For Microsoft published gallery solution it should be in the format of OMSGallery/{solutionType}. This is case sensitive	string
promotionCode	promotionCode, Not really used now, can you left as empty	string
publisher	Publisher name. For gallery solution, it is Microsoft.	string

SolutionProperties

Name	Description	Value
containedResources	The azure resources that will be contained within the solutions. They will be locked and gets deleted automatically when the solution is deleted.	string[]
referencedResources	The resources that will be referenced from this solution. Deleting any of those solution out of band will break the solution.	string[]
workspaceResourceId	The azure resourceId for the workspace where the solution will be deployed/enabled.	string (required)

Share via

Microsoft.OperationsManagement solutions

Bicep resource definition

Resource format

Property values

solutions

SolutionPlan

SolutionProperties

Quickstart templates

ARM template resource definition

Resource format

Property values

solutions

SolutionPlan

SolutionProperties

Quickstart templates

Terraform (AzAPI provider) resource definition

Resource format

Property values

solutions

SolutionPlan

SolutionProperties

Feedback

Additional resources