swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector BusinessCaseOverviewSummaryOperations API
schemes:
- https
tags:
- name: BusinessCaseOverviewSummaryOperations
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/overviewSummaries
  : get:
      operationId: microsoftAzureBusinesscaseoverviewsummaryoperationsListbybusinesscase
      tags:
      - BusinessCaseOverviewSummaryOperations
      description: List OverviewSummary resources by BusinessCase
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: projectName
        in: path
        description: Assessment Project Name
        required: true
        type: string
        pattern: ^[^<>&:\?/#]{1,260}$
      - name: businessCaseName
        in: path
        description: Business case ARM name
        required: true
        type: string
        pattern: ^[^<>&:\?/#]{1,260}$
      responses:
        '200':
          description: ARM operation completed successfully.
          schema:
            $ref: '#/definitions/OverviewSummaryListResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        BusinessCaseOverviewSummaryOperations_ListByBusinessCase_MaximumSet_Gen:
          $ref: ./examples/BusinessCaseOverviewSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Migrate Assessmentprojects Projectname Businesscases Businesscasename Overviewsummaries
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/overviewSummaries/{overviewSummaryName}
  : get:
      operationId: microsoftAzureBusinesscaseoverviewsummaryoperationsGet
      tags:
      - BusinessCaseOverviewSummaryOperations
      description: Get a OverviewSummary
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: projectName
        in: path
        description: Assessment Project Name
        required: true
        type: string
        pattern: ^[^<>&:\?/#]{1,260}$
      - name: businessCaseName
        in: path
        description: Business case ARM name
        required: true
        type: string
        pattern: ^[^<>&:\?/#]{1,260}$
      - name: overviewSummaryName
        in: path
        description: Gets the Name of the Overview Summary.
        required: true
        type: string
        pattern: ^[^<>&:\?/#]{1,260}$
      responses:
        '200':
          description: ARM operation completed successfully.
          schema:
            $ref: '#/definitions/OverviewSummary'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        BusinessCaseOverviewSummaryOperations_Get_MaximumSet_Gen:
          $ref: ./examples/BusinessCaseOverviewSummaryOperations_Get_MaximumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Migrate Assessmentprojects Projectname Businesscases Businesscasename Overviewsummaries Overviewsummaryname
definitions:
  ServersDiscovered:
    type: object
    description: Shows the discovered servers by virtualization platform.
    properties:
      vmWare:
        type: integer
        format: int32
        description: Number of servers on VMWare.
        readOnly: true
      hyperV:
        type: integer
        format: int32
        description: Number of servers on HyperV.
        readOnly: true
      physical:
        type: integer
        format: int32
        description: Number of physical servers.
        readOnly: true
      notApplicable:
        type: integer
        format: int32
        description: Number of servers whose virtualization is unknown.
        readOnly: true
  OverviewSummaryProperties:
    type: object
    description: Overview summary properties class.
    properties:
      totalAzureCost:
        type: number
        format: float
        description: The total Azure cost..
        readOnly: true
      totalAzureIaasCost:
        type: number
        format: float
        description: The total Azure IaaS cost.
        readOnly: true
      totalAzurePaasCost:
        type: number
        format: float
        description: The total Azure PaaS cost.
        readOnly: true
      totalAzureAvsCost:
        type: number
        format: float
        description: The total Avs cost.
        readOnly: true
      windowsAhubSavings:
        type: number
        format: float
        description: The windows ahub saving.
        readOnly: true
      linuxAhubSavings:
        type: number
        format: float
        description: The linux ahub saving.
        readOnly: true
      sqlAhubSavings:
        type: number
        format: float
        description: The sql ahub saving.
        readOnly: true
      totalOnPremisesCost:
        type: number
        format: float
        description: The total on premises cost.
        readOnly: true
      esuSavingsFor4years:
        type: number
        format: float
        description: ESU Savings 4 Years.
        readOnly: true
      managementCostSavings:
        type: number
        format: float
        description: The management cost saving.
        readOnly: true
      securityCostSavings:
        type: number
        format: float
        description: The security cost saving.
        readOnly: true
      yearOnYearEstimates:
        $ref: '#/definitions/YearOnYearEstimates'
        description: Shows the year-on-year cost overall.
        readOnly: true
      serversDiscovered:
        $ref: '#/definitions/ServersDiscovered'
        description: Shows the discovered servers by virtualization platform.
        readOnly: true
      utilizationData:
        $ref: '#/definitions/UtilizationData'
        description: The SQL on premises utilization insights.
        readOnly: true
      iaasOsDistribution:
        $ref: '#/definitions/IaasOsDistribution'
        description: Shows the infrastructure as a service machine OS distribution.
        readOnly: true
      osSupportStatusDistribution:
        $ref: '#/definitions/SupportStatusDistribution'
        description: OS Support Status Distribution.
        readOnly: true
      sqlSupportStatusDistribution:
        $ref: '#/definitions/SupportStatusDistribution'
        description: Sql Support Status Distribution.
        readOnly: true
      paasDistribution:
        $ref: '#/definitions/PaasDistribution'
        description: Shows the distribution of platforms.
        readOnly: true
  OverviewSummary:
    type: object
    description: Overview summary REST resource.
    properties:
      properties:
        $ref: '#/definitions/OverviewSummaryProperties'
        description: The resource-specific properties for this resource.
        x-ms-client-flatten: true
        x-ms-mutability:
        - read
        - create
    allOf:
    - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
  OverviewSummaryListResult:
    type: object
    description: The response of a OverviewSummary list operation.
    properties:
      value:
        type: array
        description: The OverviewSummary items on this page
        items:
          $ref: '#/definitions/OverviewSummary'
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
  UtilizationData:
    type: object
    description: The SQL on premises utilization insights.
    properties:
      numberOfActiveEntities:
        type: integer
        format: int32
        description: The number of active entities.
        readOnly: true
      numberOfInactiveEntities:
        type: integer
        format: int32
        description: The number of inactive entities.
        readOnly: true
      numberOfDecommisionEntities:
        type: integer
        format: int32
        description: The number of decommission entities.
        readOnly: true
      numberOfUnknownEntities:
        type: integer
        format: int32
        description: The number of unknown entities.
        readOnly: true
  SupportStatusDistribution:
    type: object
    description: Support Status Distribution.
    properties:
      unknownSupport:
        type: integer
        format: int32
        description: Unknown support.
        readOnly: true
      mainStream:
        type: integer
        format: int32
        description: Mainstream support.
        readOnly: true
      extended:
        type: integer
        format: int32
        description: Extended support.
        readOnly: true
      outOfSupport:
        type: integer
        format: int32
        description: Out of support.
        readOnly: true
  YearOnYearEstimates:
    type: object
    description: Shows the year-on-year cost overall.
    properties:
      onPremisesCost:
        type: object
        description: Year-on-Year on-premises cost.
        additionalProperties:
          format: float
          type: number
        readOnly: true
      azureCost:
        type: object
        description: Year-on-Year Azure cost.
        additionalProperties:
          format: float
          type: number
        readOnly: true
      savings:
        type: object
        description: Year-on-Year savings.
        additionalProperties:
          format: float
          type: number
        readOnly: true
      onPremisesCapexCost:
        type: object
        description: Year-on-Year on-premises capex cost.
        additionalProperties:
          format: float
          type: number
        readOnly: true
      onPremisesOpexCost:
        type: object
        description: Year-on-Year on-premises opex cost.
        additionalProperties:
          format: float
          type: number
        readOnly: true
      azureCapexCost:
        type: object
        description: Year-on-Year azure capex cost.
        additionalProperties:
          format: float
          type: number
        readOnly: true
      azureOpexCost:
        type: object
        description: Year-on-Year azure opex cost.
        additionalProperties:
          format: float
          type: number
        readOnly: true
      paybackPeriod:
        type: integer
        format: int32
        description: Payback period.
        readOnly: true
  IaasOsDistribution:
    type: object
    description: Shows the infrastructure as a service machine OS distribution.
    properties:
      windows:
        type: integer
        format: int32
        description: Number of Windows servers.
        readOnly: true
      linux:
        type: integer
        format: int32
        description: Number of Linux servers.
        readOnly: true
      other:
        type: integer
        format: int32
        description: Number of servers neither Windows or Linux.
        readOnly: true
  PaasDistribution:
    type: object
    description: Shows the distribution of platforms.
    properties:
      sqlServers:
        type: integer
        format: int32
        description: Number of SQL Server machines.
        readOnly: true
      iisWebServers:
        type: integer
        format: int32
        description: Number of IIS Web servers.
        readOnly: true
      webAppDistribution:
        type: object
        description: Distribution of webapps for each target type.
        additionalProperties:
          format: int32
          type: integer
        readOnly: true
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'