naftiko: 1.0.0-alpha2
info:
label: WebApps API Client — AppServicePlans
description: 'WebApps API Client — AppServicePlans. 30 operations. Lead operation: Get all App Service plans for a subscription..
Self-contained Naftiko capability covering one Microsoft Azure Functions business surface.'
tags:
- Microsoft Azure Functions
- AppServicePlans
created: '2026-05-19'
modified: '2026-05-19'
binds:
- namespace: env
keys:
MICROSOFT_AZURE_FUNCTIONS_API_KEY: MICROSOFT_AZURE_FUNCTIONS_API_KEY
capability:
consumes:
- type: http
namespace: azure-functions-management-appserviceplans
baseUri: https://management.azure.com
description: WebApps API Client — AppServicePlans business capability. Self-contained, no shared references.
resources:
- name: subscriptions-subscriptionId-providers-Microsoft.Web-serverfarms
path: /subscriptions/{subscriptionId}/providers/Microsoft.Web/serverfarms
operations:
- name: appserviceplanslist
method: GET
description: Get all App Service plans for a subscription.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: detailed
in: query
type: boolean
description: Specify true to return all App Service plan properties. The default is false,
which returns a subset of the properties.
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms
operations:
- name: appserviceplanslistbyresourcegroup
method: GET
description: Get all App Service plans in a resource group.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}
operations:
- name: appserviceplansget
method: GET
description: Get an App Service plan.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the App Service plan.
required: true
- name: appserviceplanscreateorupdate
method: PUT
description: Creates or updates an App Service Plan.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the App Service plan.
required: true
- name: appServicePlan
in: body
type: string
description: Details of the App Service plan.
required: true
- name: appserviceplansupdate
method: PATCH
description: Creates or updates an App Service Plan.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the App Service plan.
required: true
- name: appServicePlan
in: body
type: string
description: Details of the App Service plan.
required: true
- name: appserviceplansdelete
method: DELETE
description: Delete an App Service plan.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the App Service plan.
required: true
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/capabilities
operations:
- name: appserviceplanslistcapabilities
method: GET
description: List all capabilities of an App Service plan.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the App Service plan.
required: true
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/getrdppassword
operations:
- name: appserviceplansgetserverfarmrdppassword
method: POST
description: Get the RDP password for an IsCustomMode ServerFarm.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the App Service plan.
required: true
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}
operations:
- name: appserviceplansgethybridconnection
method: GET
description: Retrieve a Hybrid Connection in use in an App Service plan.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the App Service plan.
required: true
- name: namespaceName
in: path
type: string
description: Name of the Service Bus namespace.
required: true
- name: relayName
in: path
type: string
description: Name of the Service Bus relay.
required: true
- name: appserviceplansdeletehybridconnection
method: DELETE
description: Delete a Hybrid Connection in use in an App Service plan.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the App Service plan.
required: true
- name: namespaceName
in: path
type: string
description: Name of the Service Bus namespace.
required: true
- name: relayName
in: path
type: string
description: Name of the Service Bus relay.
required: true
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}/listKeys
operations:
- name: appserviceplanslisthybridconnectionkeys
method: POST
description: Get the send key name and value of a Hybrid Connection.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the App Service plan.
required: true
- name: namespaceName
in: path
type: string
description: Name of the Service Bus namespace.
required: true
- name: relayName
in: path
type: string
description: Name of the Service Bus relay.
required: true
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}/sites
operations:
- name: appserviceplanslistwebappsbyhybridconnection
method: GET
description: Get all apps that use a Hybrid Connection in an App Service Plan.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the App Service plan.
required: true
- name: namespaceName
in: path
type: string
description: Name of the Service Bus namespace.
required: true
- name: relayName
in: path
type: string
description: Name of the Service Bus relay.
required: true
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionPlanLimits/limit
operations:
- name: appserviceplansgethybridconnectionplanlimit
method: GET
description: Get the maximum number of Hybrid Connections allowed in an App Service plan.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the App Service plan.
required: true
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionRelays
operations:
- name: appserviceplanslisthybridconnections
method: GET
description: Retrieve all Hybrid Connections in use in an App Service plan.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the App Service plan.
required: true
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/listinstances
operations:
- name: appserviceplansgetserverfarminstancedetails
method: POST
description: Get the instance details for an app service plan.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the App Service plan.
required: true
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/restartSites
operations:
- name: appserviceplansrestartwebapps
method: POST
description: Restart all apps in an App Service plan.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the App Service plan.
required: true
- name: softRestart
in: query
type: boolean
description: Specify true to perform a soft restart, applies the configuration settings and restarts
the apps if necessary. The default is false, w
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/sites
operations:
- name: appserviceplanslistwebapps
method: GET
description: Get all apps associated with an App Service plan.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the App Service plan.
required: true
- name: $skipToken
in: query
type: string
description: 'Skip to a web app in the list of webapps associated with app service plan. If specified, the resulting
list will contain web apps starting from (including) the '
- name: $filter
in: query
type: string
description: 'Supported filter: $filter=state eq running. Returns only web apps that are currently running'
- name: $top
in: query
type: string
description: List page size. If specified, results are paged.
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/skus
operations:
- name: appserviceplansgetserverfarmskus
method: GET
description: Gets all selectable SKUs for a given App Service Plan
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the App Service plan.
required: true
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/usages
operations:
- name: appserviceplanslistusages
method: GET
description: Gets server farm usage information
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the App Service plan.
required: true
- name: $filter
in: query
type: string
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'').'
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections
operations:
- name: appserviceplanslistvnets
method: GET
description: Get all Virtual Networks associated with an App Service plan.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the App Service plan.
required: true
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}
operations:
- name: appserviceplansgetvnetfromserverfarm
method: GET
description: Get a Virtual Network associated with an App Service plan.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the App Service plan.
required: true
- name: vnetName
in: path
type: string
description: Name of the Virtual Network.
required: true
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
operations:
- name: appserviceplansgetvnetgateway
method: GET
description: Get a Virtual Network gateway.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the App Service plan.
required: true
- name: vnetName
in: path
type: string
description: Name of the Virtual Network.
required: true
- name: gatewayName
in: path
type: string
description: Name of the gateway. Only the 'primary' gateway is supported.
required: true
- name: appserviceplansupdatevnetgateway
method: PUT
description: Update a Virtual Network gateway.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the App Service plan.
required: true
- name: vnetName
in: path
type: string
description: Name of the Virtual Network.
required: true
- name: gatewayName
in: path
type: string
description: Name of the gateway. Only the 'primary' gateway is supported.
required: true
- name: connectionEnvelope
in: body
type: string
description: Definition of the gateway.
required: true
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes
operations:
- name: appserviceplanslistroutesforvnet
method: GET
description: Get all routes that are associated with a Virtual Network in an App Service plan.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the App Service plan.
required: true
- name: vnetName
in: path
type: string
description: Name of the Virtual Network.
required: true
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}
operations:
- name: appserviceplansgetrouteforvnet
method: GET
description: Get a Virtual Network route in an App Service plan.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the App Service plan.
required: true
- name: vnetName
in: path
type: string
description: Name of the Virtual Network.
required: true
- name: routeName
in: path
type: string
description: Name of the Virtual Network route.
required: true
- name: appserviceplanscreateorupdatevnetroute
method: PUT
description: Create or update a Virtual Network route in an App Service plan.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the App Service plan.
required: true
- name: vnetName
in: path
type: string
description: Name of the Virtual Network.
required: true
- name: routeName
in: path
type: string
description: Name of the Virtual Network route.
required: true
- name: route
in: body
type: string
description: Definition of the Virtual Network route.
required: true
- name: appserviceplansupdatevnetroute
method: PATCH
description: Create or update a Virtual Network route in an App Service plan.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the App Service plan.
required: true
- name: vnetName
in: path
type: string
description: Name of the Virtual Network.
required: true
- name: routeName
in: path
type: string
description: Name of the Virtual Network route.
required: true
- name: route
in: body
type: string
description: Definition of the Virtual Network route.
required: true
- name: appserviceplansdeletevnetroute
method: DELETE
description: Delete a Virtual Network route in an App Service plan.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of the App Service plan.
required: true
- name: vnetName
in: path
type: string
description: Name of the Virtual Network.
required: true
- name: routeName
in: path
type: string
description: Name of the Virtual Network route.
required: true
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/serverfarms/{name}/workers/{workerName}/reboot
operations:
- name: appserviceplansrebootworker
method: POST
description: Reboot a worker machine in an App Service plan.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: App Service plan.
required: true
- name: workerName
in: path
type: string
description: Name of worker machine, which typically starts with RD.
required: true
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/serverfarms/{name}/workers/{workerName}/recycleinstance
operations:
- name: appserviceplansrecyclemanagedinstanceworker
method: POST
description: Recycles a managed instance worker machine.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: App Service plan.
required: true
- name: workerName
in: path
type: string
description: Name of worker machine, which typically starts with RD.
required: true
exposes:
- type: rest
namespace: azure-functions-management-appserviceplans-rest
port: 8080
description: REST adapter for WebApps API Client — AppServicePlans. One Spectral-compliant resource per consumed operation,
prefixed with /v1.
resources:
- path: /v1/subscriptions/{subscriptionid}/providers/microsoft-web/serverfarms
name: subscriptions-subscriptionid-providers-microsoft-web-serverfarms
description: REST surface for subscriptions-subscriptionId-providers-Microsoft.Web-serverfarms.
operations:
- method: GET
name: appserviceplanslist
description: Get all App Service plans for a subscription.
call: azure-functions-management-appserviceplans.appserviceplanslist
with:
detailed: rest.detailed
outputParameters:
- type: object
mapping: $.
- path: /v1/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/microsoft-web/serverfarms
name: subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsof
description: REST surface for subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof.
operations:
- method: GET
name: appserviceplanslistbyresourcegroup
description: Get all App Service plans in a resource group.
call: azure-functions-management-appserviceplans.appserviceplanslistbyresourcegroup
outputParameters:
- type: object
mapping: $.
- path: /v1/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/microsoft-web/serverfarms/{name}
name: subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsof
description: REST surface for subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof.
operations:
- method: GET
name: appserviceplansget
description: Get an App Service plan.
call: azure-functions-management-appserviceplans.appserviceplansget
with:
name: rest.name
outputParameters:
- type: object
mapping: $.
- method: PUT
name: appserviceplanscreateorupdate
description: Creates or updates an App Service Plan.
call: azure-functions-management-appserviceplans.appserviceplanscreateorupdate
with:
name: rest.name
appServicePlan: rest.appServicePlan
outputParameters:
- type: object
mapping: $.
- method: PATCH
name: appserviceplansupdate
description: Creates or updates an App Service Plan.
call: azure-functions-management-appserviceplans.appserviceplansupdate
with:
name: rest.name
appServicePlan: rest.appServicePlan
outputParameters:
- type: object
mapping: $.
- method: DELETE
name: appserviceplansdelete
description: Delete an App Service plan.
call: azure-functions-management-appserviceplans.appserviceplansdelete
with:
name: rest.name
outputParameters:
- type: object
mapping: $.
- path: /v1/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/microsoft-web/serverfarms/{name}/capabilities
name: subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsof
description: REST surface for subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof.
operations:
- method: GET
name: appserviceplanslistcapabilities
description: List all capabilities of an App Service plan.
call: azure-functions-management-appserviceplans.appserviceplanslistcapabilities
with:
name: rest.name
outputParameters:
- type: object
mapping: $.
- path: /v1/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/microsoft-web/serverfarms/{name}/getrdppassword
name: subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsof
description: REST surface for subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof.
operations:
- method: POST
name: appserviceplansgetserverfarmrdppassword
description: Get the RDP password for an IsCustomMode ServerFarm.
call: azure-functions-management-appserviceplans.appserviceplansgetserverfarmrdppassword
with:
name: rest.name
outputParameters:
- type: object
mapping: $.
- path: /v1/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/microsoft-web/serverfarms/{name}/hybridconnectionnamespaces/{namespacename}/relays/{relayname}
name: subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsof
description: REST surface for subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof.
operations:
- method: GET
name: appserviceplansgethybridconnection
description: Retrieve a Hybrid Connection in use in an App Service plan.
call: azure-functions-management-appserviceplans.appserviceplansgethybridconnection
with:
name: rest.name
namespaceName: rest.namespaceName
relayName: rest.relayName
outputParameters:
- type: object
mapping: $.
- method: DELETE
name: appserviceplansdeletehybridconnection
description: Delete a Hybrid Connection in use in an App Service plan.
call: azure-functions-management-appserviceplans.appserviceplansdeletehybridconnection
with:
name: rest.name
namespaceName: rest.namespaceName
relayName: rest.relayName
outputParameters:
- type: object
mapping: $.
- path: /v1/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/microsoft-web/serverfarms/{name}/hybridconnectionnamespaces/{namespacename}/relays/{relayname}/listkeys
name: subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsof
description: REST surface for subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof.
operations:
- method: POST
name: appserviceplanslisthybridconnectionkeys
description: Get the send key name and value of a Hybrid Connection.
call: azure-functions-management-appserviceplans.appserviceplanslisthybridconnectionkeys
with:
name: rest.name
namespaceName: rest.namespaceName
relayName: rest.relayName
outputParameters:
- type: object
mapping: $.
- path: /v1/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/microsoft-web/serverfarms/{name}/hybridconnectionnamespaces/{namespacename}/relays/{relayname}/sites
name: subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsof
description: REST surface for subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof.
operations:
- method: GET
name: appserviceplanslistwebappsbyhybridconnection
description: Get all apps that use a Hybrid Connection in an App Service Plan.
call: azure-functions-management-appserviceplans.appserviceplanslistwebappsbyhybridconnection
with:
name: rest.name
namespaceName: rest.namespaceName
relayName: rest.relayName
outputParameters:
- type: object
mapping: $.
- path: /v1/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/microsoft-web/serverfarms/{name}/hybridconnectionplanlimits/limit
name: subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsof
description: REST surface for subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof.
operations:
- method: GET
name: appserviceplansgethybridconnectionplanlimit
description: Get the maximum number of Hybrid Connections allowed in an App Service plan.
call: azure-functions-management-appserviceplans.appserviceplansgethybridconnectionplanlimit
with:
name: rest.name
outputParameters:
- type: object
mapping: $.
- path: /v1/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/microsoft-web/serverfarms/{name}/hybridconnectionrelays
name: subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsof
description: REST surface for subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof.
operations:
- method: GET
name: appserviceplanslisthybridconnections
description: Retrieve all Hybrid Connections in use in an App Service plan.
call: azure-functions-management-appserviceplans.appserviceplanslisthybridconnections
with:
name: rest.name
outputParameters:
- type: object
mapping: $.
- path: /v1/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/microsoft-web/serverfarms/{name}/listinstances
name: subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsof
description: REST surface for subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof.
operations:
- method: POST
name: appserviceplansgetserverfarminstancedetails
description: Get the instance details for an app service plan.
call: azure-functions-management-appserviceplans.appserviceplansgetserverfarminstancedetails
with:
name: rest.name
outputParameters:
- type: object
mapping: $.
- path: /v1/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/microsoft-web/serverfarms/{name}/restartsites
name: subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsof
description: REST surface for subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof.
operations:
- method: POST
name: appserviceplansrestartwebapps
description: Restart all apps in an App Service plan.
call: azure-functions-management-appserviceplans.appserviceplansrestartwebapps
with:
name: rest.name
softRestart: rest.softRestart
outputParameters:
- type: object
mapping: $.
- path: /v1/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/microsoft-web/serverfarms/{name}/sites
name: subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsof
description: REST surface for subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof.
operations:
- method: GET
name: appserviceplanslistwebapps
description: Get all apps associated with an App Service plan.
call: azure-functions-management-appserviceplans.appserviceplanslistwebapps
with:
name: rest.name
$skipToken: rest.$skipToken
$filter: rest.$filter
$top: rest.$top
outputParameters:
- type: object
mapping: $.
- path: /v1/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/microsoft-web/serverfarms/{name}/skus
name: subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsof
description: REST surface for subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof.
operations:
- method: GET
name: appserviceplansgetserverfarmskus
description: Gets all selectable SKUs for a given App Service Plan
call: azure-functions-management-appserviceplans.appserviceplansgetserverfarmskus
with:
name: rest.name
outputParameters:
- type: object
mapping: $.
- path: /v1/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/microsoft-web/serverfarms/{name}/usages
name: subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsof
description: REST surface for subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof.
operations:
- method: GET
name: appserviceplanslistusages
description: Gets server farm usage information
call: azure-functions-management-appserviceplans.appserviceplanslistusages
with:
name: rest.name
$filter: rest.$filter
outputParameters:
- type: object
mapping: $.
- path: /v1/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/microsoft-web/serverfarms/{name}/virtualnetworkconnections
name: subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsof
description: REST surface for subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof.
operations:
- method: GET
name: appserviceplanslistvnets
description: Get all Virtual Networks associated with an App Service plan.
call: azure-functions-management-appserviceplans.appserviceplanslistvnets
with:
name: rest.name
outputParameters:
- type: object
mapping: $.
- path: /v1/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/microsoft-web/serverfarms/{name}/virtualnetworkconnections/{vnetname}
name: subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsof
description: REST surface for subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof.
operations:
- method: GET
name: appserviceplansgetvnetfromserverfarm
description: Get a Virtual Network associated with an App Service plan.
call: azure-functions-management-appserviceplans.appserviceplansgetvnetfromserverfarm
with:
name: rest.name
vnetName: rest.vnetName
outputParameters:
- type: object
mapping: $.
- path: /v1/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/microsoft-web/serverfarms/{name}/virtualnetworkconnections/{vnetname}/gateways/{gatewayname}
name: subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsof
description: REST surface for subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof.
operations:
- method: GET
name: appserviceplansgetvnetgateway
description: Get a Virtual Network gateway.
call: azure-functions-management-appserviceplans.appserviceplansgetvnetgateway
with:
name: rest.name
vnetName: rest.vnetName
gatewayName: rest.gatewayName
outputParameters:
- type: object
mapping: $.
- method: PUT
name: appserviceplansupdatevnetgateway
description: Update a Virtual Network gateway.
call: azure-functions-management-appserviceplans.appserviceplansupdatevnetgateway
with:
name: rest.name
vnetName: rest.vnetName
gatewayName: rest.gatewayName
connectionEnvelope: rest.connectionEnvelope
outputParameters:
- type: object
mapping: $.
- path: /v1/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/microsoft-web/serverfarms/{name}/virtualnetworkconnections/{vnetname}/routes
name: subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsof
description: REST surface for subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof.
operations:
- method: GET
name: appserviceplanslistroutesforvnet
description: Get all routes that are associated with a Virtual Network in an App Service plan.
call: azure-functions-management-appserviceplans.appserviceplanslistroutesforvnet
with:
name: rest.name
vnetName: rest.vnetName
outputParameters:
- type: object
mapping: $.
- path: /v1/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/microsoft-web/serverfarms/{name}/virtualnetworkconnections/{vnetname}/routes/{routename}
name: subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsof
description: REST surface for subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof.
operations:
- method: GET
name: appserviceplansgetrouteforvnet
description: Get a Virtual Network route in an App Service plan.
call: azure-functions-management-appserviceplans.appserviceplansgetrouteforvnet
with:
name: rest.name
vnetName: rest.vnetName
routeName: rest.routeName
outputParameters:
- type: object
mapping: $.
- method: PUT
name: appserviceplanscreateorupdatevnetroute
description: Create or update a Virtual Network route in an App Service plan.
call: azure-functions-management-appserviceplans.appserviceplanscreateorupdatevnetroute
with:
name: rest.name
vnetName: rest.vnetName
routeName: rest.routeName
route: rest.route
outputParameters:
- type: object
mapping: $.
- method: PATCH
name: appserviceplansupdatevnetroute
description: Create or update a Virtual Network route in an App Service plan.
call: azure-functions-management-appserviceplans.appserviceplansupdatevnetroute
with:
name: rest.name
vnetName: rest.vnetName
routeName: rest.routeName
route: rest.route
outputParameters:
- type: object
mapping: $.
- method: DELETE
name: appserviceplansdeletevnetroute
description: Delete a Virtual Network route in an App Service plan.
call: azure-functions-management-appserviceplans.appserviceplansdeletevnetroute
with:
name: rest.name
vnetName: rest.vnetName
routeName: rest.routeName
outputParameters:
- type: object
mapping: $.
- path: /v1/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/microsoft-web/serverfarms/{name}/workers/{workername}/reboot
name: subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsof
description: REST surface for subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-microsof.
operations:
- method: POST
name: appserviceplansrebootworker
description: Reboot a worker machine in an App Service plan.
call: azure-functions-management-appserviceplans.appserviceplansrebootworker
with:
name: rest.name
workerName: rest.workerName
outputParameters:
- type: object
mapping: $.
- path: /v1/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/microsoft-web/serverfarms/{name}/workers/{workername}/recycleinstance
name: subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsof
description: REST surface for subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-microsof.
operations:
- method: POST
name: appserviceplansrecyclemanagedinstanceworker
description: Recycles a managed instance worker machine.
call: azure-functions-management-appserviceplans.appserviceplansrecyclemanagedinstanceworker
with:
name: rest.name
workerName: rest.workerName
outputParameters:
- type: object
mapping: $.
- type: mcp
namespace: azure-functions-management-appserviceplans-mcp
port: 9090
transport: http
description: MCP adapter for WebApps API Client — AppServicePlans. One tool per consumed operation, routed inline through
this capability's consumes block.
tools:
- name: get-all-app-service-plans
description: Get all App Service plans for a subscription.
hints:
readOnly: true
destructive: false
idempotent: true
call: azure-functions-management-appserviceplans.appserviceplanslist
with:
detailed: tools.detailed
outputParameters:
- type: object
mapping: $.
- name: get-all-app-service-plans-2
description: Get all App Service plans in a resource group.
hints:
readOnly: true
destructive: false
idempotent: true
call: azure-functions-management-appserviceplans.appserviceplanslistbyresourcegroup
outputParameters:
- type: object
mapping: $.
- name: get-app-service-plan
description: Get an App Service plan.
hints:
readOnly: true
destructive: false
idempotent: true
call: azure-functions-management-appserviceplans.appserviceplansget
with:
name: tools.name
outputParameters:
- type: object
mapping: $.
- name: creates-updates-app-service-plan
description: Creates or updates an App Service Plan.
hints:
readOnly: false
destructive: false
idempotent: true
call: azure-functions-management-appserviceplans.appserviceplanscreateorupdate
with:
name: tools.name
appServicePlan: tools.appServicePlan
outputParameters:
- type: object
mapping: $.
- name: creates-updates-app-service-plan-2
description: Creates or updates an App Service Plan.
hints:
readOnly: false
destructive: false
idempotent: true
call: azure-functions-management-appserviceplans.appserviceplansupdate
with:
name: tools.name
appServicePlan: tools.appServicePlan
outputParameters:
- type: object
mapping: $.
- name: delete-app-service-plan
description: Delete an App Service plan.
hints:
readOnly: false
destructive: true
idempotent: true
call: azure-functions-management-appserviceplans.appserviceplansdelete
with:
name: tools.name
outputParameters:
- type: object
mapping: $.
- name: list-all-capabilities-app-service
description: List all capabilities of an App Service plan.
hints:
readOnly: true
destructive: false
idempotent: true
call: azure-functions-management-appserviceplans.appserviceplanslistcapabilities
with:
name: tools.name
outputParameters:
- type: object
mapping: $.
- name: get-rdp-password-iscustommode-serverfarm
description: Get the RDP password for an IsCustomMode ServerFarm.
hints:
readOnly: true
destructive: false
idempotent: false
call: azure-functions-management-appserviceplans.appserviceplansgetserverfarmrdppassword
with:
name: tools.name
outputParameters:
- type: object
mapping: $.
- name: retrieve-hybrid-connection-use-app
description: Retrieve a Hybrid Connection in use in an App Service plan.
hints:
readOnly: true
destructive: false
idempotent: true
call: azure-functions-management-appserviceplans.appserviceplansgethybridconnection
with:
name: tools.name
namespaceName: tools.namespaceName
relayName: tools.relayName
outputParameters:
- type: object
mapping: $.
- name: delete-hybrid-connection-use-app
description: Delete a Hybrid Connection in use in an App Service plan.
hints:
readOnly: false
destructive: true
idempotent: true
call: azure-functions-management-appserviceplans.appserviceplansdeletehybridconnection
with:
name: tools.name
namespaceName: tools.namespaceName
relayName: tools.relayName
outputParameters:
- type: object
mapping: $.
- name: get-send-key-name-and
description: Get the send key name and value of a Hybrid Connection.
hints:
readOnly: true
destructive: false
idempotent: false
call: azure-functions-management-appserviceplans.appserviceplanslisthybridconnectionkeys
with:
name: tools.name
namespaceName: tools.namespaceName
relayName: tools.relayName
outputParameters:
- type: object
mapping: $.
- name: get-all-apps-that-use
description: Get all apps that use a Hybrid Connection in an App Service Plan.
hints:
readOnly: true
destructive: false
idempotent: true
call: azure-functions-management-appserviceplans.appserviceplanslistwebappsbyhybridconnection
with:
name: tools.name
namespaceName: tools.namespaceName
relayName: tools.relayName
outputParameters:
- type: object
mapping: $.
- name: get-maximum-number-hybrid-connections
description: Get the maximum number of Hybrid Connections allowed in an App Service plan.
hints:
readOnly: true
destructive: false
idempotent: true
call: azure-functions-management-appserviceplans.appserviceplansgethybridconnectionplanlimit
with:
name: tools.name
outputParameters:
- type: object
mapping: $.
- name: retrieve-all-hybrid-connections-use
description: Retrieve all Hybrid Connections in use in an App Service plan.
hints:
readOnly: true
destructive: false
idempotent: true
call: azure-functions-management-appserviceplans.appserviceplanslisthybridconnections
with:
name: tools.name
outputParameters:
- type: object
mapping: $.
- name: get-instance-details-app-service
description: Get the instance details for an app service plan.
hints:
readOnly: true
destructive: false
idempotent: false
call: azure-functions-management-appserviceplans.appserviceplansgetserverfarminstancedetails
with:
name: tools.name
outputParameters:
- type: object
mapping: $.
- name: restart-all-apps-app-service
description: Restart all apps in an App Service plan.
hints:
readOnly: false
destructive: false
idempotent: false
call: azure-functions-management-appserviceplans.appserviceplansrestartwebapps
with:
name: tools.name
softRestart: tools.softRestart
outputParameters:
- type: object
mapping: $.
- name: get-all-apps-associated-app
description: Get all apps associated with an App Service plan.
hints:
readOnly: true
destructive: false
idempotent: true
call: azure-functions-management-appserviceplans.appserviceplanslistwebapps
with:
name: tools.name
$skipToken: tools.$skipToken
$filter: tools.$filter
$top: tools.$top
outputParameters:
- type: object
mapping: $.
- name: gets-all-selectable-skus-given
description: Gets all selectable SKUs for a given App Service Plan
hints:
readOnly: true
destructive: false
idempotent: true
call: azure-functions-management-appserviceplans.appserviceplansgetserverfarmskus
with:
name: tools.name
outputParameters:
- type: object
mapping: $.
- name: gets-server-farm-usage-information
description: Gets server farm usage information
hints:
readOnly: true
destructive: false
idempotent: true
call: azure-functions-management-appserviceplans.appserviceplanslistusages
with:
name: tools.name
$filter: tools.$filter
outputParameters:
- type: object
mapping: $.
- name: get-all-virtual-networks-associated
description: Get all Virtual Networks associated with an App Service plan.
hints:
readOnly: true
destructive: false
idempotent: true
call: azure-functions-management-appserviceplans.appserviceplanslistvnets
with:
name: tools.name
outputParameters:
- type: object
mapping: $.
- name: get-virtual-network-associated-app
description: Get a Virtual Network associated with an App Service plan.
hints:
readOnly: true
destructive: false
idempotent: true
call: azure-functions-management-appserviceplans.appserviceplansgetvnetfromserverfarm
with:
name: tools.name
vnetName: tools.vnetName
outputParameters:
- type: object
mapping: $.
- name: get-virtual-network-gateway
description: Get a Virtual Network gateway.
hints:
readOnly: true
destructive: false
idempotent: true
call: azure-functions-management-appserviceplans.appserviceplansgetvnetgateway
with:
name: tools.name
vnetName: tools.vnetName
gatewayName: tools.gatewayName
outputParameters:
- type: object
mapping: $.
- name: update-virtual-network-gateway
description: Update a Virtual Network gateway.
hints:
readOnly: false
destructive: false
idempotent: true
call: azure-functions-management-appserviceplans.appserviceplansupdatevnetgateway
with:
name: tools.name
vnetName: tools.vnetName
gatewayName: tools.gatewayName
connectionEnvelope: tools.connectionEnvelope
outputParameters:
- type: object
mapping: $.
- name: get-all-routes-that-are
description: Get all routes that are associated with a Virtual Network in an App Service plan.
hints:
readOnly: true
destructive: false
idempotent: true
call: azure-functions-management-appserviceplans.appserviceplanslistroutesforvnet
with:
name: tools.name
vnetName: tools.vnetName
outputParameters:
- type: object
mapping: $.
- name: get-virtual-network-route-app
description: Get a Virtual Network route in an App Service plan.
hints:
readOnly: true
destructive: false
idempotent: true
call: azure-functions-management-appserviceplans.appserviceplansgetrouteforvnet
with:
name: tools.name
vnetName: tools.vnetName
routeName: tools.routeName
outputParameters:
- type: object
mapping: $.
- name: create-update-virtual-network-route
description: Create or update a Virtual Network route in an App Service plan.
hints:
readOnly: false
destructive: false
idempotent: true
call: azure-functions-management-appserviceplans.appserviceplanscreateorupdatevnetroute
with:
name: tools.name
vnetName: tools.vnetName
routeName: tools.routeName
route: tools.route
outputParameters:
- type: object
mapping: $.
- name: create-update-virtual-network-route-2
description: Create or update a Virtual Network route in an App Service plan.
hints:
readOnly: false
destructive: false
idempotent: true
call: azure-functions-management-appserviceplans.appserviceplansupdatevnetroute
with:
name: tools.name
vnetName: tools.vnetName
routeName: tools.routeName
route: tools.route
outputParameters:
- type: object
mapping: $.
- name: delete-virtual-network-route-app
description: Delete a Virtual Network route in an App Service plan.
hints:
readOnly: false
destructive: true
idempotent: true
call: azure-functions-management-appserviceplans.appserviceplansdeletevnetroute
with:
name: tools.name
vnetName: tools.vnetName
routeName: tools.routeName
outputParameters:
- type: object
mapping: $.
- name: reboot-worker-machine-app-service
description: Reboot a worker machine in an App Service plan.
hints:
readOnly: false
destructive: false
idempotent: false
call: azure-functions-management-appserviceplans.appserviceplansrebootworker
with:
name: tools.name
workerName: tools.workerName
outputParameters:
- type: object
mapping: $.
- name: recycles-managed-instance-worker-machine
description: Recycles a managed instance worker machine.
hints:
readOnly: false
destructive: false
idempotent: false
call: azure-functions-management-appserviceplans.appserviceplansrecyclemanagedinstanceworker
with:
name: tools.name
workerName: tools.workerName
outputParameters:
- type: object
mapping: $.