Microsoft Azure BusinessCasePaasSummaryOperations API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector BusinessCasePaasSummaryOperations API
schemes:
- https
tags:
- name: BusinessCasePaasSummaryOperations
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/paasSummaries
  : get:
      operationId: microsoftAzureBusinesscasepaassummaryoperationsListbybusinesscase
      tags:
      - BusinessCasePaasSummaryOperations
      description: List PaasSummary 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/PaasSummaryListResult'
        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:
        BusinessCasePaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen:
          $ref: ./examples/BusinessCasePaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Migrate Assessmentprojects Projectname Businesscases Businesscasename Paassummaries
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/paasSummaries/{paasSummaryName}
  : get:
      operationId: microsoftAzureBusinesscasepaassummaryoperationsGet
      tags:
      - BusinessCasePaasSummaryOperations
      description: Get a PaasSummary
      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: paasSummaryName
        in: path
        description: Gets the Name of the Paas Summary.
        required: true
        type: string
        pattern: ^[^<>&:\?/#]{1,260}$
      responses:
        '200':
          description: ARM operation completed successfully.
          schema:
            $ref: '#/definitions/PaasSummary'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        BusinessCasePaasSummaryOperations_Get_MaximumSet_Gen:
          $ref: ./examples/BusinessCasePaasSummaryOperations_Get_MaximumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Migrate Assessmentprojects Projectname Businesscases Businesscasename Paassummaries Paassummaryname
definitions:
  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
  AzureSqlSummary:
    type: object
    description: Shows the Azure SQL details.
    properties:
      estimatedCostByOffer:
        type: array
        description: Estimated cost by recommended offer.
        items:
          $ref: '#/definitions/EstimatedCostByOffer'
        readOnly: true
        x-ms-identifiers: []
      distributionByServiceTier:
        type: array
        description: Distribution by service tiers, retaining just to support older Business cases.
        items:
          $ref: '#/definitions/SqlServiceTier'
        readOnly: true
        x-ms-identifiers: []
      distributionByServiceTierForSqlMi:
        type: array
        description: Distribution by service tiers for SQL MI.
        items:
          $ref: '#/definitions/SqlServiceTier'
        readOnly: true
        x-ms-identifiers: []
      distributionByServiceTierForSqlDb:
        type: array
        description: Distribution by service tiers for SQL DB.
        items:
          $ref: '#/definitions/SqlServiceTier'
        readOnly: true
        x-ms-identifiers: []
  AzurePaasSummary:
    type: object
    description: Shows the PaaS Azure summary.
    properties:
      totalSqlEntities:
        type: integer
        format: int32
        description: Number of Sql instances.
        readOnly: true
      suitableSqlEntities:
        type: integer
        format: int32
        description: Suitable Sql instances.
        readOnly: true
      totalWebApps:
        type: integer
        format: int32
        description: Number of web applications.
        readOnly: true
      suitableWebApps:
        type: integer
        format: int32
        description: Suitable web applications.
        readOnly: true
      cores:
        type: integer
        format: int32
        description: Number of cores.
        readOnly: true
      memory:
        type: number
        format: float
        description: Memory Utilization.
        readOnly: true
      storage:
        type: number
        format: float
        description: Storage Utilization.
        readOnly: true
      estimatedCostByTarget:
        $ref: '#/definitions/EstimatedCostByTarget'
        description: Shows the estimated cost by target.
        readOnly: true
      estimatedSqlServerLicensingCost:
        type: number
        format: float
        description: estimated SQL Server licensing cost.
        readOnly: true
      azureSqlSummary:
        $ref: '#/definitions/AzureSqlSummary'
        description: Shows the Azure SQL details.
        readOnly: true
      azureAppServiceSummary:
        $ref: '#/definitions/AzureAppServiceSummary'
        description: Shows Azure App Service summary.
        readOnly: true
      azureAppServiceContainerSummary:
        $ref: '#/definitions/AzureAppServiceContainerSummary'
        description: Shows Azure App Service Container summary.
        readOnly: true
      azureKubernetesServiceSummary:
        $ref: '#/definitions/AzureKubernetesServiceSummary'
        description: Shows Azure Kubernetes Service summary.
        readOnly: true
      totalAzurePaasCost:
        $ref: '#/definitions/CostDetails'
        description: The on premises PaaS cost.
        readOnly: true
  AzureAppServiceSummary:
    type: object
    description: Shows Azure App Service summary.
    properties:
      estimatedCostByOffer:
        type: array
        description: Estimated cost by recommendation offer.
        items:
          $ref: '#/definitions/EstimatedCostByOffer'
        readOnly: true
        x-ms-identifiers: []
      distributionBySku:
        type: array
        description: Distribution by SKU.
        items:
          $ref: '#/definitions/AppServiceSku'
        readOnly: true
        x-ms-identifiers: []
      distributionByApp:
        type: array
        description: Distribution by application type.
        items:
          $ref: '#/definitions/WebAppDistribution'
        readOnly: true
        x-ms-identifiers: []
  AzureKubernetesServiceSummary:
    type: object
    description: Shows Azure Kubernetes Service summary.
    properties:
      estimatedCostByOffer:
        type: array
        description: Estimated cost by recommendation offer.
        items:
          $ref: '#/definitions/EstimatedCostByOffer'
        readOnly: true
        x-ms-identifiers: []
      distributionBySku:
        type: array
        description: Distribution by SKU.
        items:
          $ref: '#/definitions/WebAppTargetSku'
        readOnly: true
        x-ms-identifiers: []
      distributionByApp:
        type: array
        description: Distribution by application type.
        items:
          $ref: '#/definitions/WebAppDistribution'
        readOnly: true
        x-ms-identifiers: []
  SqlServiceTier:
    type: object
    description: The SQL service tier.
    properties:
      serviceTierName:
        type: string
        description: The service tier name.
        readOnly: true
      serviceTierNumber:
        type: number
        format: float
        description: The number of sql entities with this tier.
        readOnly: true
  PaasSummaryProperties:
    type: object
    description: Paas summary properties class.
    properties:
      azure:
        $ref: '#/definitions/AzurePaasSummary'
        description: Shows the PaaS Azure summary.
        readOnly: true
      onPremises:
        $ref: '#/definitions/OnPremisesPaasSummary'
        description: Shows platform as a service (PaaS) summary.
        readOnly: true
  OnPremisesWebAppSummary:
    type: object
    description: The on premises web application summary.
    properties:
      numberOfWebServers:
        type: integer
        format: int32
        description: The number of web servers.
        readOnly: true
      numberOfWebApplications:
        type: integer
        format: int32
        description: The number of web applications.
        readOnly: true
      numberOfWebAppsPerType:
        type: object
        description: The number of web applications per web application type.
        additionalProperties:
          format: int32
          type: integer
        readOnly: true
  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
  SqlVersionDetails:
    type: object
    description: The SQL version details.
    properties:
      sqlVersion:
        type: string
        description: The SQL version.
        readOnly: true
      numberOfInstances:
        type: integer
        format: int32
        description: Number of instances with the above SQL version.
        readOnly: true
  WebAppTypes:
    type: string
    description: Business case supported WebApp types.
    enum:
    - Unknown
    - ASPNET
    - Java
    x-ms-enum:
      name: WebAppTypes
      modelAsString: true
      values:
      - name: Unknown
        value: Unknown
        description: Unknown WebApp Type.
      - name: ASPNET
        value: ASPNET
        description: ASPNET Type.
      - name: Java
        value: Java
        description: Java Tomcat Type.
  PaasSummary:
    type: object
    description: Paas summary REST resource.
    properties:
      properties:
        $ref: '#/definitions/PaasSummaryProperties'
        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
  WebAppDistribution:
    type: object
    description: The app type distribution.
    properties:
      webAppType:
        $ref: '#/definitions/WebAppTypes'
        description: WebApp type.
        readOnly: true
      numberOfWebApps:
        type: number
        format: float
        description: The cost details.
        readOnly: true
  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.
  OnPremisesPaasSummary:
    type: object
    description: Shows platform as a service (PaaS) summary.
    properties:
      totalServers:
        type: integer
        format: int32
        description: Total servers.
        readOnly: true
      cpuUtilization:
        type: number
        format: float
        description: CPU utilization percentage.
        readOnly: true
      memoryUtilization:
        type: number
        format: float
        description: Memory utilization percentage.
        readOnly: true
      totalOnPremisesPaasCost:
        $ref: '#/definitions/CostDetails'
        description: The on premises PaaS cost.
        readOnly: true
      onPremisesPaasCostForDecommisioned:
        $ref: '#/definitions/CostDetails'
        description: The on premises PaaS cost.
        readOnly: true
      onPremisesPaasLicensingCost:
        $ref: '#/definitions/OnPremisesPaasLicensingCost'
        description: The on premises paas licensing cost.
        readOnly: true
      onPremisesSqlSummary:
        $ref: '#/definitions/OnPremisesSqlSummary'
        description: The on premises SQL summary.
        readOnly: true
      onPremisesWebAppSummary:
        $ref: '#/definitions/OnPremisesWebAppSummary'
        description: The on premises web application summary.
        readOnly: true
      osSupportStatusDistribution:
        $ref: '#/definitions/SupportStatusDistribution'
        description: OS Support Status Distribution.
        readOnly: true
      sqlSupportStatusDistribution:
        $ref: '#/definitions/SupportStatusDistribution'
        description: 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
  WebAppTargetSku:
    type: object
    description: The Webapp target SKU with corresponding cost.
    properties:
      skuName:
        type: string
        description: The SKU name.
        readOnly: true
      cost:
        type: number
        format: float
        description: The cost details.
        readOnly: true
      count:
        type: integer
        format: int32
        description: The number of service plans or node pools recommended.
        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: []
  PaasSummaryListResult:
    type: object
    description: The response of a PaasSummary list operation.
    properties:
      value:
        type: array
        description: The PaasSummary items on this page
        items:
          $ref: '#/definitions/PaasSummary'
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
  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
  AppServiceSku:
    type: object
    description: The app service SKU with corresponding cost.
    properties:
      skuName:
        type: string
        description: The SKU name.
        readOnly: true
      cost:
        type: number
        format: float
        description: The cost details.
        readOnly: true
      count:
        type: integer
        format: int32
        description: The number of service plans recommended.
        readOnly: true
  OnPremisesSqlSummary:
    type: object
    description: The on premises SQL summary.
    properties:
      sqlInstances:
        type: integer
        format: int32
        description: The number of SQL instances.
        readOnly: true
      sqlDatabases:
        type: integer
        format: int32
        description: The number of SQL databases.
        readOnly: true
      distributionBySqlVersion:
        type: array
        description: Distribution by SQL version.
        items:
          $ref: '#/definitions/SqlVersionDetails'
        readOnly: true
        x-ms-identifiers: []
      sqlOnPremisesUtilizationData:
        $ref: '#/definitions/UtilizationData'
        description: The SQL on premises utilization insights.
        readOnly: true
      distributionBySqlEdition:
        type: array
        description: Distribution by Sql Edition.
        items:
          $ref: '#/definitions/DistributionByType'
        readOnly: true
        x-ms-identifiers: []
  AzureAppServiceContainerSummary:
    type: object
    description: Shows Azure App Service Container summary.
    properties:
      estimatedCostByOffer:
        type: array
        description: Estimated cost by recommendation offer.
        items:
          $ref: '#/definitions/EstimatedCostByOffer'
        readOnly: true
        x-ms-identifiers: []
      distributionBySku:
        type: array
        description: Distribution by SKU.
        items:
          $ref: '#/definitions/WebAppTargetSku'
        readOnly: true
        x-ms-identifiers: []
      distributionByApp:
        type: array
        description: Distribution by application type.
        items:
          $ref: '#/definitions/WebAppDistribution'
        readOnly: true
        x-ms-identifiers: []
  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
  OnPremisesPaasLicensingCost:
    type: object
    description: The on premises paas licensing cost.
    properties:
      version:
        type: string
        description: The version.
        readOnly: true
      totalCost:
        type: number
        format: float
        description: The total cost.
        readOnly: true
      decomissionServerCost:
        type: number
        format: float
        description: The decommissioned server cost.
        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
  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
  EstimatedCostByTarget:
    type: object
    description: Shows the estimated cost by target.
    properties:
      azureSqlMiCost:
        type: number
        format: float
        description: Azure SQL MI cost.
        readOnly: true
      azureSqlDbCost:
        type: number
        format: float
        description: Azure SQL DB cost.
        readOnly: true
      appServiceCost:
        type: number
        format: float
        description: Azure App Service cost.
        readOnly: true
      appServiceContainerCost:
        type: number
        format: float
        description: Azure App Service Containers cost.
        readOnly: true
      azureKubernetesServiceCost:
        type: number
        format: float
        description: Azure Kubernetes Service cost.
        readOnly: true
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'