Microsoft Azure Advisor Subscriptions API

openapi: 3.2.0
info:
  title: Microsoft Azure Advisor Subscriptions API
  version: '2026-10-01'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
  description: 'Operations tagged Subscriptions across 2 of this provider''s published API definitions: microsoft-azure-advisor-2026-10-01-openapi.json, microsoft-azure-advisor-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Subscriptions
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/configurations:
    get:
      operationId: Configurations_ListBySubscription
      summary: Retrieve Azure Advisor configurations
      description: Retrieve Azure Advisor configurations and also retrieve configurations of contained resource groups.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArmErrorResponse'
      x-ms-examples:
        GetConfigurations:
          $ref: ./examples/ListConfigurations_ListBySubscription.json
      x-ms-pageable:
        nextLinkName: nextLink
      tags:
      - Subscriptions
    servers:
    - url: https://management.azure.com
  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/configurations/{configurationName}:
    put:
      operationId: Configurations_CreateInSubscription
      summary: Create/Overwrite Azure Advisor configuration
      description: Create/Overwrite Azure Advisor configuration and also delete all configurations of contained resource groups.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter
      - name: configurationName
        in: path
        description: Advisor configuration name. Value must be 'default'
        required: true
        x-ms-enum:
          name: ConfigurationName
          modelAsString: true
          values:
          - name: default
            value: default
        schema:
          type: string
          enum:
          - default
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigData'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArmErrorResponse'
      x-ms-examples:
        PutConfigurations:
          $ref: ./examples/CreateConfiguration_CreateInSubscription.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigData'
        description: The Azure Advisor configuration data structure.
        required: true
      tags:
      - Subscriptions
    servers:
    - url: https://management.azure.com
  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/generateRecommendations:
    post:
      operationId: Recommendations_Generate
      summary: Initiates the recommendation generation or computation process for a…
      description: Initiates the recommendation generation or computation process for a subscription. This operation is asynchronous. The generated recommendations are stored in a cache in the Advisor service.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter
      responses:
        '202':
          description: The request has been accepted for processing, but processing has not yet completed.
          headers:
            Location:
              description: The URL where the status of the asynchronous operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArmErrorResponse'
      x-ms-examples:
        GenerateRecommendations:
          $ref: ./examples/GenerateRecommendations.json
      tags:
      - Subscriptions
    servers:
    - url: https://management.azure.com
  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/generateRecommendations/{operationId}:
    get:
      operationId: Recommendations_GetGenerateStatus
      summary: Retrieves the status of the recommendation computation or generation process.
      description: Retrieves the status of the recommendation computation or generation process. Invoke this API after calling the generation recommendation. The URI of this API is returned in the Location field of the response header.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter
      - name: operationId
        in: path
        description: The operation ID, which can be found from the Location field in the generate recommendation response header.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '202':
          description: Resource operation accepted.
          headers:
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        '204':
          description: There is no content to send for this request, but the headers may be useful.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArmErrorResponse'
      x-ms-examples:
        GetGenerateStatus:
          $ref: ./examples/EmptyResponse.json
      tags:
      - Subscriptions
    servers:
    - url: https://management.azure.com
  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/predict:
    post:
      operationId: Predict
      description: Predicts a recommendation.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PredictionResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArmErrorResponse'
      x-ms-examples:
        Predict:
          $ref: ./examples/Predict.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PredictionRequest'
        description: The request body
        required: true
      tags:
      - Subscriptions
      summary: Predict
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/suppressions:
    get:
      operationId: Suppressions_List
      description: Retrieves the list of snoozed or dismissed suppressions for a subscription. The snoozed or dismissed attribute of a recommendation is referred to as a suppression.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter
      - name: $top
        in: query
        description: The number of suppressions per page if a paged version of this API is being used.
        required: false
        schema:
          type: integer
          format: int32
      - name: $skipToken
        in: query
        description: The page-continuation token to use with a paged version of this API.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuppressionContractListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArmErrorResponse'
      x-ms-examples:
        ListSuppressions:
          $ref: ./examples/ListSuppressions.json
      x-ms-pageable:
        nextLinkName: nextLink
      tags:
      - Subscriptions
      summary: Suppressions list
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Advisor/configurations:
    get:
      operationId: Configurations_ListByResourceGroup
      summary: Retrieve Azure Advisor configurations
      description: Retrieve Azure Advisor configurations.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter
      - name: resourceGroup
        in: path
        description: The name of the Azure resource group.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArmErrorResponse'
      x-ms-examples:
        GetConfigurations:
          $ref: ./examples/ListConfigurations.json
      x-ms-pageable:
        nextLinkName: nextLink
      tags:
      - Subscriptions
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Advisor/configurations/{configurationName}
  : put:
      operationId: Configurations_CreateInResourceGroup
      summary: Create/Overwrite Azure Advisor configuration
      description: Create/Overwrite Azure Advisor configuration.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter
      - name: configurationName
        in: path
        description: Advisor configuration name. Value must be 'default'
        required: true
        x-ms-enum:
          name: ConfigurationName
          modelAsString: true
          values:
          - name: default
            value: default
        schema:
          type: string
          enum:
          - default
      - name: resourceGroup
        in: path
        description: The name of the Azure resource group.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigData'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArmErrorResponse'
      x-ms-examples:
        PutConfigurations:
          $ref: ./examples/CreateConfiguration.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigData'
        description: The Azure Advisor configuration data structure.
        required: true
      tags:
      - Subscriptions
    servers:
    - url: https://management.azure.com
components:
  schemas:
    PredictionRequestProperties:
      type: object
      description: Properties given for the predictor.
      properties:
        predictionType:
          $ref: '#/components/schemas/PredictionType'
          description: Type of the prediction.
        extendedProperties:
          description: Extended properties are arguments specific for each prediction type.
    DigestConfigState:
      type: string
      description: State of digest configuration.
      enum:
      - Active
      - Disabled
      x-ms-enum:
        name: DigestConfigState
        modelAsString: true
        values:
        - name: Active
          value: Active
        - name: Disabled
          value: Disabled
    Impact:
      type: string
      description: The business impact of the recommendation.
      enum:
      - High
      - Medium
      - Low
      x-ms-enum:
        name: Impact
        modelAsString: true
        values:
        - name: High
          value: High
        - name: Medium
          value: Medium
        - name: Low
          value: Low
    Duration:
      type: string
      description: 'Minimum duration for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 7 (default), 14, 21, 30, 60 or 90.'
      enum:
      - '7'
      - '14'
      - '21'
      - '30'
      - '60'
      - '90'
      x-ms-enum:
        name: Duration
        modelAsString: true
        values:
        - name: '7'
          value: '7'
        - name: '14'
          value: '14'
        - name: '21'
          value: '21'
        - name: '30'
          value: '30'
        - name: '60'
          value: '60'
        - name: '90'
          value: '90'
    DigestConfig:
      type: object
      description: Advisor Digest configuration entity
      properties:
        name:
          type: string
          description: Name of digest configuration. Value is case-insensitive and must be unique within a subscription.
        actionGroupResourceId:
          type: string
          description: Action group resource id used by digest.
        frequency:
          type: integer
          format: int32
          description: Frequency that digest will be triggered, in days. Value must be between 7 and 30 days inclusive.
        categories:
          type: array
          description: Categories to send digest for. If categories are not provided, then digest will be sent for all categories.
          items:
            $ref: '#/components/schemas/Category'
        language:
          type: string
          description: Language for digest content body. Value must be ISO 639-1 code for one of Azure portal supported languages. Otherwise, it will be converted into one. Default value is English (en).
        state:
          $ref: '#/components/schemas/DigestConfigState'
          description: State of digest configuration.
    PredictionResponse:
      type: object
      description: Response used by predictions.
      properties:
        properties:
          $ref: '#/components/schemas/PredictionResponseProperties'
          description: The properties of the prediction.
          x-ms-client-flatten: true
    CpuThreshold:
      type: string
      description: 'Minimum percentage threshold for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 5 (default), 10, 15 or 20.'
      enum:
      - '5'
      - '10'
      - '15'
      - '20'
      x-ms-enum:
        name: CpuThreshold
        modelAsString: true
        values:
        - name: '5'
          value: '5'
        - name: '10'
          value: '10'
        - name: '15'
          value: '15'
        - name: '20'
          value: '20'
    SuppressionContract:
      type: object
      description: The details of the snoozed or dismissed rule; for example, the duration, name, and GUID associated with the rule.
      properties:
        properties:
          $ref: '#/components/schemas/SuppressionProperties'
          description: The properties of the suppression.
          x-ms-client-flatten: true
      allOf:
      - $ref: ../../../../../../common-types/resource-management/v4/types.json#/definitions/ProxyResource
    SuppressionProperties:
      type: object
      description: The properties of the suppression.
      properties:
        suppressionId:
          type: string
          description: The GUID of the suppression.
        ttl:
          type: string
          description: The duration for which the suppression is valid.
        expirationTimeStamp:
          type: string
          format: date-time
          description: Gets or sets the expiration time stamp.
          readOnly: true
    ArmErrorResponse:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ARMErrorResponseBody'
          description: ARM error response body.
    ConfigurationListResult:
      type: object
      description: Paged collection of ConfigData items
      properties:
        value:
          type: array
          description: The ConfigData items on this page
          items:
            $ref: '#/components/schemas/ConfigData'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    ShortDescription:
      type: object
      description: A summary of the recommendation.
      properties:
        problem:
          type: string
          description: The issue or opportunity identified by the recommendation and proposed solution.
        solution:
          type: string
          description: The issue or opportunity identified by the recommendation and proposed solution.
    SuppressionContractListResult:
      type: object
      description: The response of a SuppressionContract list operation.
      properties:
        value:
          type: array
          description: The SuppressionContract items on this page
          items:
            $ref: '#/components/schemas/SuppressionContract'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    PredictionRequest:
      type: object
      description: Parameters for predict recommendation.
      properties:
        properties:
          $ref: '#/components/schemas/PredictionRequestProperties'
          description: Request properties for prediction recommendation.
          x-ms-client-flatten: true
    ARMErrorResponseBody:
      type: object
      description: ARM error response body.
      properties:
        message:
          type: string
          description: Gets or sets the string that describes the error in detail and provides debugging information.
        code:
          type: string
          description: Gets or sets the string that can be used to programmatically identify the error.
    Category:
      type: string
      description: The category of the recommendation.
      enum:
      - HighAvailability
      - Security
      - Performance
      - Cost
      - OperationalExcellence
      x-ms-enum:
        name: Category
        modelAsString: true
        values:
        - name: HighAvailability
          value: HighAvailability
        - name: Security
          value: Security
        - name: Performance
          value: Performance
        - name: Cost
          value: Cost
        - name: OperationalExcellence
          value: OperationalExcellence
    PredictionType:
      type: string
      description: Type of the prediction.
      enum:
      - PredictiveRightsizing
      x-ms-enum:
        name: PredictionType
        modelAsString: true
        values:
        - name: PredictiveRightsizing
          value: PredictiveRightsizing
    ConfigData:
      type: object
      description: The Advisor configuration data structure.
      properties:
        properties:
          $ref: '#/components/schemas/ConfigDataProperties'
          description: The Advisor configuration data structure.
          x-ms-client-flatten: true
      allOf:
      - $ref: ../../../../../../common-types/resource-management/v4/types.json#/definitions/Resource
    ConfigDataProperties:
      type: object
      description: Configuration data properties
      properties:
        exclude:
          type: boolean
          description: 'Exclude the resource from Advisor evaluations. Valid values: False (default) or True.'
        lowCpuThreshold:
          $ref: '#/components/schemas/CpuThreshold'
          description: 'Minimum percentage threshold for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 5 (default), 10, 15 or 20.'
        duration:
          $ref: '#/components/schemas/Duration'
          description: 'Minimum duration for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 7 (default), 14, 21, 30, 60 or 90.'
        digests:
          type: array
          description: Advisor digest configuration. Valid only for subscriptions
          items:
            $ref: '#/components/schemas/DigestConfig'
          x-ms-identifiers:
          - name
    PredictionResponseProperties:
      type: object
      description: Properties of the prediction
      properties:
        extendedProperties:
          description: Extended properties
        predictionType:
          $ref: '#/components/schemas/PredictionType'
          description: Type of the prediction.
        category:
          $ref: '#/components/schemas/Category'
          description: The category of the recommendation.
        impact:
          $ref: '#/components/schemas/Impact'
          description: The business impact of the recommendation.
        impactedField:
          type: string
          description: The resource type identified by Advisor.
        lastUpdated:
          type: string
          format: date-time
          description: The most recent time that Advisor checked the validity of the recommendation.
        shortDescription:
          $ref: '#/components/schemas/ShortDescription'
          description: A summary of the recommendation.
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.
x-refined-from:
- microsoft-azure-advisor-2026-10-01-openapi.json
- microsoft-azure-advisor-openapi.yml