Microsoft Azure Advisor Metadata Entities API

openapi: 3.2.0
info:
  title: Microsoft Azure Advisor Metadata Entities API
  version: '2026-10-01'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
  description: 'Operations tagged MetadataEntities 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: MetadataEntities
paths:
  /providers/Microsoft.Advisor/metadata:
    get:
      operationId: RecommendationMetadata_List
      tags:
      - MetadataEntities
      description: Gets the list of metadata entities.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
      - name: $filter
        in: query
        description: 'The filter to apply to the recommendation metadata.<br>Filter can be applied to properties [''[recommendationCategory](#category)'', ''[recommendationSubCategory](#recommendationSubCategory)'', ''RetirementDate''] with operators [''eq'', ''and'', ''le'', ''ge'']<br>The filter can also be applied to property [''[TrackingIds]'']<br><br>⚠ **Note:** `recommendationControl` is a legacy filter property and will be deprecated in the future. Please use `recommendationSubCategory` for filtering recommendation subcategory.<br><br>Valid options for recommendationSubCategory: [''BusinessContinuity'', ''DisasterRecovery'', ''HighAvailability'', ''MonitoringAndAlerting'', ''Other'', ''Personalized'', ''PrioritizedRecommendations'', ''Scalability'', ''ServiceUpgradeAndRetirement'', ''Validation'']<br><br>Example:<br>- $filter=recommendationCategory eq ''HighAvailability'' and recommendationSubCategory eq ''ServiceUpgradeAndRetirement'' and retirementDate ge ''2024-01-01'' and retirementDate le ''2028-01-01''. Filter can be applied on trackingIds as well.<br>- $filter=trackingIds/any(t: t eq ''some-guid'')<br><br>⚠ **Note:** `trackingIDs` filter can be used for filtering one value at a time. The support to filter multiple values is not currently available. Also the support to add other filters along with `trackingIDs` is not available.'
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetadataEntityListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArmErrorResponse'
      x-ms-examples:
        GetMetadata:
          $ref: ./examples/ListRecommendationMetadata.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Recommendation metadata list
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  /providers/Microsoft.Advisor/metadata/{name}:
    get:
      operationId: RecommendationMetadata_Get
      tags:
      - MetadataEntities
      description: Gets the metadata entity.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
      - name: name
        in: path
        description: Name of metadata entity.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetadataEntity'
        '404':
          description: The server cannot find the requested resource.
          x-ms-error-response: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARMErrorResponseBody'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArmErrorResponse'
      x-ms-examples:
        GetMetadata:
          $ref: ./examples/GetRecommendationMetadataEntity.json
      summary: Recommendation metadata get
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
components:
  schemas:
    ArmErrorResponse:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ARMErrorResponseBody'
          description: ARM error response body.
    Scenario:
      type: string
      description: The list of scenarios applicable to this metadata entity.
      enum:
      - Alerts
      x-ms-enum:
        name: Scenario
        modelAsString: true
        values:
        - name: Alerts
          value: Alerts
    MetadataEntityListResult:
      type: object
      description: The response of a MetadataEntity list operation.
      properties:
        value:
          type: array
          description: The MetadataEntity items on this page
          items:
            $ref: '#/components/schemas/MetadataEntity'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    MetadataEntity:
      type: object
      description: The metadata entity contract.
      properties:
        properties:
          $ref: '#/components/schemas/MetadataEntityProperties'
          description: The metadata entity properties.
          x-ms-client-flatten: true
      allOf:
      - $ref: ../../../../../../common-types/resource-management/v4/types.json#/definitions/ProxyResource
    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.
    MetadataSupportedValueDetail:
      type: object
      description: The metadata supported value detail.
      properties:
        id:
          type: string
          description: The id.
        displayName:
          type: string
          description: The display name.
    MetadataEntityProperties:
      type: object
      description: The metadata entity properties
      properties:
        displayName:
          type: string
          description: The display name.
        dependsOn:
          type: array
          description: The list of keys on which this entity depends on.
          items:
            type: string
        applicableScenarios:
          type: array
          description: The list of scenarios applicable to this metadata entity.
          items:
            $ref: '#/components/schemas/Scenario'
        supportedValues:
          type: array
          description: The list of supported values.
          items:
            $ref: '#/components/schemas/MetadataSupportedValueDetail'
  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