Microsoft Azure Functions AppServicePlans API
The AppServicePlans API from Microsoft Azure Functions — 22 operation(s) for appserviceplans.
Operations 30
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
GET
/subscriptions/{subscriptionId}/providers/Microsoft.Web/serverfarms
List App Service plans across a subscription · Get all App Service plans for a subscription
#
Ask an LLM
“What App Service plans exist across my whole Azure subscription?”
“Can I get every property of each plan in the subscription, not just a summary?”
Tell an agent
List every App Service plan in my subscription.
List all App Service plans in the subscription with detailed set to {detailed}.
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms
List App Service plans in a resource group · Get all App Service plans in a resource group
#
Ask an LLM
“Which App Service plans live in one particular resource group?”
“How do I see the hosting plans scoped to a single resource group?”
Tell an agent
Show the App Service plans in this resource group.
List only the resource group's App Service plans, not the whole subscription's.
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}
Get an App Service plan · Get an App Service plan
#
Ask an LLM
“How do I look up the details of one App Service plan by name?”
“What SKU and status does a specific App Service plan have?”
Tell an agent
Get the App Service plan named {name}.
Show me the configuration of plan {name}.
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}
Create or replace an App Service plan · Creates or updates an App Service Plan
#
Ask an LLM
“How do I create a new App Service plan with a chosen SKU?”
“Can I provision a hosting plan with a managed identity attached?”
Tell an agent
Create an App Service plan called {name} on SKU {sku}.
Provision plan {name} of kind {kind}, replacing it if it already exists.
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}
Patch properties of an existing App Service plan · Creates or updates an App Service Plan
#
Ask an LLM
“Can I change a few settings on an existing App Service plan without resending everything?”
“How do I partially update a plan that is already running?”
Tell an agent
Patch the existing plan {name} with properties {properties}.
Partially update App Service plan {name}, changing its kind to {kind}.
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}
Delete an App Service plan · Delete an App Service plan
#
Ask an LLM
“How do I remove an App Service plan I no longer need?”
“Can I tear down a hosting plan to stop paying for it?”
Tell an agent destructive · confirm first
Delete the App Service plan {name}.
Remove hosting plan {name} from the resource group.
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/capabilities
List capabilities of an App Service plan · List all capabilities of an App Service plan
#
Ask an LLM
“What features and capabilities does my App Service plan support?”
“Which capabilities are enabled on a given plan?”
Tell an agent
List the capabilities of App Service plan {name}.
Show what plan {name} is capable of.
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/getrdppassword
Get the RDP password for a custom-mode plan · Get the RDP password for an IsCustomMode ServerFarm
#
Ask an LLM
“How do I get the remote desktop password for a custom-mode server farm?”
“Where can I retrieve RDP credentials for an IsCustomMode App Service plan?”
Tell an agent
Fetch the RDP password for custom-mode plan {name}.
Get remote desktop credentials for server farm {name}.
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}
Get a Hybrid Connection used by a plan · Retrieve a Hybrid Connection in use in an App Service plan
#
Ask an LLM
“How do I inspect one Hybrid Connection relay that my App Service plan uses?”
“What are the settings of a specific Hybrid Connection on a plan?”
Tell an agent
Get Hybrid Connection relay {relayName} in namespace {namespaceName} on plan {name}.
Show the details of relay {relayName} used by plan {name}.
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}
Remove a Hybrid Connection from a plan · Delete a Hybrid Connection in use in an App Service plan
#
Ask an LLM
“How do I delete a Hybrid Connection that an App Service plan is using?”
“Can I detach a relay from my plan?”
Tell an agent destructive · confirm first
Delete Hybrid Connection relay {relayName} in namespace {namespaceName} from plan {name}.
Remove relay {relayName} from App Service plan {name}.
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}/listKeys
Get the send key for a Hybrid Connection · Get the send key name and value of a Hybrid Connection
#
Ask an LLM
“Where do I find the send key name and value for a Hybrid Connection?”
“How can I retrieve the access key a Hybrid Connection relay uses?”
Tell an agent
Get the send key for relay {relayName} in namespace {namespaceName} on plan {name}.
Show the Hybrid Connection keys for relay {relayName}.
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}/sites
List apps using a Hybrid Connection · Get all apps that use a Hybrid Connection in an App Service Plan
#
Ask an LLM
“Which apps in my plan depend on a particular Hybrid Connection?”
“Can I find every site that uses a given relay before I remove it?”
Tell an agent
List the apps that use relay {relayName} in namespace {namespaceName} on plan {name}.
Find which web apps depend on Hybrid Connection {relayName}.
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionPlanLimits/limit
Get the Hybrid Connection limit for a plan · Get the maximum number of Hybrid Connections allowed in an App Service plan
#
Ask an LLM
“How many Hybrid Connections is my App Service plan allowed to have?”
“What is the maximum Hybrid Connection count for a plan's tier?”
Tell an agent
Get the maximum number of Hybrid Connections allowed on plan {name}.
Check the Hybrid Connection limit for App Service plan {name}.
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionRelays
List Hybrid Connections in use by a plan · Retrieve all Hybrid Connections in use in an App Service plan
#
Ask an LLM
“What Hybrid Connections are currently in use across an App Service plan?”
“Can I see all relays a plan is connected to?”
Tell an agent
List all Hybrid Connections in use by plan {name}.
Show every relay connected to App Service plan {name}.
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/listinstances
Get instance details for an App Service plan · Get the instance details for an app service plan
#
Ask an LLM
“How do I see the individual instances running under an App Service plan?”
“Which worker instances back my plan right now?”
Tell an agent
List the instance details for plan {name}.
Show the worker instances running App Service plan {name}.
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/restartSites
Restart all apps in an App Service plan · Restart all apps in an App Service plan
#
Ask an LLM
“How do I restart every app on an App Service plan at once?”
“Can I do a soft restart of all sites in a plan instead of a full one?”
Tell an agent
Restart all apps in App Service plan {name}.
Restart every site on plan {name} with soft restart set to {softRestart}.
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/sites
List apps hosted on an App Service plan · Get all apps associated with an App Service plan
#
Ask an LLM
“Which web apps are hosted on a given App Service plan?”
“Can I page through or filter the apps assigned to a plan?”
Tell an agent
List the apps hosted on plan {name}.
Show the first {top} apps on App Service plan {name}.
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/skus
List selectable SKUs for an App Service plan · Gets all selectable SKUs for a given App Service Plan
#
Ask an LLM
“Which pricing tiers can I scale my existing App Service plan to?”
“What SKUs are selectable for a particular plan?”
Tell an agent
List the SKUs I can switch plan {name} to.
Show selectable pricing tiers for App Service plan {name}.
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/usages
Get usage information for an App Service plan · Gets server farm usage information
#
Ask an LLM
“How much of its quota is my App Service plan using?”
“Can I filter server farm usage metrics to specific names?”
Tell an agent
Get usage figures for server farm {name}.
Show plan {name} usage filtered by {filter}.
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections
List virtual networks connected to a plan · Get all Virtual Networks associated with an App Service plan
#
Ask an LLM
“Which virtual networks is my App Service plan connected to?”
“How do I list VNet integrations at the plan level?”
Tell an agent
List all virtual network connections on plan {name}.
Show the VNets associated with App Service plan {name}.
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}
Get a virtual network connected to a plan · Get a Virtual Network associated with an App Service plan
#
Ask an LLM
“How do I look at one specific VNet connection on an App Service plan?”
“What does a plan's connection to a named virtual network look like?”
Tell an agent
Get virtual network {vnetName} connected to plan {name}.
Show the VNet connection {vnetName} on App Service plan {name}.
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
Get a virtual network gateway for a plan · Get a Virtual Network gateway
#
Ask an LLM
“How do I view the gateway used by a plan's virtual network connection?”
“What is configured on the VNet gateway behind my App Service plan?”
Tell an agent
Get gateway {gatewayName} for VNet {vnetName} on plan {name}.
Show the virtual network gateway {gatewayName} settings.
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
Update a virtual network gateway for a plan · Update a Virtual Network gateway
#
Ask an LLM
“Can I change the gateway configuration for a plan's VNet connection?”
“How do I update the VNet gateway an App Service plan uses?”
Tell an agent
Update gateway {gatewayName} on VNet {vnetName} of plan {name} with {properties}.
Reconfigure the VNet gateway {gatewayName} for plan {name}.
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes
List routes for a plan's virtual network · Get all routes that are associated with a Virtual Network in an App Service plan
#
Ask an LLM
“What routes are defined for a virtual network on my App Service plan?”
“How can I see all VNet routes on a plan?”
Tell an agent
List routes for VNet {vnetName} on plan {name}.
Show every route associated with virtual network {vnetName}.
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}
Get one virtual network route on a plan · Get a Virtual Network route in an App Service plan
#
Ask an LLM
“How do I check the address range of one named VNet route on a plan?”
“Can I fetch a single route by name for a plan's virtual network?”
Tell an agent
Get route {routeName} for VNet {vnetName} on plan {name}.
Show the definition of VNet route {routeName}.
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}
Create or replace a virtual network route · Create or update a Virtual Network route in an App Service plan
#
Ask an LLM
“How do I add a new route to a plan's virtual network?”
“Can I define a VNet route on an App Service plan from scratch?”
Tell an agent
Create route {routeName} on VNet {vnetName} of plan {name} with {properties}.
Add a new VNet route named {routeName} to plan {name}.
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}
Patch an existing virtual network route · Create or update a Virtual Network route in an App Service plan
#
Ask an LLM
“Can I patch an existing VNet route without recreating it?”
“What is the way to modify a route that already exists on a plan's virtual network?”
Tell an agent
Patch existing route {routeName} on VNet {vnetName} of plan {name} with {properties}.
Modify the existing VNet route {routeName} in place.
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}
Delete a virtual network route from a plan · Delete a Virtual Network route in an App Service plan
#
Ask an LLM
“How do I remove a route from a plan's virtual network?”
“Can I delete a VNet route I added to my App Service plan?”
Tell an agent destructive · confirm first
Delete route {routeName} from VNet {vnetName} on plan {name}.
Remove VNet route {routeName}.
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/serverfarms/{name}/workers/{workerName}/reboot
Reboot a worker machine in a plan · Reboot a worker machine in an App Service plan
#
Ask an LLM
“How do I reboot a single worker machine in an App Service plan?”
“Can I restart one unhealthy worker instead of all apps?”
Tell an agent
Reboot worker {workerName} in plan {name}.
Power-cycle worker machine {workerName}.
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/serverfarms/{name}/workers/{workerName}/recycleinstance
Recycle a managed instance worker · Recycles a managed instance worker machine
#
Ask an LLM
“How do I recycle a managed instance worker machine on my plan?”
“Can a managed-instance worker be recycled rather than rebooted?”
Tell an agent
Recycle managed instance worker {workerName} on plan {name}.
Recycle the managed worker {workerName}.
Documentation
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/appservice/web-apps
📖
GettingStarted
https://learn.microsoft.com/en-us/azure/azure-functions/functions-get-started
📖
APIReference
https://learn.microsoft.com/en-us/rest/api/appservice/web-apps/get
📖
Authentication
https://learn.microsoft.com/en-us/rest/api/azure/#register-your-client-application-with-azure-ad