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

AppServiceEnvironmentsOperations 类

参考

警告

请勿直接实例化此类。

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

WebSiteManagementClient的

<xref:app_service_environments> 属性。

继承: builtins.object

AppServiceEnvironmentsOperations

构造函数

AppServiceEnvironmentsOperations(*args, **kwargs)

方法

begin_change_vnet	将应用服务环境移到其他 VNET。将应用服务环境移到其他 VNET。
begin_create_or_update	创建或更新应用服务环境。创建或更新应用服务环境。
begin_create_or_update_multi_role_pool	创建或更新多角色池。创建或更新多角色池。
begin_create_or_update_worker_pool	创建或更新辅助角色池。创建或更新辅助角色池。
begin_delete	删除应用服务环境。删除应用服务环境。
begin_resume	恢复应用服务环境。恢复应用服务环境。
begin_suspend	暂停应用服务环境。暂停应用服务环境。
get	获取应用服务环境的属性。获取应用服务环境的属性。
get_diagnostics_item	获取应用服务环境的诊断项。获取应用服务环境的诊断项。
get_inbound_network_dependencies_endpoints	获取应用服务环境的所有入站依赖项的网络终结点。获取应用服务环境的所有入站依赖项的网络终结点。
get_multi_role_pool	获取多角色池的属性。获取多角色池的属性。
get_outbound_network_dependencies_endpoints	获取应用服务环境的所有出站依赖项的网络终结点。获取应用服务环境的所有出站依赖项的网络终结点。
get_worker_pool	获取辅助角色池的属性。获取辅助角色池的属性。
list	获取订阅的所有App 服务环境。获取订阅的所有App 服务环境。
list_app_service_plans	获取应用服务环境中的所有App 服务计划。获取应用服务环境中的所有App 服务计划。
list_by_resource_group	获取资源组中的所有App 服务环境。获取资源组中的所有App 服务环境。
list_capacities	获取应用服务环境的已用、可用和总辅助角色容量。获取应用服务环境的已用、可用和总辅助角色容量。
list_diagnostics	获取应用服务环境的诊断信息。获取应用服务环境的诊断信息。
list_metric_definitions	获取应用服务环境的全局指标定义。获取应用服务环境的全局指标定义。
list_metrics	获取应用服务环境的全局指标。获取应用服务环境的全局指标。
list_multi_role_metric_definitions	获取应用服务环境的多角色池的指标定义。获取应用服务环境的多角色池的指标定义。
list_multi_role_metrics	获取应用服务环境的多角色池的指标。获取应用服务环境的多角色池的指标。
list_multi_role_pool_instance_metric_definitions	获取应用服务环境多角色池的特定实例的指标定义。获取应用服务环境多角色池的特定实例的指标定义。
list_multi_role_pool_instance_metrics	获取应用服务环境的多角色池的特定实例的指标。获取应用服务环境的多角色池的特定实例的指标。
list_multi_role_pool_skus	获取用于缩放多角色池的可用 SKU。获取用于缩放多角色池的可用 SKU。
list_multi_role_pools	获取所有多角色池。获取所有多角色池。
list_multi_role_usages	获取应用服务环境的多角色池的使用情况指标。获取应用服务环境的多角色池的使用情况指标。
list_operations	列出应用服务环境上当前正在运行的所有操作。列出应用服务环境上当前正在运行的所有操作。
list_usages	获取应用服务环境的全局使用情况指标。获取应用服务环境的全局使用情况指标。
list_vips	获取分配给应用服务环境的 IP 地址。获取分配给应用服务环境的 IP 地址。
list_web_apps	获取应用服务环境中的所有应用。获取应用服务环境中的所有应用。
list_web_worker_metric_definitions	获取应用服务环境的工作器池的指标定义。获取应用服务环境的工作器池的指标定义。
list_web_worker_metrics	获取 AppServiceEnvironment (应用服务环境) 辅助角色池的指标。获取 AppServiceEnvironment (应用服务环境) 辅助角色池的指标。
list_web_worker_usages	获取应用服务环境辅助角色池的使用情况指标。获取应用服务环境辅助角色池的使用情况指标。
list_worker_pool_instance_metric_definitions	获取应用服务环境的工作器池的特定实例的指标定义。获取应用服务环境的工作器池的特定实例的指标定义。
list_worker_pool_instance_metrics	获取应用服务环境辅助角色池的特定实例的指标。获取应用服务环境辅助角色池的特定实例的指标。
list_worker_pool_skus	获取用于缩放辅助角色池的可用 SKU。获取用于缩放辅助角色池的可用 SKU。
list_worker_pools	获取应用服务环境的所有辅助角色池。获取应用服务环境的所有辅助角色池。
reboot	重新启动应用服务环境中的所有计算机。重新启动应用服务环境中的所有计算机。
update	创建或更新应用服务环境。创建或更新应用服务环境。
update_multi_role_pool	创建或更新多角色池。创建或更新多角色池。
update_worker_pool	创建或更新辅助角色池。创建或更新辅助角色池。

begin_change_vnet

将应用服务环境移到其他 VNET。

begin_change_vnet(resource_group_name: str, name: str, vnet_info: _models.VirtualNetworkProfile, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[Iterable['_models.Site']]

参数

resource_group_name: str

必需

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

name: str

必需

应用服务环境的名称。必需。

vnet_info: VirtualNetworkProfile 或 IO

必需

新虚拟网络的详细信息。是 VirtualNetworkProfile 类型还是 IO 类型。必需。

content_type: str

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

cls: callable

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

continuation_token: str

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

polling: bool 或 PollingMethod

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

polling_interval: int

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

LROPoller 的实例，返回迭代器（如 WebAppCollection 的实例）或 cls 的结果 (响应)

返回类型

LROPoller[ItemPaged[Site]]

例外

HttpResponseError

begin_create_or_update

创建或更新应用服务环境。

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

参数

resource_group_name: str

必需

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

name: str

必需

应用服务环境的名称。必需。

hosting_environment_envelope: AppServiceEnvironmentResource 或 IO

必需

应用服务环境的配置详细信息。是 AppServiceEnvironmentResource 类型或 IO 类型。必需。

content_type: str

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

cls: callable

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

continuation_token: str

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

polling: bool 或 PollingMethod

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

polling_interval: int

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

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

返回类型

LROPoller[AppServiceEnvironmentResource]

例外

HttpResponseError

begin_create_or_update_multi_role_pool

创建或更新多角色池。

begin_create_or_update_multi_role_pool(resource_group_name: str, name: str, multi_role_pool_envelope: _models.WorkerPoolResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.WorkerPoolResource]

参数

resource_group_name: str

必需

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

name: str

必需

应用服务环境的名称。必需。

multi_role_pool_envelope: WorkerPoolResource 或 IO

必需

多角色池的属性。是 WorkerPoolResource 类型还是 IO 类型。必需。

content_type: str

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

cls: callable

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

continuation_token: str

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

polling: bool 或 PollingMethod

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

polling_interval: int

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

LROPoller 的实例，返回 WorkerPoolResource 或 cl 的结果 (响应)

返回类型

LROPoller[WorkerPoolResource]

例外

HttpResponseError

begin_create_or_update_worker_pool

创建或更新辅助角色池。

begin_create_or_update_worker_pool(resource_group_name: str, name: str, worker_pool_name: str, worker_pool_envelope: _models.WorkerPoolResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.WorkerPoolResource]

参数

resource_group_name: str

必需

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

name: str

必需

应用服务环境的名称。必需。

worker_pool_name: str

必需

辅助角色池的名称。必需。

worker_pool_envelope: WorkerPoolResource 或 IO

必需

辅助角色池的属性。是 WorkerPoolResource 类型还是 IO 类型。必需。

content_type: str

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

cls: callable

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

continuation_token: str

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

polling: bool 或 PollingMethod

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

polling_interval: int

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

LROPoller 的实例，返回 WorkerPoolResource 或 cl 的结果 (响应)

返回类型

LROPoller[WorkerPoolResource]

例外

HttpResponseError

begin_delete

删除应用服务环境。

begin_delete(resource_group_name: str, name: str, force_delete: bool | None = None, **kwargs: Any) -> LROPoller[None]

参数

resource_group_name: str

必需

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

name: str

必需

应用服务环境的名称。必需。

force_delete: bool

必需

指定 <code>true</code> 以强制删除，即使应用服务环境包含资源也是如此。默认为 <code>false</code>。默认值为 None。

cls: callable

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

continuation_token: str

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

polling: bool 或 PollingMethod

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

polling_interval: int

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

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

返回类型

LROPoller[None]

例外

HttpResponseError

begin_resume

恢复应用服务环境。

begin_resume(resource_group_name: str, name: str, **kwargs: Any) -> LROPoller[Iterable[Site]]

参数

resource_group_name: str

必需

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

name: str

必需

应用服务环境的名称。必需。

cls: callable

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

continuation_token: str

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

polling: bool 或 PollingMethod

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

polling_interval: int

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

LROPoller 的实例，返回迭代器（如 WebAppCollection 的实例）或 cls 的结果 (响应)

返回类型

LROPoller[ItemPaged[Site]]

例外

HttpResponseError

begin_suspend

暂停应用服务环境。

begin_suspend(resource_group_name: str, name: str, **kwargs: Any) -> LROPoller[Iterable[Site]]

参数

resource_group_name: str

必需

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

name: str

必需

应用服务环境的名称。必需。

cls: callable

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

continuation_token: str

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

polling: bool 或 PollingMethod

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

polling_interval: int

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

LROPoller 的实例，返回迭代器（如 WebAppCollection 的实例）或 cls 的结果 (响应)

返回类型

LROPoller[ItemPaged[Site]]

例外

HttpResponseError

get

获取应用服务环境的属性。

get(resource_group_name: str, name: str, **kwargs: Any) -> AppServiceEnvironmentResource

参数

resource_group_name: str

必需

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

name: str

必需

应用服务环境的名称。必需。

cls: callable

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

AppServiceEnvironmentResource 或 cls 的结果 (响应)

返回类型

AppServiceEnvironmentResource

例外

HttpResponseError

get_diagnostics_item

获取应用服务环境的诊断项。

get_diagnostics_item(resource_group_name: str, name: str, diagnostics_name: str, **kwargs: Any) -> HostingEnvironmentDiagnostics

参数

resource_group_name: str

必需

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

name: str

必需

应用服务环境的名称。必需。

diagnostics_name: str

必需

诊断项的名称。必需。

cls: callable

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

HostingEnvironmentDiagnostics 或 cls 的结果 (响应)

返回类型

HostingEnvironmentDiagnostics

例外

HttpResponseError

get_inbound_network_dependencies_endpoints

获取应用服务环境的所有入站依赖项的网络终结点。

get_inbound_network_dependencies_endpoints(resource_group_name: str, name: str, **kwargs: Any) -> Iterable[InboundEnvironmentEndpoint]

参数

resource_group_name: str

必需

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

name: str

必需

应用服务环境的名称。必需。

cls: callable

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

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

返回类型

ItemPaged[InboundEnvironmentEndpoint]

例外

HttpResponseError

get_multi_role_pool

获取多角色池的属性。

get_multi_role_pool(resource_group_name: str, name: str, **kwargs: Any) -> WorkerPoolResource

参数

resource_group_name: str

必需

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

name: str

必需

应用服务环境的名称。必需。

cls: callable

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

WorkerPoolResource 或 cls 的结果 (响应)

返回类型

WorkerPoolResource

例外

HttpResponseError

get_outbound_network_dependencies_endpoints

获取应用服务环境的所有出站依赖项的网络终结点。

get_outbound_network_dependencies_endpoints(resource_group_name: str, name: str, **kwargs: Any) -> Iterable[OutboundEnvironmentEndpoint]

参数

resource_group_name: str

必需

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

name: str

必需

应用服务环境的名称。必需。

cls: callable

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

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

返回类型

ItemPaged[OutboundEnvironmentEndpoint]

例外

HttpResponseError

get_worker_pool

获取辅助角色池的属性。

get_worker_pool(resource_group_name: str, name: str, worker_pool_name: str, **kwargs: Any) -> WorkerPoolResource

参数

resource_group_name: str

必需

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

name: str

必需

应用服务环境的名称。必需。

worker_pool_name: str

必需

辅助角色池的名称。必需。

cls: callable

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

WorkerPoolResource 或 cls 的结果 (响应)

返回类型

WorkerPoolResource

例外

HttpResponseError

list

获取订阅的所有App 服务环境。

list(**kwargs: Any) -> Iterable[AppServiceEnvironmentResource]

参数

cls: callable

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

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

返回类型

ItemPaged[AppServiceEnvironmentResource]

例外

HttpResponseError

list_app_service_plans

获取应用服务环境中的所有App 服务计划。

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

参数

resource_group_name: str

必需

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

name: str

必需

应用服务环境的名称。必需。

cls: callable

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

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

返回类型

ItemPaged[AppServicePlan]

例外

HttpResponseError

list_by_resource_group

获取资源组中的所有App 服务环境。

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

参数

resource_group_name: str

必需

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

cls: callable

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

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

返回类型

ItemPaged[AppServiceEnvironmentResource]

例外

HttpResponseError

list_capacities

获取应用服务环境的已用、可用和总辅助角色容量。

list_capacities(resource_group_name: str, name: str, **kwargs: Any) -> Iterable[StampCapacity]

参数

resource_group_name: str

必需

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

name: str

必需

应用服务环境的名称。必需。

cls: callable

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

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

返回类型

ItemPaged[StampCapacity]

例外

HttpResponseError

list_diagnostics

获取应用服务环境的诊断信息。

list_diagnostics(resource_group_name: str, name: str, **kwargs: Any) -> List[HostingEnvironmentDiagnostics]

参数

resource_group_name: str

必需

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

name: str

必需

应用服务环境的名称。必需。

cls: callable

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

HostingEnvironmentDiagnostics 列表或 cls (响应)

返回类型

list[HostingEnvironmentDiagnostics]

例外

HttpResponseError

list_metric_definitions

获取应用服务环境的全局指标定义。

list_metric_definitions(resource_group_name: str, name: str, **kwargs: Any) -> MetricDefinition

参数

resource_group_name: str

必需

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

name: str

必需

应用服务环境的名称。必需。

cls: callable

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

MetricDefinition 或 cls 的结果 (响应)

返回类型

MetricDefinition

例外

HttpResponseError

list_metrics

获取应用服务环境的全局指标。

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

参数

resource_group_name: str

必需

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

name: str

必需

应用服务环境的名称。必需。

details: bool

必需

指定 <code>true</code> 以包含实例详细信息。默认为 <code>false</code>。默认值为 None。

filter: str

必需

仅返回筛选器中指定的使用情况/指标。筛选器符合 odata 语法。示例：$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|分钟|Day]'。默认值为 None。

cls: callable

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

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

返回类型

ItemPaged[ResourceMetric]

例外

HttpResponseError

list_multi_role_metric_definitions

获取应用服务环境的多角色池的指标定义。

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

参数

resource_group_name: str

必需

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

name: str

必需

应用服务环境的名称。必需。

cls: callable

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

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

返回类型

ItemPaged[ResourceMetricDefinition]

例外

HttpResponseError

list_multi_role_metrics

获取应用服务环境的多角色池的指标。

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

参数

resource_group_name: str

必需

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

name: str

必需

应用服务环境的名称。必需。

start_time: str

必需

指标查询的开始时间。默认值为 None。

end_time: str

必需

指标查询的结束时间。默认值为 None。

time_grain: str

必需

指标查询的时间粒度。默认值为 None。

details: bool

必需

指定 <code>true</code> 以包含实例详细信息。默认为 <code>false</code>。默认值为 None。

filter: str

必需

cls: callable

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

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

返回类型

ItemPaged[ResourceMetric]

例外

HttpResponseError

list_multi_role_pool_instance_metric_definitions

获取应用服务环境多角色池的特定实例的指标定义。

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

参数

resource_group_name: str

必需

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

name: str

必需

应用服务环境的名称。必需。

instance: str

必需

多角色池中实例的名称。必需。

cls: callable

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

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

返回类型

ItemPaged[ResourceMetricDefinition]

例外

HttpResponseError

list_multi_role_pool_instance_metrics

获取应用服务环境的多角色池的特定实例的指标。

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

参数

resource_group_name: str

必需

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

name: str

必需

应用服务环境的名称。必需。

instance: str

必需

多角色池中实例的名称。必需。

details: bool

必需

指定 <code>true</code> 以包含实例详细信息。默认为 <code>false</code>。默认值为 None。

cls: callable

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

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

返回类型

ItemPaged[ResourceMetric]

例外

HttpResponseError

list_multi_role_pool_skus

获取用于缩放多角色池的可用 SKU。

list_multi_role_pool_skus(resource_group_name: str, name: str, **kwargs: Any) -> Iterable[SkuInfo]

参数

resource_group_name: str

必需

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

name: str

必需

应用服务环境的名称。必需。

cls: callable

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

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

返回类型

ItemPaged[SkuInfo]

例外

HttpResponseError

list_multi_role_pools

获取所有多角色池。

list_multi_role_pools(resource_group_name: str, name: str, **kwargs: Any) -> Iterable[WorkerPoolResource]

参数

resource_group_name: str

必需

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

name: str

必需

应用服务环境的名称。必需。

cls: callable

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

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

返回类型

ItemPaged[WorkerPoolResource]

例外

HttpResponseError

list_multi_role_usages

获取应用服务环境的多角色池的使用情况指标。

list_multi_role_usages(resource_group_name: str, name: str, **kwargs: Any) -> Iterable[Usage]

参数

resource_group_name: str

必需

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

name: str

必需

应用服务环境的名称。必需。

cls: callable

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

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

返回类型

ItemPaged[Usage]

例外

HttpResponseError

list_operations

列出应用服务环境上当前正在运行的所有操作。

list_operations(resource_group_name: str, name: str, **kwargs: Any) -> List[Operation]

参数

resource_group_name: str

必需

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

name: str

必需

应用服务环境的名称。必需。

cls: callable

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

操作列表或 cls (响应)

返回类型

list[Operation]

例外

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

必需

应用服务环境的名称。必需。

filter: str

必需

仅返回筛选器中指定的使用情况/指标。筛选器符合 odata 语法。示例：$filter= (name.value eq “Metric1”或 name.value eq 'Metric2') and startTime eq 2014-01-01T00：00：00Z 和 endTime eq 2014-12-31T23：59：59Z 和 timeGrain eq duration'[Hour|分钟 |Day]'。默认值为 None。

cls: callable

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

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

返回类型

ItemPaged[CsmUsageQuota]

例外

HttpResponseError

list_vips

获取分配给应用服务环境的 IP 地址。

list_vips(resource_group_name: str, name: str, **kwargs: Any) -> AddressResponse

参数

resource_group_name: str

必需

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

name: str

必需

应用服务环境的名称。必需。

cls: callable

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

AddressResponse 或 cls 的结果 (响应)

返回类型

AddressResponse

例外

HttpResponseError

list_web_apps

获取应用服务环境中的所有应用。

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

参数

resource_group_name: str

必需

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

name: str

必需

应用服务环境的名称。必需。

properties_to_include: str

必需

要包含的应用属性列表的逗号分隔。默认值为 None。

cls: callable

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

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

返回类型

ItemPaged[Site]

例外

HttpResponseError

list_web_worker_metric_definitions

获取应用服务环境的工作器池的指标定义。

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

参数

resource_group_name: str

必需

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

name: str

必需

应用服务环境的名称。必需。

worker_pool_name: str

必需

辅助角色池的名称。必需。

cls: callable

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

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

返回类型

ItemPaged[ResourceMetricDefinition]

例外

HttpResponseError

list_web_worker_metrics

获取 AppServiceEnvironment (应用服务环境) 辅助角色池的指标。

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

参数

resource_group_name: str

必需

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

name: str

必需

应用服务环境的名称。必需。

worker_pool_name: str

必需

辅助角色池的名称。必需。

details: bool

必需

指定 <code>true</code> 以包含实例详细信息。默认为 <code>false</code>。默认值为 None。

filter: str

必需

cls: callable

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

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

返回类型

ItemPaged[ResourceMetric]

例外

HttpResponseError

list_web_worker_usages

获取应用服务环境辅助角色池的使用情况指标。

list_web_worker_usages(resource_group_name: str, name: str, worker_pool_name: str, **kwargs: Any) -> Iterable[Usage]

参数

resource_group_name: str

必需

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

name: str

必需

应用服务环境的名称。必需。

worker_pool_name: str

必需

辅助角色池的名称。必需。

cls: callable

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

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

返回类型

ItemPaged[Usage]

例外

HttpResponseError

list_worker_pool_instance_metric_definitions

获取应用服务环境的工作器池的特定实例的指标定义。

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

参数

resource_group_name: str

必需

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

name: str

必需

应用服务环境的名称。必需。

worker_pool_name: str

必需

辅助角色池的名称。必需。

instance: str

必需

辅助角色池中实例的名称。必需。

cls: callable

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

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

返回类型

ItemPaged[ResourceMetricDefinition]

例外

HttpResponseError

list_worker_pool_instance_metrics

获取应用服务环境辅助角色池的特定实例的指标。

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

参数

resource_group_name: str

必需

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

name: str

必需

应用服务环境的名称。必需。

worker_pool_name: str

必需

辅助角色池的名称。必需。

instance: str

必需

辅助角色池中实例的名称。必需。

details: bool

必需

指定 <code>true</code> 以包含实例详细信息。默认为 <code>false</code>。默认值为 None。

filter: str

必需

cls: callable

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

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

返回类型

ItemPaged[ResourceMetric]

例外

HttpResponseError

list_worker_pool_skus

获取用于缩放辅助角色池的可用 SKU。

list_worker_pool_skus(resource_group_name: str, name: str, worker_pool_name: str, **kwargs: Any) -> Iterable[SkuInfo]

参数

resource_group_name: str

必需

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

name: str

必需

应用服务环境的名称。必需。

worker_pool_name: str

必需

辅助角色池的名称。必需。

cls: callable

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

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

返回类型

ItemPaged[SkuInfo]

例外

HttpResponseError

list_worker_pools

获取应用服务环境的所有辅助角色池。

list_worker_pools(resource_group_name: str, name: str, **kwargs: Any) -> Iterable[WorkerPoolResource]

参数

resource_group_name: str

必需

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

name: str

必需

应用服务环境的名称。必需。

cls: callable

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

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

返回类型

ItemPaged[WorkerPoolResource]

例外

HttpResponseError

reboot

重新启动应用服务环境中的所有计算机。

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

参数

resource_group_name: str

必需

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

name: str

必需

应用服务环境的名称。必需。

cls: callable

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

无响应或 cls 的结果 (响应)

返回类型

None

例外

HttpResponseError

update

创建或更新应用服务环境。

update(resource_group_name: str, name: str, hosting_environment_envelope: _models.AppServiceEnvironmentPatchResource, *, content_type: str = 'application/json', **kwargs: Any) -> _models.AppServiceEnvironmentResource | None

参数

resource_group_name: str

必需

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

name: str

必需

应用服务环境的名称。必需。

hosting_environment_envelope: AppServiceEnvironmentPatchResource 或 IO

必需

应用服务环境的配置详细信息。是 AppServiceEnvironmentPatchResource 类型或 IO 类型。必需。

content_type: str

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

cls: callable

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

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

返回类型

AppServiceEnvironmentResource,

None

例外

HttpResponseError

update_multi_role_pool

创建或更新多角色池。

update_multi_role_pool(resource_group_name: str, name: str, multi_role_pool_envelope: _models.WorkerPoolResource, *, content_type: str = 'application/json', **kwargs: Any) -> _models.WorkerPoolResource | None

参数

resource_group_name: str

必需

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

name: str

必需

应用服务环境的名称。必需。

multi_role_pool_envelope: WorkerPoolResource 或 IO

必需

多角色池的属性。是 WorkerPoolResource 类型还是 IO 类型。必需。

content_type: str

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

cls: callable

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

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

返回类型

WorkerPoolResource,

None

例外

HttpResponseError

update_worker_pool

创建或更新辅助角色池。

update_worker_pool(resource_group_name: str, name: str, worker_pool_name: str, worker_pool_envelope: _models.WorkerPoolResource, *, content_type: str = 'application/json', **kwargs: Any) -> _models.WorkerPoolResource | None

参数

resource_group_name: str

必需

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

name: str

必需

应用服务环境的名称。必需。

worker_pool_name: str

必需

辅助角色池的名称。必需。

worker_pool_envelope: WorkerPoolResource 或 IO

必需

辅助角色池的属性。是 WorkerPoolResource 类型还是 IO 类型。必需。

content_type: str

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

cls: callable

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

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

返回类型

WorkerPoolResource,

None

例外

HttpResponseError

属性

models

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