Microsoft Azure
Microsoft Azure ServerFarms API

The ServerFarms API from Microsoft Azure — 13 operation(s) for serverfarms.
Documentation GitHub OpenAPI
OpenAPI Specification

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ServerFarms API
schemes:
- https
tags:
- name: ServerFarms
paths:
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms:
    get:
      tags:
      - ServerFarms
      summary: Microsoft Azure Gets Collection Of App Service Plans In A Resource Group For A Given Subscription
      operationId: microsoftAzureServerfarmsGetserverfarms
      consumes: []
      produces:
      - application/json
      - text/json
      parameters:
      - name: resourceGroupName
        in: path
        description: Name of resource group
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ServerFarmCollection'
      deprecated: false
      x-ms-pageable:
        nextLinkName: nextLink
      description: Needs a more full description created.
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}:
    get:
      tags:
      - ServerFarms
      summary: Microsoft Azure Gets Specified App Service Plan In A Resource Group
      operationId: microsoftAzureServerfarmsGetserverfarm
      consumes: []
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: resourceGroupName
        in: path
        description: Name of resource group
        required: true
        type: string
      - name: name
        in: path
        description: Name of App Service Plan
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ServerFarmWithRichSku'
      deprecated: false
      description: Needs a more full description created.
    put:
      tags:
      - ServerFarms
      summary: Microsoft Azure Creates Or Updates An App Service Plan
      operationId: microsoftAzureServerfarmsCreateorupdateserverfarm
      consumes:
      - application/json
      - text/json
      - application/x-www-form-urlencoded
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: resourceGroupName
        in: path
        description: Name of resource group
        required: true
        type: string
      - name: name
        in: path
        description: Name of App Service Plan
        required: true
        type: string
      - name: serverFarmEnvelope
        in: body
        description: Details of App Service Plan
        required: true
        schema:
          $ref: '#/definitions/ServerFarmWithRichSku'
      - name: allowPendingState
        in: query
        description: 'OBSOLETE: If true, allow pending state for App Service Plan'
        type: boolean
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ServerFarmWithRichSku'
        '202':
          description: Operation is in progress
          schema:
            $ref: '#/definitions/ServerFarmWithRichSku'
      deprecated: false
      x-ms-long-running-operation: true
      description: Needs a more full description created.
    delete:
      tags:
      - ServerFarms
      summary: Microsoft Azure Deletes A App Service Plan
      operationId: microsoftAzureServerfarmsDeleteserverfarm
      consumes: []
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: resourceGroupName
        in: path
        description: Name of resource group
        required: true
        type: string
      - name: name
        in: path
        description: Name of App Service Plan
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Object'
      deprecated: false
      description: Needs a more full description created.
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/metrics:
    get:
      tags:
      - ServerFarms
      summary: Microsoft Azure Queries For App Service Plan Metrics
      operationId: microsoftAzureServerfarmsGetserverfarmmetrics
      consumes: []
      produces:
      - application/json
      - text/json
      parameters:
      - name: resourceGroupName
        in: path
        description: Name of resource group
        required: true
        type: string
      - name: name
        in: path
        description: Name of App Service Plan
        required: true
        type: string
      - name: details
        in: query
        description: If true, metrics are broken down per App Service Plan instance
        type: boolean
      - name: $filter
        in: query
        description: 'Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq ''Metric1'' or name.value eq ''Metric2'') and startTime eq ''2014-01-01T00:00:00Z'' and endTime eq ''2014-12-31T23:59:59Z'' and timeGrain eq duration''[Hour|Minute|Day]''.'
        type: string
        x-ms-skip-url-encoding: true
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ResourceMetricCollection'
      deprecated: false
      x-ms-pageable:
        nextLinkName: nextLink
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/metricdefinitions
  : get:
      tags:
      - ServerFarms
      summary: Microsoft Azure List Of Metrics That Can Be Queried For An App Service Plan
      operationId: microsoftAzureServerfarmsGetserverfarmmetricdefintions
      consumes: []
      produces:
      - application/json
      - text/json
      parameters:
      - name: resourceGroupName
        in: path
        description: Name of resource group
        required: true
        type: string
      - name: name
        in: path
        description: Name of App Service Plan
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/MetricDefinitionCollection'
      deprecated: false
      x-ms-pageable:
        nextLinkName: nextLink
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections
  : get:
      tags:
      - ServerFarms
      summary: Microsoft Azure Gets List Of Vnets Associated With App Service Plan
      operationId: microsoftAzureServerfarmsGetvnetsforserverfarm
      consumes: []
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: resourceGroupName
        in: path
        description: Name of resource group
        required: true
        type: string
      - name: name
        in: path
        description: Name of App Service Plan
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/VnetInfo'
      deprecated: false
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}
  : get:
      tags:
      - ServerFarms
      summary: Microsoft Azure Gets A Vnet Associated With An App Service Plan
      operationId: microsoftAzureServerfarmsGetvnetfromserverfarm
      consumes: []
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: resourceGroupName
        in: path
        description: Name of resource group
        required: true
        type: string
      - name: name
        in: path
        description: Name of App Service Plan
        required: true
        type: string
      - name: vnetName
        in: path
        description: Name of virtual network
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/VnetInfo'
        '404':
          description: Virtual network could not be found
      deprecated: false
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes
  : get:
      tags:
      - ServerFarms
      summary: Microsoft Azure Gets A List Of All Routes Associated With A Vnet, In An App Service Plan
      operationId: microsoftAzureServerfarmsGetroutesforvnet
      consumes: []
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: resourceGroupName
        in: path
        description: Name of resource group
        required: true
        type: string
      - name: name
        in: path
        description: Name of App Service Plan
        required: true
        type: string
      - name: vnetName
        in: path
        description: Name of virtual network
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/VnetRoute'
      deprecated: false
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}
  : get:
      tags:
      - ServerFarms
      summary: Microsoft Azure Gets A Specific Route Associated With A Vnet, In An App Service Plan
      operationId: microsoftAzureServerfarmsGetrouteforvnet
      consumes: []
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: resourceGroupName
        in: path
        description: Name of resource group
        required: true
        type: string
      - name: name
        in: path
        description: Name of App Service Plan
        required: true
        type: string
      - name: vnetName
        in: path
        description: Name of virtual network
        required: true
        type: string
      - name: routeName
        in: path
        description: Name of the virtual network route
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/VnetRoute'
        '404':
          description: Specified route does not exist
      deprecated: false
      description: Needs a more full description created.
    put:
      tags:
      - ServerFarms
      summary: Microsoft Azure Creates A New Route Or Updates An Existing Route For A Vnet In An App Service Plan
      operationId: microsoftAzureServerfarmsCreateorupdatevnetroute
      consumes:
      - application/json
      - text/json
      - application/x-www-form-urlencoded
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: resourceGroupName
        in: path
        description: Name of resource group
        required: true
        type: string
      - name: name
        in: path
        description: Name of App Service Plan
        required: true
        type: string
      - name: vnetName
        in: path
        description: Name of virtual network
        required: true
        type: string
      - name: routeName
        in: path
        description: Name of the virtual network route
        required: true
        type: string
      - name: route
        in: body
        description: The route object
        required: true
        schema:
          $ref: '#/definitions/VnetRoute'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/VnetRoute'
        '400':
          description: Invalid request. Ensure that required parameters are given, and that addresses and address spaces are valid
        '404':
          description: Route not found. This will only occur when using the PATCH verb.
      deprecated: false
      description: Needs a more full description created.
    delete:
      tags:
      - ServerFarms
      summary: Microsoft Azure Deletes An Existing Route For A Vnet In An App Service Plan
      operationId: microsoftAzureServerfarmsDeletevnetroute
      consumes: []
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: resourceGroupName
        in: path
        description: Name of resource group
        required: true
        type: string
      - name: name
        in: path
        description: Name of App Service Plan
        required: true
        type: string
      - name: vnetName
        in: path
        description: Name of virtual network
        required: true
        type: string
      - name: routeName
        in: path
        description: Name of the virtual network route
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Object'
        '404':
          description: Specified route does not exist.
      deprecated: false
      description: Needs a more full description created.
    patch:
      tags:
      - ServerFarms
      summary: Microsoft Azure Creates A New Route Or Updates An Existing Route For A Vnet In An App Service Plan
      operationId: microsoftAzureServerfarmsUpdatevnetroute
      consumes:
      - application/json
      - text/json
      - application/x-www-form-urlencoded
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: resourceGroupName
        in: path
        description: Name of resource group
        required: true
        type: string
      - name: name
        in: path
        description: Name of App Service Plan
        required: true
        type: string
      - name: vnetName
        in: path
        description: Name of virtual network
        required: true
        type: string
      - name: routeName
        in: path
        description: Name of the virtual network route
        required: true
        type: string
      - name: route
        in: body
        description: The route object
        required: true
        schema:
          $ref: '#/definitions/VnetRoute'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/VnetRoute'
        '400':
          description: Invalid request. Ensure that required parameters are given, and that addresses and address spaces are valid
        '404':
          description: Route not found. This will only occur when using the PATCH verb.
      deprecated: false
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
  : get:
      tags:
      - ServerFarms
      summary: Microsoft Azure Gets The Vnet Gateway
      operationId: microsoftAzureServerfarmsGetserverfarmvnetgateway
      consumes: []
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: resourceGroupName
        in: path
        description: Name of resource group
        required: true
        type: string
      - name: name
        in: path
        description: Name of the App Service Plan
        required: true
        type: string
      - name: vnetName
        in: path
        description: Name of the virtual network
        required: true
        type: string
      - name: gatewayName
        in: path
        description: Name of the gateway. Only the 'primary' gateway is supported.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/VnetGateway'
      deprecated: false
      description: Needs a more full description created.
    put:
      tags:
      - ServerFarms
      summary: Microsoft Azure Updates The Vnet Gateway
      operationId: microsoftAzureServerfarmsUpdateserverfarmvnetgateway
      consumes:
      - application/json
      - text/json
      - application/x-www-form-urlencoded
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: resourceGroupName
        in: path
        description: The resource group
        required: true
        type: string
      - name: name
        in: path
        description: The name of the App Service Plan
        required: true
        type: string
      - name: vnetName
        in: path
        description: The name of the virtual network
        required: true
        type: string
      - name: gatewayName
        in: path
        description: The name of the gateway. Only 'primary' is supported.
        required: true
        type: string
      - name: connectionEnvelope
        in: body
        description: The gateway entity.
        required: true
        schema:
          $ref: '#/definitions/VnetGateway'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/VnetGateway'
      deprecated: false
      description: Needs a more full description created.
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/sites:
    get:
      tags:
      - ServerFarms
      summary: Microsoft Azure Gets List Of Apps Associated With An App Service Plan
      operationId: microsoftAzureServerfarmsGetserverfarmsites
      consumes: []
      produces:
      - application/json
      - text/json
      parameters:
      - name: resourceGroupName
        in: path
        description: Name of resource group
        required: true
        type: string
      - name: name
        in: path
        description: Name of App Service Plan
        required: true
        type: string
      - name: $skipToken
        in: query
        description: Skip to of web apps in a list. If specified, the resulting list will contain web apps starting from (including) the skipToken. Else, the resulting list contains web apps from the start of the list
        type: string
      - name: $filter
        in: query
        description: 'Supported filter: $filter=state eq running. Returns only web apps that are currently running'
        type: string
      - name: $top
        in: query
        description: List page size. If specified, results are paged.
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/SiteCollection'
      deprecated: false
      x-ms-pageable:
        nextLinkName: nextLink
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/workers/{workerName}/reboot
  : post:
      tags:
      - ServerFarms
      summary: Microsoft Azure Submit A Reboot Request For A Worker Machine In The Specified Server Farm
      operationId: microsoftAzureServerfarmsRebootworkerforserverfarm
      consumes: []
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: resourceGroupName
        in: path
        description: Name of resource group
        required: true
        type: string
      - name: name
        in: path
        description: Name of server farm
        required: true
        type: string
      - name: workerName
        in: path
        description: Name of worker machine, typically starts with RD
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Object'
      deprecated: false
      description: Needs a more full description created.
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/restartSites:
    post:
      tags:
      - ServerFarms
      summary: Microsoft Azure Restarts Web Apps In A Specified App Service Plan
      operationId: microsoftAzureServerfarmsRestartsitesforserverfarm
      consumes: []
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: resourceGroupName
        in: path
        description: Name of resource group
        required: true
        type: string
      - name: name
        in: path
        description: Name of App Service Plan
        required: true
        type: string
      - name: softRestart
        in: query
        description: Soft restart applies the configuration settings and restarts the apps if necessary. Hard restart always restarts and reprovisions the apps
        type: boolean
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Object'
      deprecated: false
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/operationresults/{operationId}
  : get:
      tags:
      - ServerFarms
      summary: Microsoft Azure Gets A Server Farm Operation
      operationId: microsoftAzureServerfarmsGetserverfarmoperation
      consumes: []
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: resourceGroupName
        in: path
        description: Name of resource group
        required: true
        type: string
      - name: name
        in: path
        description: Name of server farm
        required: true
        type: string
      - name: operationId
        in: path
        description: Id of Server farm operation"&gt;
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ServerFarmWithRichSku'
      deprecated: false
      description: Needs a more full description created.
definitions:
  MetricDefinition:
    description: Class representing metadata for the metrics
    type: object
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      properties:
        properties:
          name:
            description: Name of the metric
            type: string
          unit:
            description: Unit of the metric
            type: string
          primaryAggregationType:
            description: Primary aggregation type
            type: string
          metricAvailabilities:
            description: List of time grains supported for the metric together with retention period
            type: array
            items:
              $ref: '#/definitions/MetricAvailabilily'
          displayName:
            description: Friendly name shown in the UI
            type: string
        x-ms-client-flatten: true
  Experiments:
    description: Class containing Routing in production experiments
    type: object
    properties:
      rampUpRules:
        description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects.
        type: array
        items:
          $ref: '#/definitions/RampUpRule'
  ServerFarmCollection:
    description: Collection of serverfarms
    type: object
    properties:
      value:
        description: Collection of resources
        type: array
        items:
          $ref: '#/definitions/ServerFarmWithRichSku'
      nextLink:
        description: Link to next page of resources
        type: string
  CloningInfo:
    description: Represents information needed for cloning operation
    type: object
    properties:
      correlationId:
        description: "Correlation Id of cloning operation. This id ties multiple cloning operations\r\n            together to use the same snapshot"
        type: string
      overwrite:
        description: Overwrite destination web app
        type: boolean
      cloneCustomHostNames:
        description: If true, clone custom hostnames from source web app
        type: boolean
      cloneSourceControl:
        description: Clone source control from source web app
        type: boolean
      sourceWebAppId:
        description: "ARM resource id of the source web app. Web app resource id is of the form \r\n            /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \r\n            /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots"
        type: string
      hostingEnvironment:
        description: Hosting environment
        type: string
      appSettingsOverrides:
        description: "Application settings overrides for cloned web app. If specified these settings will override the settings cloned \r\n            from source web app. If not specified, application settings from source web app are retained."
        type: object
        additionalProperties:
          type: string
      configureLoadBalancing:
        description: If specified configure load balancing for source and clone site
        type: boolean
      trafficManagerProfileId:
        description: "ARM resource id of the traffic manager profile to use if it exists. Traffic manager resource id is of the form \r\n            /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}"
        type: string
      trafficManagerProfileName:
        description: Name of traffic manager profile to create. This is only needed if traffic manager profile does not already exist
        type: string
  HostNameSslState:
    description: Object that represents a SSL-enabled host name.
    required:
    - sslState
    type: object
    properties:
      name:
        description: Host name
        type: string
      sslState:
        description: SSL type
        enum:
        - Disabled
        - SniEnabled
        - IpBasedEnabled
        type: string
        x-ms-enum:
          name: SslState
          modelAsString: false
      virtualIP:
        description: Virtual IP address assigned to the host name if IP based SSL is enabled
        type: string
      thumbprint:
        description: SSL cert thumbprint
        type: string
      toUpdate:
        description: Set this flag to update existing host name
        type: boolean
  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 \r\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}.\r\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.\r\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
  ResourceMetricCollection:
    description: Collection of metric responses
    type: object
    properties:
      value:
        description: Collection of resources
        type: array
        items:
          $ref: '#/definitions/ResourceMetric'
      nextLink:
        description: Link to next page of resources
        type: string
  SiteConfig:
    description: Configuration of Azure web site
    type: object
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      properties:
        properties:
          numberOfWorkers:
            format: int32
            description: Number of workers
            type: integer
          defaultDocuments:
            description: Default documents
            type: array
            items:
              type: string
          netFrameworkVersion:
            description: Net Framework Version
            type: string
          phpVersion:
            description: Version of PHP
            type: string
          pythonVersion:
            description: Version of Python
            type: string
          nodeVersion:
            description: Version of Node
            type: string
          requestTracingEnabled:
            description: Enable request tracing
            type: boolean
          requestTracingExpirationT

# --- truncated at 32 KB (58 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-serverfarms-api-openapi.yml
Microsoft Azure ServerFarms API

Documentation

Specifications

Other Resources

OpenAPI Specification
