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"> 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 requestTracingExpirationTime: format: date-time description: Request tracing expiration time type: string remoteDebuggingEnabled: description: Remote Debugging Enabled type: boolean remoteDebuggingVersion: description: Remote Debugging Version type: string httpLoggingEnabled: description: HTTP logging Enabled type: boolean logsDirectorySizeLimit: format: int32 description: HTTP Logs Directory size limit type: integer detailedErrorLoggingEnabled: description: Detailed error logging enabled type: boolean publishingUsername: description: Publishing user name type: string publishingPassword: description: Publishing password type: string appSettings: description: Application Settings type: array items: $ref: '#/definitions/NameValuePair' metadata: description: Site Metadata type: array items: $ref: '#/definitions/NameValuePair' connectionStrings: description: Connection strings type: array items: $ref: '#/definitions/ConnStringInfo' handlerMappings: description: Handler mappings type: array items: $ref: '#/definitions/HandlerMapping' documentRoot: description: Document root type: string scmType: description: SCM type type: string use32BitWorkerProcess: description: Use 32 bit worker process type: boolean webSocketsEnabled: description: Web socket enabled. type: boolean alwaysOn: description: Always On type: boolean javaVersion: description: Java version type: string javaContainer: description: Java container type: string javaContainerVersion: description: Java container version type: string appCommandLine: description: App Command Line to launch type: string managedPipelineMode: description: Managed pipeline mode enum: - Integrated - Classic type: string x-ms-enum: name: ManagedPipelineMode modelAsString: false virtualApplications: description: Virtual applications type: array items: $ref: '#/definitions/VirtualApplication' loadBalancing: description: Site load balancing enum: - WeightedRoundRobin - LeastRequests - LeastResponseTime - WeightedTotalTraffic - RequestHash type: string x-ms-enum: name: SiteLoadBalancing modelAsString: false experiments: $ref: '#/definitions/Experiments' description: This is work around for polymorphic types limits: $ref: '#/definitions/SiteLimits' description: Site limits autoHealEnabled: description: Auto heal enabled type: boolean autoHealRules: $ref: '#/definitions/AutoHealRules' description: Auto heal rules tracingOptions: description: Tracing options type: string vnetName: description: Vnet name type: string cors: $ref: '#/definitions/CorsSettings' description: Cross-Origin Resource Sharing (CORS) settings. apiDefinition: $ref: '#/definitions/ApiDefinitionInfo' description: Information about the formal API definition for the web app. autoSwapSlotName: description: Auto swap slot name type: string localMySqlEnabled: description: Local mysql enabled type: boolean ipSecurityRestrictions: description: Ip Security restrictions type: array items: $ref: '#/definitions/IpSecurityRestriction' x-ms-client-flatten: true 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 MetricDefinitionCollection: description: Collection of metric definitions type: object properties: value: description: Collection of resources type: array items: $ref: '#/definitions/MetricDefinition' nextLink: description: Link to next page of resources type: string Resource: required: - location properties: id: description: Resource Id type: string name: description: Resource Name type: string kind: description: Kind of resource type: string location: description: Resource Location type: string type: description: Resource type type: string tags: description: Resource tags type: object additionalProperties: type: string x-ms-azure-resource: true VnetRoute: description: VnetRoute contract used to pass routing information for a vnet. type: object allOf: - $ref: '#/definitions/Resource' properties: properties: properties: name: description: The name of this route. This is only returned by the server and does not need to be set by the client. type: string startAddress: description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. type: string endAddress: description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. type: string routeType: description: "The type of route this is:\r\n DEFAULT - By default, every web app has routes to the local address ranges specified by RFC1918\r\n INHERITED - Routes inherited from the real Virtual Network routes\r\n STATIC - Static route set on the web app only\r\n \r\n These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them\r\n with new INHERITED routes." type: string x-ms-client-flatten: true VnetInfo: description: VNETInfo contract. This contract is public and is a stripped down version of VNETInfoInternal type: object allOf: - $ref: '#/definitions/Resource' properties: properties: properties: vnetResourceId: description: The vnet resource id type: string certThumbprint: description: The client certificate thumbprint type: string certBlob: description: "A certificate file (.cer) blob containing the public key of the private key used to authenticate a \r\n Point-To-Site VPN connection." type: string routes: description: The routes that this virtual network connection uses. type: array items: $ref: '#/definitions/VnetRoute' resyncRequired: description: Flag to determine if a resync is required type: boolean dnsServers: description: Dns servers to be used by this VNET. This should be a comma-separated list of IP addresses. type: string x-ms-client-flatten: true 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 ResourceMetricValue: description: Value of resource metric type: object properties: timeStamp: description: Value timestamp type: string average: format: float description: Value average type: number minimum: format: float description: Value minimum type: number maximum: format: float description: Value maximum type: number total: format: float description: Value total type: number count: format: float description: Value count type: number SkuDescription: description: Describes a sku for a scalable resource type: object properties: name: description: Name of the resource sku type: string tier: description: Service Tier of the resource sku type: string size: description: Size specifier of the resource sku type: string family: description: Family code of the resource sku type: string capacity: format: int32 description: Current number of instances assigned to the resource type: integer VnetGateway: description: The VnetGateway contract. This is used to give the vnet gateway access to the VPN package. type: object allOf: - $ref: '#/definitions/Resource' properties: properties: properties: vnetName: description: The VNET name. type: string vpnPackageUri: description: The URI where the Vpn package can be downloaded type: string x-ms-client-flatten: true ServerFarmWithRichSku: description: App Service Plan Model type: object allOf: - $ref: '#/definitions/Resource' properties: properties: required: - status properties: name: description: Name for the App Service Plan type: string workerTierName: description: Target worker tier assigned to the App Service Plan type: string status: description: App Service Plan Status enum: - Ready - Pending type: string readOnly: true x-ms-enum: name: StatusOptions modelAsString: false subscription: description: App Service Plan Subscription type: string readOnly: true adminSiteName: description: App Service Plan administration site type: string hostingEnvironmentProfile: $ref: '#/definitions/HostingEnvironmentProfile' description: Specification for the hosting environment (App Service Environment) to use for the App Service Plan maximumNumberOfWorkers: format: int32 description: Maximum number of instances that can be assigned to this App Service Plan type: integer geoRegion: description: Geographical location for the App Service Plan type: string readOnly: true perSiteScaling: description: "If True apps assigned to this App Service Plan can be scaled independently\r\n If False apps assigned to this App Service Plan will scale to all instances of the plan" type: boolean numberOfSites: format: int32 description: Number of web apps assigned to this App Service Plan type: integer readOnly: true resourceGroup: description: Resource group of the server farm type: string readOnly: true reserved: description: Enables creation of a Linux App Service Plan type: boolean x-ms-client-flatten: true sku: $ref: '#/definitions/SkuDescription' SiteLimits: description: Represents metric limits set on a web app. type: object properties: maxPercentageCpu: format: double description: Maximum allowed CPU usage percentage type: number maxMemoryInMb: format: int64 description: Maximum allowed memory usage in MB type: integer maxDiskSizeInMb: format: int64 description: Maximum allowed disk size usage in MB type: integer ResourceMetricName: description: Name of a metric for any resource type: object properties: value: description: metric name value type: string localizedValue: description: Localized metric name value type: string AutoHealCustomAction: description: "AutoHealCustomAction - Describes the custom action to be executed\r\n when an auto heal rule is triggered." type: object properties: exe: description: Executable to be run type: string parameters: description: Parameters for the executable type: string CorsSettings: description: Cross-Origin Resource Sharing (CORS) settings for the web app. type: object properties: allowedOrigins: description: "Gets or sets the list of origins that should be allowed to make cross-origin\r\n calls (for example: http://example.com:12345). Use \"*\" to allow all." type: array items: type: string MetricAvailabilily: description: Class representing metrics availability and retention type: object properties: timeGrain: description: Time grain type: string retention: description: Retention period for the current {Microsoft.Web.Hosting.Administration.MetricAvailabilily.TimeGrain} type: string SiteCollection: description: Collection of sites type: object properties: value: description: Collection of resources type: array items: $ref: '#/definitions/Site' nextLink: description: Link to next page of resources type: string SlowRequestsBasedTrigger: description: SlowRequestsBasedTrigger type: object properties: timeTaken: description: TimeTaken type: string count: format: int32 description: Count type: integer timeInterval: description: TimeInterval type: string VirtualApplication: type: object properties: virtualPath: type: string physicalPath: type: string preloadEnabled: type: boolean virtualDirectories: type: array items: $ref: '#/definitions/VirtualDirectory' AutoHealActions: description: "AutoHealActions - Describes the actions which can be\r\n taken by the auto-heal module when a rule is triggered." required: - actionType type: object properties: actionType: description: ActionType - predefined action to be taken enum: - Recycle - LogEvent - CustomAction type: string x-ms-enum: name: AutoHealActionType modelAsString: false customAction: $ref: '#/definitions/AutoHealCustomAction' description: CustomAction - custom action to be taken minProcessExecutionTime: description: "MinProcessExecutionTime - minimum time the process must execute\r\n before taking the action" type: string 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 KeyValuePair[String,String]: type: object properties: key: type: string readOnly: true value: type: string readOnly: true Site: description: Represents a web app type: object allOf: - $ref: '#/definitions/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\r\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. \r\n Normal means that the site is running correctly and that management information for the site is available. \r\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: '#/definitions/HostNameSslState' serverFarmId: type: string lastModifiedTimeUtc: format: date-time description: Last time web app was modified in UTC type: string readOnly: true siteConfig: $ref: '#/definitions/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: '#/definitions/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.\r\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\r\n This only applies to function container" type: integer cloningInfo: $ref: '#/definitions/CloningInfo' description: "This is only valid for web app creation. If specified, web app is cloned from \r\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: '#/definitions/AutoHealTriggers' description: Triggers - Conditions that describe when to execute the auto-heal actions actions: $ref: '#/definitions/AutoHealActions' description: Actions - Actions to be executed when a rule is triggered RequestsBasedTrigger: description: RequestsBasedTrigger type: object properties: count: format: int32 description: Count type: integer timeInterval: description: TimeInterval type: string AutoHealTriggers: description: AutoHealTriggers - describes the triggers for auto-heal. type: object properties: requests: $ref: '#/definitions/RequestsBasedTrigger' description: Requests - Defines a rule based on total requests privateBytesInKB: format: int32 description: PrivateBytesInKB - Defines a rule based on private bytes type: integer statusCodes: description: StatusCodes - Defines a rule based on status codes type: array items: $ref: '#/definitions/StatusCodesBasedTrigger' slowRequests: $ref: '#/definitions/SlowRequestsBasedTrigger' description: SlowRequests - Defines a rule based on request execution time IpSecurityRestriction: description: Represents an ip security restriction on a web app. type: object properties: ipAddress: description: IP address the security restriction is valid for type: string subnetMask: description: Subnet mask for the range of IP addresses the restriction is valid for type: string HandlerMapping: description: "The IIS handler mappings used to define which handler processes HTTP requests with certain extension. \r\n For example it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension." type: object properties: extension: description: Requests with this extension will be handled using the specified FastCGI application. type: string scriptProcessor: description: The absolute path to the FastCGI application. type: string arguments: description: Command-line arguments to be passed to the script processor. type: string NameValuePair: description: Name value pair type: object properties: name: description: Pair name type: string value: description: Pair value type: string Object: type: object properties: {} ApiDefinitionInfo: description: Information about the formal API definition for the web app. type: object properties: url: description: The URL of the API definition. type: string ResourceMetric: description: Object representing a metric for any resource type: object properties: name: $ref: '#/definitions/ResourceMetricName' description: Name of metric unit: description: Metric unit type: string timeGrain: description: Metric granularity. E.g PT1H, PT5M, P1D type: string startTime: format: date-time description: Metric start time type: string endTime: format: date-time description: Metric end time type: string resourceId: description: Metric resource Id type: string metricValues: description: Metric values type: array items: $ref: '#/definitions/ResourceMetricValue' properties: description: Properties type: array items: $ref: '#/definitions/KeyValuePair[String,String]' VirtualDirectory: type: object properties: virtualPath: type: string physicalPath: type: string parameters: apiVersionParameter: name: api-version in: query description: API Version required: true type: string subscriptionIdParameter: name: subscriptionId in: path description: Subscription Id required: true type: string x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'