Microsoft Azure SqlAssessmentOptionsOperations API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector SqlAssessmentOptionsOperations API
schemes:
- https
tags:
- name: SqlAssessmentOptionsOperations
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlAssessmentOptions
  : get:
      operationId: microsoftAzureSqlassessmentoptionsoperationsListbyassessmentproject
      tags:
      - SqlAssessmentOptionsOperations
      description: List SqlAssessmentOptions resources by AssessmentProject
      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}$
      responses:
        '200':
          description: ARM operation completed successfully.
          schema:
            $ref: '#/definitions/SqlAssessmentOptionsListResult'
        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:
        SqlAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen:
          $ref: ./examples/SqlAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Migrate Assessmentprojects Projectname Sqlassessmentoptions
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlAssessmentOptions/{assessmentOptionsName}
  : get:
      operationId: microsoftAzureSqlassessmentoptionsoperationsGet
      tags:
      - SqlAssessmentOptionsOperations
      description: Get a SqlAssessmentOptions
      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: assessmentOptionsName
        in: path
        description: Sql assessment options ARM name. Accepted values is 'default'
        required: true
        type: string
        pattern: ^[^<>&:\?/#]{1,260}$
      responses:
        '200':
          description: ARM operation completed successfully.
          schema:
            $ref: '#/definitions/SqlAssessmentOptions'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        SqlAssessmentOptionsOperations_Get_MaximumSet_Gen:
          $ref: ./examples/SqlAssessmentOptionsOperations_Get_MaximumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Migrate Assessmentprojects Projectname Sqlassessmentoptions Assessmentoptionsname
definitions:
  TargetType:
    type: string
    enum:
    - Unknown
    - Recommended
    - AzureSqlDatabase
    - AzureSqlManagedInstance
    - AzureSqlVirtualMachine
    - AzureVirtualMachine
    x-ms-enum:
      name: TargetType
      modelAsString: true
  SqlAssessmentOptionsListResult:
    type: object
    description: The response of a SqlAssessmentOptions list operation.
    properties:
      value:
        type: array
        description: The SqlAssessmentOptions items on this page
        items:
          $ref: '#/definitions/SqlAssessmentOptions'
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
  SqlPaaSTargetOptions:
    type: object
    description: SQL target options.
    properties:
      computeTier:
        $ref: '#/definitions/ComputeTier'
        description: Gets or sets the Azure SQL compute tier.
      hardwareGeneration:
        $ref: '#/definitions/HardwareGeneration'
        description: Gets or sets the Azure SQL hardware generation.
      targetType:
        $ref: '#/definitions/TargetType'
        description: Gets or sets the Azure SQL target type.
      serviceTier:
        $ref: '#/definitions/AzureSqlServiceTier'
        description: Gets or sets the Azure SQL service tier.
      targetLocations:
        type: array
        description: Gets or sets the target location.
        items:
          $ref: '#/definitions/AzureLocation'
        x-ms-identifiers: []
  AzureVmFamily:
    type: string
    enum:
    - Unknown
    - Basic_A0_A4
    - Standard_A0_A7
    - Standard_A8_A11
    - Av2_series
    - D_series
    - Dv2_series
    - DS_series
    - DSv2_series
    - F_series
    - Fs_series
    - G_series
    - GS_series
    - H_series
    - Ls_series
    - Dsv3_series
    - Dv3_series
    - Fsv2_series
    - Ev3_series
    - Esv3_series
    - M_series
    - DC_Series
    - Lsv2_series
    - Ev4_series
    - Esv4_series
    - Edv4_series
    - Edsv4_series
    - Dv4_series
    - Dsv4_series
    - Ddv4_series
    - Ddsv4_series
    - Easv4_series
    - Dasv4_series
    - Mv2_series
    - Eav4_series
    - Dav4_series
    - Msv2_series
    - Mdsv2_series
    - Dv5_series
    - Dsv5_series
    - Ddv5_series
    - Ddsv5_series
    - Dasv5_series
    - Dadsv5_series
    - Ev5_series
    - Esv5_series
    - Edv5_series
    - Edsv5_series
    - Easv5_series
    - Eadsv5_series
    - Ebsv5_series
    - Ebdsv5_series
    x-ms-enum:
      name: AzureVmFamily
      modelAsString: true
      values:
      - name: Unknown
        value: Unknown
      - name: BasicA0A4
        value: Basic_A0_A4
      - name: StandardA0A7
        value: Standard_A0_A7
      - name: StandardA8A11
        value: Standard_A8_A11
      - name: Av2Series
        value: Av2_series
      - name: DSeries
        value: D_series
      - name: Dv2Series
        value: Dv2_series
      - name: DSSeries
        value: DS_series
      - name: DSv2Series
        value: DSv2_series
      - name: FSeries
        value: F_series
      - name: FsSeries
        value: Fs_series
      - name: GSeries
        value: G_series
      - name: GSSeries
        value: GS_series
      - name: HSeries
        value: H_series
      - name: LsSeries
        value: Ls_series
      - name: Dsv3Series
        value: Dsv3_series
      - name: Dv3Series
        value: Dv3_series
      - name: Fsv2Series
        value: Fsv2_series
      - name: Ev3Series
        value: Ev3_series
      - name: Esv3Series
        value: Esv3_series
      - name: MSeries
        value: M_series
      - name: DCSeries
        value: DC_Series
      - name: Lsv2Series
        value: Lsv2_series
      - name: Ev4Series
        value: Ev4_series
      - name: Esv4Series
        value: Esv4_series
      - name: Edv4Series
        value: Edv4_series
      - name: Edsv4Series
        value: Edsv4_series
      - name: Dv4Series
        value: Dv4_series
      - name: Dsv4Series
        value: Dsv4_series
      - name: Ddv4Series
        value: Ddv4_series
      - name: Ddsv4Series
        value: Ddsv4_series
      - name: Easv4Series
        value: Easv4_series
      - name: Dasv4Series
        value: Dasv4_series
      - name: Mv2Series
        value: Mv2_series
      - name: Eav4Series
        value: Eav4_series
      - name: Dav4Series
        value: Dav4_series
      - name: Msv2Series
        value: Msv2_series
      - name: Mdsv2Series
        value: Mdsv2_series
      - name: Dv5Series
        value: Dv5_series
      - name: Dsv5Series
        value: Dsv5_series
      - name: Ddv5Series
        value: Ddv5_series
      - name: Ddsv5Series
        value: Ddsv5_series
      - name: Dasv5Series
        value: Dasv5_series
      - name: Dadsv5Series
        value: Dadsv5_series
      - name: Ev5Series
        value: Ev5_series
      - name: Esv5Series
        value: Esv5_series
      - name: Edv5Series
        value: Edv5_series
      - name: Edsv5Series
        value: Edsv5_series
      - name: Easv5Series
        value: Easv5_series
      - name: Eadsv5Series
        value: Eadsv5_series
      - name: Ebsv5Series
        value: Ebsv5_series
      - name: Ebdsv5Series
        value: Ebdsv5_series
  AzureSqlServiceTier:
    type: string
    enum:
    - Unknown
    - Automatic
    - GeneralPurpose
    - BusinessCritical
    - HyperScale
    x-ms-enum:
      name: AzureSqlServiceTier
      modelAsString: true
  SqlAssessmentOptionsProperties:
    type: object
    description: SQL Assessment options properties Web model object.
    properties:
      vmFamilies:
        type: array
        description: Gets the list of VM families.
        items:
          $ref: '#/definitions/VmFamilyOptions'
        readOnly: true
        x-ms-identifiers: []
      reservedInstanceVmFamilies:
        type: array
        description: Gets the Reserved Instance VM Families list.
        items:
          $ref: '#/definitions/AzureVmFamily'
        readOnly: true
        x-ms-identifiers: []
      premiumDiskVmFamilies:
        type: array
        description: Gets the Premium disk VM Families list.
        items:
          $ref: '#/definitions/AzureVmFamily'
        readOnly: true
        x-ms-identifiers: []
      savingsPlanVmFamilies:
        type: array
        description: Gets or sets the Premium disk VM Families list.
        items:
          $ref: '#/definitions/AzureVmFamily'
        x-ms-identifiers: []
      savingsPlanSupportedLocations:
        type: array
        description: Gets or sets the list of Azure locations supporting Saving Plans for IAAS.
        items:
          $ref: '#/definitions/AzureLocation'
        x-ms-identifiers: []
      savingsPlanSupportedLocationsForPaas:
        type: array
        description: Gets or sets the list of Azure locations supporting Saving Plans for PAAS.
        items:
          $ref: '#/definitions/AzureLocation'
        x-ms-identifiers: []
      reservedInstanceSupportedLocationsForIaas:
        type: array
        description: Gets or sets the list of Azure locations supporting Reserved Instances for IAAS.
        items:
          $ref: '#/definitions/AzureLocation'
        x-ms-identifiers: []
      savingsPlanSupportedOffers:
        type: array
        description: Gets or sets the list of Azure Offers supporting Saving Plans.
        items:
          $ref: '#/definitions/AzureOfferCode'
        x-ms-identifiers: []
      sqlSkus:
        type: array
        description: Gets or sets the list of SQL target SKU properties for dropdowns.
        items:
          $ref: '#/definitions/SqlPaaSTargetOptions'
        x-ms-identifiers: []
      reservedInstanceSqlTargets:
        type: array
        description: Gets or sets the Reserved Instance SQL target types.
        items:
          $ref: '#/definitions/TargetType'
        x-ms-identifiers: []
      reservedInstanceSupportedLocations:
        type: array
        description: Gets or sets the list of Azure locations supporting Reserved Instances.
        items:
          $ref: '#/definitions/AzureLocation'
        x-ms-identifiers: []
      reservedInstanceSupportedCurrencies:
        type: array
        description: Gets or sets the list of currencies supported for Reserved Instances.
        items:
          $ref: '#/definitions/AzureCurrency'
        x-ms-identifiers: []
      reservedInstanceSupportedOffers:
        type: array
        description: Gets or sets the list of offers supported for Reserved Instances.
        items:
          $ref: '#/definitions/AzureOfferCode'
        x-ms-identifiers: []
      supportedOffers:
        type: array
        description: Gets or sets the list of offers supported for SQL assessments.
        items:
          $ref: '#/definitions/AzureOfferCode'
        x-ms-identifiers: []
  SqlAssessmentOptions:
    type: object
    description: SQL Assessment options web model object.
    properties:
      properties:
        $ref: '#/definitions/SqlAssessmentOptionsProperties'
        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
  VmFamilyOptions:
    type: object
    description: 'VM family name, the list of targeted azure locations and the category of the

      family.'
    properties:
      familyName:
        type: string
        description: Name of the VM family.
        readOnly: true
      targetLocations:
        type: array
        description: List of Azure regions.
        items:
          type: string
        readOnly: true
      category:
        type: array
        description: Category of the VM family.
        items:
          type: string
        readOnly: true
  AzureOfferCode:
    type: string
    enum:
    - Unknown
    - MSAZR0003P
    - MSAZR0044P
    - MSAZR0059P
    - MSAZR0060P
    - MSAZR0062P
    - MSAZR0063P
    - MSAZR0064P
    - MSAZR0029P
    - MSAZR0022P
    - MSAZR0023P
    - MSAZR0148P
    - MSAZR0025P
    - MSAZR0036P
    - MSAZR0120P
    - MSAZR0121P
    - MSAZR0122P
    - MSAZR0123P
    - MSAZR0124P
    - MSAZR0125P
    - MSAZR0126P
    - MSAZR0127P
    - MSAZR0128P
    - MSAZR0129P
    - MSAZR0130P
    - MSAZR0111P
    - MSAZR0144P
    - MSAZR0149P
    - MSMCAZR0044P
    - MSMCAZR0059P
    - MSMCAZR0060P
    - MSMCAZR0063P
    - MSMCAZR0120P
    - MSMCAZR0121P
    - MSMCAZR0125P
    - MSMCAZR0128P
    - MSAZRDE0003P
    - MSAZRDE0044P
    - MSAZRUSGOV0003P
    - EA
    - MSAZR0243P
    - SavingsPlan1Year
    - SavingsPlan3Year
    x-ms-enum:
      name: AzureOfferCode
      modelAsString: true
      values:
      - name: Unknown
        value: Unknown
      - name: Msazr0003P
        value: MSAZR0003P
      - name: Msazr0044P
        value: MSAZR0044P
      - name: Msazr0059P
        value: MSAZR0059P
      - name: Msazr0060P
        value: MSAZR0060P
      - name: Msazr0062P
        value: MSAZR0062P
      - name: Msazr0063P
        value: MSAZR0063P
      - name: Msazr0064P
        value: MSAZR0064P
      - name: Msazr0029P
        value: MSAZR0029P
      - name: Msazr0022P
        value: MSAZR0022P
      - name: Msazr0023P
        value: MSAZR0023P
      - name: Msazr0148P
        value: MSAZR0148P
      - name: Msazr0025P
        value: MSAZR0025P
      - name: Msazr0036P
        value: MSAZR0036P
      - name: Msazr0120P
        value: MSAZR0120P
      - name: Msazr0121P
        value: MSAZR0121P
      - name: Msazr0122P
        value: MSAZR0122P
      - name: Msazr0123P
        value: MSAZR0123P
      - name: Msazr0124P
        value: MSAZR0124P
      - name: Msazr0125P
        value: MSAZR0125P
      - name: Msazr0126P
        value: MSAZR0126P
      - name: Msazr0127P
        value: MSAZR0127P
      - name: Msazr0128P
        value: MSAZR0128P
      - name: Msazr0129P
        value: MSAZR0129P
      - name: Msazr0130P
        value: MSAZR0130P
      - name: Msazr0111P
        value: MSAZR0111P
      - name: Msazr0144P
        value: MSAZR0144P
      - name: Msazr0149P
        value: MSAZR0149P
      - name: Msmcazr0044P
        value: MSMCAZR0044P
      - name: Msmcazr0059P
        value: MSMCAZR0059P
      - name: Msmcazr0060P
        value: MSMCAZR0060P
      - name: Msmcazr0063P
        value: MSMCAZR0063P
      - name: Msmcazr0120P
        value: MSMCAZR0120P
      - name: Msmcazr0121P
        value: MSMCAZR0121P
      - name: Msmcazr0125P
        value: MSMCAZR0125P
      - name: Msmcazr0128P
        value: MSMCAZR0128P
      - name: Msazrde0003P
        value: MSAZRDE0003P
      - name: Msazrde0044P
        value: MSAZRDE0044P
      - name: Msazrusgov0003P
        value: MSAZRUSGOV0003P
      - name: EA
        value: EA
      - name: Msazr0243P
        value: MSAZR0243P
      - name: SavingsPlan1Year
        value: SavingsPlan1Year
      - name: SavingsPlan3Year
        value: SavingsPlan3Year
  AzureLocation:
    type: string
    description: Location for Azure.
    enum:
    - Unknown
    - EastAsia
    - SoutheastAsia
    - AustraliaEast
    - AustraliaSoutheast
    - BrazilSouth
    - CanadaCentral
    - CanadaEast
    - WestEurope
    - NorthEurope
    - CentralIndia
    - SouthIndia
    - WestIndia
    - JapanEast
    - JapanWest
    - KoreaCentral
    - KoreaSouth
    - UkWest
    - UkSouth
    - NorthCentralUs
    - EastUs
    - WestUs2
    - SouthCentralUs
    - CentralUs
    - EastUs2
    - WestUs
    - WestCentralUs
    - GermanyCentral
    - GermanyNortheast
    - ChinaNorth
    - ChinaEast
    - USGovArizona
    - USGovTexas
    - USGovIowa
    - USGovVirginia
    - USDoDCentral
    - USDoDEast
    - FranceCentral
    - AustraliaCentral
    - SouthAfricaNorth
    - FranceSouth
    - AustraliaCentral2
    - SouthAfricaWest
    - GermanyNorth
    - GermanyWestCentral
    - NorwayEast
    - NorwayWest
    - ChinaEast2
    - ChinaNorth2
    - SwitzerlandNorth
    - SwitzerlandWest
    - UAENorth
    - UAECentral
    - UsNatEast
    - UsNatWest
    - UsSecEast
    - UsSecCentral
    - UsSecWest
    - SwedenCentral
    - QatarCentral
    x-ms-enum:
      name: AzureLocation
      modelAsString: true
  AzureCurrency:
    type: string
    description: Currency for Azure.
    enum:
    - Unknown
    - USD
    - DKK
    - CAD
    - IDR
    - JPY
    - KRW
    - NZD
    - NOK
    - RUB
    - SAR
    - ZAR
    - SEK
    - TRY
    - GBP
    - MXN
    - MYR
    - INR
    - HKD
    - BRL
    - TWD
    - EUR
    - CHF
    - ARS
    - AUD
    - CNY
    x-ms-enum:
      name: AzureCurrency
      modelAsString: true
  HardwareGeneration:
    type: string
    enum:
    - Unknown
    - Automatic
    - Gen5
    - Fsv2_series
    - M_series
    - DC_series
    x-ms-enum:
      name: HardwareGeneration
      modelAsString: true
      values:
      - name: Unknown
        value: Unknown
      - name: Automatic
        value: Automatic
      - name: Gen5
        value: Gen5
      - name: Fsv2Series
        value: Fsv2_series
      - name: MSeries
        value: M_series
      - name: DCSeries
        value: DC_series
  ComputeTier:
    type: string
    enum:
    - Unknown
    - Automatic
    - Provisioned
    - Serverless
    x-ms-enum:
      name: ComputeTier
      modelAsString: true
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'