你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

AppServicePlansOperations 类

参考

警告

请勿直接实例化此类。

相反，应通过以下方式访问以下操作：

WebSiteManagementClient's

<xref:app_service_plans> 属性。

继承: builtins.object

AppServicePlansOperations

构造函数

AppServicePlansOperations(*args, **kwargs)

方法

begin_create_or_update	创建或更新App 服务计划。创建或更新App 服务计划。
create_or_update_vnet_route	在App 服务计划中创建或更新虚拟网络路由。在App 服务计划中创建或更新虚拟网络路由。
delete	删除App 服务计划。删除App 服务计划。
delete_hybrid_connection	删除App 服务计划中使用的混合连接。删除App 服务计划中使用的混合连接。
delete_vnet_route	删除App 服务计划中虚拟网络路由。删除App 服务计划中虚拟网络路由。
get	获取App 服务计划。获取App 服务计划。
get_hybrid_connection	检索App 服务计划中使用的混合连接。检索App 服务计划中使用的混合连接。
get_hybrid_connection_plan_limit	获取App 服务计划中允许的最大混合连接数。获取App 服务计划中允许的最大混合连接数。
get_route_for_vnet	获取App 服务计划中虚拟网络路线。获取App 服务计划中虚拟网络路线。
get_server_farm_skus	获取给定App 服务计划的所有可选 SKU。获取给定App 服务计划的所有可选 SKU。
get_vnet_from_server_farm	获取与App 服务计划关联的虚拟网络。获取与App 服务计划关联的虚拟网络。
get_vnet_gateway	获取虚拟网络网关。获取虚拟网络网关。
list	获取订阅的所有App 服务计划。获取订阅的所有App 服务计划。
list_by_resource_group	获取资源组中的所有App 服务计划。获取资源组中的所有App 服务计划。
list_capabilities	列出App 服务计划的所有功能。列出App 服务计划的所有功能。
list_hybrid_connection_keys	获取混合连接的发送密钥名称和值。获取混合连接的发送密钥名称和值。
list_hybrid_connections	检索App 服务计划中使用的所有混合连接。检索App 服务计划中使用的所有混合连接。
list_routes_for_vnet	获取与App 服务计划中虚拟网络关联的所有路由。获取与App 服务计划中虚拟网络关联的所有路由。
list_usages	获取服务器场使用情况信息。获取服务器场使用情况信息。
list_vnets	获取与App 服务计划关联的所有虚拟网络。获取与App 服务计划关联的所有虚拟网络。
list_web_apps	获取与App 服务计划关联的所有应用。获取与App 服务计划关联的所有应用。
list_web_apps_by_hybrid_connection	获取App 服务计划中使用混合连接的所有应用。获取App 服务计划中使用混合连接的所有应用。
reboot_worker	重新启动App 服务计划中的工作计算机。重新启动App 服务计划中的工作计算机。
restart_web_apps	重启App 服务计划中的所有应用。重启App 服务计划中的所有应用。
update	创建或更新App 服务计划。创建或更新App 服务计划。
update_vnet_gateway	更新虚拟网络网关。更新虚拟网络网关。
update_vnet_route	在App 服务计划中创建或更新虚拟网络路由。在App 服务计划中创建或更新虚拟网络路由。

begin_create_or_update

创建或更新App 服务计划。

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]

参数

resource_group_name: str

必需

资源所属的资源组的名称。必需。

name: str

必需

应用服务计划的名称。必需。

app_service_plan: AppServicePlan 或 IO

必需

App 服务计划的详细信息。是 AppServicePlan 类型或 IO 类型。必需。

content_type: str

Body 参数内容类型。已知值为：“application/json”。默认值为 None。

cls: callable

将传递直接响应的自定义类型或函数

continuation_token: str

用于从保存状态重启轮询的继续标记。

polling: bool 或 PollingMethod

默认情况下，轮询方法将为 ARMPolling。将此操作传入 False 以不进行轮询，或为个人轮询策略传入你自己的初始化轮询对象。

polling_interval: int

如果没有 Retry-After 标头，则 LRO 操作的两次轮询之间的默认等待时间。

返回 AppServicePlan 或 cls 的结果的 LROPoller 实例， (响应)

返回类型

LROPoller[AppServicePlan]

例外

HttpResponseError

create_or_update_vnet_route

在App 服务计划中创建或更新虚拟网络路由。

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

参数

resource_group_name: str

必需

资源所属的资源组的名称。必需。

name: str

必需

应用服务计划的名称。必需。

vnet_name: str

必需

虚拟网络的名称。必需。

route_name: str

必需

虚拟网络路由的名称。必需。

route: VnetRoute 或 IO

必需

虚拟网络路由的定义。是 VnetRoute 类型或 IO 类型。必需。

content_type: str

Body 参数内容类型。已知值为：“application/json”。默认值为 None。

cls: callable

将传递直接响应的自定义类型或函数

VnetRoute 或 None 或 cls 的结果 (响应)

返回类型

VnetRoute,

None

例外

HttpResponseError

delete

删除App 服务计划。

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

参数

resource_group_name: str

必需

资源所属的资源组的名称。必需。

name: str

必需

应用服务计划的名称。必需。

cls: callable

将传递直接响应的自定义类型或函数

无或 cls 的结果 (响应)

返回类型

None

例外

HttpResponseError

delete_hybrid_connection

删除App 服务计划中使用的混合连接。

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

参数

resource_group_name: str

必需

资源所属的资源组的名称。必需。

name: str

必需

应用服务计划的名称。必需。

namespace_name: str

必需

服务总线命名空间的名称。必需。

relay_name: str

必需

服务总线中继的名称。必需。

cls: callable

将传递直接响应的自定义类型或函数

无或 cls 的结果 (响应)

返回类型

None

例外

HttpResponseError

delete_vnet_route

删除App 服务计划中虚拟网络路由。

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

参数

resource_group_name: str

必需

资源所属的资源组的名称。必需。

name: str

必需

应用服务计划的名称。必需。

vnet_name: str

必需

虚拟网络的名称。必需。

route_name: str

必需

虚拟网络路由的名称。必需。

cls: callable

将传递直接响应的自定义类型或函数

无或 cls 的结果 (响应)

返回类型

None

例外

HttpResponseError

get

获取App 服务计划。

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

参数

resource_group_name: str

必需

资源所属的资源组的名称。必需。

name: str

必需

应用服务计划的名称。必需。

cls: callable

将传递直接响应的自定义类型或函数

AppServicePlan 或 None 或 cls 的结果 (响应)

返回类型

AppServicePlan,

None

例外

HttpResponseError

get_hybrid_connection

检索App 服务计划中使用的混合连接。

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

参数

resource_group_name: str

必需

资源所属的资源组的名称。必需。

name: str

必需

应用服务计划的名称。必需。

namespace_name: str

必需

服务总线命名空间的名称。必需。

relay_name: str

必需

服务总线中继的名称。必需。

cls: callable

将传递直接响应的自定义类型或函数

HybridConnection 或 cls 的结果 (响应)

返回类型

HybridConnection

例外

HttpResponseError

get_hybrid_connection_plan_limit

获取App 服务计划中允许的最大混合连接数。

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

参数

resource_group_name: str

必需

资源所属的资源组的名称。必需。

name: str

必需

应用服务计划的名称。必需。

cls: callable

将传递直接响应的自定义类型或函数

HybridConnectionLimits 或 cls 的结果 (响应)

返回类型

HybridConnectionLimits

例外

HttpResponseError

get_route_for_vnet

获取App 服务计划中虚拟网络路线。

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

参数

resource_group_name: str

必需

资源所属的资源组的名称。必需。

name: str

必需

应用服务计划的名称。必需。

vnet_name: str

必需

虚拟网络的名称。必需。

route_name: str

必需

虚拟网络路由的名称。必需。

cls: callable

将传递直接响应的自定义类型或函数

VnetRoute 或 None 列表或 cls 的结果 (响应)

返回类型

list[VnetRoute],

None

例外

HttpResponseError

get_server_farm_skus

获取给定App 服务计划的所有可选 SKU。

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

参数

resource_group_name: str

必需

资源所属的资源组的名称。必需。

name: str

必需

App 服务计划的名称。必需。

cls: callable

将传递直接响应的自定义类型或函数

json 或 cls 的结果 (响应)

返回类型

<xref:JSON>

例外

HttpResponseError

get_vnet_from_server_farm

获取与App 服务计划关联的虚拟网络。

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

参数

resource_group_name: str

必需

资源所属的资源组的名称。必需。

name: str

必需

应用服务计划的名称。必需。

vnet_name: str

必需

虚拟网络的名称。必需。

cls: callable

将传递直接响应的自定义类型或函数

VnetInfo 或 None 或 cls 的结果 (响应)

返回类型

VnetInfo,

None

例外

HttpResponseError

get_vnet_gateway

获取虚拟网络网关。

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

参数

resource_group_name: str

必需

资源所属的资源组的名称。必需。

name: str

必需

应用服务计划的名称。必需。

vnet_name: str

必需

虚拟网络的名称。必需。

gateway_name: str

必需

网关的名称。仅支持“主”网关。必需。

cls: callable

将传递直接响应的自定义类型或函数

VnetGateway 或 cls 的结果 (响应)

返回类型

VnetGateway

例外

HttpResponseError

list

获取订阅的所有App 服务计划。

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

参数

detailed: bool

必需

指定 <code>true</code> 以返回所有App 服务计划属性。默认值为 <code>false</code>，它返回属性的子集。

检索所有属性可能会增加 API 延迟。默认值为 None。

cls: callable

将传递直接响应的自定义类型或函数

迭代器，例如 AppServicePlan 的实例或 cls (响应)

返回类型

ItemPaged[AppServicePlan]

例外

HttpResponseError

list_by_resource_group

获取资源组中的所有App 服务计划。

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

参数

resource_group_name: str

必需

资源所属的资源组的名称。必需。

cls: callable

将传递直接响应的自定义类型或函数

迭代器，例如 AppServicePlan 的实例或 cls (响应)

返回类型

ItemPaged[AppServicePlan]

例外

HttpResponseError

list_capabilities

列出App 服务计划的所有功能。

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

参数

resource_group_name: str

必需

资源所属的资源组的名称。必需。

name: str

必需

应用服务计划的名称。必需。

cls: callable

将传递直接响应的自定义类型或函数

功能列表或 cls (响应)

返回类型

list[Capability]

例外

HttpResponseError

list_hybrid_connection_keys

获取混合连接的发送密钥名称和值。

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

参数

resource_group_name: str

必需

资源所属的资源组的名称。必需。

name: str

必需

应用服务计划的名称。必需。

namespace_name: str

必需

服务总线命名空间的名称。必需。

relay_name: str

必需

服务总线中继的名称。必需。

cls: callable

将传递直接响应的自定义类型或函数

HybridConnectionKey 或 cls 的结果 (响应)

返回类型

HybridConnectionKey

例外

HttpResponseError

list_hybrid_connections

检索App 服务计划中使用的所有混合连接。

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

参数

resource_group_name: str

必需

资源所属的资源组的名称。必需。

name: str

必需

应用服务计划的名称。必需。

cls: callable

将传递直接响应的自定义类型或函数

迭代器，例如 HybridConnection 的实例或 cls 的结果 (响应)

返回类型

ItemPaged[HybridConnection]

例外

HttpResponseError

list_routes_for_vnet

获取与App 服务计划中虚拟网络关联的所有路由。

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

参数

resource_group_name: str

必需

资源所属的资源组的名称。必需。

name: str

必需

应用服务计划的名称。必需。

vnet_name: str

必需

虚拟网络的名称。必需。

cls: callable

将传递直接响应的自定义类型或函数

VnetRoute 列表或 cls 的结果 (响应)

返回类型

list[VnetRoute]

例外

HttpResponseError

list_usages

获取服务器场使用情况信息。

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

参数

resource_group_name: str

必需

资源所属的资源组的名称。必需。

name: str

必需

App 服务计划的名称。必需。

filter: str

必需

仅返回筛选器中指定的使用情况/指标。筛选器符合 odata 语法。示例：$filter= (name.value eq 'Metric1' 或 name.value eq 'Metric2') 。默认值为 None。

cls: callable

将传递直接响应的自定义类型或函数

迭代器，如 CsmUsageQuota 的实例或 cls 的结果 (响应)

返回类型

ItemPaged[CsmUsageQuota]

例外

HttpResponseError

list_vnets

获取与App 服务计划关联的所有虚拟网络。

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

参数

resource_group_name: str

必需

资源所属的资源组的名称。必需。

name: str

必需

应用服务计划的名称。必需。

cls: callable

将传递直接响应的自定义类型或函数

VnetInfo 列表或 cls (响应)

返回类型

list[VnetInfo]

例外

HttpResponseError

list_web_apps

获取与App 服务计划关联的所有应用。

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]

参数

resource_group_name: str

必需

资源所属的资源组的名称。必需。

name: str

必需

应用服务计划的名称。必需。

skip_token: str

必需

跳到与应用服务计划关联的 Web 应用列表中的 Web 应用。如果指定，则生成的列表将包含从 (开始的 Web 应用，包括 skipToken) 。否则，生成的列表包含列表开头的 Web 应用。默认值为 None。

filter: str

必需

支持的筛选器：$filter=正在运行的状态 eq。仅返回当前正在运行的 Web 应用。默认值为 None。

top: str

必需

列表页面大小。如果指定，则对结果进行分页。默认值为 None。

cls: callable

将传递直接响应的自定义类型或函数

迭代器，例如站点的实例或 cls 的结果 (响应)

返回类型

ItemPaged[Site]

例外

HttpResponseError

list_web_apps_by_hybrid_connection

获取App 服务计划中使用混合连接的所有应用。

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

参数

resource_group_name: str

必需

资源所属的资源组的名称。必需。

name: str

必需

应用服务计划的名称。必需。

namespace_name: str

必需

混合连接命名空间的名称。必需。

relay_name: str

必需

混合连接中继的名称。必需。

cls: callable

将传递直接响应的自定义类型或函数

迭代器，如 str 实例或 cls 的结果 (响应)

返回类型

ItemPaged[str]

例外

HttpResponseError

reboot_worker

重新启动App 服务计划中的工作计算机。

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

参数

resource_group_name: str

必需

资源所属的资源组的名称。必需。

name: str

必需

应用服务计划的名称。必需。

worker_name: str

必需

辅助角色计算机的名称，通常以 RD 开头。必需。

cls: callable

将传递直接响应的自定义类型或函数

无或 cls 的结果 (响应)

返回类型

None

例外

HttpResponseError

restart_web_apps

重启App 服务计划中的所有应用。

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

参数

resource_group_name: str

必需

资源所属的资源组的名称。必需。

name: str

必需

应用服务计划的名称。必需。

soft_restart: bool

必需

指定 <code>true</code> 以执行软重启，应用配置设置，并在必要时重启应用。默认值为 <code>false</code>，它始终重启并重新预配应用。默认值为 None。

cls: callable

将传递直接响应的自定义类型或函数

无或 cls 的结果 (响应)

返回类型

None

例外

HttpResponseError

update

创建或更新App 服务计划。

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

参数

resource_group_name: str

必需

资源所属的资源组的名称。必需。

name: str

必需

应用服务计划的名称。必需。

app_service_plan: AppServicePlanPatchResource 或 IO

必需

App 服务计划的详细信息。是 AppServicePlanPatchResource 类型或 IO 类型。必需。

content_type: str

Body 参数内容类型。已知值为：“application/json”。默认值为 None。

cls: callable

将传递直接响应的自定义类型或函数

AppServicePlan 或 cls 的结果 (响应)

返回类型

AppServicePlan

例外

HttpResponseError

update_vnet_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

参数

resource_group_name: str

必需

资源所属的资源组的名称。必需。

name: str

必需

应用服务计划的名称。必需。

vnet_name: str

必需

虚拟网络的名称。必需。

gateway_name: str

必需

网关的名称。仅支持“主”网关。必需。

connection_envelope: VnetGateway 或 IO

必需

网关的定义。是 VnetGateway 类型或 IO 类型。必需。

content_type: str

Body 参数内容类型。已知值为：“application/json”。默认值为 None。

cls: callable

将传递直接响应的自定义类型或函数

VnetGateway 或 cls 的结果 (响应)

返回类型

VnetGateway

例外

HttpResponseError

update_vnet_route

在App 服务计划中创建或更新虚拟网络路由。

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

参数

resource_group_name: str

必需

资源所属的资源组的名称。必需。

name: str

必需

应用服务计划的名称。必需。

vnet_name: str

必需

虚拟网络的名称。必需。

route_name: str

必需

虚拟网络路由的名称。必需。

route: VnetRoute 或 IO

必需

虚拟网络路由的定义。是 VnetRoute 类型或 IO 类型。必需。

content_type: str

Body 参数内容类型。已知值为：“application/json”。默认值为 None。

cls: callable

将传递直接响应的自定义类型或函数

VnetRoute 或 None 或 cls 的结果 (响应)

返回类型

VnetRoute,

None

例外

HttpResponseError

属性

models

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