swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector spotPlacementRecommender API
schemes:
- https
tags:
- name: spotPlacementRecommender
paths:
  ? /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/diagnostics/spotPlacementRecommender/generate
  : post:
      tags:
      - spotPlacementRecommender
      operationId: microsoftAzureSpotplacementrecommenderPost
      description: Generates placement scores for Spot VM skus.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - name: spotPlacementRecommenderInput
        in: body
        required: true
        schema:
          $ref: '#/definitions/SpotPlacementRecommenderInput'
        description: SpotPlacementRecommender object supplied in the body of the Post spot placement recommender operation.
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SpotPlacementRecommenderResponse'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Returns spot VM placement scores for given configurations.:
          $ref: ./examples/SpotPlacementRecommender.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Compute Locations Location Diagnostics Spotplacementrecommender Generate
definitions:
  SpotPlacementRecommenderInput:
    type: object
    properties:
      desiredLocations:
        type: array
        items:
          type: string
        description: The desired regions
      desiredSizes:
        type: array
        items:
          $ref: '#/definitions/ResourceSize'
        description: The desired resource SKUs.
      desiredCount:
        type: integer
        format: int32
        description: Desired instance count per region/zone based on the scope.
      availabilityZones:
        type: boolean
        description: Defines if the scope is zonal or regional.
    description: SpotPlacementRecommender API Input.
  ResourceSize:
    type: object
    properties:
      sku:
        type: string
        description: The resource's CRP virtual machine SKU size.
    description: SpotPlacementRecommender API response.
  PlacementScore:
    type: object
    properties:
      sku:
        type: string
        description: The resource's CRP virtual machine SKU size.
      region:
        type: string
        description: The region.
      availabilityZone:
        type: string
        description: The availability region.
      score:
        type: string
        description: The placement score.
      isQuotaAvailable:
        type: boolean
        description: Whether the desired quota is available.
    description: The spot placement score for sku/region/zone combination.
  SpotPlacementRecommenderResponse:
    type: object
    properties:
      desiredLocations:
        type: array
        items:
          type: string
        description: The desired regions
      desiredSizes:
        type: array
        items:
          $ref: '#/definitions/ResourceSize'
        description: The desired resource SKUs.
      desiredCount:
        type: integer
        format: int32
        description: Desired instance count per region/zone based on the scope.
      availabilityZones:
        type: boolean
        description: Defines if the scope is zonal or regional.
      placementScores:
        type: array
        items:
          $ref: '#/definitions/PlacementScore'
        description: The spot placement scores.
    description: SpotPlacementRecommender API response.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'