swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector TomcatWebServersController API
schemes:
- https
tags:
- name: TomcatWebServersController
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/tomcatWebServers
  : get:
      operationId: microsoftAzureTomcatwebserverscontrollerListbywebappsite
      tags:
      - TomcatWebServersController
      description: Method to get all Tomcat 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/TomcatWebServersListResult'
        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:
        TomcatWebServersController_ListByWebAppSite_MaximumSet_Gen:
          $ref: ./examples/TomcatWebServersController_ListByWebAppSite_MaximumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Mastersites Sitename Webappsites Webappsitename Tomcatwebservers
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/tomcatWebServers/{webServerName}
  : get:
      operationId: microsoftAzureTomcatwebserverscontrollerGet
      tags:
      - TomcatWebServersController
      description: Method to get an Tomcat web server.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - 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}$
      - name: webServerName
        in: path
        description: Web server name.
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      responses:
        '200':
          description: ARM operation completed successfully.
          schema:
            $ref: '#/definitions/TomcatWebServers'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        TomcatWebServersController_Get_MaximumSet_Gen:
          $ref: ./examples/TomcatWebServersController_Get_MaximumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Mastersites Sitename Webappsites Webappsitename Tomcatwebservers Webservername
definitions:
  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.
  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
  OperatingSystem:
    type: object
    description: Second level object returned as part of Machine REST resource.
    properties:
      osType:
        type: string
        description: Gets or sets the type of the operating system.
      osName:
        type: string
        description: Gets or sets the Name of the operating system.
      osVersion:
        type: string
        description: Gets or sets the Version of the operating system.
      osArchitecture:
        type: string
        description: Gets or sets the Architecture of the operating system.
  TomcatWebServersListResult:
    type: object
    description: The response of a TomcatWebServers list operation.
    properties:
      value:
        type: array
        description: The TomcatWebServers items on this page
        items:
          $ref: '#/definitions/TomcatWebServers'
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
  ConnectorUnit:
    type: object
    description: The connectors of the web server.
    properties:
      bindings:
        type: array
        description: Gets or sets the bindings for the connector.
        items:
          $ref: '#/definitions/FrontEndBinding'
        x-ms-identifiers: []
  TomcatEngineUnit:
    type: object
    description: Tomcat engine data.
    properties:
      name:
        type: string
        description: Gets or sets the name of the engine.
      hosts:
        type: array
        description: Gets or sets the hosts defined for the engine.
        items:
          $ref: '#/definitions/TomcatHostUnit'
        x-ms-identifiers: []
  TomcatServiceUnit:
    type: object
    description: Tomcat service data.
    properties:
      name:
        type: string
        description: Gets or sets the name of the service.
      connectors:
        type: array
        description: Gets or sets the connectors defined for the service component.
        items:
          $ref: '#/definitions/ConnectorUnit'
        x-ms-identifiers: []
      engine:
        $ref: '#/definitions/TomcatEngineUnit'
        description: Gets or sets the engine defined for the service component.
  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.
  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.
  TomcatWebServers:
    type: object
    description: Web server REST Resource.
    properties:
      properties:
        $ref: '#/definitions/TomcatWebServerProperties'
        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
  FrontEndBinding:
    type: object
    description: Frontend bindings for a web application.
    properties:
      protocol:
        type: string
        description: Gets or sets the Binding protocol.
      hostName:
        type: string
        description: Gets or sets the Host name.
      port:
        type: string
        description: Gets or sets the Port number.
      ipAddress:
        type: string
        description: Gets or sets the IP Address.
  TomcatWebServerProperties:
    type: object
    description: Class for web server properties.
    properties:
      services:
        type: array
        description: Gets or sets the services defined in the server.
        items:
          $ref: '#/definitions/TomcatServiceUnit'
        x-ms-identifiers: []
      catalinaHome:
        type: string
        description: Catalina Home
        readOnly: true
      jvmVersion:
        type: string
        description: Version  of the JVM
        readOnly: true
      sessionPersistenceMechanism:
        type: string
        description: session persistence mechanism
        readOnly: true
      isClusteringPresent:
        type: boolean
        description: Gets a value indicating whether application is deleted.
      isMemoryRealmPresent:
        type: boolean
        description: Gets a value indicating whether application is deleted.
        readOnly: true
      isSessionTrackingPresent:
        type: boolean
        description: is session tracking present
        readOnly: true
      isAccessLogValvePresent:
        type: boolean
        description: is access log valve present
        readOnly: true
      maxMemoryUsageInMb:
        type: string
        description: max memory usage in mb
        readOnly: true
      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
      operatingSystemDetails:
        $ref: '#/definitions/OperatingSystem'
        description: Gets or sets the Operating System Details installed on the machine.
      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
  TomcatHostUnit:
    type: object
    description: Tomcat host data.
    properties:
      name:
        type: string
        description: Gets or sets the name of the host.
      appBasePath:
        type: string
        description: Gets or sets the app base path for the host.
      appBase:
        type: string
        description: Gets or sets the app base value configured for the host.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'