AppServicePlansOperations Class

Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:app_service_plans> attribute.

Inheritance: builtins.object

AppServicePlansOperations

Constructor

AppServicePlansOperations(*args, **kwargs)

Methods

begin_create_or_update	Creates or updates an App Service Plan. Creates or updates an App Service Plan.
create_or_update_vnet_route	Create or update a Virtual Network route in an App Service plan. Create or update a Virtual Network route in an App Service plan.
delete	Delete an App Service plan. Delete an App Service plan.
delete_hybrid_connection	Delete a Hybrid Connection in use in an App Service plan. Delete a Hybrid Connection in use in an App Service plan.
delete_vnet_route	Delete a Virtual Network route in an App Service plan. Delete a Virtual Network route in an App Service plan.
get	Get an App Service plan. Get an App Service plan.
get_hybrid_connection	Retrieve a Hybrid Connection in use in an App Service plan. Retrieve a Hybrid Connection in use in an App Service plan.
get_hybrid_connection_plan_limit	Get the maximum number of Hybrid Connections allowed in an App Service plan. Get the maximum number of Hybrid Connections allowed in an App Service plan.
get_route_for_vnet	Get a Virtual Network route in an App Service plan. Get a Virtual Network route in an App Service plan.
get_server_farm_skus	Gets all selectable SKUs for a given App Service Plan. Gets all selectable SKUs for a given App Service Plan.
get_vnet_from_server_farm	Get a Virtual Network associated with an App Service plan. Get a Virtual Network associated with an App Service plan.
get_vnet_gateway	Get a Virtual Network gateway. Get a Virtual Network gateway.
list	Get all App Service plans for a subscription. Get all App Service plans for a subscription.
list_by_resource_group	Get all App Service plans in a resource group. Get all App Service plans in a resource group.
list_capabilities	List all capabilities of an App Service plan. List all capabilities of an App Service plan.
list_hybrid_connection_keys	Get the send key name and value of a Hybrid Connection. Get the send key name and value of a Hybrid Connection.
list_hybrid_connections	Retrieve all Hybrid Connections in use in an App Service plan. Retrieve all Hybrid Connections in use in an App Service plan.
list_metric_defintions	Get metrics that can be queried for an App Service plan, and their definitions. Get metrics that can be queried for an App Service plan, and their definitions.
list_metrics	Get metrics for an App Service plan. Get metrics for an App Service plan.
list_routes_for_vnet	Get all routes that are associated with a Virtual Network in an App Service plan. Get all routes that are associated with a Virtual Network in an App Service plan.
list_usages	Gets server farm usage information. Gets server farm usage information.
list_vnets	Get all Virtual Networks associated with an App Service plan. Get all Virtual Networks associated with an App Service plan.
list_web_apps	Get all apps associated with an App Service plan. Get all apps associated with an App Service plan.
list_web_apps_by_hybrid_connection	Get all apps that use a Hybrid Connection in an App Service Plan. Get all apps that use a Hybrid Connection in an App Service Plan.
reboot_worker	Reboot a worker machine in an App Service plan. Reboot a worker machine in an App Service plan.
restart_web_apps	Restart all apps in an App Service plan. Restart all apps in an App Service plan.
update	Creates or updates an App Service Plan. Creates or updates an App Service Plan.
update_vnet_gateway	Update a Virtual Network gateway. Update a Virtual Network gateway.
update_vnet_route	Create or update a Virtual Network route in an App Service plan. Create or update a Virtual Network route in an App Service plan.

begin_create_or_update

Creates or updates an App Service Plan.

begin_create_or_update(resource_group_name: str, name: str, app_service_plan: _models.AppServicePlan, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.AppServicePlan]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the App Service plan. Required.
app_service_plan Required	AppServicePlan or IO[bytes] Details of the App Service plan. Is either a AppServicePlan type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[AppServicePlan]	An instance of LROPoller that returns either AppServicePlan or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

create_or_update_vnet_route

Create or update a Virtual Network route in an App Service plan.

create_or_update_vnet_route(resource_group_name: str, name: str, vnet_name: str, route_name: str, route: _models.VnetRoute, *, content_type: str = 'application/json', **kwargs: Any) -> _models.VnetRoute | None

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the App Service plan. Required.
vnet_name Required	str Name of the Virtual Network. Required.
route_name Required	str Name of the Virtual Network route. Required.
route Required	VnetRoute or IO[bytes] Definition of the Virtual Network route. Is either a VnetRoute type or a IO[bytes] type. Required.

Returns

Type	Description
VnetRoute, None	VnetRoute or None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

delete

Delete an App Service plan.

delete(resource_group_name: str, name: str, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the App Service plan. Required.

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

delete_hybrid_connection

Delete a Hybrid Connection in use in an App Service plan.

delete_hybrid_connection(resource_group_name: str, name: str, namespace_name: str, relay_name: str, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the App Service plan. Required.
namespace_name Required	str Name of the Service Bus namespace. Required.
relay_name Required	str Name of the Service Bus relay. Required.

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

delete_vnet_route

Delete a Virtual Network route in an App Service plan.

delete_vnet_route(resource_group_name: str, name: str, vnet_name: str, route_name: str, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the App Service plan. Required.
vnet_name Required	str Name of the Virtual Network. Required.
route_name Required	str Name of the Virtual Network route. Required.

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Get an App Service plan.

get(resource_group_name: str, name: str, **kwargs: Any) -> AppServicePlan | None

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the App Service plan. Required.

Returns

Type	Description
AppServicePlan, None	AppServicePlan or None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_hybrid_connection

Retrieve a Hybrid Connection in use in an App Service plan.

get_hybrid_connection(resource_group_name: str, name: str, namespace_name: str, relay_name: str, **kwargs: Any) -> HybridConnection

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the App Service plan. Required.
namespace_name Required	str Name of the Service Bus namespace. Required.
relay_name Required	str Name of the Service Bus relay. Required.

Returns

Type	Description
HybridConnection	HybridConnection or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_hybrid_connection_plan_limit

Get the maximum number of Hybrid Connections allowed in an App Service plan.

get_hybrid_connection_plan_limit(resource_group_name: str, name: str, **kwargs: Any) -> HybridConnectionLimits

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the App Service plan. Required.

Returns

Type	Description
HybridConnectionLimits	HybridConnectionLimits or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_route_for_vnet

Get a Virtual Network route in an App Service plan.

get_route_for_vnet(resource_group_name: str, name: str, vnet_name: str, route_name: str, **kwargs: Any) -> List[VnetRoute] | None

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the App Service plan. Required.
vnet_name Required	str Name of the Virtual Network. Required.
route_name Required	str Name of the Virtual Network route. Required.

Returns

Type	Description
list[VnetRoute], None	list of VnetRoute or None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_server_farm_skus

Gets all selectable SKUs for a given App Service Plan.

get_server_farm_skus(resource_group_name: str, name: str, **kwargs: Any) -> MutableMapping[str, Any]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of App Service Plan. Required.

Returns

Type	Description
<xref:JSON>	JSON or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_vnet_from_server_farm

Get a Virtual Network associated with an App Service plan.

get_vnet_from_server_farm(resource_group_name: str, name: str, vnet_name: str, **kwargs: Any) -> VnetInfo | None

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the App Service plan. Required.
vnet_name Required	str Name of the Virtual Network. Required.

Returns

Type	Description
VnetInfo, None	VnetInfo or None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_vnet_gateway

Get a Virtual Network gateway.

get_vnet_gateway(resource_group_name: str, name: str, vnet_name: str, gateway_name: str, **kwargs: Any) -> VnetGateway

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the App Service plan. Required.
vnet_name Required	str Name of the Virtual Network. Required.
gateway_name Required	str Name of the gateway. Only the 'primary' gateway is supported. Required.

Returns

Type	Description
VnetGateway	VnetGateway or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list

Get all App Service plans for a subscription.

list(detailed: bool | None = None, **kwargs: Any) -> Iterable[AppServicePlan]

Parameters

Name	Description
detailed Required	bool Specify `<code>true</code>` to return all App Service plan properties. The default is `<code>false</code>`, which returns a subset of the properties. Retrieval of all properties may increase the API latency. Default value is None.

Returns

Type	Description
ItemPaged[AppServicePlan]	An iterator like instance of either AppServicePlan or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

Get all App Service plans in a resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[AppServicePlan]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.

Returns

Type	Description
ItemPaged[AppServicePlan]	An iterator like instance of either AppServicePlan or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_capabilities

List all capabilities of an App Service plan.

list_capabilities(resource_group_name: str, name: str, **kwargs: Any) -> List[Capability]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the App Service plan. Required.

Returns

Type	Description
list[Capability]	list of Capability or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_hybrid_connection_keys

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

list_hybrid_connection_keys(resource_group_name: str, name: str, namespace_name: str, relay_name: str, **kwargs: Any) -> HybridConnectionKey

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the App Service plan. Required.
namespace_name Required	str The name of the Service Bus namespace. Required.
relay_name Required	str The name of the Service Bus relay. Required.

Returns

Type	Description
HybridConnectionKey	HybridConnectionKey or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_hybrid_connections

Retrieve all Hybrid Connections in use in an App Service plan.

list_hybrid_connections(resource_group_name: str, name: str, **kwargs: Any) -> Iterable[HybridConnection]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the App Service plan. Required.

Returns

Type	Description
ItemPaged[HybridConnection]	An iterator like instance of either HybridConnection or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_metric_defintions

Get metrics that can be queried for an App Service plan, and their definitions.

list_metric_defintions(resource_group_name: str, name: str, **kwargs: Any) -> Iterable[ResourceMetricDefinition]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the App Service plan. Required.

Returns

Type	Description
ItemPaged[ResourceMetricDefinition]	An iterator like instance of either ResourceMetricDefinition or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_metrics

Get metrics for an App Service plan.

list_metrics(resource_group_name: str, name: str, details: bool | None = None, filter: str | None = None, **kwargs: Any) -> Iterable[ResourceMetric]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the App Service plan. Required.
details Required	bool Specify `<code>true</code>` to include instance details. The default is `<code>false</code>`. Default value is None.
filter Required	str Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[Hour\|Minute\|Day]'. Default value is None.

Returns

Type	Description
ItemPaged[ResourceMetric]	An iterator like instance of either ResourceMetric or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_routes_for_vnet

Get all routes that are associated with a Virtual Network in an App Service plan.

list_routes_for_vnet(resource_group_name: str, name: str, vnet_name: str, **kwargs: Any) -> List[VnetRoute]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the App Service plan. Required.
vnet_name Required	str Name of the Virtual Network. Required.

Returns

Type	Description
list[VnetRoute]	list of VnetRoute or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_usages

Gets server farm usage information.

list_usages(resource_group_name: str, name: str, filter: str | None = None, **kwargs: Any) -> Iterable[CsmUsageQuota]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of App Service Plan. Required.
filter Required	str Return 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.

Returns

Type	Description
ItemPaged[CsmUsageQuota]	An iterator like instance of either CsmUsageQuota or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_vnets

Get all Virtual Networks associated with an App Service plan.

list_vnets(resource_group_name: str, name: str, **kwargs: Any) -> List[VnetInfo]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the App Service plan. Required.

Returns

Type	Description
list[VnetInfo]	list of VnetInfo or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_web_apps

Get all apps associated with an App Service plan.

list_web_apps(resource_group_name: str, name: str, skip_token: str | None = None, filter: str | None = None, top: str | None = None, **kwargs: Any) -> Iterable[Site]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the App Service plan. Required.
skip_token Required	str 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 skipToken. Otherwise, the resulting list contains web apps from the start of the list. Default value is None.
filter Required	str Supported filter: $filter=state eq running. Returns only web apps that are currently running. Default value is None.
top Required	str List page size. If specified, results are paged. Default value is None.

Returns

Type	Description
ItemPaged[Site]	An iterator like instance of either Site or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_web_apps_by_hybrid_connection

Get all apps that use a Hybrid Connection in an App Service Plan.

list_web_apps_by_hybrid_connection(resource_group_name: str, name: str, namespace_name: str, relay_name: str, **kwargs: Any) -> Iterable[str]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the App Service plan. Required.
namespace_name Required	str Name of the Hybrid Connection namespace. Required.
relay_name Required	str Name of the Hybrid Connection relay. Required.

Returns

Type	Description
ItemPaged[str]	An iterator like instance of either str or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

reboot_worker

Reboot a worker machine in an App Service plan.

reboot_worker(resource_group_name: str, name: str, worker_name: str, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the App Service plan. Required.
worker_name Required	str Name of worker machine, which typically starts with RD. Required.

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

restart_web_apps

Restart all apps in an App Service plan.

restart_web_apps(resource_group_name: str, name: str, soft_restart: bool | None = None, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the App Service plan. Required.
soft_restart Required	bool Specify `<code>true</code>` to perform a soft restart, applies the configuration settings and restarts the apps if necessary. The default is `<code>false</code>`, which always restarts and reprovisions the apps. Default value is None.

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

update

Creates or updates an App Service Plan.

update(resource_group_name: str, name: str, app_service_plan: _models.AppServicePlanPatchResource, *, content_type: str = 'application/json', **kwargs: Any) -> _models.AppServicePlan

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the App Service plan. Required.
app_service_plan Required	AppServicePlanPatchResource or IO[bytes] Details of the App Service plan. Is either a AppServicePlanPatchResource type or a IO[bytes] type. Required.

Returns

Type	Description
AppServicePlan	AppServicePlan or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

update_vnet_gateway

Update a Virtual Network gateway.

update_vnet_gateway(resource_group_name: str, name: str, vnet_name: str, gateway_name: str, connection_envelope: _models.VnetGateway, *, content_type: str = 'application/json', **kwargs: Any) -> _models.VnetGateway

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the App Service plan. Required.
vnet_name Required	str Name of the Virtual Network. Required.
gateway_name Required	str Name of the gateway. Only the 'primary' gateway is supported. Required.
connection_envelope Required	VnetGateway or IO[bytes] Definition of the gateway. Is either a VnetGateway type or a IO[bytes] type. Required.

Returns

Type	Description
VnetGateway	VnetGateway or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

update_vnet_route

Create or update a Virtual Network route in an App Service plan.

update_vnet_route(resource_group_name: str, name: str, vnet_name: str, route_name: str, route: _models.VnetRoute, *, content_type: str = 'application/json', **kwargs: Any) -> _models.VnetRoute | None

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
name Required	str Name of the App Service plan. Required.
vnet_name Required	str Name of the Virtual Network. Required.
route_name Required	str Name of the Virtual Network route. Required.
route Required	VnetRoute or IO[bytes] Definition of the Virtual Network route. Is either a VnetRoute type or a IO[bytes] type. Required.

Returns

Type	Description
VnetRoute, None	VnetRoute or None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.web.v2018_02_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\web\\v2018_02_01\\models\\__init__.py'>

Share via

AppServicePlansOperations Class

Constructor

Methods

begin_create_or_update

Parameters

Returns

Exceptions

create_or_update_vnet_route

Parameters

Returns

Exceptions

delete

Parameters

Returns

Exceptions

delete_hybrid_connection

Parameters

Returns

Exceptions

delete_vnet_route

Parameters

Returns

Exceptions

get

Parameters

Returns

Exceptions

get_hybrid_connection

Parameters

Returns

Exceptions

get_hybrid_connection_plan_limit

Parameters

Returns

Exceptions

get_route_for_vnet

Parameters

Returns

Exceptions

get_server_farm_skus

Parameters

Returns

Exceptions

get_vnet_from_server_farm

Parameters

Returns

Exceptions

get_vnet_gateway

Parameters

Returns

Exceptions

list

Parameters

Returns

Exceptions

list_by_resource_group

Parameters

Returns

Exceptions

list_capabilities

Parameters

Returns

Exceptions

list_hybrid_connection_keys

Parameters

Returns

Exceptions

list_hybrid_connections

Parameters

Returns

Exceptions

list_metric_defintions

Parameters

Returns

Exceptions

list_metrics

Parameters

Returns

Exceptions