How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Microsoft Azure ServerFarms API

The ServerFarms API from Microsoft Azure — 13 operation(s) for serverfarms.

Microsoft Azure ServerFarms API is one of 1667 APIs that Microsoft Azure publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include ServerFarms. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a JSON-LD context, and a getting-started guide.

This API exposes 19 operations across 13 paths, and defines 40 schemas. It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.

19 operations 13 paths 40 schemas 2 DELETE11 GET1 PATCH2 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2020-08-01-preview
Resource Areas
1

Paths & Operations 19

Across 13 paths, the API surfaces 19 operations — 2 DELETE, 11 GET, 1 PATCH, 2 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

ServerFarms 19
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms
Microsoft Azure Gets Collection Of App Service Plans In A Resource Group For A Given Subscription
microsoftAzureServerfarmsGetserverfarms 3 params → 200
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}
Microsoft Azure Gets Specified App Service Plan In A Resource Group
microsoftAzureServerfarmsGetserverfarm 4 params → 200
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}
Microsoft Azure Creates Or Updates An App Service Plan
microsoftAzureServerfarmsCreateorupdateserverfarm 5 params body → 200202
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}
Microsoft Azure Deletes A App Service Plan
microsoftAzureServerfarmsDeleteserverfarm 4 params → 200
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/metrics
Microsoft Azure Queries For App Service Plan Metrics
microsoftAzureServerfarmsGetserverfarmmetrics 6 params → 200
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/metricdefinitions
Microsoft Azure List Of Metrics That Can Be Queried For An App Service Plan
microsoftAzureServerfarmsGetserverfarmmetricdefintions 4 params → 200
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections
Microsoft Azure Gets List Of Vnets Associated With App Service Plan
microsoftAzureServerfarmsGetvnetsforserverfarm 4 params → 200
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}
Microsoft Azure Gets A Vnet Associated With An App Service Plan
microsoftAzureServerfarmsGetvnetfromserverfarm 5 params → 200404
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes
Microsoft Azure Gets A List Of All Routes Associated With A Vnet, In An App Service Plan
microsoftAzureServerfarmsGetroutesforvnet 5 params → 200
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}
Microsoft Azure Gets A Specific Route Associated With A Vnet, In An App Service Plan
microsoftAzureServerfarmsGetrouteforvnet 6 params → 200404
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}
Microsoft Azure Creates A New Route Or Updates An Existing Route For A Vnet In An App Service Plan
microsoftAzureServerfarmsCreateorupdatevnetroute 6 params body → 200400404
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}
Microsoft Azure Deletes An Existing Route For A Vnet In An App Service Plan
microsoftAzureServerfarmsDeletevnetroute 6 params → 200404
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}
Microsoft Azure Creates A New Route Or Updates An Existing Route For A Vnet In An App Service Plan
microsoftAzureServerfarmsUpdatevnetroute 6 params body → 200400404
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
Microsoft Azure Gets The Vnet Gateway
microsoftAzureServerfarmsGetserverfarmvnetgateway 6 params → 200
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
Microsoft Azure Updates The Vnet Gateway
microsoftAzureServerfarmsUpdateserverfarmvnetgateway 6 params body → 200
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/sites
Microsoft Azure Gets List Of Apps Associated With An App Service Plan
microsoftAzureServerfarmsGetserverfarmsites 7 params → 200
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/workers/{workerName}/reboot
Microsoft Azure Submit A Reboot Request For A Worker Machine In The Specified Server Farm
microsoftAzureServerfarmsRebootworkerforserverfarm 5 params → 200
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/restartSites
Microsoft Azure Restarts Web Apps In A Specified App Service Plan
microsoftAzureServerfarmsRestartsitesforserverfarm 5 params → 200
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/operationresults/{operationId}
Microsoft Azure Gets A Server Farm Operation
microsoftAzureServerfarmsGetserverfarmoperation 5 params → 200

Schemas 40

The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are CloningInfo (10 properties), RampUpRule (8 properties), ResourceMetric (8 properties), Resource (6 properties). Each schema is shown below with its type and property counts.

VirtualApplication
object
4 properties
ConnStringInfo
object
Represents database connection string information
3 properties 1 required
HostingEnvironmentProfile
object
Specification for a hostingEnvironment (App Service Environment) to use for this resource
3 properties
Object
object
SiteCollection
object
Collection of sites
2 properties
StatusCodesBasedTrigger
object
StatusCodeBasedTrigger
5 properties
RampUpRule
object
Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance
8 properties
ResourceMetricName
object
Name of a metric for any resource
2 properties
ResourceMetricCollection
object
Collection of metric responses
2 properties
ResourceMetricValue
object
Value of resource metric
6 properties
Site
object
Represents a web app
1 property
AutoHealRules
object
AutoHealRules - describes the rules which can be defined for auto-heal
2 properties
SiteLimits
object
Represents metric limits set on a web app.
3 properties
AutoHealCustomAction
object
AutoHealCustomAction - Describes the custom action to be executed when an auto heal rule is triggered.
2 properties
SiteConfig
object
Configuration of Azure web site
1 property
IpSecurityRestriction
object
Represents an ip security restriction on a web app.
2 properties
ServerFarmCollection
object
Collection of serverfarms
2 properties
MetricDefinition
object
Class representing metadata for the metrics
1 property
SlowRequestsBasedTrigger
object
SlowRequestsBasedTrigger
3 properties
VnetGateway
object
The VnetGateway contract. This is used to give the vnet gateway access to the VPN package.
1 property
SkuDescription
object
Describes a sku for a scalable resource
5 properties
Experiments
object
Class containing Routing in production experiments
1 property
MetricDefinitionCollection
object
Collection of metric definitions
2 properties
CorsSettings
object
Cross-Origin Resource Sharing (CORS) settings for the web app.
1 property
Resource
object
6 properties 1 required
ServerFarmWithRichSku
object
App Service Plan Model
2 properties
KeyValuePair_String_String
object
2 properties
HostNameSslState
object
Object that represents a SSL-enabled host name.
5 properties 1 required
VnetRoute
object
VnetRoute contract used to pass routing information for a vnet.
1 property
AutoHealActions
object
AutoHealActions - Describes the actions which can be taken by the auto-heal module when a rule is triggered.
3 properties 1 required
AutoHealTriggers
object
AutoHealTriggers - describes the triggers for auto-heal.
4 properties
RequestsBasedTrigger
object
RequestsBasedTrigger
2 properties
ResourceMetric
object
Object representing a metric for any resource
8 properties
VirtualDirectory
object
2 properties
NameValuePair
object
Name value pair
2 properties
ApiDefinitionInfo
object
Information about the formal API definition for the web app.
1 property
CloningInfo
object
Represents information needed for cloning operation
10 properties
VnetInfo
object
VNETInfo contract. This contract is public and is a stripped down version of VNETInfoInternal
1 property
HandlerMapping
object
The IIS handler mappings used to define which handler processes HTTP requests with certain extension. For example it is used to configure php-cgi.exe process t…
3 properties
MetricAvailabilily
object
Class representing metrics availability and retention
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-serverfarms-api-openapi.yml Raw ↑

Other APIs Microsoft Azure publishes across the network.

Microsoft Azure AI Search API
Microsoft Azure Communication Services API
Microsoft Azure Event Grid API
Microsoft Azure Functions API
Microsoft Azure DevOps REST API
Microsoft Azure AI Foundry API
Microsoft Azure Resource JSON Schema
Microsoft Azure JSON-LD Context
Microsoft Azure AccessConnector API
Microsoft Azure AccessControlRecords API
Microsoft Azure AccessPolicies API
Microsoft Azure AccessReviewInstanceAcceptRecommmendations API
Where this information came from

This is an independent, third-party profile of Microsoft Azure ServerFarms API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.