swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector AvsAssessedMachinesOperations API
schemes:
- https
tags:
- name: AvsAssessedMachinesOperations
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/avsAssessments/{assessmentName}/avsAssessedMachines
  : get:
      operationId: microsoftAzureAvsassessedmachinesoperationsListbyavsassessment
      tags:
      - AvsAssessedMachinesOperations
      description: List AvsAssessedMachine resources by AvsAssessment
      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: $filter
        in: query
        description: Filter query.
        required: false
        type: string
      - name: pageSize
        in: query
        description: Optional parameter for page size.
        required: false
        type: integer
        format: int32
      - name: continuationToken
        in: query
        description: Optional parameter for continuation token.
        required: false
        type: string
      - name: totalRecordCount
        in: query
        description: Total record count.
        required: false
        type: integer
        format: int32
      - name: projectName
        in: path
        description: Assessment Project Name
        required: true
        type: string
        pattern: ^[^<>&:\?/#]{1,260}$
      - name: groupName
        in: path
        description: Group ARM name
        required: true
        type: string
        pattern: ^[^<>&:\?/#]{1,260}$
      - name: assessmentName
        in: path
        description: AVS Assessment ARM name
        required: true
        type: string
        pattern: ^[^<>&:\?/#]{1,260}$
      responses:
        '200':
          description: ARM operation completed successfully.
          schema:
            $ref: '#/definitions/AvsAssessedMachineListResult'
        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:
        AvsAssessedMachinesOperations_ListByAvsAssessment_MaximumSet_Gen:
          $ref: ./examples/AvsAssessedMachinesOperations_ListByAvsAssessment_MaximumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Migrate Assessmentprojects Projectname Groups Groupname Avsassessments Assessmentname Avsassessedmachines
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/avsAssessments/{assessmentName}/avsAssessedMachines/{avsAssessedMachineName}
  : get:
      operationId: microsoftAzureAvsassessedmachinesoperationsGet
      tags:
      - AvsAssessedMachinesOperations
      description: Get a AvsAssessedMachine
      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: groupName
        in: path
        description: Group ARM name
        required: true
        type: string
        pattern: ^[^<>&:\?/#]{1,260}$
      - name: assessmentName
        in: path
        description: AVS Assessment ARM name
        required: true
        type: string
        pattern: ^[^<>&:\?/#]{1,260}$
      - name: avsAssessedMachineName
        in: path
        description: AVS assessment Assessed Machine ARM name
        required: true
        type: string
        pattern: ^[^<>&:\?/#]{1,260}$
      responses:
        '200':
          description: ARM operation completed successfully.
          schema:
            $ref: '#/definitions/AvsAssessedMachine'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        AvsAssessedMachinesOperations_Get_MaximumSet_Gen:
          $ref: ./examples/AvsAssessedMachinesOperations_Get_MaximumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Migrate Assessmentprojects Projectname Groups Groupname Avsassessments Assessmentname Avsassessedmachines Avsassessedmachinename
definitions:
  AssessedMachineType:
    type: string
    enum:
    - Unknown
    - AssessedMachine
    - AvsAssessedMachine
    - SqlAssessedMachine
    x-ms-enum:
      name: AssessedMachineType
      modelAsString: true
  GuestOperatingSystemArchitecture:
    type: string
    enum:
    - Unknown
    - X86
    - X64
    x-ms-enum:
      name: GuestOperatingSystemArchitecture
      modelAsString: true
  AvsAssessedMachineProperties:
    type: object
    description: AVS assessed machine properties web model.
    properties:
      errors:
        type: array
        description: List of errors for this machine.
        items:
          $ref: '#/definitions/Error'
        readOnly: true
        x-ms-identifiers: []
      disks:
        type: object
        description: List of Disks that were assessed as part of this machine's assessment.
        additionalProperties:
          $ref: '#/definitions/AvsAssessedDisk'
        readOnly: true
      networkAdapters:
        type: object
        description: 'List of Network Adapters that were assessed as part of this machine''s

          assessment.'
        additionalProperties:
          $ref: '#/definitions/AvsAssessedNetworkAdapter'
        readOnly: true
      storageInUseGB:
        type: number
        format: float
        description: Gets the storage in use.
        readOnly: true
      suitabilityExplanation:
        $ref: '#/definitions/AzureAvsVmSuitabilityExplanation'
        description: Gets the explanation if machine is not suitable for cloud.
        readOnly: true
      suitabilityDetail:
        $ref: '#/definitions/AzureAvsVmSuitabilityDetail'
        description: Gets the details if machine is not suitable for cloud.
        readOnly: true
      type:
        $ref: '#/definitions/AssessedMachineType'
        description: Assessed machine type.
        readOnly: true
      bootType:
        $ref: '#/definitions/MachineBootType'
        description: Boot type of machine discovered in private data center.
        readOnly: true
      operatingSystemType:
        type: string
        description: Operating system as reported by datacenter management solution.
        readOnly: true
      operatingSystemName:
        type: string
        description: Operating system as reported by datacenter management solution.
        readOnly: true
      operatingSystemVersion:
        type: string
        description: Operating system version as reported by datacenter management solution.
        readOnly: true
      operatingSystemArchitecture:
        $ref: '#/definitions/GuestOperatingSystemArchitecture'
        description: Operating system architecture as reported by datacenter management solution.
        readOnly: true
      createdTimestamp:
        type: string
        format: date-time
        description: When was machine first created.
        readOnly: true
      updatedTimestamp:
        type: string
        format: date-time
        description: When was machine last updated.
        readOnly: true
      displayName:
        type: string
        description: Display Name of the Machine.
        readOnly: true
      description:
        type: string
        description: Description for the machine.
        readOnly: true
      datacenterMachineArmId:
        type: string
        description: Data center machine ARM id.
        readOnly: true
      datacenterManagementServerArmId:
        type: string
        description: Data center management server ARM id.
        readOnly: true
      datacenterManagementServerName:
        type: string
        description: Data center management server name.
        readOnly: true
      megabytesOfMemory:
        type: number
        format: float
        description: Megabytes of memory found allocated for the machine in private data center.
        readOnly: true
      numberOfCores:
        type: integer
        format: int32
        description: Number of CPU cores found on the machine.
        readOnly: true
      confidenceRatingInPercentage:
        type: number
        format: float
        description: Confidence Rating in Percentage.
        readOnly: true
      percentageCoresUtilization:
        type: number
        format: float
        description: "Percentile of Percentage of Cores Utilized noted during time period T.\n        \n   Here N and T are settings on Assessment."
        readOnly: true
      percentageMemoryUtilization:
        type: number
        format: float
        description: "Percentile of Percentage of Memory Utilized noted during time period T.\n       \n    Here N and T are settings on Assessment."
        readOnly: true
      suitability:
        $ref: '#/definitions/CloudSuitability'
        description: 'Gets a value indicating whether machine is suitable for the cloud platform

          selected.'
        readOnly: true
  AvsAssessedMachine:
    type: object
    description: AVS assessment Assessed Machine resource.
    properties:
      properties:
        $ref: '#/definitions/AvsAssessedMachineProperties'
        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
  AzureAvsVmSuitabilityDetail:
    type: string
    enum:
    - None
    - PercentageOfCoresUtilizedMissing
    - PercentageOfMemoryUtilizedMissing
    - PercentageOfCoresUtilizedOutOfRange
    - PercentageOfMemoryUtilizedOutOfRange
    - PercentageOfStorageUtilizedOutOfRange
    x-ms-enum:
      name: AzureAvsVmSuitabilityDetail
      modelAsString: true
  CloudSuitability:
    type: string
    description: Cloud Suitability for Azure.
    enum:
    - Unknown
    - NotSuitable
    - Suitable
    - ConditionallySuitable
    - ReadinessUnknown
    x-ms-enum:
      name: CloudSuitability
      modelAsString: true
      values:
      - name: Unknown
        value: Unknown
        description: Unknown. Indicates missing data.
      - name: NotSuitable
        value: NotSuitable
        description: Not Suitable for Azure.
      - name: Suitable
        value: Suitable
        description: Suitable for Azure.
      - name: ConditionallySuitable
        value: ConditionallySuitable
        description: Conditionally Suitable for Azure.
      - name: ReadinessUnknown
        value: ReadinessUnknown
        description: Unknown Readiness for Azure.
  MachineBootType:
    type: string
    enum:
    - Unknown
    - EFI
    - BIOS
    - NotSpecified
    x-ms-enum:
      name: MachineBootType
      modelAsString: true
      values:
      - name: Unknown
        value: Unknown
      - name: EFI
        value: EFI
      - name: Bios
        value: BIOS
      - name: NotSpecified
        value: NotSpecified
  AvsAssessedMachineListResult:
    type: object
    description: The response of a AvsAssessedMachine list operation.
    properties:
      value:
        type: array
        description: The AvsAssessedMachine items on this page
        items:
          $ref: '#/definitions/AvsAssessedMachine'
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
  AzureAvsVmSuitabilityExplanation:
    type: string
    enum:
    - Unknown
    - NotApplicable
    - IpV6NotSupported
    - UnsupportedOperatingSystem
    x-ms-enum:
      name: AzureAvsVmSuitabilityExplanation
      modelAsString: true
  Error:
    type: object
    description: Error web model class.
    properties:
      id:
        type: integer
        format: int32
        description: Gets the error ID.
        readOnly: true
      code:
        type: string
        description: Gets the error code.
        readOnly: true
      runAsAccountId:
        type: string
        description: Gets the Run as account ID.
        readOnly: true
      applianceName:
        type: string
        description: Gets the Appliance name.
        readOnly: true
      message:
        type: string
        description: Gets the error message.
        readOnly: true
      summaryMessage:
        type: string
        description: Gets the error summary message.
        readOnly: true
      agentScenario:
        type: string
        description: Gets the agent scenario where this error occurred.
        readOnly: true
      possibleCauses:
        type: string
        description: Gets the error possible causes.
        readOnly: true
      recommendedAction:
        type: string
        description: Gets the recommended action for the error.
        readOnly: true
      severity:
        type: string
        description: Gets the error severity.
        readOnly: true
      messageParameters:
        type: object
        description: Gets the error message parameters.
        additionalProperties:
          type: string
        readOnly: true
      updatedTimeStamp:
        type: string
        format: date-time
        description: Gets the time stamp when the error was updated.
        readOnly: true
      impactedAssessmentType:
        type: string
        description: Gets the type of assessment impacted by this error.
        readOnly: true
  AvsAssessedNetworkAdapter:
    type: object
    description: Second level object returned as part of AVS AssessedMachine REST resource.
    properties:
      macAddress:
        type: string
        description: Mac address of the NIC.
        readOnly: true
      ipAddresses:
        type: array
        description: IP V4 addresses for the machine.
        items:
          type: string
        readOnly: true
      displayName:
        type: string
        description: Gets the display name of the network adapter.
        readOnly: true
      megabytesPerSecondReceived:
        type: number
        format: float
        description: "Gets the Received data for Network Adapter in MB/s.\n            This value is\nthe percentile of historical data based on options selected in Assessment."
        readOnly: true
      megabytesPerSecondTransmitted:
        type: number
        format: float
        description: "Gets the Transmitted data for Network Adapter in MB/s.\n            This value\nis the percentile of historical data based on options selected in Assessment."
        readOnly: true
  AvsAssessedDisk:
    type: object
    description: AVS assessed disk web model class.
    properties:
      name:
        type: string
        description: Gets the ID of the disk.
        readOnly: true
      displayName:
        type: string
        description: Gets the display name of the disk.
        readOnly: true
      gigabytesProvisioned:
        type: number
        format: float
        description: Gigabytes Provisioned for a disk in private data center.
        readOnly: true
      megabytesPerSecondOfRead:
        type: number
        format: float
        description: Disk Read Throughput in MB/s.
        readOnly: true
      megabytesPerSecondOfWrite:
        type: number
        format: float
        description: Disk Write Throughput in MB/s.
        readOnly: true
      numberOfReadOperationsPerSecond:
        type: number
        format: float
        description: Read Operations per second.
        readOnly: true
      numberOfWriteOperationsPerSecond:
        type: number
        format: float
        description: Write Operations per second.
        readOnly: true
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'