swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector HeatMaps API
schemes:
- https
tags:
- name: HeatMaps
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}/heatMaps/{heatMapType}
  : get:
      tags:
      - HeatMaps
      operationId: microsoftAzureHeatmapGet
      description: Gets latest heatmap for Traffic Manager profile.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group containing the Traffic Manager endpoint.
      - name: profileName
        in: path
        required: true
        type: string
        description: The name of the Traffic Manager profile.
      - name: heatMapType
        in: path
        required: true
        type: string
        enum:
        - default
        description: The type of HeatMap for the Traffic Manager profile.
      - name: topLeft
        in: query
        required: false
        allowEmptyValue: true
        description: The top left latitude,longitude pair of the rectangular viewport to query for.
        type: array
        minItems: 2
        maxItems: 2
        collectionFormat: csv
        items:
          type: number
          format: double
      - name: botRight
        in: query
        required: false
        allowEmptyValue: true
        description: The bottom right latitude,longitude pair of the rectangular viewport to query for.
        type: array
        minItems: 2
        maxItems: 2
        collectionFormat: csv
        items:
          type: number
          format: double
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The Traffic Manager heatmap.
          schema:
            $ref: '#/definitions/HeatMapModel'
        default:
          description: Default response. It will be deserialized as per the Error definition.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        HeatMap-GET:
          $ref: ./examples/HeatMap-GET.json
        HeatMap-GET-With-TopLeft-BotRight:
          $ref: ./examples/HeatMap-GET-With-TopLeft-BotRight.json
        HeatMap-GET-With-Null-Values:
          $ref: ./examples/HeatMap-GET-With-Null-Values.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Trafficmanagerprofiles Profilename Heatmaps Heatmaptype
definitions:
  HeatMapProperties:
    properties:
      startTime:
        type: string
        format: date-time
        description: The beginning of the time window for this HeatMap, inclusive.
      endTime:
        type: string
        format: date-time
        description: The ending of the time window for this HeatMap, exclusive.
      endpoints:
        type: array
        description: The endpoints used in this HeatMap calculation.
        items:
          $ref: '#/definitions/HeatMapEndpoint'
      trafficFlows:
        type: array
        description: The traffic flows produced in this HeatMap calculation.
        items:
          $ref: '#/definitions/TrafficFlow'
    description: Class representing a Traffic Manager HeatMap properties.
  ProxyResource:
    description: The resource model definition for a ARM proxy resource. It will have everything other than required location and tags
    allOf:
    - $ref: '#/definitions/Resource'
  Resource:
    description: The core properties of ARM resources
    properties:
      id:
        readOnly: true
        type: string
        description: Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
      name:
        readOnly: true
        type: string
        description: The name of the resource
      type:
        readOnly: true
        type: string
        description: The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.
    x-ms-azure-resource: true
  CloudError:
    type: object
    properties:
      error:
        $ref: '#/definitions/CloudErrorBody'
        description: The content of the error.
    description: An error returned by the Azure Resource Manager
    x-ms-external: true
  TrafficFlow:
    properties:
      sourceIp:
        type: string
        description: The IP address that this query experience originated from.
      latitude:
        type: number
        format: double
        description: The approximate latitude that these queries originated from.
      longitude:
        type: number
        format: double
        description: The approximate longitude that these queries originated from.
      queryExperiences:
        type: array
        description: The query experiences produced in this HeatMap calculation.
        items:
          $ref: '#/definitions/QueryExperience'
    description: Class representing a Traffic Manager HeatMap traffic flow properties.
  HeatMapEndpoint:
    properties:
      resourceId:
        type: string
        description: The ARM Resource ID of this Traffic Manager endpoint.
      endpointId:
        type: integer
        description: A number uniquely identifying this endpoint in query experiences.
    description: Class which is a sparse representation of a Traffic Manager endpoint.
  CloudErrorBody:
    type: object
    properties:
      code:
        type: string
        description: Error code
      message:
        type: string
        description: Error message
      target:
        type: string
        description: Error target
      details:
        type: array
        items:
          $ref: '#/definitions/CloudErrorBody'
        description: Error details
    description: The content of an error returned by the Azure Resource Manager
    x-ms-external: true
  HeatMapModel:
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/HeatMapProperties'
        description: The properties of the Traffic Manager HeatMap.
    allOf:
    - $ref: '#/definitions/ProxyResource'
    description: Class representing a Traffic Manager HeatMap.
  QueryExperience:
    properties:
      endpointId:
        type: integer
        description: The id of the endpoint from the 'endpoints' array which these queries were routed to.
      queryCount:
        type: integer
        description: The number of queries originating from this location.
      latency:
        type: number
        format: double
        description: The latency experienced by queries originating from this location.
    required:
    - endpointId
    - queryCount
    description: Class representing a Traffic Manager HeatMap query experience properties.
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: Client Api Version.
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    required: true
    type: string
    description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'