Microsoft Azure Functions AppServicePlans API
The AppServicePlans API from Microsoft Azure Functions — 22 operation(s) for appserviceplans.
Microsoft Azure Functions AppServicePlans API is one of 23 APIs that Microsoft Azure Functions publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include AppServicePlans. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, an API reference, and authentication docs.
This API exposes 30 operations across 22 paths, and defines 125 schemas. It is described by OpenAPI 3.2.0, at version 2025-05-01.
Requests are made against a single base URL, https://management.azure.com.
30 operations
22 paths
125 schemas
3 DELETE16 GET2 PATCH6 POST3 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Microsoft Azure Functions AppServicePlans API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (azure_auth) using the implicit flow, exposing 1 scope.
By default, every request must be authenticated.
azure_auth— Azure Active Directory OAuth2 Flow.
Paths & Operations 30
Across 22 paths, the API surfaces 30 operations — 3 DELETE, 16 GET, 2 PATCH, 6 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.
AppServicePlans 30
GET
/subscriptions/{subscriptionId}/providers/Microsoft.Web/serverfarms
Get all App Service plans for a subscription.
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms
Get all App Service plans in a resource group.
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}
Get an App Service plan.
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}
Creates or updates an App Service Plan.
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}
Creates or updates an App Service Plan.
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}
Delete an App Service plan.
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/capabilities
List all capabilities of an App Service plan.
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/getrdppassword
Get the RDP password for an IsCustomMode ServerFarm.
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}
Retrieve a Hybrid Connection in use in an App Service plan.
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}
Delete a Hybrid Connection in use in an App Service plan.
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}/listKeys
Get the send key name and value of a Hybrid Connection.
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}/sites
Get all apps that use a Hybrid Connection in an App Service Plan.
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionPlanLimits/limit
Get the maximum number of Hybrid Connections allowed in an App Service plan.
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionRelays
Retrieve all Hybrid Connections in use in an App Service plan.
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/listinstances
Get the instance details for an app service plan.
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/restartSites
Restart all apps in an App Service plan.
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/sites
Get all apps associated with an App Service plan.
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/skus
Gets all selectable SKUs for a given App Service Plan
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/usages
Gets server farm usage information
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections
Get all Virtual Networks associated with an App Service plan.
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}
Get a Virtual Network associated with an App Service plan.
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
Get a Virtual Network gateway.
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
Update a Virtual Network gateway.
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes
Get all routes that are associated with a Virtual Network in an App Service plan.
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}
Get a Virtual Network route in an App Service plan.
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}
Create or update a Virtual Network route in an App Service plan.
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}
Create or update a Virtual Network route in an App Service plan.
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}
Delete a Virtual Network route in an App Service plan.
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/serverfarms/{name}/workers/{workerName}/reboot
Reboot a worker machine in an App Service plan.
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/serverfarms/{name}/workers/{workerName}/recycleinstance
Recycles a managed instance worker machine.
Schemas 125
The contract defines 125 schemas that model the data the API accepts and returns. The most detailed are SiteConfig (73 properties), SiteProperties (56 properties), AppServicePlanProperties (31 properties), AppServicePlanPatchResourceProperties (23 properties). Each schema is shown below with its type and property counts.
FtpsState
string
State of FTP / FTPS service
HybridConnectionKeyProperties
object
HybridConnectionKey resource specific properties
2 properties
StorageMount
object
Server farm storage mount configuration.
5 properties
Operation
object
An operation on a resource.
8 properties
ManagedServiceIdentityType
string
Type of managed service identity.
SlowRequestsBasedTrigger
object
Trigger based on request execution time.
4 properties
KeyVaultReferenceWithStatus
object
Object to hold key vault reference and the resolution status
2 properties
ServerFarmRdpDetails
object
Server Farm RDP connection details.
2 properties
FunctionsRuntime
object
Function app runtime name and version.
2 properties
HybridConnectionLimits
object
Hybrid Connection limits contract. This is used to return the plan limits of Hybrid Connections.
2 properties
Site
object
A web app, a mobile app backend, or an API app.
4 properties
AutoHealActions
object
Actions which to take by the auto-heal module when a rule is triggered.
3 properties
DefaultErrorResponseErrorDetailsItem
object
Detailed errors.
3 properties
Capability
object
Describes the capabilities/features allowed for a specific SKU.
3 properties
AutoHealRules
object
Rules that can be defined for auto-heal.
2 properties
RequestsBasedTrigger
object
Trigger based on total requests.
2 properties
WebAppCollection
object
Collection of App Service apps.
2 properties
1 required
NameValuePair
object
Name value pair.
2 properties
FunctionsDeploymentStorage
object
Storage for deployed package used by the function app.
3 properties
KubeEnvironmentProfile
object
Specification for a Kubernetes Environment to use for this resource.
3 properties
ResourceConfig
object
Function app resource requirements.
2 properties
OperationStatus
string
The current status of the operation.
TlsCipherSuites
string
The minimum strength TLS cipher suite allowed for an application
AppServicePlanProperties
object
AppServicePlan resource specific properties
31 properties
ExtendedLocation
object
Extended Location.
2 properties
VnetRoute
object
Virtual Network route contract used to pass routing information for a Virtual Network.
2 properties
FunctionAppConfig
object
Function app configuration.
4 properties
RouteType
string
The type of route this is: DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 INHERITED - Routes inherited from the re…
ServerFarmInstance
object
Represents details of a single instance in a server farm.
3 properties
CsmUsageQuota
object
Usage of the quota resource.
5 properties
Experiments
object
Routing rules in production experiments.
1 property
SiteUpdateStrategyType
string
Function app site update strategy type. Available options: Recreate, RollingUpdate
HybridConnectionProperties
object
HybridConnection resource specific properties
8 properties
AppServicePlan
object
App Service plan.
5 properties
InstallScriptSource
object
Object to hold install script reference.
2 properties
DefaultErrorResponse
object
App Service error response.
1 property
ManagedPipelineMode
string
Managed pipeline mode.
AppServicePlanPatchResource
object
ARM resource for a app service plan.
2 properties
RegistryAdapter
object
Server farm registry adapter configuration.
3 properties
DefaultErrorResponseError
object
Error model.
5 properties
ConnectionStringType
string
Type of database.
AutoGeneratedDomainNameLabelScope
string
Specifies the scope of uniqueness for the default hostname during resource creation
ServerFarmInstanceDetails
object
Represents instance details for an app service plan.
3 properties
DaprLogLevel
string
Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info.
DaprConfig
object
App Dapr configuration.
7 properties
AzureStorageState
string
State of the storage account.
StatusCodesBasedTrigger
object
Trigger based on status code.
6 properties
ErrorEntity
object
Body of the error response returned from the API.
8 properties
ProxyOnlyResource
object
Azure proxy only resource. This resource is not tracked by Azure Resource Manager.
4 properties
FunctionsDeploymentStorageAuthentication
object
Authentication method to access the storage account for deployment.
3 properties
StorageMountType
string
Type of the storage mount.
AzureStorageInfoValue
object
Azure Files or Blob Storage access information value for dictionary storage.
7 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
ManagedServiceIdentity
object
Managed service identity.
4 properties
SkuDescription
object
Description of a SKU for a scalable resource.
8 properties
RuntimeName
string
Function app runtime name. Available options: dotnet-isolated, node, java, powershell, python, custom
AzureStorageProtocol
string
Mounting protocol to use for the storage account.
InstallScriptType
string
Type of the install script.
IpSecurityRestriction
object
IP security restriction on an app.
11 properties
HybridConnectionCollection
object
Collection of hostname bindings.
2 properties
1 required
SupportedTlsVersions
string
MinTlsVersion: configures the minimum version of TLS required for SSL requests
VnetInfoResource
object
Virtual Network information ARM resource.
2 properties
StatusOptions
string
App Service plan status.
SiteMachineKey
object
MachineKey of an app.
4 properties
AutoHealTriggers
object
Triggers for auto-heal.
6 properties
ClientCertMode
string
This composes with ClientCertEnabled setting. - ClientCertEnabled: false means ClientCert is ignored. - ClientCertEnabled: true and ClientCertMode: Required me…
SiteAvailabilityState
string
Management information availability state for the app.
SslState
string
SSL type
IPMode
string
Specifies the IP mode of the app.
FunctionsAlwaysReadyConfig
object
Sets the number of 'Always Ready' instances for a function group or a specific function.
2 properties
PushSettings
object
Push settings for the App.
1 property
OutboundVnetRouting
object
Outbound traffic options over virtual network.
5 properties
HybridConnectionKey
object
Hybrid Connection key contract. This has the send key name and value for a Hybrid Connection.
1 property
SiteLimits
object
Metric limits set on an app.
3 properties
RegistryAdapterType
string
Type of the registry adapter.
VnetRouteProperties
object
VnetRoute resource specific properties
3 properties
SiteProperties
object
Site resource specific properties
56 properties
HostingEnvironmentProfile
object
Specification for an App Service Environment to use for this resource.
3 properties
DefaultAction
string
Default action for main access restriction if no rules are matched.
AppServicePlanPatchResourceProperties
object
AppServicePlanPatchResource resource specific properties
23 properties
ResourceCollection
object
Collection of resources.
2 properties
1 required
SlotSwapStatus
object
The status of the last successful slot swap operation.
3 properties
UserAssignedIdentity
object
User Assigned identity.
2 properties
AutoHealCustomAction
object
Custom action to be executed when an auto heal rule is triggered.
2 properties
IpFilterTag
string
Defines what this IP filter will be used for. This is to support IP filtering on proxies.
FunctionsDeploymentStorageType
string
Property to select Azure Storage type. Available options: blobContainer.
HostNameSslState
object
SSL-enabled hostname.
6 properties
VnetGatewayProperties
object
VnetGateway resource specific properties
2 properties
1 required
CsmUsageQuotaCollection
object
Paged collection of CsmUsageQuota items
2 properties
1 required
RedundancyMode
string
Site redundancy mode
FunctionsScaleAndConcurrencyTriggers
object
Scale and concurrency settings for the function app triggers.
1 property
PushSettingsProperties
object
PushSettings resource specific properties
4 properties
1 required
AutoHealActionType
string
Predefined action to be taken.
ConnStringInfo
object
Database connection string information.
3 properties
UsageState
string
State indicating whether the app has exceeded its quota usage. Read-only.
VnetInfo
object
Virtual Network information contract.
7 properties
HybridConnectionLimitsProperties
object
HybridConnectionLimits resource specific properties
2 properties
ServerFarmNetworkSettings
object
Network settings for an app service plan.
1 property
CorsSettings
object
Cross-Origin Resource Sharing (CORS) settings for the app.
2 properties
ApiDefinitionInfo
object
Information about the formal API definition for the app.
1 property
CloningInfo
object
Information needed for cloning operation.
11 properties
1 required
AppServicePlanCollection
object
Collection of App Service plans.
2 properties
1 required
VnetGateway
object
The Virtual Network gateway contract. This is used to give the Virtual Network gateway access to the VPN package.
2 properties
ApiManagementConfig
object
Azure API management (APIM) configuration linked to the app.
1 property
VirtualDirectory
object
Directory for virtual application.
2 properties
ProvisioningState
string
Provisioning state of the App Service Plan.
HybridConnection
object
Hybrid Connection contract. This is used to configure a Hybrid Connection.
2 properties
StatusCodesRangeBasedTrigger
object
Trigger based on range of status codes.
4 properties
LocalizableString
object
Localizable string object containing the name and a localized value.
2 properties
SiteLoadBalancing
string
Site load balancing.
VirtualApplication
object
Virtual application in an app.
4 properties
AuthenticationType
string
Property to select authentication type to access the selected storage account. Available options: SystemAssignedIdentity, UserAssignedIdentity, StorageAccountC…
AzureStorageType
string
Type of storage.
SkuCapacity
object
Description of the App Service plan scale options.
5 properties
InstallScript
object
Server farm install script configuration.
2 properties
FunctionsSiteUpdateStrategy
object
Function app site update strategy configuration for deployments and site config updates.
1 property
SiteConfig
object
Configuration of an App Service app.
73 properties
SiteDnsConfig
object
6 properties
FunctionsScaleAndConcurrencyTriggersHttp
object
Scale and concurrency settings for the HTTP trigger.
1 property
HostType
string
Indicates whether the hostname is a standard or repository hostname.
FunctionsDeployment
object
Configuration section for the function app deployment.
1 property
FunctionsScaleAndConcurrency
object
Scale and concurrency settings for the function app.
4 properties
DefaultIdentity
object
2 properties
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…
3 properties
ScmType
string
SCM type.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Microsoft Azure Functions 12
Other APIs Microsoft Azure Functions publishes across the network.
Azure Functions Runtime API
Microsoft Azure Functions AppServiceEnvironments API
Microsoft Azure Functions Certificates API
Microsoft Azure Functions DeletedWebApps API
Microsoft Azure Functions Diagnostics API
Microsoft Azure Functions Global API
Microsoft Azure Functions KubeEnvironments API
Microsoft Azure Functions Operations API
Microsoft Azure Functions Provider API
Microsoft Azure Functions Providers API
Microsoft Azure Functions Recommendations API
Microsoft Azure Functions ResourceHealthMetadata API
#AppServicePlans
Where this information came from
This is an independent, third-party profile of Microsoft Azure Functions AppServicePlans 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.