Microsoft Azure Advisor

Azure Advisor REST API

Azure Advisor REST API provides personalized recommendations for optimizing Azure deployments across reliability, security, performance, cost, and operational excellence. It supports retrieving recommendations, suppressing alerts, and configuring recommendation settings.

GitHub OpenAPI

Documentation

📖
Documentation
https://learn.microsoft.com/en-us/rest/api/advisor/
📖
APIReference
https://learn.microsoft.com/en-us/rest/api/advisor/operation-groups
📖
Authentication
https://learn.microsoft.com/en-us/azure/active-directory/develop/authentication-vs-authorization

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-advisor/refs/heads/main/openapi/microsoft-azure-advisor-openapi.yml

SDKs

📦
SDK
https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/advisor

OpenAPI Specification

microsoft-azure-advisor-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Azure Advisor REST API
  description: Azure Advisor is a personalized cloud consultant providing best-practice recommendations
    for cost, performance, security, reliability, and operational excellence across Azure deployments.
    The REST API enables programmatic listing, retrieval, and management of recommendations and configuration
    settings.
  version: '2024-01-01'
externalDocs:
  description: Azure Advisor REST API Documentation
  url: https://learn.microsoft.com/en-us/rest/api/advisor/
servers:
- url: https://management.azure.com
  description: Azure Resource Manager
tags:
- name: Recommendations
  description: Recommendations operations
- name: Suppressions
  description: Suppressions operations
- name: Configurations
  description: Configurations operations
- name: Operations
  description: Operations operations
security:
- azure_auth:
  - user_impersonation
paths:
  /providers/Microsoft.Advisor/operations:
    get:
      operationId: listOperations
      summary: Azure Advisor REST API List operations
      description: Lists all available REST API operations for Microsoft.Advisor.
      tags:
      - Operations
      parameters:
      - $ref: '#/components/parameters/apiVersion'
      responses:
        '200':
          description: Operations list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationList'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/recommendations:
    get:
      operationId: listRecommendationsBySubscription
      summary: Azure Advisor REST API List by subscription
      description: Lists all recommendations resources within the specified subscription.
      tags:
      - Recommendations
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/apiVersion'
      responses:
        '200':
          description: Resource list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceList'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Advisor/recommendations:
    get:
      operationId: listRecommendationsByResourceGroup
      summary: Azure Advisor REST API List by resource group
      description: Lists all recommendations resources within the specified resource group.
      tags:
      - Recommendations
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - $ref: '#/components/parameters/apiVersion'
      responses:
        '200':
          description: Resource list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceList'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Advisor/recommendations/{name}:
    parameters:
    - $ref: '#/components/parameters/subscriptionId'
    - $ref: '#/components/parameters/resourceGroupName'
    - name: name
      in: path
      required: true
      description: Name of the resource.
      schema:
        type: string
    - $ref: '#/components/parameters/apiVersion'
    get:
      operationId: getRecommendations
      summary: Azure Advisor REST API Get resource
      description: Gets a specific recommendations resource.
      tags:
      - Recommendations
      responses:
        '200':
          description: Resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Resource'
        '404':
          description: Not found
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    put:
      operationId: createOrUpdateRecommendations
      summary: Azure Advisor REST API Create or update resource
      description: Creates or updates a recommendations resource.
      tags:
      - Recommendations
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Resource'
      responses:
        '200':
          description: Resource updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Resource'
        '201':
          description: Resource created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Resource'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    patch:
      operationId: updateRecommendations
      summary: Azure Advisor REST API Update resource
      description: Updates a recommendations resource.
      tags:
      - Recommendations
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
      responses:
        '200':
          description: Resource updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Resource'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    delete:
      operationId: deleteRecommendations
      summary: Azure Advisor REST API Delete resource
      description: Deletes a recommendations resource.
      tags:
      - Recommendations
      responses:
        '200':
          description: Resource deleted
        '202':
          description: Deletion accepted
        '204':
          description: Resource not found or already deleted
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  parameters:
    subscriptionId:
      name: subscriptionId
      in: path
      required: true
      description: The ID of the target subscription.
      schema:
        type: string
    resourceGroupName:
      name: resourceGroupName
      in: path
      required: true
      description: The name of the resource group.
      schema:
        type: string
    apiVersion:
      name: api-version
      in: query
      required: true
      description: The API version to use for this operation.
      schema:
        type: string
  schemas:
    Resource:
      type: object
      properties:
        id:
          type: string
          description: Resource ID.
        name:
          type: string
          description: Resource name.
        type:
          type: string
          description: Resource type.
        location:
          type: string
          description: Resource location.
        tags:
          type: object
          additionalProperties:
            type: string
        properties:
          type: object
          description: Resource-specific properties.
    ResourceList:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/Resource'
        nextLink:
          type: string
          description: URL to the next page of results.
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            target:
              type: string
    Operation:
      type: object
      properties:
        name:
          type: string
        display:
          type: object
          properties:
            provider:
              type: string
            resource:
              type: string
            operation:
              type: string
            description:
              type: string
        isDataAction:
          type: boolean
    OperationList:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/Operation'
        nextLink:
          type: string
  securitySchemes:
    azure_auth:
      type: oauth2
      description: Azure Active Directory OAuth2 Flow.
      flows:
        implicit:
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
          scopes:
            user_impersonation: Impersonate your user account
x-generated-from: https://learn.microsoft.com/en-us/rest/api/advisor/
x-generated-by: claude-crawl-2026-05-08