Microsoft Azure ManagedHostingEnvironments API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Managed Hosting Environments API
tags:
- name: ManagedHostingEnvironments
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}
  : get:
      tags:
      - ManagedHostingEnvironments
      summary: Microsoft Azure Get Properties Of A Managed Hosting Environment
      operationId: microsoftAzureManagedhostingenvironmentsGetmanagedhostingenvironment
      parameters:
      - name: resourceGroupName
        in: path
        description: Name of resource group
        required: true
        schema:
          type: string
      - name: name
        in: path
        description: Name of managed hosting environment
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagedHostingEnvironment'
            text/json:
              schema:
                $ref: '#/components/schemas/ManagedHostingEnvironment'
            application/xml:
              schema:
                $ref: '#/components/schemas/ManagedHostingEnvironment'
            text/xml:
              schema:
                $ref: '#/components/schemas/ManagedHostingEnvironment'
      deprecated: false
      description: Needs a more full description created.
    put:
      tags:
      - ManagedHostingEnvironments
      summary: Microsoft Azure Create Or Update A Managed Hosting Environment
      operationId: microsoftAzureManagedhostingenvironmentsCreateorupdatemanagedhostingenvironment
      parameters:
      - name: resourceGroupName
        in: path
        description: Name of resource group
        required: true
        schema:
          type: string
      - name: name
        in: path
        description: Name of managed hosting environment
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '202':
          description: Asynchronous operation in progress
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HostingEnvironment'
            text/json:
              schema:
                $ref: '#/components/schemas/HostingEnvironment'
            application/xml:
              schema:
                $ref: '#/components/schemas/HostingEnvironment'
            text/xml:
              schema:
                $ref: '#/components/schemas/HostingEnvironment'
        '400':
          description: Bad request
        '404':
          description: Not found
        '409':
          description: Conflict
      deprecated: false
      x-ms-long-running-operation: true
      description: Needs a more full description created.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HostingEnvironment'
          text/json:
            schema:
              $ref: '#/components/schemas/HostingEnvironment'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/HostingEnvironment'
        description: Properties of managed hosting environment
        required: true
    delete:
      tags:
      - ManagedHostingEnvironments
      summary: Microsoft Azure Delete A Managed Hosting Environment
      operationId: microsoftAzureManagedhostingenvironmentsDeletemanagedhostingenvironment
      parameters:
      - name: resourceGroupName
        in: path
        description: Name of resource group
        required: true
        schema:
          type: string
      - name: name
        in: path
        description: Name of managed hosting environment
        required: true
        schema:
          type: string
      - name: forceDelete
        in: query
        description: Delete even if the managed hosting environment contains resources
        schema:
          type: boolean
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '202':
          description: Asynchronous operation in progress
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Object'
            text/json:
              schema:
                $ref: '#/components/schemas/Object'
            application/xml:
              schema:
                $ref: '#/components/schemas/Object'
            text/xml:
              schema:
                $ref: '#/components/schemas/Object'
        '400':
          description: Bad request
        '404':
          description: Not found
        '409':
          description: Conflict
      deprecated: false
      x-ms-long-running-operation: true
      description: Needs a more full description created.
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments:
    get:
      tags:
      - ManagedHostingEnvironments
      summary: Microsoft Azure Get All Managed Hosting Environments In A Resource Group
      operationId: microsoftAzureManagedhostingenvironmentsGetmanagedhostingenvironments
      parameters:
      - name: resourceGroupName
        in: path
        description: Name of resource group
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HostingEnvironmentCollection'
            text/json:
              schema:
                $ref: '#/components/schemas/HostingEnvironmentCollection'
      deprecated: false
      x-ms-pageable:
        nextLinkName: nextLink
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}/capacities/virtualip
  : get:
      tags:
      - ManagedHostingEnvironments
      summary: Microsoft Azure Get List Of Ip Addresses Assigned To A Managed Hosting Environment
      operationId: microsoftAzureManagedhostingenvironmentsGetmanagedhostingenvironmentvips
      parameters:
      - name: resourceGroupName
        in: path
        description: Name of resource group
        required: true
        schema:
          type: string
      - name: name
        in: path
        description: Name of managed hosting environment
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddressResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/AddressResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/AddressResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/AddressResponse'
      deprecated: false
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}/operations/{operationId}
  : get:
      tags:
      - ManagedHostingEnvironments
      summary: Microsoft Azure Get Status Of An Operation On A Managed Hosting Environment
      operationId: microsoftAzureManagedhostingenvironmentsGetmanagedhostingenvironmentoperation
      parameters:
      - name: resourceGroupName
        in: path
        description: Name of resource group
        required: true
        schema:
          type: string
      - name: name
        in: path
        description: Name of managed hosting environment
        required: true
        schema:
          type: string
      - name: operationId
        in: path
        description: operation identifier GUID
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: Operation completed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Object'
            text/json:
              schema:
                $ref: '#/components/schemas/Object'
            application/xml:
              schema:
                $ref: '#/components/schemas/Object'
            text/xml:
              schema:
                $ref: '#/components/schemas/Object'
        '202':
          description: Asynchronous operation in progress
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Object'
            text/json:
              schema:
                $ref: '#/components/schemas/Object'
            application/xml:
              schema:
                $ref: '#/components/schemas/Object'
            text/xml:
              schema:
                $ref: '#/components/schemas/Object'
        '404':
          description: Not found
        '500':
          description: Operation failed
      deprecated: false
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}/sites
  : get:
      tags:
      - ManagedHostingEnvironments
      summary: Microsoft Azure Get All Sites On The Managed Hosting Environment
      operationId: microsoftAzureManagedhostingenvironmentsGetmanagedhostingenvironmentsites
      parameters:
      - name: resourceGroupName
        in: path
        description: Name of resource group
        required: true
        schema:
          type: string
      - name: name
        in: path
        description: Name of managed hosting environment
        required: true
        schema:
          type: string
      - name: propertiesToInclude
        in: query
        description: Comma separated list of site properties to include
        schema:
          type: string
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SiteCollection'
            text/json:
              schema:
                $ref: '#/components/schemas/SiteCollection'
      deprecated: false
      x-ms-pageable:
        nextLinkName: nextLink
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}/webhostingplans
  : get:
      tags:
      - ManagedHostingEnvironments
      summary: Microsoft Azure Get All Serverfarms App Service Plans On The Managed Hosting Environment
      operationId: microsoftAzureManagedhostingenvironmentsGetmanagedhostingenvironmentwebhostingplans
      parameters:
      - name: resourceGroupName
        in: path
        description: Name of resource group
        required: true
        schema:
          type: string
      - name: name
        in: path
        description: Name of managed hosting environment
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerFarmCollection'
            text/json:
              schema:
                $ref: '#/components/schemas/ServerFarmCollection'
      deprecated: false
      x-ms-pageable:
        nextLinkName: nextLink
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}/serverfarms
  : get:
      tags:
      - ManagedHostingEnvironments
      summary: Microsoft Azure Get All Serverfarms App Service Plans On The Managed Hosting Environment
      operationId: microsoftAzureManagedhostingenvironmentsGetmanagedhostingenvironmentserverfarms
      parameters:
      - name: resourceGroupName
        in: path
        description: Name of resource group
        required: true
        schema:
          type: string
      - name: name
        in: path
        description: Name of managed hosting environment
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerFarmCollection'
            text/json:
              schema:
                $ref: '#/components/schemas/ServerFarmCollection'
      deprecated: false
      x-ms-pageable:
        nextLinkName: nextLink
      description: Needs a more full description created.
components:
  schemas:
    VirtualApplication:
      type: object
      properties:
        virtualPath:
          type: string
        physicalPath:
          type: string
        preloadEnabled:
          type: boolean
        virtualDirectories:
          type: array
          items:
            $ref: '#/components/schemas/VirtualDirectory'
    ConnStringInfo:
      description: Represents database connection string information
      required:
      - type
      type: object
      properties:
        name:
          description: Name of connection string
          type: string
        connectionString:
          description: Connection string value
          type: string
        type:
          description: Type of database
          enum:
          - MySql
          - SQLServer
          - SQLAzure
          - Custom
          type: string
          x-ms-enum:
            name: DatabaseServerType
            modelAsString: false
    HostingEnvironmentProfile:
      description: Specification for a hostingEnvironment (App Service Environment) to use for this resource
      type: object
      properties:
        id:
          description: Resource id of the hostingEnvironment (App Service Environment)
          type: string
        name:
          description: Name of the hostingEnvironment (App Service Environment) (read only)
          type: string
        type:
          description: Resource type of the hostingEnvironment (App Service Environment) (read only)
          type: string
    AddressResponse:
      description: Describes main public ip address and any extra vips
      type: object
      properties:
        serviceIpAddress:
          description: Main public vip
          type: string
        internalIpAddress:
          description: VNET internal ip address of the hostingEnvironment (App Service Environment) if it is in internal load-balancing mode
          type: string
        outboundIpAddresses:
          description: IP addresses appearing on outbound connections
          type: array
          items:
            type: string
        vipMappings:
          description: Additional vips
          type: array
          items:
            $ref: '#/components/schemas/VirtualIPMapping'
    SiteCollection:
      description: Collection of sites
      type: object
      properties:
        value:
          description: Collection of resources
          type: array
          items:
            $ref: '#/components/schemas/Site'
        nextLink:
          description: Link to next page of resources
          type: string
    StatusCodesBasedTrigger:
      description: StatusCodeBasedTrigger
      type: object
      properties:
        status:
          format: int32
          description: HTTP status code
          type: integer
        subStatus:
          format: int32
          description: SubStatus
          type: integer
        win32Status:
          format: int32
          description: Win32 error code
          type: integer
        count:
          format: int32
          description: Count
          type: integer
        timeInterval:
          description: TimeInterval
          type: string
    Object:
      type: object
      properties: {}
    RampUpRule:
      description: Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance
      type: object
      properties:
        actionHostName:
          description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net
          type: string
        reroutePercentage:
          format: double
          description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName}
          type: number
        changeStep:
          format: double
          description: "[Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches \n            {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}.\n            Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl}"
          type: number
        changeIntervalInMinutes:
          format: int32
          description: '[Optional] Specifies interval in minutes to reevaluate ReroutePercentage'
          type: integer
        minReroutePercentage:
          format: double
          description: '[Optional] Specifies lower boundary above which ReroutePercentage will stay.'
          type: number
        maxReroutePercentage:
          format: double
          description: '[Optional] Specifies upper boundary below which ReroutePercentage will stay.'
          type: number
        changeDecisionCallbackUrl:
          description: "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. See TiPCallback site extension for the scaffold and contracts.\n            https://www.siteextensions.net/packages/TiPCallback/"
          type: string
        name:
          description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.
          type: string
    HostingEnvironment:
      description: Description of an hostingEnvironment (App Service Environment)
      type: object
      allOf:
      - $ref: '#/components/schemas/Resource'
      properties:
        properties:
          required:
          - status
          properties:
            name:
              description: Name of the hostingEnvironment (App Service Environment)
              type: string
            location:
              description: Location of the hostingEnvironment (App Service Environment), e.g. "West US"
              type: string
            provisioningState:
              description: Provisioning state of the hostingEnvironment (App Service Environment)
              enum:
              - Succeeded
              - Failed
              - Canceled
              - InProgress
              - Deleting
              type: string
              x-ms-enum:
                name: ProvisioningState
                modelAsString: false
            status:
              description: Current status of the hostingEnvironment (App Service Environment)
              enum:
              - Preparing
              - Ready
              - Scaling
              - Deleting
              type: string
              x-ms-enum:
                name: HostingEnvironmentStatus
                modelAsString: false
            vnetName:
              description: Name of the hostingEnvironment's (App Service Environment) virtual network
              type: string
            vnetResourceGroupName:
              description: Resource group of the hostingEnvironment's (App Service Environment) virtual network
              type: string
            vnetSubnetName:
              description: Subnet of the hostingEnvironment's (App Service Environment) virtual network
              type: string
            virtualNetwork:
              $ref: '#/components/schemas/VirtualNetworkProfile'
              description: Description of the hostingEnvironment's (App Service Environment) virtual network
            internalLoadBalancingMode:
              description: Specifies which endpoints to serve internally in the hostingEnvironment's (App Service Environment) VNET
              enum:
              - None
              - Web
              - Publishing
              type: string
              x-ms-enum:
                name: InternalLoadBalancingMode
                modelAsString: false
            multiSize:
              description: Front-end VM size, e.g. "Medium", "Large"
              type: string
            multiRoleCount:
              format: int32
              description: Number of front-end instances
              type: integer
            workerPools:
              description: Description of worker pools with worker size ids, VM sizes, and number of workers in each pool
              type: array
              items:
                $ref: '#/components/schemas/WorkerPool'
            ipsslAddressCount:
              format: int32
              description: Number of IP SSL addresses reserved for this hostingEnvironment (App Service Environment)
              type: integer
            databaseEdition:
              description: Edition of the metadata database for the hostingEnvironment (App Service Environment) e.g. "Standard"
              type: string
            databaseServiceObjective:
              description: Service objective of the metadata database for the hostingEnvironment (App Service Environment) e.g. "S0"
              type: string
            upgradeDomains:
              format: int32
              description: Number of upgrade domains of this hostingEnvironment (App Service Environment)
              type: integer
            subscriptionId:
              description: Subscription of the hostingEnvironment (App Service Environment)
              type: string
            dnsSuffix:
              description: DNS suffix of the hostingEnvironment (App Service Environment)
              type: string
            lastAction:
              description: Last deployment action on this hostingEnvironment (App Service Environment)
              type: string
            lastActionResult:
              description: Result of the last deployment action on this hostingEnvironment (App Service Environment)
              type: string
            allowedMultiSizes:
              description: List of comma separated strings describing which VM sizes are allowed for front-ends
              type: string
            allowedWorkerSizes:
              description: List of comma separated strings describing which VM sizes are allowed for workers
              type: string
            maximumNumberOfMachines:
              format: int32
              description: Maximum number of VMs in this hostingEnvironment (App Service Environment)
              type: integer
            vipMappings:
              description: Description of IP SSL mapping for this hostingEnvironment (App Service Environment)
              type: array
              items:
                $ref: '#/components/schemas/VirtualIPMapping'
            environmentCapacities:
              description: Current total, used, and available worker capacities
              type: array
              items:
                $ref: '#/components/schemas/StampCapacity'
            networkAccessControlList:
              description: Access control list for controlling traffic to the hostingEnvironment (App Service Environment)
              type: array
              items:
                $ref: '#/components/schemas/NetworkAccessControlEntry'
            environmentIsHealthy:
              description: True/false indicating whether the hostingEnvironment (App Service Environment) is healthy
              type: boolean
            environmentStatus:
              description: Detailed message about with results of the last check of the hostingEnvironment (App Service Environment)
              type: string
            resourceGroup:
              description: Resource group of the hostingEnvironment (App Service Environment)
              type: string
            apiManagementAccountId:
              description: Api Management Account associated with this Hosting Environment
              type: string
            suspended:
              description: "True/false indicating whether the hostingEnvironment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available\n            (most likely because NSG blocked the incoming traffic)"
              type: boolean
            clusterSettings:
              description: Custom settings for changing the behavior of the hosting environment
              type: array
              items:
                $ref: '#/components/schemas/NameValuePair'
          x-ms-client-flatten: true
    Site:
      description: Represents a web app
      type: object
      allOf:
      - $ref: '#/components/schemas/Resource'
      properties:
        properties:
          required:
          - usageState
          - availabilityState
          properties:
            name:
              description: Name of web app
              type: string
            state:
              description: State of the web app
              type: string
              readOnly: true
            hostNames:
              description: Hostnames associated with web app
              type: array
              items:
                type: string
              readOnly: true
            repositorySiteName:
              description: Name of repository site
              type: string
              readOnly: true
            usageState:
              description: State indicating whether web app has exceeded its quota usage
              enum:
              - Normal
              - Exceeded
              type: string
              readOnly: true
              x-ms-enum:
                name: UsageState
                modelAsString: false
            enabled:
              description: True if the site is enabled; otherwise, false. Setting this  value to false disables the site (takes the site off line).
              type: boolean
            enabledHostNames:
              description: "Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled\n            the app is not served on those hostnames"
              type: array
              items:
                type: string
              readOnly: true
            availabilityState:
              description: "Management information availability state for the web app. Possible values are Normal or Limited. \n            Normal means that the site is running correctly and that management information for the site is available. \n            Limited means that only partial management information for the site is available and that detailed site information is unavailable."
              enum:
              - Normal
              - Limited
              - DisasterRecoveryMode
              type: string
              readOnly: true
              x-ms-enum:
                name: SiteAvailabilityState
                modelAsString: false
            hostNameSslStates:
              description: Hostname SSL states are  used to manage the SSL bindings for site's hostnames.
              type: array
              items:
                $ref: '#/components/schemas/HostNameSslState'
            serverFarmId:
              type: string
            lastModifiedTimeUtc:
              format: date-time
              description: Last time web app was modified in UTC
              type: string
              readOnly: true
            siteConfig:
              $ref: '#/components/schemas/SiteConfig'
              description: Configuration of web app
            trafficManagerHostNames:
              description: Read-only list of Azure Traffic manager hostnames associated with web app
              type: array
              items:
                type: string
              readOnly: true
            premiumAppDeployed:
              description: If set indicates whether web app is deployed as a premium app
              type: boolean
              readOnly: true
            scmSiteAlsoStopped:
              description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false.
              type: boolean
            targetSwapSlot:
              description: Read-only property that specifies which slot this app will swap into
              type: string
              readOnly: true
            hostingEnvironmentProfile:
              $ref: '#/components/schemas/HostingEnvironmentProfile'
              description: Specification for the hosting environment (App Service Environment) to use for the web app
            microService:
              description: ''
              type: string
            gatewaySiteName:
              description: Name of gateway app associated with web app
              type: string
            clientAffinityEnabled:
              description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app
              type: boolean
            clientCertEnabled:
              description: Specifies if the client certificate is enabled for the web app
              type: boolean
            hostNamesDisabled:
              description: "Specifies if the public hostnames are disabled the web app.\n            If set to true the app is only accessible via API Management process"
              type: boolean
            outboundIpAddresses:
              description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app.
              type: string
              readOnly: true
            containerSize:
              format: int32
              description: Size of a function container
              type: integer
            maxNumberOfWorkers:
              format: int32
              description: "Maximum number of workers\n            This only applies to function container"
              type: integer
            cloningInfo:
              $ref: '#/components/schemas/CloningInfo'
              description: "This is only valid for web app creation. If specified, web app is cloned from \n            a source web app"
            resourceGroup:
              description: Resource group web app belongs to
              type: string
              readOnly: true
            isDefaultContainer:
              description: Site is a default container
              type: boolean
              readOnly: true
            defaultHostName:
              description: Default hostname of the web app
              type: string
              readOnly: true
          x-ms-client-flatten: true
    AutoHealRules:
      description: AutoHealRules - describes the rules which can be defined for auto-heal
      type: object
      properties:
        triggers:
          $ref: '#/components/schemas/AutoHealTriggers'
          description: Triggers - Condit

# --- truncated at 32 KB (57 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-managedhostingenvironments-api-openapi.yml