Microsoft Azure AvsAssessmentOptionsOperations API

openapi: 3.2.0
info:
  title: Microsoft Azure Azure Migrate Assessment Service Avs…
  version: 2023-04-01-preview
  description: Azure Migrate Resource Provider management API.
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: AvsAssessmentOptionsOperations
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/avsAssessmentOptions
  : get:
      operationId: microsoftAzureAvsassessmentoptionsoperationsListbyassessmentproject
      tags:
      - AvsAssessmentOptionsOperations
      description: List AvsAssessmentOptions 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
        schema:
          type: string
          pattern: ^[^<>&:\?/#]{1,260}$
      responses:
        '200':
          description: ARM operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvsAssessmentOptionsListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        AvsAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen:
          $ref: ./examples/AvsAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/avsAssessmentOptions/{avsAssessmentOptionsName}
  : get:
      operationId: microsoftAzureAvsassessmentoptionsoperationsGet
      tags:
      - AvsAssessmentOptionsOperations
      description: Get a AvsAssessmentOptions
      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
        schema:
          type: string
          pattern: ^[^<>&:\?/#]{1,260}$
      - name: avsAssessmentOptionsName
        in: path
        description: AVS Assessment options ARM name. Accepted value is 'default'
        required: true
        schema:
          type: string
          pattern: ^[^<>&:\?/#]{1,260}$
      responses:
        '200':
          description: ARM operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvsAssessmentOptions'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        AvsAssessmentOptionsOperations_Get_MaximumSet_Gen:
          $ref: ./examples/AvsAssessmentOptionsOperations_Get_MaximumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
components:
  schemas:
    AvsAssessmentOptionsProperties:
      type: object
      description: AVS Assessment options properties.
      properties:
        avsNodes:
          type: array
          description: AVS SKU Nodes.
          items:
            $ref: '#/components/schemas/AvsSkuOptions'
          x-ms-identifiers: []
        failuresToTolerateAndRaidLevelValues:
          type: array
          description: FTT and Raid level values.
          items:
            $ref: '#/components/schemas/FttAndRaidLevel'
        reservedInstanceAvsNodes:
          type: array
          description: List of AVS nodes for RI.
          items:
            $ref: '#/components/schemas/AzureAvsNodeType'
        reservedInstanceSupportedLocations:
          type: array
          description: List of supported Azure regions for reserved instances.
          items:
            $ref: '#/components/schemas/AzureLocation'
        reservedInstanceSupportedCurrencies:
          type: array
          description: List of supported currencies for reserved instances.
          items:
            $ref: '#/components/schemas/AzureCurrency'
        reservedInstanceSupportedOffers:
          type: array
          description: List of supported Azure offer codes for reserved instances.
          items:
            $ref: '#/components/schemas/AzureOfferCode'
    FttAndRaidLevel:
      type: string
      description: FTT and RAID Level.
      enum:
      - Unknown
      - Ftt1Raid1
      - Ftt1Raid5
      - Ftt2Raid1
      - Ftt2Raid6
      - Ftt3Raid1
      x-ms-enum:
        name: FttAndRaidLevel
        modelAsString: true
        values:
        - name: Unknown
          value: Unknown
          description: Unknown FTT and RAID Level.
        - name: Ftt1Raid1
          value: Ftt1Raid1
          description: FTT 1 and RAID Level 1.
        - name: Ftt1Raid5
          value: Ftt1Raid5
          description: FTT 1 and RAID Level 5.
        - name: Ftt2Raid1
          value: Ftt2Raid1
          description: FTT 2 and RAID Level 1.
        - name: Ftt2Raid6
          value: Ftt2Raid6
          description: FTT 2 and RAID Level 6.
        - name: Ftt3Raid1
          value: Ftt3Raid1
          description: FTT 3 and RAID Level 1.
    AvsAssessmentOptions:
      type: object
      description: AVS Assessment options resource.
      properties:
        properties:
          $ref: '#/components/schemas/AvsAssessmentOptionsProperties'
          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
    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
    AzureAvsNodeType:
      type: string
      enum:
      - Unknown
      - AV36
      x-ms-enum:
        name: AzureAvsNodeType
        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
    AvsAssessmentOptionsListResult:
      type: object
      description: The response of a AvsAssessmentOptions list operation.
      properties:
        value:
          type: array
          description: The AvsAssessmentOptions items on this page
          items:
            $ref: '#/components/schemas/AvsAssessmentOptions'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    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
    AvsSkuOptions:
      type: object
      description: AVS SKU specific options.
      properties:
        nodeType:
          $ref: '#/components/schemas/AzureAvsNodeType'
          description: AVS Node type.
        targetLocations:
          type: array
          description: List of locations where this node type is available.
          items:
            $ref: '#/components/schemas/AzureLocation'
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.