swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Metadata API
schemes:
- https
tags:
- name: Metadata
paths:
  /providers/Microsoft.ResourceHealth/metadata:
    get:
      tags:
      - Metadata
      operationId: microsoftAzureMetadataList
      description: Gets the list of metadata entities.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK. Successfully retrieved metadata entities
          schema:
            $ref: '#/definitions/MetadataEntityListResult'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        GetMetadata:
          $ref: ./examples/Metadata_List.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Providers Microsoft Resourcehealth Metadata
  /providers/Microsoft.ResourceHealth/metadata/{name}:
    get:
      tags:
      - Metadata
      operationId: microsoftAzureMetadataGetentity
      description: Gets the list of metadata entities.
      parameters:
      - name: name
        in: path
        description: Name of metadata entity.
        required: true
        type: string
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK. Successfully retrieved metadata entities
          schema:
            $ref: '#/definitions/MetadataEntity'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        GetMetadata:
          $ref: ./examples/Metadata_GetEntity.json
      summary: Microsoft Azure Get Providers Microsoft Resourcehealth Metadata Name
definitions:
  ErrorResponse:
    description: Error details.
    type: object
    properties:
      code:
        description: The error code.
        type: string
        readOnly: true
      message:
        description: The error message.
        type: string
        readOnly: true
      details:
        description: The error details.
        type: string
        readOnly: true
  MetadataEntityListResult:
    description: The list of metadata entities
    type: object
    properties:
      value:
        description: The list of metadata entities.
        type: array
        items:
          $ref: '#/definitions/MetadataEntity'
      nextLink:
        description: The link used to get the next page of metadata.
        type: string
  MetadataSupportedValueDetail:
    description: The metadata supported value detail.
    type: object
    properties:
      id:
        description: The id.
        type: string
      displayName:
        description: The display name.
        type: string
      resourceTypes:
        description: The list of associated resource types.
        type: array
        items:
          type: string
  MetadataEntity:
    description: The metadata entity contract.
    type: object
    properties:
      properties:
        $ref: '#/definitions/MetadataEntityProperties'
        description: The metadata entity properties.
        x-ms-client-flatten: true
    allOf:
    - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource
  MetadataEntityProperties:
    description: The metadata entity properties
    type: object
    properties:
      displayName:
        description: The display name.
        type: string
      dependsOn:
        description: The list of keys on which this entity depends on.
        type: array
        items:
          type: string
      applicableScenarios:
        description: The list of scenarios applicable to this metadata entity.
        type: array
        items:
          enum:
          - Alerts
          type: string
          x-ms-enum:
            name: Scenario
            modelAsString: true
      supportedValues:
        description: The list of supported values.
        type: array
        items:
          $ref: '#/definitions/MetadataSupportedValueDetail'
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'