Microsoft Azure
Microsoft Azure Solution API

The Solution API from Microsoft Azure — 3 operation(s) for solution.
Documentation GitHub OpenAPI
OpenAPI Specification

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Solution API
schemes:
- https
tags:
- name: Solution
paths:
  ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationsManagement/solutions/{solutionName}
  : put:
      tags:
      - Solution
      x-ms-examples:
        SolutionCreate:
          $ref: ./examples/SolutionCreate.json
      x-ms-long-running-operation: true
      operationId: microsoftAzureSolutionsCreateorupdate
      summary: Microsoft Azure Create Update Solution
      description: Creates or updates the Solution.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SolutionNameParameter'
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/Solution'
        description: The parameters required to create OMS Solution.
      responses:
        '201':
          description: Created response definition.
          schema:
            $ref: '#/definitions/Solution'
        default:
          schema:
            $ref: '#/definitions/CodeMessageError'
          description: Error response definition.
    patch:
      tags:
      - Solution
      x-ms-examples:
        SolutionUpdate:
          $ref: ./examples/SolutionUpdate.json
      x-ms-long-running-operation: true
      operationId: microsoftAzureSolutionsUpdate
      summary: Microsoft Azure Patch A Solution
      description: Patch a Solution. Only updating tags supported.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SolutionNameParameter'
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/SolutionPatch'
        description: The parameters required to patch a Solution.
      responses:
        '200':
          description: Patch succeeded.
          schema:
            $ref: '#/definitions/Solution'
        default:
          schema:
            $ref: '#/definitions/CodeMessageError'
          description: Error response definition.
    delete:
      tags:
      - Solution
      x-ms-examples:
        SolutionDelete:
          $ref: ./examples/SolutionDelete.json
      x-ms-long-running-operation: true
      operationId: microsoftAzureSolutionsDelete
      summary: Microsoft Azure Deletes The Solution
      description: Deletes the solution in the subscription.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/SolutionNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK response definition.
        default:
          schema:
            $ref: '#/definitions/CodeMessageError'
          description: Error response definition.
    get:
      tags:
      - Solution
      operationId: microsoftAzureSolutionsGet
      x-ms-examples:
        SolutionGet:
          $ref: ./examples/SolutionGet.json
      summary: Microsoft Azure Retrieve Solution
      description: Retrieves the user solution.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/SolutionNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK response definition.
          schema:
            $ref: '#/definitions/Solution'
        default:
          schema:
            $ref: '#/definitions/CodeMessageError'
          description: Error response definition.
  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationsManagement/solutions:
    get:
      tags:
      - Solution
      operationId: microsoftAzureSolutionsListbyresourcegroup
      x-ms-examples:
        SolutionList:
          $ref: ./examples/SolutionList.json
      summary: Microsoft Azure Retrieves The Solution List For The Subscription
      description: Retrieves the solution list. It will retrieve both first party and third party solutions
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK response definition.
          schema:
            $ref: '#/definitions/SolutionPropertiesList'
        default:
          schema:
            $ref: '#/definitions/CodeMessageError'
          description: Error response definition.
  /subscriptions/{subscriptionId}/providers/Microsoft.OperationsManagement/solutions:
    get:
      tags:
      - Solution
      operationId: microsoftAzureSolutionsListbysubscription
      x-ms-examples:
        SolutionList:
          $ref: ./examples/SolutionListForSubscription.json
      summary: Microsoft Azure Retrieves The Solution List For The Subscription
      description: Retrieves the solution list. It will retrieve both first party and third party solutions
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK response definition.
          schema:
            $ref: '#/definitions/SolutionPropertiesList'
        default:
          schema:
            $ref: '#/definitions/CodeMessageError'
          description: Error response definition.
definitions:
  SolutionPlan:
    description: Plan for solution object supported by the OperationsManagement resource provider.
    properties:
      name:
        type: string
        description: 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.
      publisher:
        type: string
        description: Publisher name. For gallery solution, it is Microsoft.
      promotionCode:
        type: string
        description: promotionCode, Not really used now, can you left as empty
      product:
        type: string
        description: 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
  SolutionPatch:
    properties:
      tags:
        type: object
        additionalProperties:
          type: string
        description: Resource tags
    description: The properties of a Solution that can be patched.
    x-ms-azure-resource: true
  SolutionProperties:
    description: Solution properties supported by the OperationsManagement resource provider.
    properties:
      workspaceResourceId:
        type: string
        description: The azure resourceId for the workspace where the solution will be deployed/enabled.
      provisioningState:
        type: string
        description: The provisioning state for the solution.
        readOnly: true
      containedResources:
        type: array
        items:
          type: string
          description: the azure resourceId of the resource.
        description: The azure resources that will be contained within the solutions. They will be locked and gets deleted automatically when the solution is deleted.
      referencedResources:
        type: array
        items:
          type: string
          description: the azure resourceId of the resource.
        description: The resources that will be referenced from this solution. Deleting any of those solution out of band will break the solution.
    required:
    - workspaceResourceId
    x-ms-azure-resource: true
  CodeMessageError:
    properties:
      error:
        type: object
        properties:
          code:
            type: string
            description: The error type.
          message:
            type: string
            description: The error message.
        description: The error details for a failed request.
    description: The error body contract.
  Solution:
    properties:
      id:
        readOnly: true
        type: string
        description: Resource ID.
      name:
        readOnly: true
        type: string
        description: Resource name.
      type:
        readOnly: true
        type: string
        description: Resource type.
      location:
        type: string
        description: Resource location
      tags:
        type: object
        additionalProperties:
          type: string
        description: Resource tags
      plan:
        description: Plan for solution object supported by the OperationsManagement resource provider.
        $ref: '#/definitions/SolutionPlan'
      properties:
        description: Properties for solution object supported by the OperationsManagement resource provider.
        $ref: '#/definitions/SolutionProperties'
    description: The container for solution.
    x-ms-azure-resource: true
  SolutionPropertiesList:
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/Solution'
        description: List of solution properties within the subscription.
    description: the list of solution response
parameters:
  SolutionNameParameter:
    x-ms-parameter-location: method
    name: solutionName
    in: path
    required: true
    type: string
    description: User Solution Name.
  ResourceGroupNameParameter:
    name: resourceGroupName
    in: path
    required: true
    type: string
    x-ms-parameter-location: method
    description: The name of the resource group to get. The name is case insensitive.
    pattern: ^[-\w\._\(\)]+$
    minLength: 1
    maxLength: 90
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: Client Api Version.
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    required: true
    type: string
    description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'
Microsoft Azure Solution API

Documentation

Specifications

Other Resources

OpenAPI Specification
