swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector WebServersController API
schemes:
- https
tags:
- name: WebServersController
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/webServers
  : get:
      operationId: microsoftAzureWebserverscontrollerListbywebappsite
      tags:
      - WebServersController
      description: Method to get all web servers.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - name: filter
        in: query
        description: filter query
        required: false
        type: string
      - name: top
        in: query
        description: page size  query
        required: false
        type: string
      - name: continuationToken
        in: query
        description: Optional parameter for continuation token.
        required: false
        type: string
      - name: totalRecordCount
        in: query
        description: Total count of machines in the given site.
        required: false
        type: integer
        format: int32
      - name: siteName
        in: path
        description: Site name
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: webAppSiteName
        in: path
        description: Web app site name.
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      responses:
        '200':
          description: ARM operation completed successfully.
          schema:
            $ref: '#/definitions/WebServerListResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        WebServersController_ListByWebAppSite_MaximumSet_Gen:
          $ref: ./examples/WebServersController_ListByWebAppSite_MaximumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Mastersites Sitename Webappsites Webappsitename Webservers
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/webServers
  : get:
      tags:
      - WebServersController
      summary: Microsoft Azure Gets A List Of Webservers In The Migrate Project
      operationId: microsoftAzureWebserverscontrollerListwebservers
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/migrateProjectName'
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/continuationToken'
      - $ref: '#/parameters/pageSize'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/WebServerCollection'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      deprecated: false
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        WebServersController_ListWebServers_MaximumSet_Gen:
          $ref: ./examples/WebServersController_ListWebServers_MaximumSet_Gen.json
        WebServersController_ListWebServers_MinimumSet_Gen:
          $ref: ./examples/WebServersController_ListWebServers_MinimumSet_Gen.json
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/webServers/{webServerId}
  : get:
      tags:
      - WebServersController
      summary: Microsoft Azure Gets A Webserver In The Migrate Project
      operationId: microsoftAzureWebserverscontrollerGetwebserver
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/migrateProjectName'
      - $ref: '#/parameters/webServerId'
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/WebServer_2'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      deprecated: false
      x-ms-examples:
        WebServersController_GetWebServer_MaximumSet_Gen:
          $ref: ./examples/WebServersController_GetWebServer_MaximumSet_Gen.json
        WebServersController_GetWebServer_MinimumSet_Gen:
          $ref: ./examples/WebServersController_GetWebServer_MinimumSet_Gen.json
      description: Needs a more full description created.
definitions:
  WebServerProperties:
    type: object
    description: Class for web server properties.
    properties:
      configurationLocation:
        type: string
        description: Gets the configuration location.
        readOnly: true
      version:
        type: string
        description: Gets the configuration location.
        readOnly: true
      machineIds:
        type: array
        description: Gets the list of machines.
        items:
          type: string
        readOnly: true
      webApplications:
        type: array
        description: Gets the list of web applications.
        items:
          type: string
        readOnly: true
      displayName:
        type: string
        description: Gets the display name.
        readOnly: true
      serverFqdn:
        type: string
        description: Gets the server FQDN.
        readOnly: true
      runAsAccountId:
        type: string
        description: Gets the run as account id.
        readOnly: true
      isDeleted:
        type: boolean
        description: Gets a value indicating whether application is deleted.
        readOnly: true
      createdTimestamp:
        type: string
        description: Gets the timestamp marking creation of the entity.
        readOnly: true
      updatedTimestamp:
        type: string
        description: Gets the timestamp marking last update operation.
        readOnly: true
      serverType:
        type: string
        description: Gets the server type.
        readOnly: true
      errors:
        type: array
        description: Gets the Error details.
        items:
          $ref: '#/definitions/HealthErrorDetails'
        readOnly: true
      applianceNames:
        type: array
        description: Gets the appliance names.
        items:
          type: string
        readOnly: true
      hasErrors:
        type: boolean
        description: Gets a value indicating whether the WebApp has errors or not.
        readOnly: true
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        description: provisioning state enum
        readOnly: true
  HealthErrorDetails:
    type: object
    description: Error contract returned when some exception occurs in Rest API.
    properties:
      message:
        type: string
        description: Gets the error message.
        readOnly: true
      messageParameters:
        type: object
        description: Gets the message parameters.
        additionalProperties:
          type: string
        readOnly: true
      applianceName:
        type: string
        description: Gets the appliance name.
        readOnly: true
      id:
        type: integer
        format: int64
        description: Gets the error ID.
        readOnly: true
      code:
        type: string
        description: Gets the error name.
        readOnly: true
      possibleCauses:
        type: string
        description: Gets the possible causes of error.
        readOnly: true
      recommendedAction:
        type: string
        description: Gets the recommended action to resolve error.
        readOnly: true
      severity:
        type: string
        description: Gets the error severity.
        readOnly: true
      summaryMessage:
        type: string
        description: Gets the error summary message.
        readOnly: true
      source:
        $ref: '#/definitions/HealthErrorDetailsSource'
        description: Gets the error source.
        readOnly: true
      updatedTimeStamp:
        type: string
        format: date-time
        description: Gets the time stamp when the error was updated.
        readOnly: true
      runAsAccountId:
        type: string
        description: Gets run as account id used while performing discovery             of entity.
        readOnly: true
      discoveryScope:
        $ref: '#/definitions/HealthErrorDetailsDiscoveryScope'
        description: Gets discovery scope for which             error is encountered.
        readOnly: true
  WebServerCollection:
    type: object
    description: Collection of web servers.
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/WebServer_2'
      nextLink:
        type: string
  WebServerListResult:
    type: object
    description: The response of a WebServer list operation.
    properties:
      value:
        type: array
        description: The WebServer items on this page
        items:
          $ref: '#/definitions/WebServer'
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
  HealthErrorDetailsDiscoveryScope:
    type: string
    description: Gets discovery scope for which             error is encountered.
    enum:
    - AppsAndRoles
    - DependencyMap
    - StaticData
    - SQLServerConnectionInfo
    - DiscoveryTargets
    x-ms-enum:
      name: HealthErrorDetailsDiscoveryScope
      modelAsString: true
      values:
      - name: AppsAndRoles
        value: AppsAndRoles
        description: AppsAndRoles value.
      - name: DependencyMap
        value: DependencyMap
        description: DependencyMap value.
      - name: StaticData
        value: StaticData
        description: StaticData value.
      - name: SQLServerConnectionInfo
        value: SQLServerConnectionInfo
        description: SQLServerConnectionInfo value.
      - name: DiscoveryTargets
        value: DiscoveryTargets
        description: DiscoveryTargets value.
  WebServerSummary:
    type: object
    description: Summary of information representing web server.
    properties:
      discoveredCount:
        format: int32
        type: integer
      assessedCount:
        format: int32
        type: integer
      readyForMigration:
        format: int32
        type: integer
      migratingCount:
        format: int32
        type: integer
      migratedCount:
        format: int32
        type: integer
  ProvisioningState:
    type: string
    description: The status of the current operation.
    enum:
    - Created
    - Updated
    - Running
    - Completed
    - Failed
    - Succeeded
    - Canceled
    x-ms-enum:
      name: ProvisioningState
      modelAsString: true
      values:
      - name: Created
        value: Created
        description: Created value.
      - name: Updated
        value: Updated
        description: Updated value.
      - name: Running
        value: Running
        description: Running value.
      - name: Completed
        value: Completed
        description: Completed value.
      - name: Failed
        value: Failed
        description: Failed value.
      - name: Succeeded
        value: Succeeded
        description: Succeeded value.
      - name: Canceled
        value: Canceled
        description: Canceled value.
  WebServerDiscoveryDetails:
    type: object
    description: Details of discovery data of web server.
    properties:
      id:
        description: Gets the relative URL to get to this WebServerDiscoveryDetails resource.
        type: string
      osName:
        type: string
      osVersion:
        type: string
      cpuCores:
        format: int32
        type: integer
      memoryInMb:
        type: string
      webServerType:
        type: string
      webServerVersion:
        type: string
      portList:
        type: array
        items:
          format: int32
          type: integer
      lastUpdatedTime:
        format: date-time
        type: string
      enqueueTime:
        type: string
      solutionName:
        type: string
      webServerId:
        type: string
      webServerName:
        type: string
      extendedInfo:
        type: object
        additionalProperties:
          type: string
  WebServer:
    type: object
    description: Web application REST Resource.
    properties:
      properties:
        $ref: '#/definitions/WebServerProperties'
        description: The resource-specific properties for this resource.
        x-ms-client-flatten: true
        x-ms-mutability:
        - read
        - create
    allOf:
    - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource
  WebServer_2:
    type: object
    description: Class representing a web server.
    properties:
      id:
        type: string
      name:
        type: string
      type:
        type: string
        readOnly: true
      properties:
        $ref: '#/definitions/WebServerProperties_2'
  HealthErrorDetailsSource:
    type: string
    description: HealthError Details Source
    enum:
    - RefreshFabricLayout
    - RefreshFabricLayoutGuest
    - RefreshFabricLayoutDependencyMap
    x-ms-enum:
      name: HealthErrorDetailsSource
      modelAsString: true
      values:
      - name: RefreshFabricLayout
        value: RefreshFabricLayout
        description: RefreshFabricLayout value.
      - name: RefreshFabricLayoutGuest
        value: RefreshFabricLayoutGuest
        description: RefreshFabricLayoutGuest value.
      - name: RefreshFabricLayoutDependencyMap
        value: RefreshFabricLayoutDependencyMap
        description: RefreshFabricLayoutDependencyMap value.
  WebServerProperties_2:
    type: object
    description: Properties of class representing web server.
    properties:
      discoveryData:
        type: array
        items:
          $ref: '#/definitions/WebServerDiscoveryDetails'
      summary:
        type: object
        additionalProperties:
          $ref: '#/definitions/WebServerSummary'
      lastUpdatedTime:
        format: date-time
        type: string
parameters:
  migrateProjectName:
    name: migrateProjectName
    description: Name of the Azure Migrate project.
    type: string
    in: path
    x-ms-parameter-location: method
    required: true
    pattern: ^[a-zA-Z0-9-]{3,24}$
  webServerId:
    name: webServerId
    description: The ARM name of the virtual desktop user.
    type: string
    in: path
    x-ms-parameter-location: method
    required: true
  pageSize:
    name: pageSize
    description: The number of items to be returned in a single page. This value is honored only if it is less than the 100.
    type: integer
    format: int32
    in: query
    required: false
    x-ms-parameter-location: method
  continuationToken:
    name: continuationToken
    description: The continuation token.
    type: string
    in: query
    required: false
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'