openapi: 3.2.0
info:
  version: 2021-04-30-preview
  title: Microsoft Azure Automanage Best Practices API
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Best Practices
paths:
  /providers/Microsoft.Automanage/bestPractices/{bestPracticeName}:
    get:
      tags:
      - Best Practices
      operationId: microsoftAzureBestpracticesGet
      description: Get information about a Automanage best practice
      x-ms-examples:
        'Get an Automanage best practice ':
          $ref: ./examples/getBestPractice.json
      parameters:
      - name: bestPracticeName
        in: path
        required: true
        description: The Automanage best practice name.
        schema:
          type: string
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK. The Automanage best practice was returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BestPractice'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Get Providers Microsoft Automanage Bestpractices…
  /providers/Microsoft.Automanage/bestPractices:
    get:
      tags:
      - Best Practices
      operationId: microsoftAzureBestpracticesListbytenant
      description: Retrieve a list of Automanage best practices
      x-ms-examples:
        'List Automanage bestPractices ':
          $ref: ./examples/listBestPracticesByTenant.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK. List of Automanage bestPractices configuration profile.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BestPracticeList'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: null
      summary: Microsoft Azure Get Providers Microsoft Automanage Bestpractices
components:
  schemas:
    BestPracticeList:
      description: The response of the list best practice operation.
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/BestPractice'
          description: Result of the list best practice operation.
    ConfigurationDictionary:
      description: The custom configuration for configuration profile. Name and value pairs that define the configuration details of the configuration profile.
      type: object
      example:
        Antimalware/Enable: true
    BestPractice:
      description: Definition of the Automanage best practice.
      type: object
      x-ms-azure-resource: true
      properties:
        id:
          type: string
          description: The fully qualified ID for the best practice.  For example, /providers/Microsoft.Automanage/bestPractices/azureBestPracticesProduction
          readOnly: true
        type:
          type: string
          description: The type of the resource.  For example, Microsoft.Automanage/bestPractices
          readOnly: true
        name:
          type: string
          description: The name of the best practice. For example, azureBestPracticesProduction
          readOnly: true
        properties:
          title: Properties
          x-ms-client-flatten: true
          $ref: '#/components/schemas/ConfigurationProfileProperties'
          description: Properties of the best practice.
        systemData:
          $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
          readOnly: true
          description: Azure Resource Manager metadata containing createdBy and modifiedBy information.
    ConfigurationProfileProperties:
      description: Automanage configuration profile properties.
      type: object
      properties:
        configuration:
          title: configuration
          $ref: '#/components/schemas/ConfigurationDictionary'
          description: configuration dictionary of the configuration profile.
        overrides:
          title: overrides
          $ref: '#/components/schemas/Overrides'
          description: overrides of the configuration profile.
    Overrides:
      description: The custom overrides for configuration profile
      type: array
      items:
        type: object
      x-ms-identifiers: []
  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