swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector WebAppSitesController API
schemes:
- https
tags:
- name: WebAppSitesController
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites
  : get:
      operationId: microsoftAzureWebappsitescontrollerListbymastersite
      tags:
      - WebAppSitesController
      description: Method to get all sites.
      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}$
      responses:
        '200':
          description: ARM operation completed successfully.
          schema:
            $ref: '#/definitions/WebAppSiteListResult'
        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:
        WebAppSitesController_ListByMasterSite_MaximumSet_Gen:
          $ref: ./examples/WebAppSitesController_ListByMasterSite_MaximumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Mastersites Sitename Webappsites
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}
  : get:
      operationId: microsoftAzureWebappsitescontrollerGet
      tags:
      - WebAppSitesController
      description: Method to get a site.
      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}$
      responses:
        '200':
          description: ARM operation completed successfully.
          schema:
            $ref: '#/definitions/WebAppSite'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        WebAppSitesController_Get_MaximumSet_Gen:
          $ref: ./examples/WebAppSitesController_Get_MaximumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Mastersites Sitename Webappsites Webappsitename
    put:
      operationId: microsoftAzureWebappsitescontrollerCreate
      tags:
      - WebAppSitesController
      description: Method to create a WebApp site.
      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: body
        in: body
        description: Resource create parameters.
        required: true
        schema:
          $ref: '#/definitions/WebAppSite'
      responses:
        '200':
          description: ARM update operation completed successfully.
          schema:
            $ref: '#/definitions/WebAppSite'
        '201':
          description: ARM create operation completed successfully.
          schema:
            $ref: '#/definitions/WebAppSite'
          headers:
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        WebAppSitesController_Create_MaximumSet_Gen:
          $ref: ./examples/WebAppSitesController_Create_MaximumSet_Gen.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Mastersites Sitename Webappsites Webappsitename
    patch:
      operationId: microsoftAzureWebappsitescontrollerUpdate
      tags:
      - WebAppSitesController
      description: Method to update an existing site.
      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: properties
        in: body
        description: The resource properties to be updated.
        required: true
        schema:
          $ref: '#/definitions/WebAppSiteUpdate'
      responses:
        '200':
          description: ARM operation completed successfully.
          schema:
            $ref: '#/definitions/WebAppSite'
        '202':
          description: Resource update request accepted.
          headers:
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
            Location:
              type: string
              description: The Location header contains the URL where the status of the long running operation can be checked.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      x-ms-examples:
        WebAppSitesController_Update_MaximumSet_Gen:
          $ref: ./examples/WebAppSitesController_Update_MaximumSet_Gen.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Mastersites Sitename Webappsites Webappsitename
    delete:
      operationId: microsoftAzureWebappsitescontrollerDelete
      tags:
      - WebAppSitesController
      description: Deletes the WebApp site.
      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}$
      responses:
        '200':
          description: Resource deleted successfully.
        '202':
          description: Resource deletion accepted.
          headers:
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
            Location:
              type: string
              description: The Location header contains the URL where the status of the long running operation can be checked.
        '204':
          description: Resource deleted successfully.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      x-ms-examples:
        WebAppSitesController_Delete_MaximumSet_Gen:
          $ref: ./examples/WebAppSitesController_Delete_MaximumSet_Gen.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Mastersites Sitename Webappsites Webappsitename
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/errorSummary
  : post:
      operationId: microsoftAzureWebappsitescontrollerErrorsummary
      tags:
      - WebAppSitesController
      description: MMethod to get error summary from web app  site.
      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: body
        in: body
        description: The content of the action request
        required: true
        schema:
          $ref: '#/definitions/ErrorSummaryRequest'
      responses:
        '200':
          description: ARM operation completed successfully.
          schema:
            $ref: '#/definitions/SiteErrorSummary'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        WebAppSitesController_ErrorSummary_MaximumSet_Gen:
          $ref: ./examples/WebAppSitesController_ErrorSummary_MaximumSet_Gen.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Mastersites Sitename Webappsites Webappsitename Errorsummary
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/exportInventory
  : post:
      operationId: microsoftAzureWebappsitescontrollerExportinventory
      tags:
      - WebAppSitesController
      description: Method to generate report containing web app inventory.
      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: body
        in: body
        description: The content of the action request
        required: true
        schema:
          $ref: '#/definitions/ExportWebAppsRequest'
      responses:
        '200':
          description: ARM operation completed successfully.
          schema:
            type: object
        '202':
          description: Resource operation accepted.
          headers:
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
            Location:
              type: string
              description: The Location header contains the URL where the status of the long running operation can be checked.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      x-ms-examples:
        WebAppSitesController_ExportInventory_MaximumSet_Gen:
          $ref: ./examples/WebAppSitesController_ExportInventory_MaximumSet_Gen.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Mastersites Sitename Webappsites Webappsitename Exportinventory
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/refresh
  : post:
      operationId: microsoftAzureWebappsitescontrollerRefresh
      tags:
      - WebAppSitesController
      description: Method to refresh a site.
      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: body
        in: body
        description: The content of the action request
        required: true
        schema:
          $ref: '#/definitions/ProxySiteRefreshBody'
      responses:
        '200':
          description: ARM operation completed successfully.
          schema:
            type: object
        '202':
          description: Resource operation accepted.
          headers:
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
            Location:
              type: string
              description: The Location header contains the URL where the status of the long running operation can be checked.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      x-ms-examples:
        WebAppSitesController_Refresh_MaximumSet_Gen:
          $ref: ./examples/WebAppSitesController_Refresh_MaximumSet_Gen.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Mastersites Sitename Webappsites Webappsitename Refresh
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/summary
  : post:
      operationId: microsoftAzureWebappsitescontrollerSummary
      tags:
      - WebAppSitesController
      description: Method to get site usage/summary.
      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}$
      responses:
        '200':
          description: ARM operation completed successfully.
          schema:
            $ref: '#/definitions/WebAppSiteUsage'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        WebAppSitesController_Summary_MaximumSet_Gen:
          $ref: ./examples/WebAppSitesController_Summary_MaximumSet_Gen.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Mastersites Sitename Webappsites Webappsitename Summary
definitions:
  WebAppSiteUsage:
    type: object
    description: Web app site usage.
    properties:
      webServerCount:
        type: integer
        format: int32
        description: Gets or sets the number of web servers discovered in the site.
      webApplicationCount:
        type: integer
        format: int32
        description: Gets or sets the number of web applications discovered in the site.
      runAsAccountCount:
        type: integer
        format: int32
        description: Gets or sets the number of run as accounts in the site.
  ProxySiteRefreshBody:
    type: object
    description: Request body for Proxy site refresh action.
    properties:
      applianceName:
        type: string
        description: Gets or sets the appliance name of the agent in the site.
  WebAppSiteUpdate:
    type: object
    description: The type used for update operations of the WebAppSite.
    properties:
      properties:
        $ref: '#/definitions/WebAppSiteUpdateProperties'
        x-ms-client-flatten: true
  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.
  WebAppSitePropertiesDiscoveryScenario:
    type: string
    description: Discovery Scenario
    enum:
    - Migrate
    - DR
    x-ms-enum:
      name: WebAppSitePropertiesDiscoveryScenario
      modelAsString: true
      values:
      - name: Migrate
        value: Migrate
        description: Migrate value.
      - name: DR
        value: DR
        description: DR value.
  SiteAgentProperties:
    type: object
    description: Class for site agent properties.
    properties:
      id:
        type: string
        description: Gets the ID of the agent.
        readOnly: true
      version:
        type: string
        description: Gets the version of the agent.
        readOnly: true
      lastHeartBeatUtc:
        type: string
        format: date-time
        description: Gets the last heartbeat time of the agent in UTC.
        readOnly: true
      keyVaultUri:
        type: string
        description: Gets or sets the key vault URI.
      keyVaultId:
        type: string
        description: Gets or sets the key vault ARM Id.
  DiscoveryScopeErrorSummary:
    type: object
    description: The site error summary model.
    properties:
      affectedResourceType:
        type: string
        description: Gets or sets the affected resource type.
      affectedObjectsCount:
        type: integer
        format: int64
        description: Count of affected objects.
      discoveryScope:
        $ref: '#/definitions/DiscoveryScopes'
        description: Gets or sets the count of affected objects.
    required:
    - affectedResourceType
    - affectedObjectsCount
    - discoveryScope
  WebAppSiteProperties:
    type: object
    description: Class for Web app site properties.
    properties:
      siteAppliancePropertiesCollection:
        type: array
        description: "Gets or sets the appliance details used by service to communicate\n           \nto the appliance."
        items:
          $ref: '#/definitions/SiteApplianceProperties'
        x-ms-identifiers: []
      discoveryScenario:
        $ref: '#/definitions/WebAppSitePropertiesDiscoveryScenario'
        description: Gets or sets the discovery scenario.
      serviceEndpoint:
        type: string
        description: Gets the service endpoint.
        readOnly: true
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        description: provisioning state enum
        readOnly: true
  WebAppSite:
    type: object
    description: WebApp site web model.
    properties:
      properties:
        $ref: '#/definitions/WebAppSiteProperties'
        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
  ExportWebAppsRequest:
    type: object
    description: ExportWebAppsRequest body
    properties:
      filter:
        type: string
        description: filter options.
  ErrorSummaryRequest:
    type: object
    description: ErrorSummaryRequest body
    properties:
      applianceName:
        type: string
        description: Gets or sets the Appliance Name.
  SiteErrorSummary:
    type: object
    description: Site error summary.
    properties:
      applianceName:
        type: string
        description: Appliance Name.
      discoveryScopeErrorSummaries:
        $ref: '#/definitions/DiscoveryScopeErrorSummary'
        description: Gets the error message.
      nextLink:
        type: string
        description: The link to fetch more models.
    required:
    - applianceName
    - discoveryScopeErrorSummaries
  SiteSpnProperties:
    type: object
    description: Class for site properties.
    properties:
      tenantId:
        type: string
        description: "Gets or sets the tenant Id for the service principal with which the\non-premise\n            management/data plane components would communicate with\nour Azure services."
      applicationId:
        type: string
        description: "Gets or sets the application/client Id for the service principal with which\nthe\n            on-premise management/data plane components would communicate\nwith our Azure \n            services."
      objectId:
        type: string
        description: "Gets or sets the object Id of the service principal with which the on-premise\n\n           management/data plane components would communicate with our Azure\nservices."
      audience:
        type: string
        description: Gets or sets the intended audience for the service principal.
      aadAuthority:
        type: string
        description: "Gets or sets the AAD Authority URL which was used to request the token for\nthe\n            service principal."
      rawCertData:
        type: string
        description: Gets or sets the raw certificate data for building certificate expiry flows.
  WebAppSiteListResult:
    type: object
    description: The response of a WebAppSite list operation.
    properties:
      value:
        type: array
        description: The WebAppSite items on this page
        items:
          $ref: '#/definitions/WebAppSite'
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
  WebAppSiteUpdateProperties:
    type: object
    description: The updatable properties of the WebAppSite.
    properties:
      siteAppliancePropertiesCollection:
        type: array
        description: "Gets or sets the appliance details used by service to communicate\n           \nto the appliance."
        items:
          $ref: '#/definitions/SiteApplianceProperties'
        x-ms-identifiers: []
      discoveryScenario:
        $ref: '#/definitions/WebAppSitePropertiesDiscoveryScenario'
        description: Gets or sets the discovery scenario.
  DiscoveryScopes:
    type: string
    description: Discovery scopes
    enum:
    - AppsAndRoles
    - DependencyMap
    - StaticData
    - SQLServerConnectionInfo
    x-ms-enum:
      name: DiscoveryScopes
      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.
  SiteApplianceProperties:
    type: object
    description: Class for site appliance properties.
    properties:
      servicePrincipalIdentityDetails:
        $ref: '#/definitions/SiteSpnProperties'
        description: ' Gets or sets the service principal identity details used by agent for  communication              to the service.  '
      agentDetails:
        $ref: '#/definitions/SiteAgentProperties'
        description: Gets or sets the on-premises agent details.
      applianceName:
        type: string
        description: Gets or sets the Appliance Name.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'