Skip to main content

app_service_plans

Creates, updates, deletes, gets or lists an app_service_plans resource.

Overview​

Nameapp_service_plans
TypeResource
Idazure.web.app_service_plans

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringResource Id.
namestringResource Name.
kindstringKind of resource.
sendKeyNamestringThe name of the send key.
sendKeyValuestringThe value of the send key.
typestringResource type.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_hybrid_connection_keysselectresource_group_name, name, namespace_name, relay_name, subscription_idGet the send key name and value of a Hybrid Connection. Description for Get the send key name and value of a Hybrid Connection.
get_vnet_gatewayselectresource_group_name, name, vnet_name, gateway_name, subscription_idGet a Virtual Network gateway. Description for Get a Virtual Network gateway.
get_route_for_vnetselectresource_group_name, name, vnet_name, route_name, subscription_idGet a Virtual Network route in an App Service plan. Description for Get a Virtual Network route in an App Service plan.
list_routes_for_vnetselectresource_group_name, name, vnet_name, subscription_idGet all routes that are associated with a Virtual Network in an App Service plan. Description for Get all routes that are associated with a Virtual Network in an App Service plan.
getselectresource_group_name, name, subscription_idGet an App Service plan. Description for Get an App Service plan.
list_by_resource_groupselectresource_group_name, subscription_idGet all App Service plans in a resource group. Description for Get all App Service plans in a resource group.
listselectsubscription_iddetailedGet all App Service plans for a subscription. Description for Get all App Service plans for a subscription.
create_or_updateinsertresource_group_name, name, subscription_id, locationCreates or updates an App Service Plan. Description for Creates or updates an App Service Plan.
updateupdateresource_group_name, name, subscription_idCreates or updates an App Service Plan. Description for Creates or updates an App Service Plan.
create_or_updatereplaceresource_group_name, name, subscription_id, locationCreates or updates an App Service Plan. Description for Creates or updates an App Service Plan.
deletedeleteresource_group_name, name, subscription_idDelete an App Service plan. Description for Delete an App Service plan.
list_capabilitiesexecresource_group_name, name, subscription_idList all capabilities of an App Service plan. Description for List all capabilities of an App Service plan.
list_hybrid_connectionsexecresource_group_name, name, subscription_idRetrieve all Hybrid Connections in use in an App Service plan. Description for Retrieve all Hybrid Connections in use in an App Service plan.
list_web_appsexecresource_group_name, name, subscription_id$skipToken, $filter, $topGet all apps associated with an App Service plan. Description for Get all apps associated with an App Service plan.
list_usagesexecresource_group_name, name, subscription_id$filterGets server farm usage information. Description for Gets server farm usage information.
list_web_apps_by_hybrid_connectionexecresource_group_name, name, namespace_name, relay_name, subscription_idGet all apps that use a Hybrid Connection in an App Service Plan. Description for Get all apps that use a Hybrid Connection in an App Service Plan.
list_vnetsexecresource_group_name, name, subscription_idGet all Virtual Networks associated with an App Service plan. Description for Get all Virtual Networks associated with an App Service plan.
get_server_farm_rdp_passwordexecresource_group_name, name, subscription_idGet the RDP password for an IsCustomMode ServerFarm. Description for Get the RDP password for an IsCustomMode ServerFarm.
get_server_farm_instance_detailsexecresource_group_name, name, subscription_idGet the instance details for an app service plan. Description for Get the instance details for an app service plan.
get_server_farm_skusexecresource_group_name, name, subscription_idGets all selectable SKUs for a given App Service Plan. Description for Gets all selectable SKUs for a given App Service Plan.
get_hybrid_connectionexecresource_group_name, name, namespace_name, relay_name, subscription_idRetrieve a Hybrid Connection in use in an App Service plan. Description for Retrieve a Hybrid Connection in use in an App Service plan.
delete_hybrid_connectionexecresource_group_name, name, namespace_name, relay_name, subscription_idDelete a Hybrid Connection in use in an App Service plan. Description for Delete a Hybrid Connection in use in an App Service plan.
get_hybrid_connection_plan_limitexecresource_group_name, name, subscription_idGet the maximum number of Hybrid Connections allowed in an App Service plan. Description for Get the maximum number of Hybrid Connections allowed in an App Service plan.
get_vnet_from_server_farmexecresource_group_name, name, vnet_name, subscription_idGet a Virtual Network associated with an App Service plan. Description for Get a Virtual Network associated with an App Service plan.
update_vnet_gatewayexecresource_group_name, name, vnet_name, gateway_name, subscription_idUpdate a Virtual Network gateway. Description for Update a Virtual Network gateway.
create_or_update_vnet_routeexecresource_group_name, name, vnet_name, route_name, subscription_idCreate or update a Virtual Network route in an App Service plan. Description for Create or update a Virtual Network route in an App Service plan.
update_vnet_routeexecresource_group_name, name, vnet_name, route_name, subscription_idCreate or update a Virtual Network route in an App Service plan. Description for Create or update a Virtual Network route in an App Service plan.
delete_vnet_routeexecresource_group_name, name, vnet_name, route_name, subscription_idDelete a Virtual Network route in an App Service plan. Description for Delete a Virtual Network route in an App Service plan.
recycle_managed_instance_workerexecresource_group_name, name, worker_name, subscription_idRecycles a managed instance worker machine. Description for Recycles a managed instance worker machine.
restart_web_appsexecresource_group_name, name, subscription_idsoftRestartRestart all apps in an App Service plan. Description for Restart all apps in an App Service plan.
reboot_workerexecresource_group_name, name, worker_name, subscription_idReboot a worker machine in an App Service plan. Description for Reboot a worker machine in an App Service plan.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
gateway_namestringName of the gateway. Only the 'primary' gateway is supported. Required.
namestringApp Service plan. Required.
namespace_namestringName of the Service Bus namespace. Required.
relay_namestringName of the Service Bus relay. Required.
resource_group_namestringThe name of the resource group. The name is case insensitive. Required.
route_namestringName of the Virtual Network route. Required.
subscription_idstring
vnet_namestringName of the Virtual Network. Required.
worker_namestringName of worker machine, which typically starts with RD. Required.
$filterstringReturn only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2'). Default value is None.
$skipTokenstringSkip 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 skipToken. Otherwise, the resulting list contains web apps from the start of the list. Default value is None.
$topstringList page size. If specified, results are paged. Default value is None.
detailedbooleanSpecify true to return all App Service plan properties. The default is false, which returns a subset of the properties. Retrieval of all properties may increase the API latency. Default value is None.
softRestartbooleanSpecify true to perform a soft restart, applies the configuration settings and restarts the apps if necessary. The default is false, which always restarts and reprovisions the apps. Default value is None.

SELECT examples​

Get the send key name and value of a Hybrid Connection. Description for Get the send key name and value of a Hybrid Connection.

SELECT
id,
name,
kind,
sendKeyName,
sendKeyValue,
type
FROM azure.web.app_service_plans
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND name = '{{ name }}' -- required
AND namespace_name = '{{ namespace_name }}' -- required
AND relay_name = '{{ relay_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples​

Creates or updates an App Service Plan. Description for Creates or updates an App Service Plan.

INSERT INTO azure.web.app_service_plans (
tags,
location,
properties,
sku,
extendedLocation,
kind,
identity,
resource_group_name,
name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ sku }}',
'{{ extendedLocation }}',
'{{ kind }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
extendedLocation,
identity,
kind,
location,
properties,
sku,
systemData,
tags,
type
;

UPDATE examples​

Creates or updates an App Service Plan. Description for Creates or updates an App Service Plan.

UPDATE azure.web.app_service_plans
SET 
kind = '{{ kind }}',
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
extendedLocation,
identity,
kind,
location,
properties,
sku,
systemData,
tags,
type;

REPLACE examples​

Creates or updates an App Service Plan. Description for Creates or updates an App Service Plan.

REPLACE azure.web.app_service_plans
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
sku = '{{ sku }}',
extendedLocation = '{{ extendedLocation }}',
kind = '{{ kind }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
extendedLocation,
identity,
kind,
location,
properties,
sku,
systemData,
tags,
type;

DELETE examples​

Delete an App Service plan. Description for Delete an App Service plan.

DELETE FROM azure.web.app_service_plans
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods​

List all capabilities of an App Service plan. Description for List all capabilities of an App Service plan.

EXEC azure.web.app_service_plans.list_capabilities 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;