Share via

Microsoft.OperationsManagement solutions

  • Article

Bicep resource definition

The solutions resource type can be deployed with operations that target:

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' = {
  location: 'string'
  name: 'string'
  plan: {
    name: 'string'
    product: 'string'
    promotionCode: 'string'
    publisher: 'string'
  }
  properties: {
    containedResources: [
      'string'
    ]
    referencedResources: [
      'string'
    ]
    workspaceResourceId: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

Microsoft.OperationsManagement/solutions

Name Description Value
location Resource location string
name The resource name string (required)
plan Plan for solution object supported by the OperationsManagement resource provider. SolutionPlan
properties Properties for solution object supported by the OperationsManagement resource provider. SolutionProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

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)

SolutionTags

Name Description Value

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File Description
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.
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
Enable Microsoft Sentinel Enable Microsoft Sentinel, a scalable, cloud-native, security information event management (SIEM) and security orchestration automated response (SOAR) solution.
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.
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.

ARM template resource definition

The solutions resource type can be deployed with operations that target:

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",
  "plan": {
    "name": "string",
    "product": "string",
    "promotionCode": "string",
    "publisher": "string"
  },
  "properties": {
    "containedResources": [ "string" ],
    "referencedResources": [ "string" ],
    "workspaceResourceId": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

Microsoft.OperationsManagement/solutions

Name Description Value
apiVersion The api version '2015-11-01-preview'
location Resource location string
name The resource name string (required)
plan Plan for solution object supported by the OperationsManagement resource provider. SolutionPlan
properties Properties for solution object supported by the OperationsManagement resource provider. SolutionProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.OperationsManagement/solutions'

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)

SolutionTags

Name Description Value

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
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.
AKS Cluster with a NAT Gateway and an Application Gateway

Deploy to Azure		 This sample shows how to a deploy an AKS cluster with NAT Gateway for outbound connections and an Application Gateway for inbound connections.
AKS cluster with the Application Gateway Ingress Controller

Deploy to Azure		 This sample shows how to deploy an AKS cluster with Application Gateway, Application Gateway Ingress Controller, Azure Container Registry, Log Analytics and Key Vault
Create a Private AKS Cluster with a Public DNS Zone

Deploy to Azure		 This sample shows how to a deploy a private AKS cluster with a Public DNS Zone.
Deploy Solace PubSub+ message broker onto Azure Linux VM(s)

Deploy to Azure		 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).
Enable Microsoft Sentinel

Deploy to Azure		 Enable Microsoft Sentinel, a scalable, cloud-native, security information event management (SIEM) and security orchestration automated response (SOAR) solution.
Log Analytics workspace with solutions and data sources

Deploy to Azure		 Deploys a Log Analytics workspace with specified solutions and data sources
Log Analytics workspace with VM Insights, Container Insights

Deploy to Azure		 Deploys a Log Analytics workspace with VM Insights, Container Insights solutions and diagnostics.
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.
OMS Automation solution

Deploy to Azure		 Azure Automation solution for OMS
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 Solution - Hyper-V Replica

Deploy to Azure		 A template for creating an OMS solution to monitor Hyper-V replica.
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.
Use Azure Firewall as a DNS Proxy in a Hub & Spoke topology

Deploy to Azure		 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.

Terraform (AzAPI provider) resource definition

The solutions resource type can be deployed with operations that target:

  • 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"
  plan = {
    name = "string"
    product = "string"
    promotionCode = "string"
    publisher = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      containedResources = [
        "string"
      ]
      referencedResources = [
        "string"
      ]
      workspaceResourceId = "string"
    }
  })
}

Property values

Microsoft.OperationsManagement/solutions

Name Description Value
location Resource location string
name The resource name string (required)
plan Plan for solution object supported by the OperationsManagement resource provider. SolutionPlan
properties Properties for solution object supported by the OperationsManagement resource provider. SolutionProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.OperationsManagement/solutions@2015-11-01-preview"

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)

SolutionTags

Name Description Value