naftiko: 1.0.0-alpha2
info:
label: Microsoft Azure AppServicePlans API Client — AppServicePlans
description: 'Microsoft Azure AppServicePlans API Client — AppServicePlans. 27 operations. Lead operation: Microsoft Azure
Get All App Service Plans For A Subscription. Self-contained Naftiko capability covering one Microsoft Azure business
surface.'
tags:
- Microsoft Azure
- AppServicePlans
created: '2026-05-19'
modified: '2026-05-19'
binds:
- namespace: env
keys:
MICROSOFT_AZURE_API_KEY: MICROSOFT_AZURE_API_KEY
capability:
consumes:
- type: http
namespace: appserviceplans-api-client-appserviceplans
baseUri: https://management.azure.com
description: Microsoft Azure AppServicePlans 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: microsoftazureappserviceplanslist
method: GET
description: Microsoft Azure 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: microsoftazureappserviceplanslistbyresourcegroup
method: GET
description: Microsoft Azure 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: microsoftazureappserviceplansget
method: GET
description: Microsoft Azure 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: microsoftazureappserviceplanscreateorupdate
method: PUT
description: Microsoft Azure 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: microsoftazureappserviceplansdelete
method: DELETE
description: Microsoft Azure 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: microsoftazureappserviceplansupdate
method: PATCH
description: Microsoft Azure 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: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/capabilities
operations:
- name: microsoftazureappserviceplanslistcapabilities
method: GET
description: Microsoft Azure 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}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}
operations:
- name: microsoftazureappserviceplansgethybridconnection
method: GET
description: Microsoft Azure 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: microsoftazureappserviceplansdeletehybridconnection
method: DELETE
description: Microsoft Azure 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: microsoftazureappserviceplanslisthybridconnectionkeys
method: POST
description: Microsoft Azure 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: The name of the Service Bus namespace.
required: true
- name: relayName
in: path
type: string
description: The 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: microsoftazureappserviceplanslistwebappsbyhybridconnection
method: GET
description: Microsoft Azure 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 Hybrid Connection namespace.
required: true
- name: relayName
in: path
type: string
description: Name of the Hybrid Connection relay.
required: true
- name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionPlanLimits/limit
operations:
- name: microsoftazureappserviceplansgethybridconnectionplanlimit
method: GET
description: Microsoft Azure 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: microsoftazureappserviceplanslisthybridconnections
method: GET
description: Microsoft Azure 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}/restartSites
operations:
- name: microsoftazureappserviceplansrestartwebapps
method: POST
description: Microsoft Azure 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: microsoftazureappserviceplanslistwebapps
method: GET
description: Microsoft Azure 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: microsoftazureappserviceplansgetserverfarmskus
method: GET
description: Microsoft Azure 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 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: microsoftazureappserviceplanslistusages
method: GET
description: Microsoft Azure Gets Server Farm Usage Information
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: name
in: path
type: string
description: Name of 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: microsoftazureappserviceplanslistvnets
method: GET
description: Microsoft Azure 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: microsoftazureappserviceplansgetvnetfromserverfarm
method: GET
description: Microsoft Azure 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: microsoftazureappserviceplansgetvnetgateway
method: GET
description: Microsoft Azure 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: microsoftazureappserviceplansupdatevnetgateway
method: PUT
description: Microsoft Azure 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: microsoftazureappserviceplanslistroutesforvnet
method: GET
description: Microsoft Azure 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: microsoftazureappserviceplansgetrouteforvnet
method: GET
description: Microsoft Azure 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: microsoftazureappserviceplanscreateorupdatevnetroute
method: PUT
description: Microsoft Azure 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: microsoftazureappserviceplansdeletevnetroute
method: DELETE
description: Microsoft Azure 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: microsoftazureappserviceplansupdatevnetroute
method: PATCH
description: Microsoft Azure 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: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/workers/{workerName}/reboot
operations:
- name: microsoftazureappserviceplansrebootworker
method: POST
description: Microsoft Azure 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: Name of the 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: appserviceplans-api-client-appserviceplans-rest
port: 8080
description: REST adapter for Microsoft Azure AppServicePlans 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: microsoftazureappserviceplanslist
description: Microsoft Azure Get All App Service Plans For A Subscription
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplanslist
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: microsoftazureappserviceplanslistbyresourcegroup
description: Microsoft Azure Get All App Service Plans In A Resource Group
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplanslistbyresourcegroup
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: microsoftazureappserviceplansget
description: Microsoft Azure Get An App Service Plan
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplansget
with:
name: rest.name
outputParameters:
- type: object
mapping: $.
- method: PUT
name: microsoftazureappserviceplanscreateorupdate
description: Microsoft Azure Creates Or Updates An App Service Plan
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplanscreateorupdate
with:
name: rest.name
appServicePlan: rest.appServicePlan
outputParameters:
- type: object
mapping: $.
- method: DELETE
name: microsoftazureappserviceplansdelete
description: Microsoft Azure Delete An App Service Plan
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplansdelete
with:
name: rest.name
outputParameters:
- type: object
mapping: $.
- method: PATCH
name: microsoftazureappserviceplansupdate
description: Microsoft Azure Creates Or Updates An App Service Plan
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplansupdate
with:
name: rest.name
appServicePlan: rest.appServicePlan
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: microsoftazureappserviceplanslistcapabilities
description: Microsoft Azure List All Capabilities Of An App Service Plan
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplanslistcapabilities
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: microsoftazureappserviceplansgethybridconnection
description: Microsoft Azure Retrieve A Hybrid Connection In Use In An App Service Plan
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplansgethybridconnection
with:
name: rest.name
namespaceName: rest.namespaceName
relayName: rest.relayName
outputParameters:
- type: object
mapping: $.
- method: DELETE
name: microsoftazureappserviceplansdeletehybridconnection
description: Microsoft Azure Delete A Hybrid Connection In Use In An App Service Plan
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplansdeletehybridconnection
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: microsoftazureappserviceplanslisthybridconnectionkeys
description: Microsoft Azure Get The Send Key Name And Value Of A Hybrid Connection
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplanslisthybridconnectionkeys
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: microsoftazureappserviceplanslistwebappsbyhybridconnection
description: Microsoft Azure Get All Apps That Use A Hybrid Connection In An App Service Plan
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplanslistwebappsbyhybridconnection
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: microsoftazureappserviceplansgethybridconnectionplanlimit
description: Microsoft Azure Get The Maximum Number Of Hybrid Connections Allowed In An App Service Plan
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplansgethybridconnectionplanlimit
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: microsoftazureappserviceplanslisthybridconnections
description: Microsoft Azure Retrieve All Hybrid Connections In Use In An App Service Plan
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplanslisthybridconnections
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: microsoftazureappserviceplansrestartwebapps
description: Microsoft Azure Restart All Apps In An App Service Plan
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplansrestartwebapps
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: microsoftazureappserviceplanslistwebapps
description: Microsoft Azure Get All Apps Associated With An App Service Plan
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplanslistwebapps
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: microsoftazureappserviceplansgetserverfarmskus
description: Microsoft Azure Gets All Selectable Skus For A Given App Service Plan
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplansgetserverfarmskus
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: microsoftazureappserviceplanslistusages
description: Microsoft Azure Gets Server Farm Usage Information
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplanslistusages
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: microsoftazureappserviceplanslistvnets
description: Microsoft Azure Get All Virtual Networks Associated With An App Service Plan
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplanslistvnets
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: microsoftazureappserviceplansgetvnetfromserverfarm
description: Microsoft Azure Get A Virtual Network Associated With An App Service Plan
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplansgetvnetfromserverfarm
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: microsoftazureappserviceplansgetvnetgateway
description: Microsoft Azure Get A Virtual Network Gateway
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplansgetvnetgateway
with:
name: rest.name
vnetName: rest.vnetName
gatewayName: rest.gatewayName
outputParameters:
- type: object
mapping: $.
- method: PUT
name: microsoftazureappserviceplansupdatevnetgateway
description: Microsoft Azure Update A Virtual Network Gateway
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplansupdatevnetgateway
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: microsoftazureappserviceplanslistroutesforvnet
description: Microsoft Azure Get All Routes That Are Associated With A Virtual Network In An App Service Plan
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplanslistroutesforvnet
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: microsoftazureappserviceplansgetrouteforvnet
description: Microsoft Azure Get A Virtual Network Route In An App Service Plan
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplansgetrouteforvnet
with:
name: rest.name
vnetName: rest.vnetName
routeName: rest.routeName
outputParameters:
- type: object
mapping: $.
- method: PUT
name: microsoftazureappserviceplanscreateorupdatevnetroute
description: Microsoft Azure Create Or Update A Virtual Network Route In An App Service Plan
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplanscreateorupdatevnetroute
with:
name: rest.name
vnetName: rest.vnetName
routeName: rest.routeName
route: rest.route
outputParameters:
- type: object
mapping: $.
- method: DELETE
name: microsoftazureappserviceplansdeletevnetroute
description: Microsoft Azure Delete A Virtual Network Route In An App Service Plan
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplansdeletevnetroute
with:
name: rest.name
vnetName: rest.vnetName
routeName: rest.routeName
outputParameters:
- type: object
mapping: $.
- method: PATCH
name: microsoftazureappserviceplansupdatevnetroute
description: Microsoft Azure Create Or Update A Virtual Network Route In An App Service Plan
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplansupdatevnetroute
with:
name: rest.name
vnetName: rest.vnetName
routeName: rest.routeName
route: rest.route
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: microsoftazureappserviceplansrebootworker
description: Microsoft Azure Reboot A Worker Machine In An App Service Plan
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplansrebootworker
with:
name: rest.name
workerName: rest.workerName
outputParameters:
- type: object
mapping: $.
- type: mcp
namespace: appserviceplans-api-client-appserviceplans-mcp
port: 9090
transport: http
description: MCP adapter for Microsoft Azure AppServicePlans API Client — AppServicePlans. One tool per consumed operation,
routed inline through this capability's consumes block.
tools:
- name: microsoft-azure-get-all-app
description: Microsoft Azure Get All App Service Plans For A Subscription
hints:
readOnly: true
destructive: false
idempotent: true
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplanslist
with:
detailed: tools.detailed
outputParameters:
- type: object
mapping: $.
- name: microsoft-azure-get-all-app-2
description: Microsoft Azure Get All App Service Plans In A Resource Group
hints:
readOnly: true
destructive: false
idempotent: true
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplanslistbyresourcegroup
outputParameters:
- type: object
mapping: $.
- name: microsoft-azure-get-app-service
description: Microsoft Azure Get An App Service Plan
hints:
readOnly: true
destructive: false
idempotent: true
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplansget
with:
name: tools.name
outputParameters:
- type: object
mapping: $.
- name: microsoft-azure-creates-updates-app
description: Microsoft Azure Creates Or Updates An App Service Plan
hints:
readOnly: false
destructive: false
idempotent: true
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplanscreateorupdate
with:
name: tools.name
appServicePlan: tools.appServicePlan
outputParameters:
- type: object
mapping: $.
- name: microsoft-azure-delete-app-service
description: Microsoft Azure Delete An App Service Plan
hints:
readOnly: false
destructive: true
idempotent: true
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplansdelete
with:
name: tools.name
outputParameters:
- type: object
mapping: $.
- name: microsoft-azure-creates-updates-app-2
description: Microsoft Azure Creates Or Updates An App Service Plan
hints:
readOnly: false
destructive: false
idempotent: true
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplansupdate
with:
name: tools.name
appServicePlan: tools.appServicePlan
outputParameters:
- type: object
mapping: $.
- name: microsoft-azure-list-all-capabilities
description: Microsoft Azure List All Capabilities Of An App Service Plan
hints:
readOnly: true
destructive: false
idempotent: true
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplanslistcapabilities
with:
name: tools.name
outputParameters:
- type: object
mapping: $.
- name: microsoft-azure-retrieve-hybrid-connection
description: Microsoft Azure Retrieve A Hybrid Connection In Use In An App Service Plan
hints:
readOnly: true
destructive: false
idempotent: true
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplansgethybridconnection
with:
name: tools.name
namespaceName: tools.namespaceName
relayName: tools.relayName
outputParameters:
- type: object
mapping: $.
- name: microsoft-azure-delete-hybrid-connection
description: Microsoft Azure Delete A Hybrid Connection In Use In An App Service Plan
hints:
readOnly: false
destructive: true
idempotent: true
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplansdeletehybridconnection
with:
name: tools.name
namespaceName: tools.namespaceName
relayName: tools.relayName
outputParameters:
- type: object
mapping: $.
- name: microsoft-azure-get-send-key
description: Microsoft Azure Get The Send Key Name And Value Of A Hybrid Connection
hints:
readOnly: true
destructive: false
idempotent: false
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplanslisthybridconnectionkeys
with:
name: tools.name
namespaceName: tools.namespaceName
relayName: tools.relayName
outputParameters:
- type: object
mapping: $.
- name: microsoft-azure-get-all-apps
description: Microsoft Azure Get All Apps That Use A Hybrid Connection In An App Service Plan
hints:
readOnly: true
destructive: false
idempotent: true
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplanslistwebappsbyhybridconnection
with:
name: tools.name
namespaceName: tools.namespaceName
relayName: tools.relayName
outputParameters:
- type: object
mapping: $.
- name: microsoft-azure-get-maximum-number
description: Microsoft Azure Get The Maximum Number Of Hybrid Connections Allowed In An App Service Plan
hints:
readOnly: true
destructive: false
idempotent: true
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplansgethybridconnectionplanlimit
with:
name: tools.name
outputParameters:
- type: object
mapping: $.
- name: microsoft-azure-retrieve-all-hybrid
description: Microsoft Azure Retrieve All Hybrid Connections In Use In An App Service Plan
hints:
readOnly: true
destructive: false
idempotent: true
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplanslisthybridconnections
with:
name: tools.name
outputParameters:
- type: object
mapping: $.
- name: microsoft-azure-restart-all-apps
description: Microsoft Azure Restart All Apps In An App Service Plan
hints:
readOnly: false
destructive: false
idempotent: false
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplansrestartwebapps
with:
name: tools.name
softRestart: tools.softRestart
outputParameters:
- type: object
mapping: $.
- name: microsoft-azure-get-all-apps-2
description: Microsoft Azure Get All Apps Associated With An App Service Plan
hints:
readOnly: true
destructive: false
idempotent: true
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplanslistwebapps
with:
name: tools.name
$skipToken: tools.$skipToken
$filter: tools.$filter
$top: tools.$top
outputParameters:
- type: object
mapping: $.
- name: microsoft-azure-gets-all-selectable
description: Microsoft Azure Gets All Selectable Skus For A Given App Service Plan
hints:
readOnly: true
destructive: false
idempotent: true
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplansgetserverfarmskus
with:
name: tools.name
outputParameters:
- type: object
mapping: $.
- name: microsoft-azure-gets-server-farm
description: Microsoft Azure Gets Server Farm Usage Information
hints:
readOnly: true
destructive: false
idempotent: true
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplanslistusages
with:
name: tools.name
$filter: tools.$filter
outputParameters:
- type: object
mapping: $.
- name: microsoft-azure-get-all-virtual
description: Microsoft Azure Get All Virtual Networks Associated With An App Service Plan
hints:
readOnly: true
destructive: false
idempotent: true
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplanslistvnets
with:
name: tools.name
outputParameters:
- type: object
mapping: $.
- name: microsoft-azure-get-virtual-network
description: Microsoft Azure Get A Virtual Network Associated With An App Service Plan
hints:
readOnly: true
destructive: false
idempotent: true
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplansgetvnetfromserverfarm
with:
name: tools.name
vnetName: tools.vnetName
outputParameters:
- type: object
mapping: $.
- name: microsoft-azure-get-virtual-network-2
description: Microsoft Azure Get A Virtual Network Gateway
hints:
readOnly: true
destructive: false
idempotent: true
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplansgetvnetgateway
with:
name: tools.name
vnetName: tools.vnetName
gatewayName: tools.gatewayName
outputParameters:
- type: object
mapping: $.
- name: microsoft-azure-update-virtual-network
description: Microsoft Azure Update A Virtual Network Gateway
hints:
readOnly: false
destructive: false
idempotent: true
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplansupdatevnetgateway
with:
name: tools.name
vnetName: tools.vnetName
gatewayName: tools.gatewayName
connectionEnvelope: tools.connectionEnvelope
outputParameters:
- type: object
mapping: $.
- name: microsoft-azure-get-all-routes
description: Microsoft Azure Get All Routes That Are Associated With A Virtual Network In An App Service Plan
hints:
readOnly: true
destructive: false
idempotent: true
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplanslistroutesforvnet
with:
name: tools.name
vnetName: tools.vnetName
outputParameters:
- type: object
mapping: $.
- name: microsoft-azure-get-virtual-network-3
description: Microsoft Azure Get A Virtual Network Route In An App Service Plan
hints:
readOnly: true
destructive: false
idempotent: true
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplansgetrouteforvnet
with:
name: tools.name
vnetName: tools.vnetName
routeName: tools.routeName
outputParameters:
- type: object
mapping: $.
- name: microsoft-azure-create-update-virtual
description: Microsoft Azure Create Or Update A Virtual Network Route In An App Service Plan
hints:
readOnly: false
destructive: false
idempotent: true
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplanscreateorupdatevnetroute
with:
name: tools.name
vnetName: tools.vnetName
routeName: tools.routeName
route: tools.route
outputParameters:
- type: object
mapping: $.
- name: microsoft-azure-delete-virtual-network
description: Microsoft Azure Delete A Virtual Network Route In An App Service Plan
hints:
readOnly: false
destructive: true
idempotent: true
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplansdeletevnetroute
with:
name: tools.name
vnetName: tools.vnetName
routeName: tools.routeName
outputParameters:
- type: object
mapping: $.
- name: microsoft-azure-create-update-virtual-2
description: Microsoft Azure Create Or Update A Virtual Network Route In An App Service Plan
hints:
readOnly: false
destructive: false
idempotent: true
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplansupdatevnetroute
with:
name: tools.name
vnetName: tools.vnetName
routeName: tools.routeName
route: tools.route
outputParameters:
- type: object
mapping: $.
- name: microsoft-azure-reboot-worker-machine
description: Microsoft Azure Reboot A Worker Machine In An App Service Plan
hints:
readOnly: false
destructive: false
idempotent: false
call: appserviceplans-api-client-appserviceplans.microsoftazureappserviceplansrebootworker
with:
name: tools.name
workerName: tools.workerName
outputParameters:
- type: object
mapping: $.