swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector BusinessCaseIaasSummaryOperations API
schemes:
- https
tags:
- name: BusinessCaseIaasSummaryOperations
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/iaasSummaries
  : get:
      operationId: microsoftAzureBusinesscaseiaassummaryoperationsListbybusinesscase
      tags:
      - BusinessCaseIaasSummaryOperations
      description: List IaasSummary 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/IaasSummaryListResult'
        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:
        BusinessCaseIaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen:
          $ref: ./examples/BusinessCaseIaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Migrate Assessmentprojects Projectname Businesscases Businesscasename Iaassummaries
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/iaasSummaries/{iaasSummaryName}
  : get:
      operationId: microsoftAzureBusinesscaseiaassummaryoperationsGet
      tags:
      - BusinessCaseIaasSummaryOperations
      description: Get a IaasSummary
      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: iaasSummaryName
        in: path
        description: Gets the Name of the Iaas Summary.
        required: true
        type: string
        pattern: ^[^<>&:\?/#]{1,260}$
      responses:
        '200':
          description: ARM operation completed successfully.
          schema:
            $ref: '#/definitions/IaasSummary'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        BusinessCaseIaasSummaryOperations_Get_MaximumSet_Gen:
          $ref: ./examples/BusinessCaseIaasSummaryOperations_Get_MaximumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Migrate Assessmentprojects Projectname Businesscases Businesscasename Iaassummaries Iaassummaryname
definitions:
  AzureIaasVmSummary:
    type: object
    description: Azure Iaas virtual machine summary.
    properties:
      serversSuitableForMigration:
        type: integer
        format: int32
        description: Servers suitable for migration.
        readOnly: true
      totalNumberOfServers:
        type: integer
        format: int32
        description: The total number of servers.
        readOnly: true
      cores:
        type: integer
        format: int32
        description: The total number of IaaS VM cores.
        readOnly: true
      memoryGb:
        type: number
        format: float
        description: The total memory in GB.
        readOnly: true
      azureVmCostDetails:
        $ref: '#/definitions/CostDetails'
        description: The on premises PaaS cost.
        readOnly: true
      estimatedCost:
        type: number
        format: float
        description: Estimated cost.
        readOnly: true
      osLicensingCost:
        type: number
        format: float
        description: OS licensing cost.
        readOnly: true
      estimatedCostByRecommendedOffer:
        type: array
        description: Estimated cost by offer.
        items:
          $ref: '#/definitions/EstimatedCostByOffer'
        readOnly: true
        x-ms-identifiers: []
      recommendedVmFamilySummary:
        type: array
        description: The recommended VM family summary.
        items:
          $ref: '#/definitions/RecommendedVmFamilySummary'
        readOnly: true
        x-ms-identifiers: []
      costByStorageType:
        type: array
        description: The cost by storage type.
        items:
          $ref: '#/definitions/CostByStorageType'
        readOnly: true
        x-ms-identifiers: []
  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
  IaasOsLicensingDetails:
    type: object
    description: The Iaas OS licensing details.
    properties:
      osType:
        type: string
        description: The OS type.
        readOnly: true
      totalCost:
        type: number
        format: float
        description: The total cost.
        readOnly: true
      decomissionCost:
        type: number
        format: float
        description: The decommission cost.
        readOnly: true
  DistributionByVirtualization:
    type: object
    description: The distribution by virtualization.
    properties:
      virtualizationType:
        type: string
        description: The Virtualization type.
        readOnly: true
      count:
        type: integer
        format: int32
        description: The number of machines with the Virtualization type classification.
        readOnly: true
  AzureIaasSqlSummary:
    type: object
    description: Azure Iaas sql server summary.
    properties:
      totalSqlEntities:
        type: integer
        format: int32
        description: Total SQL entities.
        readOnly: true
      suitableSqlEntities:
        type: integer
        format: int32
        description: Suitable SQL entities.
        readOnly: true
      azureSqlCostDetails:
        $ref: '#/definitions/CostDetails'
        description: The on premises PaaS cost.
        readOnly: true
      estimatedCost:
        type: number
        format: float
        description: Estimated cost.
        readOnly: true
      osLicensingCost:
        type: number
        format: float
        description: OS licensing cost.
        readOnly: true
      estimatedCostByRecommendedOffer:
        type: array
        description: Estimated cost by offer.
        items:
          $ref: '#/definitions/EstimatedCostByOffer'
        readOnly: true
        x-ms-identifiers: []
      recommendedVmFamilySummary:
        type: array
        description: The recommended VM family summary.
        items:
          $ref: '#/definitions/RecommendedVmFamilySummary'
        readOnly: true
        x-ms-identifiers: []
      costByStorageType:
        type: array
        description: The cost by storage type.
        items:
          $ref: '#/definitions/CostByStorageType'
        readOnly: true
        x-ms-identifiers: []
  ManagementCostComponentName:
    type: string
    description: Management Cost Component Names.
    enum:
    - Unknown
    - SystemCenterLicenseCost
    - VSphereManagementCost
    - ThirdPartyManagementCost
    - OtherMonitoringCost
    - OtherDataProtectionCost
    - OtherPatchingCost
    - AzureMonitoringCost
    - AzurePatchingCost
    - AzureDataProtectionCost
    x-ms-enum:
      name: ManagementCostComponentName
      modelAsString: true
      values:
      - name: Unknown
        value: Unknown
        description: Unknown Management Cost Component.
      - name: SystemCenterLicenseCost
        value: SystemCenterLicenseCost
        description: System Center License Cost.
      - name: VSphereManagementCost
        value: VSphereManagementCost
        description: VSphere eManagement Cost.
      - name: ThirdPartyManagementCost
        value: ThirdPartyManagementCost
        description: Third Party Management Cost.
      - name: OtherMonitoringCost
        value: OtherMonitoringCost
        description: Other Monitoring Cost.
      - name: OtherDataProtectionCost
        value: OtherDataProtectionCost
        description: Other Data Protection Cost.
      - name: OtherPatchingCost
        value: OtherPatchingCost
        description: Other Patching Cost.
      - name: AzureMonitoringCost
        value: AzureMonitoringCost
        description: Azure Monitoring Cost.
      - name: AzurePatchingCost
        value: AzurePatchingCost
        description: Azure Patching Cost.
      - name: AzureDataProtectionCost
        value: AzureDataProtectionCost
        description: Azure Data Protection Cost.
  DistributionByOperatingSystem:
    type: object
    description: The distribution by operating system.
    properties:
      osClassificationType:
        type: string
        description: The Os classification type.
        readOnly: true
      count:
        type: integer
        format: int32
        description: The number of machines with the OS type classification.
        readOnly: true
  EstimatedCostByOffer:
    type: object
    description: The estimated cost by offer.
    properties:
      offerName:
        type: string
        description: The offer name.
        readOnly: true
      cost:
        type: number
        format: float
        description: Cost for the offer.
        readOnly: true
  ManagementCostDetails:
    type: object
    description: Management Cost Details.
    properties:
      managementCost:
        type: number
        format: float
        description: Management Cost.
        readOnly: true
      managementCostComponents:
        type: array
        description: Management Cost Components.
        items:
          $ref: '#/definitions/ManagementCostComponent'
        readOnly: true
        x-ms-identifiers: []
  RecommendedVmFamilySummary:
    type: object
    description: The recommended VM family summary.
    properties:
      azureVmFamily:
        type: string
        description: The Azure VM family.
        readOnly: true
      numberOfMachines:
        type: integer
        format: int32
        description: The number of machines.
        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
  AzureIaasSummary:
    type: object
    description: The Azure IaaS summary.
    properties:
      yearOnYearEstimates:
        $ref: '#/definitions/YearOnYearEstimates'
        description: Shows the year-on-year cost overall.
        readOnly: true
      azureIaasVmSummary:
        $ref: '#/definitions/AzureIaasVmSummary'
        description: Azure Iaas virtual machine summary.
        readOnly: true
      azureIaasSqlSummary:
        $ref: '#/definitions/AzureIaasSqlSummary'
        description: Azure Iaas sql server summary.
        readOnly: true
      azureIaasCostDetails:
        $ref: '#/definitions/CostDetails'
        description: The on premises PaaS cost.
        readOnly: true
  ManagementCostComponent:
    type: object
    description: Management Cost Component.
    properties:
      name:
        $ref: '#/definitions/ManagementCostComponentName'
        description: Name of Management Cost Component.
      value:
        type: number
        format: float
        description: Cost of Management Component.
    required:
    - name
  IaasSummaryListResult:
    type: object
    description: The response of a IaasSummary list operation.
    properties:
      value:
        type: array
        description: The IaasSummary items on this page
        items:
          $ref: '#/definitions/IaasSummary'
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
  IaasSummaryProperties:
    type: object
    description: Iaas summary properties class.
    properties:
      azureIaasSummary:
        $ref: '#/definitions/AzureIaasSummary'
        description: The Azure IaaS summary.
        readOnly: true
      onPremisesIaasSummary:
        $ref: '#/definitions/OnPremisesIaasSummary'
        description: The on premises IaaS summary.
        readOnly: true
  CostByStorageType:
    type: object
    description: The cost by storage type.
    properties:
      storageType:
        type: string
        description: The storage type.
        readOnly: true
      cost:
        type: number
        format: float
        description: Cost per storage type.
        readOnly: true
  DistributionByType:
    type: object
    description: Distribution by Type.
    properties:
      type:
        type: string
        description: Distribution Type.
        readOnly: true
      count:
        type: integer
        format: int32
        description: Distribution Count.
        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
  OnPremisesIaasSummary:
    type: object
    description: The on premises IAAS summary.
    properties:
      servers:
        type: integer
        format: int32
        description: The number of servers.
        readOnly: true
      cores:
        type: integer
        format: int32
        description: The number of cores.
        readOnly: true
      memoryGb:
        type: number
        format: float
        description: Total memory in GB.
        readOnly: true
      cpuUtilization:
        type: number
        format: float
        description: The CPU utilization.
        readOnly: true
      memoryUtilization:
        type: number
        format: float
        description: The memory utilization.
        readOnly: true
      storageUtilization:
        type: number
        format: float
        description: The storage utilization.
        readOnly: true
      onPremisesIaasCostDetails:
        $ref: '#/definitions/CostDetails'
        description: The on premises PaaS cost.
        readOnly: true
      onPremisesIaasCostForDecommissioned:
        $ref: '#/definitions/CostDetails'
        description: The on premises PaaS cost.
        readOnly: true
      osLicensingDetails:
        type: array
        description: The OS licensing details.
        items:
          $ref: '#/definitions/IaasOsLicensingDetails'
        readOnly: true
        x-ms-identifiers: []
      distributionByOperatingSystem:
        type: array
        description: The distribution by operating system.
        items:
          $ref: '#/definitions/DistributionByOperatingSystem'
        readOnly: true
        x-ms-identifiers: []
      onPremisesUtilizationData:
        $ref: '#/definitions/UtilizationData'
        description: The SQL on premises utilization insights.
        readOnly: true
      distributionByVirtualization:
        type: array
        description: The distribution by virtualization.
        items:
          $ref: '#/definitions/DistributionByVirtualization'
        readOnly: true
        x-ms-identifiers: []
      iaasOsSupportStatusDistribution:
        $ref: '#/definitions/SupportStatusDistribution'
        description: Iaas OS Support Status Distribution.
        readOnly: true
      iaasSqlSupportStatusDistribution:
        $ref: '#/definitions/SupportStatusDistribution'
        description: Iaas Sql Support Status Distribution.
        readOnly: true
      osServicePackInsight:
        $ref: '#/definitions/ServicePackInsight'
        description: OS Service Pack Insight.
        readOnly: true
      sqlServicePackInsight:
        $ref: '#/definitions/ServicePackInsight'
        description: Sql Service Pack Insight.
        readOnly: true
      distributionByOperatingSystemVersion:
        type: array
        description: Distribution by Operating System Version.
        items:
          $ref: '#/definitions/DistributionByType'
        readOnly: true
        x-ms-identifiers: []
      distributionBySqlVersion:
        type: array
        description: Distribution by Sql Version.
        items:
          $ref: '#/definitions/DistributionByType'
        readOnly: true
        x-ms-identifiers: []
      distributionBySqlEdition:
        type: array
        description: Distribution by Sql Edition.
        items:
          $ref: '#/definitions/DistributionByType'
        readOnly: true
        x-ms-identifiers: []
  ServicePackInsight:
    type: object
    description: Service Pack Insight.
    properties:
      unknownServicePack:
        type: integer
        format: int32
        description: Unknown support.
        readOnly: true
      patched:
        type: integer
        format: int32
        description: Patched Service Pack Insight.
        readOnly: true
      unpatched:
        type: integer
        format: int32
        description: Unpatched Service Pack Insight.
        readOnly: true
  IaasSummary:
    type: object
    description: Iaas summary REST resource.
    properties:
      properties:
        $ref: '#/definitions/IaasSummaryProperties'
        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
  CostDetails:
    type: object
    description: The on premises PaaS cost.
    properties:
      storageCost:
        type: number
        format: float
        description: The storage cost.
        readOnly: true
      computeCost:
        type: number
        format: float
        description: The compute cost.
        readOnly: true
      itLaborCost:
        type: number
        format: float
        description: The IT labor cost.
        readOnly: true
      networkCost:
        type: number
        format: float
        description: The network cost.
        readOnly: true
      ahubSavings:
        type: number
        format: float
        description: The windows AhubSavings.
        readOnly: true
      linuxAhubSavings:
        type: number
        format: float
        description: The linux AhubSavings.
        readOnly: true
      securityCost:
        type: number
        format: float
        description: Security Cost.
        readOnly: true
      managementCostDetails:
        $ref: '#/definitions/ManagementCostDetails'
        description: Management Cost Details.
        readOnly: true
      esuSavings:
        type: number
        format: float
        description: esu savings.
        readOnly: true
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'