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

AppServiceEnvironmentsOperations 类

警告

请勿直接实例化此类。

相反,应通过以下方式访问以下操作:

WebSiteManagementClient

<xref:app_service_environments> 属性。

继承
builtins.object
AppServiceEnvironmentsOperations

构造函数

AppServiceEnvironmentsOperations(*args, **kwargs)

方法

begin_approve_or_reject_private_endpoint_connection

批准或拒绝专用终结点连接。

“批准或拒绝专用终结点连接”的说明。

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_delete_private_endpoint_connection

删除专用终结点连接。

删除专用终结点连接的说明。

begin_resume

恢复应用服务环境。

恢复应用服务环境的说明。

begin_suspend

暂停应用服务环境。

暂停应用服务环境的说明。

begin_upgrade

启动应用服务环境升级(如果可用)。

启动应用服务环境升级(如果可用)的说明。

delete_ase_custom_dns_suffix_configuration

删除应用服务环境的自定义 Dns 后缀配置。

删除应用服务环境的自定义 Dns 后缀配置。

get

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

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

get_ase_custom_dns_suffix_configuration

获取应用服务环境的自定义 Dns 后缀配置。

获取应用服务环境的自定义 Dns 后缀配置。

get_ase_v3_networking_configuration

获取应用服务环境的网络配置。

获取应用服务环境的网络配置的说明。

get_diagnostics_item

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

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

get_inbound_network_dependencies_endpoints

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

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

get_multi_role_pool

获取多角色池的属性。

获取多角色池的属性的说明。

get_outbound_network_dependencies_endpoints

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

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

get_private_endpoint_connection

获取专用终结点连接。

获取专用终结点连接的说明。

get_private_endpoint_connection_list

获取与托管环境关联的专用终结点的列表。

说明 获取与托管环境关联的专用终结点列表。

get_private_link_resources

获取专用链接资源。

获取专用链接资源的说明。

get_vip_info

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

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

get_worker_pool

获取辅助角色池的属性。

获取辅助角色池的属性的说明。

list

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

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

list_app_service_plans

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

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

list_by_resource_group

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

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

list_capacities

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

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

list_diagnostics

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

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

list_multi_role_metric_definitions

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

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

list_multi_role_pool_instance_metric_definitions

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

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

list_multi_role_pool_skus

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

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

list_multi_role_pools

获取所有多角色池。

获取所有多角色池的说明。

list_multi_role_usages

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

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

list_operations

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

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

list_usages

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

获取应用服务环境的全局使用情况指标的说明。

list_web_apps

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

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

list_web_worker_metric_definitions

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

获取应用服务环境辅助角色池的指标定义的说明。

list_web_worker_usages

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

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

list_worker_pool_instance_metric_definitions

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

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

list_worker_pool_skus

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

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

list_worker_pools

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

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

reboot

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

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

test_upgrade_available_notification

发送测试通知,告知此应用服务环境有升级可用。

发送测试通知,告知此应用服务环境有升级可用。

update

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

有关创建或更新应用服务环境的说明。

update_ase_custom_dns_suffix_configuration

更新应用服务环境的自定义 Dns 后缀配置。

更新应用服务环境的自定义 Dns 后缀配置。

update_ase_networking_configuration

更新应用服务环境的网络配置。

更新应用服务环境的网络配置的说明。

update_multi_role_pool

创建或更新多角色池。

有关创建或更新多角色池的说明。

update_worker_pool

创建或更新辅助角色池。

有关创建或更新辅助角色池的说明。

begin_approve_or_reject_private_endpoint_connection

批准或拒绝专用终结点连接。

“批准或拒绝专用终结点连接”的说明。

async begin_approve_or_reject_private_endpoint_connection(resource_group_name: str, name: str, private_endpoint_connection_name: str, private_endpoint_wrapper: _models.PrivateLinkConnectionApprovalRequestResource, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.RemotePrivateEndpointConnectionARMResource]

参数

resource_group_name
str
必需

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

name
str
必需

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

private_endpoint_connection_name
str
必需

必需。

private_endpoint_wrapper
PrivateLinkConnectionApprovalRequestResourceIO
必需

是 PrivateLinkConnectionApprovalRequestResource 类型或 IO 类型。 必需。

content_type
str

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

cls
callable

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

continuation_token
str

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

polling
boolAsyncPollingMethod

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

polling_interval
int

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

返回

AsyncLROPoller 的实例,返回 RemotePrivateEndpointConnectionARMResource 或 cls 的结果 (响应)

返回类型

例外

begin_change_vnet

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

有关将应用服务环境移动到其他 VNET 的说明。

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

参数

resource_group_name
str
必需

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

name
str
必需

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

vnet_info
VirtualNetworkProfileIO
必需

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

content_type
str

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

cls
callable

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

continuation_token
str

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

polling
boolAsyncPollingMethod

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

polling_interval
int

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

返回

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

返回类型

例外

begin_create_or_update

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

有关创建或更新应用服务环境的说明。

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

参数

resource_group_name
str
必需

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

name
str
必需

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

hosting_environment_envelope
AppServiceEnvironmentResourceIO
必需

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

content_type
str

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

cls
callable

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

continuation_token
str

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

polling
boolAsyncPollingMethod

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

polling_interval
int

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

返回

AsyncLROPoller 的实例,返回 AppServiceEnvironmentResource 或 cls 的结果 (响应)

返回类型

例外

begin_create_or_update_multi_role_pool

创建或更新多角色池。

有关创建或更新多角色池的说明。

async 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) -> AsyncLROPoller[_models.WorkerPoolResource]

参数

resource_group_name
str
必需

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

name
str
必需

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

multi_role_pool_envelope
WorkerPoolResourceIO
必需

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

content_type
str

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

cls
callable

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

continuation_token
str

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

polling
boolAsyncPollingMethod

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

polling_interval
int

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

返回

返回 WorkerPoolResource 或 cls (响应结果的 AsyncLROPoller 实例)

返回类型

例外

begin_create_or_update_worker_pool

创建或更新辅助角色池。

有关创建或更新辅助角色池的说明。

async 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) -> AsyncLROPoller[_models.WorkerPoolResource]

参数

resource_group_name
str
必需

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

name
str
必需

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

worker_pool_name
str
必需

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

worker_pool_envelope
WorkerPoolResourceIO
必需

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

content_type
str

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

cls
callable

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

continuation_token
str

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

polling
boolAsyncPollingMethod

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

polling_interval
int

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

返回

AsyncLROPoller 的实例,返回 WorkerPoolResource 或 cls 的结果 (响应)

返回类型

例外

begin_delete

删除应用服务环境。

删除应用服务环境的说明。

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

参数

resource_group_name
str
必需

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

name
str
必需

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

force_delete
bool
必需

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

cls
callable

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

continuation_token
str

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

polling
boolAsyncPollingMethod

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

polling_interval
int

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

返回

AsyncLROPoller 的实例,返回 None 或 cls 的结果 (响应)

返回类型

例外

begin_delete_private_endpoint_connection

删除专用终结点连接。

删除专用终结点连接的说明。

async begin_delete_private_endpoint_connection(resource_group_name: str, name: str, private_endpoint_connection_name: str, **kwargs: Any) -> AsyncLROPoller[MutableMapping[str, Any]]

参数

resource_group_name
str
必需

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

name
str
必需

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

private_endpoint_connection_name
str
必需

必需。

cls
callable

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

continuation_token
str

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

polling
boolAsyncPollingMethod

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

polling_interval
int

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

返回

AsyncLROPoller 的实例,返回 JSON 或 cl 的结果 (响应)

返回类型

AsyncLROPoller[<xref:JSON>]

例外

begin_resume

恢复应用服务环境。

恢复应用服务环境的说明。

async begin_resume(resource_group_name: str, name: str, **kwargs: Any) -> AsyncLROPoller[AsyncIterable[Site]]

参数

resource_group_name
str
必需

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

name
str
必需

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

cls
callable

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

continuation_token
str

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

polling
boolAsyncPollingMethod

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

polling_interval
int

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

返回

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

返回类型

例外

begin_suspend

暂停应用服务环境。

暂停应用服务环境的说明。

async begin_suspend(resource_group_name: str, name: str, **kwargs: Any) -> AsyncLROPoller[AsyncIterable[Site]]

参数

resource_group_name
str
必需

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

name
str
必需

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

cls
callable

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

continuation_token
str

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

polling
boolAsyncPollingMethod

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

polling_interval
int

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

返回

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

返回类型

例外

begin_upgrade

启动应用服务环境升级(如果可用)。

启动应用服务环境升级(如果可用)的说明。

async begin_upgrade(resource_group_name: str, name: str, **kwargs: Any) -> AsyncLROPoller[None]

参数

resource_group_name
str
必需

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

name
str
必需

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

cls
callable

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

continuation_token
str

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

polling
boolAsyncPollingMethod

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

polling_interval
int

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

返回

AsyncLROPoller 的实例,返回 None 或 cls 的结果 (响应)

返回类型

例外

delete_ase_custom_dns_suffix_configuration

删除应用服务环境的自定义 Dns 后缀配置。

删除应用服务环境的自定义 Dns 后缀配置。

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

参数

resource_group_name
str
必需

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

name
str
必需

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

cls
callable

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

返回

JSON 或 cls 的结果 (响应)

返回类型

<xref:JSON>

例外

get

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

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

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

参数

resource_group_name
str
必需

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

name
str
必需

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

cls
callable

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

返回

AppServiceEnvironmentResource 或 cls 的结果 (响应)

返回类型

例外

get_ase_custom_dns_suffix_configuration

获取应用服务环境的自定义 Dns 后缀配置。

获取应用服务环境的自定义 Dns 后缀配置。

async get_ase_custom_dns_suffix_configuration(resource_group_name: str, name: str, **kwargs: Any) -> CustomDnsSuffixConfiguration

参数

resource_group_name
str
必需

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

name
str
必需

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

cls
callable

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

返回

CustomDnsSuffixConfiguration 或 cls 的结果 (响应)

返回类型

例外

get_ase_v3_networking_configuration

获取应用服务环境的网络配置。

获取应用服务环境的网络配置的说明。

async get_ase_v3_networking_configuration(resource_group_name: str, name: str, **kwargs: Any) -> AseV3NetworkingConfiguration

参数

resource_group_name
str
必需

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

name
str
必需

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

cls
callable

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

返回

AseV3NetworkingConfiguration 或 cls 的结果 (响应)

返回类型

例外

get_diagnostics_item

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

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

async 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 (响应的结果)

返回类型

例外

get_inbound_network_dependencies_endpoints

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

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

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

参数

resource_group_name
str
必需

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

name
str
必需

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

cls
callable

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

返回

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

返回类型

例外

get_multi_role_pool

获取多角色池的属性。

获取多角色池的属性的说明。

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

参数

resource_group_name
str
必需

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

name
str
必需

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

cls
callable

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

返回

WorkerPoolResource 或 cls 的结果 (响应)

返回类型

例外

get_outbound_network_dependencies_endpoints

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

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

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

参数

resource_group_name
str
必需

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

name
str
必需

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

cls
callable

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

返回

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

返回类型

例外

get_private_endpoint_connection

获取专用终结点连接。

获取专用终结点连接的说明。

async get_private_endpoint_connection(resource_group_name: str, name: str, private_endpoint_connection_name: str, **kwargs: Any) -> RemotePrivateEndpointConnectionARMResource

参数

resource_group_name
str
必需

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

name
str
必需

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

private_endpoint_connection_name
str
必需

专用终结点连接的名称。 必需。

cls
callable

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

返回

RemotePrivateEndpointConnectionARMResource 或 cls (响应的结果)

返回类型

例外

get_private_endpoint_connection_list

获取与托管环境关联的专用终结点的列表。

说明 获取与托管环境关联的专用终结点列表。

get_private_endpoint_connection_list(resource_group_name: str, name: str, **kwargs: Any) -> AsyncIterable[RemotePrivateEndpointConnectionARMResource]

参数

resource_group_name
str
必需

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

name
str
必需

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

cls
callable

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

返回

迭代器,例如 RemotePrivateEndpointConnectionARMResource 的实例或 cls (响应的结果)

返回类型

例外

获取专用链接资源。

获取专用链接资源的说明。

async get_private_link_resources(resource_group_name: str, name: str, **kwargs: Any) -> PrivateLinkResourcesWrapper

参数

resource_group_name
str
必需

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

name
str
必需

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

cls
callable

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

返回

PrivateLinkResourcesWrapper 或 cls 的结果 (响应)

返回类型

例外

get_vip_info

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

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

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

参数

resource_group_name
str
必需

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

name
str
必需

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

cls
callable

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

返回

AddressResponse 或 cls 的结果 (响应)

返回类型

例外

get_worker_pool

获取辅助角色池的属性。

获取辅助角色池的属性的说明。

async 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 的结果 (响应)

返回类型

例外

list

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

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

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

参数

cls
callable

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

返回

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

返回类型

例外

list_app_service_plans

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

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

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

参数

resource_group_name
str
必需

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

name
str
必需

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

cls
callable

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

返回

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

返回类型

例外

list_by_resource_group

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

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

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

参数

resource_group_name
str
必需

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

cls
callable

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

返回

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

返回类型

例外

list_capacities

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

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

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

参数

resource_group_name
str
必需

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

name
str
必需

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

cls
callable

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

返回

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

返回类型

例外

list_diagnostics

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

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

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

参数

resource_group_name
str
必需

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

name
str
必需

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

cls
callable

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

返回

HostingEnvironmentDiagnostics 的列表或 cls (响应)

返回类型

例外

list_multi_role_metric_definitions

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

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

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

参数

resource_group_name
str
必需

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

name
str
必需

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

cls
callable

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

返回

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

返回类型

例外

list_multi_role_pool_instance_metric_definitions

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

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

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

参数

resource_group_name
str
必需

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

name
str
必需

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

instance
str
必需

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

cls
callable

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

返回

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

返回类型

例外

list_multi_role_pool_skus

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

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

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

参数

resource_group_name
str
必需

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

name
str
必需

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

cls
callable

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

返回

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

返回类型

例外

list_multi_role_pools

获取所有多角色池。

获取所有多角色池的说明。

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

参数

resource_group_name
str
必需

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

name
str
必需

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

cls
callable

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

返回

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

返回类型

例外

list_multi_role_usages

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

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

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

参数

resource_group_name
str
必需

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

name
str
必需

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

cls
callable

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

返回

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

返回类型

例外

list_operations

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

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

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

参数

resource_group_name
str
必需

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

name
str
必需

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

cls
callable

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

返回

操作列表或 cls (响应)

返回类型

例外

list_usages

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

获取应用服务环境的全局使用情况指标的说明。

list_usages(resource_group_name: str, name: str, filter: str | None = None, **kwargs: Any) -> AsyncIterable[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 的结果 (响应)

返回类型

例外

list_web_apps

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

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

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

参数

resource_group_name
str
必需

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

name
str
必需

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

properties_to_include
str
必需

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

cls
callable

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

返回

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

返回类型

例外

list_web_worker_metric_definitions

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

获取应用服务环境辅助角色池的指标定义的说明。

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

参数

resource_group_name
str
必需

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

name
str
必需

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

worker_pool_name
str
必需

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

cls
callable

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

返回

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

返回类型

例外

list_web_worker_usages

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

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

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

参数

resource_group_name
str
必需

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

name
str
必需

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

worker_pool_name
str
必需

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

cls
callable

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

返回

迭代器,例如 Usage 的实例或 cls (响应)

返回类型

例外

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) -> AsyncIterable[ResourceMetricDefinition]

参数

resource_group_name
str
必需

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

name
str
必需

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

worker_pool_name
str
必需

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

instance
str
必需

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

cls
callable

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

返回

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

返回类型

例外

list_worker_pool_skus

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

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

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

参数

resource_group_name
str
必需

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

name
str
必需

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

worker_pool_name
str
必需

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

cls
callable

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

返回

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

返回类型

例外

list_worker_pools

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

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

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

参数

resource_group_name
str
必需

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

name
str
必需

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

cls
callable

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

返回

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

返回类型

例外

reboot

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

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

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

参数

resource_group_name
str
必需

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

name
str
必需

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

cls
callable

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

返回

无或 cls 的结果 (响应)

返回类型

例外

test_upgrade_available_notification

发送测试通知,告知此应用服务环境有升级可用。

发送测试通知,告知此应用服务环境有升级可用。

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

参数

resource_group_name
str
必需

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

name
str
必需

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

cls
callable

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

返回

无或 cls 的结果 (响应)

返回类型

例外

update

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

有关创建或更新应用服务环境的说明。

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

参数

resource_group_name
str
必需

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

name
str
必需

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

hosting_environment_envelope
AppServiceEnvironmentPatchResourceIO
必需

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

content_type
str

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

cls
callable

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

返回

AppServiceEnvironmentResource 或 cls 的结果 (响应)

返回类型

例外

update_ase_custom_dns_suffix_configuration

更新应用服务环境的自定义 Dns 后缀配置。

更新应用服务环境的自定义 Dns 后缀配置。

async update_ase_custom_dns_suffix_configuration(resource_group_name: str, name: str, custom_dns_suffix_configuration: _models.CustomDnsSuffixConfiguration, *, content_type: str = 'application/json', **kwargs: Any) -> _models.CustomDnsSuffixConfiguration

参数

resource_group_name
str
必需

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

name
str
必需

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

custom_dns_suffix_configuration
CustomDnsSuffixConfigurationIO
必需

是 CustomDnsSuffixConfiguration 类型或 IO 类型。 必需。

content_type
str

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

cls
callable

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

返回

CustomDnsSuffixConfiguration 或 cls 的结果 (响应)

返回类型

例外

update_ase_networking_configuration

更新应用服务环境的网络配置。

更新应用服务环境的网络配置的说明。

async update_ase_networking_configuration(resource_group_name: str, name: str, ase_networking_configuration: _models.AseV3NetworkingConfiguration, *, content_type: str = 'application/json', **kwargs: Any) -> _models.AseV3NetworkingConfiguration

参数

resource_group_name
str
必需

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

name
str
必需

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

ase_networking_configuration
AseV3NetworkingConfigurationIO
必需

是 AseV3NetworkingConfiguration 类型或 IO 类型。 必需。

content_type
str

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

cls
callable

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

返回

AseV3NetworkingConfiguration 或 cls 的结果 (响应)

返回类型

例外

update_multi_role_pool

创建或更新多角色池。

有关创建或更新多角色池的说明。

async 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

参数

resource_group_name
str
必需

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

name
str
必需

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

multi_role_pool_envelope
WorkerPoolResourceIO
必需

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

content_type
str

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

cls
callable

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

返回

WorkerPoolResource 或 cls 的结果 (响应)

返回类型

例外

update_worker_pool

创建或更新辅助角色池。

有关创建或更新辅助角色池的说明。

async 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

参数

resource_group_name
str
必需

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

name
str
必需

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

worker_pool_name
str
必需

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

worker_pool_envelope
WorkerPoolResourceIO
必需

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

content_type
str

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

cls
callable

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

返回

WorkerPoolResource 或 cls 的结果 (响应)

返回类型

例外

属性

models

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