共用方式為


AppServiceEnvironmentsOperations 類別

警告

請勿直接具現化此類別。

您應該改為透過 存取下列作業

WebSiteManagementClient's

<xref:app_service_environments> 屬性。

繼承
builtins.object
AppServiceEnvironmentsOperations

建構函式

AppServiceEnvironmentsOperations(*args, **kwargs)

方法

begin_approve_or_reject_private_endpoint_connection

核准或拒絕私人端點連線。

核准或拒絕私人端點連線的描述。

begin_change_vnet

將App Service 環境移至不同的 VNET。

將App Service 環境移至不同 VNET 的描述。

begin_create_or_update

建立或更新App Service 環境。

建立或更新App Service 環境的描述。

begin_create_or_update_multi_role_pool

建立或更新多角色集區。

建立或更新多角色集區的描述。

begin_create_or_update_worker_pool

建立或更新背景工作集區。

建立或更新背景工作集區的描述。

begin_delete

刪除App Service 環境。

刪除App Service 環境的描述。

begin_delete_private_endpoint_connection

刪除私人端點連線。

刪除私人端點連線的描述。

begin_resume

繼續App Service 環境。

繼續App Service 環境的描述。

begin_suspend

暫停App Service 環境。

暫停App Service 環境的描述。

begin_upgrade

如果有的話,請起始App Service 環境升級。

如果有的話,起始App Service 環境升級的描述。

delete_ase_custom_dns_suffix_configuration

刪除App Service 環境的自訂 Dns 尾碼組態。

刪除App Service 環境的自訂 Dns 尾碼組態。

get

取得App Service 環境的屬性。

取得App Service 環境屬性的描述。

get_ase_custom_dns_suffix_configuration

取得App Service 環境的自訂 Dns 尾碼組態。

取得App Service 環境的自訂 Dns 尾碼組態。

get_ase_v3_networking_configuration

取得App Service 環境的網路設定。

取得App Service 環境的網路設定描述。

get_diagnostics_item

取得App Service 環境的診斷專案。

取得App Service 環境診斷專案的描述。

get_inbound_network_dependencies_endpoints

取得App Service 環境所有輸入相依性的網路端點。

取得App Service 環境所有輸入相依性之網路端點的描述。

get_multi_role_pool

取得多重角色集區的屬性。

取得多重角色集區屬性的描述。

get_outbound_network_dependencies_endpoints

取得App Service 環境所有輸出相依性的網路端點。

取得App Service 環境所有輸出相依性之網路端點的描述。

get_private_endpoint_connection

取得私人端點連線。

取得私人端點連線的描述。

get_private_endpoint_connection_list

取得與裝載環境相關聯的私人端點清單。

描述 取得與裝載環境相關聯的私人端點清單。

get_private_link_resources

取得私人連結資源。

取得私人連結資源的描述。

get_vip_info

取得指派給App Service 環境的 IP 位址。

指派給App Service 環境之取得 IP 位址的描述。

get_worker_pool

取得背景工作集區的屬性。

取得背景工作集區屬性的描述。

list

取得訂用帳戶的所有App Service環境。

取得訂用帳戶的所有App Service環境的描述。

list_app_service_plans

取得App Service 環境中的所有App Service方案。

取得App Service 環境中所有App Service計畫的描述。

list_by_resource_group

取得資源群組中的所有App Service環境。

取得資源群組中所有App Service環境的描述。

list_capacities

取得App Service 環境的已使用、可用和總背景工作角色容量。

描述 取得App Service 環境的已使用、可用和總背景工作角色容量。

list_diagnostics

取得App Service 環境的診斷資訊。

取得App Service 環境診斷資訊的描述。

list_multi_role_metric_definitions

取得App Service 環境多重角色集區的計量定義。

取得App Service 環境多重角色集區的計量定義描述。

list_multi_role_pool_instance_metric_definitions

取得App Service 環境之多重角色集區特定實例的計量定義。

針對App Service 環境之多重角色集區的特定實例取得計量定義的描述。

list_multi_role_pool_skus

取得可調整多角色集區的可用 SKU。

取得適用于調整多重角色集區之可用 SKU 的描述。

list_multi_role_pools

取得所有多重角色集區。

取得所有多重角色集區的描述。

list_multi_role_usages

取得App Service 環境多重角色集區的使用量計量。

取得App Service 環境多重角色集區使用計量的描述。

list_operations

列出目前在App Service 環境上執行的所有作業。

列出目前在App Service 環境上執行的所有作業的描述。

list_usages

取得App Service 環境的全域使用計量。

取得App Service 環境全域使用計量的描述。

list_web_apps

取得App Service 環境中的所有應用程式。

取得App Service 環境中所有應用程式的描述。

list_web_worker_metric_definitions

取得App Service 環境背景工作集區的計量定義。

取得App Service 環境背景工作集區之計量定義的描述。

list_web_worker_usages

取得App Service 環境背景工作集區的使用計量。

取得App Service 環境背景工作集區使用計量的描述。

list_worker_pool_instance_metric_definitions

取得App Service 環境之背景工作集區特定實例的計量定義。

針對App Service 環境之背景工作集區的特定實例取得計量定義的描述。

list_worker_pool_skus

取得調整背景工作集區的可用 SKU。

用於調整背景工作集區可用 SKU 的描述。

list_worker_pools

取得App Service 環境的所有背景工作集區。

取得App Service 環境之所有背景工作集區的描述。

reboot

重新開機App Service 環境中的所有機器。

App Service 環境中重新開機所有機器的描述。

test_upgrade_available_notification

傳送測試通知,指出升級可供此App Service 環境使用。

傳送測試通知,指出升級可供此App Service 環境使用。

update

建立或更新App Service 環境。

建立或更新App Service 環境的描述。

update_ase_custom_dns_suffix_configuration

更新App Service 環境的自訂 Dns 尾碼組態。

更新App Service 環境的自訂 Dns 尾碼組態。

update_ase_networking_configuration

更新App Service 環境的網路設定。

更新App Service 環境的網路設定描述。

update_multi_role_pool

建立或更新多角色集區。

建立或更新多角色集區的描述。

update_worker_pool

建立或更新背景工作集區。

建立或更新背景工作集區的描述。

begin_approve_or_reject_private_endpoint_connection

核准或拒絕私人端點連線。

核准或拒絕私人端點連線的描述。

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) -> LROPoller[_models.RemotePrivateEndpointConnectionARMResource]

參數

resource_group_name
str
必要

資源所屬資源群組的名稱。 必要。

name
str
必要

App Service 環境的名稱。 必要。

private_endpoint_connection_name
str
必要

必要。

private_endpoint_wrapper
PrivateLinkConnectionApprovalRequestResourceIO
必要

這是 PrivateLinkConnectionApprovalRequestResource 類型或 IO 類型。 必要。

content_type
str

本文參數內容類型。 已知值為:'application/json'。 預設值為 [無]。

cls
callable

將傳遞直接回應的自訂類型或函式

continuation_token
str

從已儲存狀態重新開機輪詢器的接續權杖。

polling
boolPollingMethod

根據預設,您的輪詢方法會是 ARMPolling。 傳入 False 表示此作業無法輪詢,或傳入您自己的已初始化輪詢物件,以取得個人輪詢策略。

polling_interval
int

如果沒有 Retry-After 標頭,則兩次輪詢 LRO 作業之間的預設等候時間。

傳回

會傳回 RemotePrivateEndpointConnectionARMResource 或 cls (回應結果的 LROPoller 實例)

傳回類型

例外狀況

begin_change_vnet

將App Service 環境移至不同的 VNET。

將App Service 環境移至不同 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
必要

App Service 環境的名稱。 必要。

vnet_info
VirtualNetworkProfileIO
必要

新虛擬網路的詳細資料。 這是 VirtualNetworkProfile 類型或 IO 類型。 必要。

content_type
str

本文參數內容類型。 已知值為:'application/json'。 預設值為 [無]。

cls
callable

將傳遞直接回應的自訂類型或函式

continuation_token
str

從已儲存狀態重新開機輪詢器的接續權杖。

polling
boolPollingMethod

根據預設,您的輪詢方法會是 ARMPolling。 傳入 False 表示此作業無法輪詢,或傳入您自己的已初始化輪詢物件,以取得個人輪詢策略。

polling_interval
int

如果沒有 Retry-After 標頭,則兩次輪詢 LRO 作業之間的預設等候時間。

傳回

LROPoller 的實例,會傳回反覆運算器,例如 WebAppCollection 的實例或 cls (回應的結果)

傳回類型

例外狀況

begin_create_or_update

建立或更新App Service 環境。

建立或更新App Service 環境的描述。

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
必要

App Service 環境的名稱。 必要。

hosting_environment_envelope
AppServiceEnvironmentResourceIO
必要

App Service 環境的組態詳細資料。 這是 AppServiceEnvironmentResource 類型或 IO 類型。 必要。

content_type
str

本文參數內容類型。 已知值為:'application/json'。 預設值為 [無]。

cls
callable

將傳遞直接回應的自訂類型或函式

continuation_token
str

從已儲存狀態重新開機輪詢器的接續權杖。

polling
boolPollingMethod

根據預設,您的輪詢方法會是 ARMPolling。 傳入 False 表示此作業無法輪詢,或傳入您自己的已初始化輪詢物件,以取得個人輪詢策略。

polling_interval
int

如果沒有 Retry-After 標頭,則兩次輪詢 LRO 作業之間的預設等候時間。

傳回

傳回 AppServiceEnvironmentResource 或 cls (回應結果的 LROPoller 實例)

傳回類型

例外狀況

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
必要

App Service 環境的名稱。 必要。

multi_role_pool_envelope
WorkerPoolResourceIO
必要

多重角色集區的屬性。 這是 WorkerPoolResource 類型或 IO 類型。 必要。

content_type
str

本文參數內容類型。 已知值為:'application/json'。 預設值為 [無]。

cls
callable

將傳遞直接回應的自訂類型或函式

continuation_token
str

從已儲存狀態重新開機輪詢器的接續權杖。

polling
boolPollingMethod

根據預設,您的輪詢方法會是 ARMPolling。 傳入 False 表示此作業無法輪詢,或傳入您自己的已初始化輪詢物件,以取得個人輪詢策略。

polling_interval
int

如果沒有 Retry-After 標頭,則兩次輪詢 LRO 作業之間的預設等候時間。

傳回

LROPoller 的實例,會傳回 WorkerPoolResource 或 cls (回應的結果)

傳回類型

例外狀況

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
必要

App Service 環境的名稱。 必要。

worker_pool_name
str
必要

背景工作集區的名稱。 必要。

worker_pool_envelope
WorkerPoolResourceIO
必要

背景工作集區的屬性。 這是 WorkerPoolResource 類型或 IO 類型。 必要。

content_type
str

本文參數內容類型。 已知值為:'application/json'。 預設值為 [無]。

cls
callable

將傳遞直接回應的自訂類型或函式

continuation_token
str

從已儲存狀態重新開機輪詢器的接續權杖。

polling
boolPollingMethod

根據預設,您的輪詢方法會是 ARMPolling。 傳入 False 表示此作業無法輪詢,或傳入您自己的已初始化輪詢物件,以取得個人輪詢策略。

polling_interval
int

如果沒有 Retry-After 標頭,則兩次輪詢 LRO 作業之間的預設等候時間。

傳回

LROPoller 的實例,會傳回 WorkerPoolResource 或 cls 的結果 (回應)

傳回類型

例外狀況

begin_delete

刪除App Service 環境。

刪除App Service 環境的描述。

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

參數

resource_group_name
str
必要

資源所屬資源群組的名稱。 必要。

name
str
必要

App Service 環境的名稱。 必要。

force_delete
bool
必要

指定 <code>true</code> 以強制刪除,即使App Service 環境包含資源也一樣。 預設值為 <code>false</code>。 預設值為 [無]。

cls
callable

將傳遞直接回應的自訂類型或函式

continuation_token
str

從已儲存狀態重新開機輪詢器的接續權杖。

polling
boolPollingMethod

根據預設,您的輪詢方法會是 ARMPolling。 針對此作業傳入 False,以不輪詢,或傳入您自己的初始化輪詢物件,以取得個人輪詢策略。

polling_interval
int

如果沒有 Retry-After 標頭,則為 LRO 作業的兩個輪詢之間的預設等候時間。

傳回

LROPoller 的實例,會傳回 None 或 cls (回應的結果)

傳回類型

例外狀況

begin_delete_private_endpoint_connection

刪除私人端點連線。

刪除私人端點連線的描述。

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

參數

resource_group_name
str
必要

資源所屬資源群組的名稱。 必要。

name
str
必要

App Service 環境的名稱。 必要。

private_endpoint_connection_name
str
必要

必要。

cls
callable

將傳遞直接回應的自訂類型或函式

continuation_token
str

從已儲存狀態重新開機輪詢器的接續權杖。

polling
boolPollingMethod

根據預設,您的輪詢方法會是 ARMPolling。 針對此作業傳入 False,以不輪詢,或傳入您自己的初始化輪詢物件,以取得個人輪詢策略。

polling_interval
int

如果沒有 Retry-After 標頭,則為 LRO 作業的兩個輪詢之間的預設等候時間。

傳回

LROPoller 的實例,會傳回 cls (回應的結果)

傳回類型

LROPoller[<xref:JSON>]

例外狀況

begin_resume

繼續App Service 環境。

繼續App Service 環境的描述。

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

參數

resource_group_name
str
必要

資源所屬資源群組的名稱。 必要。

name
str
必要

App Service 環境的名稱。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

continuation_token
str

從已儲存狀態重新開機輪詢器的接續權杖。

polling
boolPollingMethod

根據預設,您的輪詢方法會是 ARMPolling。 針對此作業傳入 False,以不輪詢,或傳入您自己的初始化輪詢物件,以取得個人輪詢策略。

polling_interval
int

如果沒有 Retry-After 標頭,則為 LRO 作業的兩個輪詢之間的預設等候時間。

傳回

LROPoller 的實例,傳回反覆運算器,例如 WebAppCollection 實例或 cls 的結果 (回應)

傳回類型

例外狀況

begin_suspend

暫停App Service 環境。

暫停App Service 環境的描述。

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

參數

resource_group_name
str
必要

資源所屬資源群組的名稱。 必要。

name
str
必要

App Service 環境的名稱。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

continuation_token
str

從已儲存狀態重新開機輪詢器的接續權杖。

polling
boolPollingMethod

根據預設,您的輪詢方法會是 ARMPolling。 針對此作業傳入 False,以不輪詢,或傳入您自己的初始化輪詢物件,以取得個人輪詢策略。

polling_interval
int

如果沒有 Retry-After 標頭,則為 LRO 作業的兩個輪詢之間的預設等候時間。

傳回

LROPoller 的實例,傳回反覆運算器,例如 WebAppCollection 實例或 cls 的結果 (回應)

傳回類型

例外狀況

begin_upgrade

如果有的話,請起始App Service 環境升級。

如果有的話,起始App Service 環境升級的描述。

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

參數

resource_group_name
str
必要

資源所屬資源群組的名稱。 必要。

name
str
必要

App Service 環境的名稱。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

continuation_token
str

從已儲存狀態重新開機輪詢器的接續權杖。

polling
boolPollingMethod

根據預設,您的輪詢方法會是 ARMPolling。 針對此作業傳入 False,以不輪詢,或傳入您自己的初始化輪詢物件,以取得個人輪詢策略。

polling_interval
int

如果沒有 Retry-After 標頭,則為 LRO 作業的兩個輪詢之間的預設等候時間。

傳回

LROPoller 的實例,會傳回 None 或 cls (回應的結果)

傳回類型

例外狀況

delete_ase_custom_dns_suffix_configuration

刪除App Service 環境的自訂 Dns 尾碼組態。

刪除App Service 環境的自訂 Dns 尾碼組態。

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

參數

resource_group_name
str
必要

資源所屬資源群組的名稱。 必要。

name
str
必要

App Service 環境的名稱。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

JSON 或 cls 的結果 (回應)

傳回類型

<xref:JSON>

例外狀況

get

取得App Service 環境的屬性。

取得App Service 環境屬性的描述。

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

參數

resource_group_name
str
必要

資源所屬資源群組的名稱。 必要。

name
str
必要

App Service 環境的名稱。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

AppServiceEnvironmentResource 或 cls (回應的結果)

傳回類型

例外狀況

get_ase_custom_dns_suffix_configuration

取得App Service 環境的自訂 Dns 尾碼組態。

取得App Service 環境的自訂 Dns 尾碼組態。

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

參數

resource_group_name
str
必要

資源所屬資源群組的名稱。 必要。

name
str
必要

App Service 環境的名稱。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

CustomDnsSuffixConfiguration 或 cls (回應的結果)

傳回類型

例外狀況

get_ase_v3_networking_configuration

取得App Service 環境的網路設定。

取得App Service 環境的網路設定描述。

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

參數

resource_group_name
str
必要

資源所屬資源群組的名稱。 必要。

name
str
必要

App Service 環境的名稱。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

AseV3NetworkingConfiguration 或 cls 的結果 (回應)

傳回類型

例外狀況

get_diagnostics_item

取得App Service 環境的診斷專案。

取得App Service 環境診斷專案的描述。

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

參數

resource_group_name
str
必要

資源所屬資源群組的名稱。 必要。

name
str
必要

App Service 環境的名稱。 必要。

diagnostics_name
str
必要

診斷專案的名稱。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

HostingEnvironmentDiagnostics 或 cls 的結果 (回應)

傳回類型

例外狀況

get_inbound_network_dependencies_endpoints

取得App Service 環境所有輸入相依性的網路端點。

取得App Service 環境所有輸入相依性之網路端點的描述。

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

參數

resource_group_name
str
必要

資源所屬資源群組的名稱。 必要。

name
str
必要

App Service 環境的名稱。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

反覆運算器,例如 InboundEnvironmentEndpoint 的實例或 cls 的結果 (回應)

傳回類型

例外狀況

get_multi_role_pool

取得多重角色集區的屬性。

取得多重角色集區屬性的描述。

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

參數

resource_group_name
str
必要

資源所屬資源群組的名稱。 必要。

name
str
必要

App Service 環境的名稱。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

WorkerPoolResource 或 cls 的結果 (回應)

傳回類型

例外狀況

get_outbound_network_dependencies_endpoints

取得App Service 環境所有輸出相依性的網路端點。

取得App Service 環境所有輸出相依性之網路端點的描述。

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

參數

resource_group_name
str
必要

資源所屬資源群組的名稱。 必要。

name
str
必要

App Service 環境的名稱。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

像是 OutboundEnvironmentEndpoint 實例或 cls (回應結果的反覆運算器)

傳回類型

例外狀況

get_private_endpoint_connection

取得私人端點連線。

取得私人端點連線的描述。

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

參數

resource_group_name
str
必要

資源所屬資源群組的名稱。 必要。

name
str
必要

App Service 環境的名稱。 必要。

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) -> Iterable[RemotePrivateEndpointConnectionARMResource]

參數

resource_group_name
str
必要

資源所屬資源群組的名稱。 必要。

name
str
必要

App Service 環境的名稱。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

Iterator,例如 RemotePrivateEndpointConnectionARMResource 的實例,或 cls 的結果 (回應)

傳回類型

例外狀況

取得私人連結資源。

取得私人連結資源的描述。

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

參數

resource_group_name
str
必要

資源所屬資源群組的名稱。 必要。

name
str
必要

App Service 環境的名稱。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

PrivateLinkResourcesWrapper 或 cls (回應的結果)

傳回類型

例外狀況

get_vip_info

取得指派給App Service 環境的 IP 位址。

指派給App Service 環境之取得 IP 位址的描述。

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

參數

resource_group_name
str
必要

資源所屬資源群組的名稱。 必要。

name
str
必要

App Service 環境的名稱。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

AddressResponse 或 cls (回應的結果)

傳回類型

例外狀況

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
必要

App Service 環境的名稱。 必要。

worker_pool_name
str
必要

背景工作集區的名稱。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

WorkerPoolResource 或 cls 的結果 (回應)

傳回類型

例外狀況

list

取得訂用帳戶的所有App Service環境。

取得訂用帳戶的所有App Service環境的描述。

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

參數

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

像是 AppServiceEnvironmentResource 實例或 cls (回應結果的反覆運算器)

傳回類型

例外狀況

list_app_service_plans

取得App Service 環境中的所有App Service方案。

取得App Service 環境中所有App Service計畫的描述。

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

參數

resource_group_name
str
必要

資源所屬資源群組的名稱。 必要。

name
str
必要

App Service 環境的名稱。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

像是 AppServicePlan 實例或 cls (回應結果的反覆運算器)

傳回類型

例外狀況

list_by_resource_group

取得資源群組中的所有App Service環境。

取得資源群組中所有App Service環境的描述。

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

參數

resource_group_name
str
必要

資源所屬資源群組的名稱。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

像是 AppServiceEnvironmentResource 實例或 cls (回應結果的反覆運算器)

傳回類型

例外狀況

list_capacities

取得App Service 環境的已使用、可用和總背景工作角色容量。

描述 取得App Service 環境的已使用、可用和總背景工作角色容量。

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

參數

resource_group_name
str
必要

資源所屬資源群組的名稱。 必要。

name
str
必要

App Service 環境的名稱。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

反覆運算器,例如 StampCapacity 實例或 cls 的結果 (回應)

傳回類型

例外狀況

list_diagnostics

取得App Service 環境的診斷資訊。

取得App Service 環境診斷資訊的描述。

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

參數

resource_group_name
str
必要

資源所屬資源群組的名稱。 必要。

name
str
必要

App Service 環境的名稱。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

HostingEnvironmentDiagnostics 或 cls (回應結果的清單)

傳回類型

例外狀況

list_multi_role_metric_definitions

取得App Service 環境多重角色集區的計量定義。

取得App Service 環境多重角色集區的計量定義描述。

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

參數

resource_group_name
str
必要

資源所屬資源群組的名稱。 必要。

name
str
必要

App Service 環境的名稱。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

反覆運算器,例如 ResourceMetricDefinition 的實例或 cls 的結果 (回應)

傳回類型

例外狀況

list_multi_role_pool_instance_metric_definitions

取得App Service 環境之多重角色集區特定實例的計量定義。

針對App Service 環境之多重角色集區的特定實例取得計量定義的描述。

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
必要

App Service 環境的名稱。 必要。

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) -> Iterable[SkuInfo]

參數

resource_group_name
str
必要

資源所屬資源群組的名稱。 必要。

name
str
必要

App Service 環境的名稱。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

像是 SkuInfo 實例或 cls (回應結果的反覆運算器)

傳回類型

例外狀況

list_multi_role_pools

取得所有多重角色集區。

取得所有多重角色集區的描述。

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

參數

resource_group_name
str
必要

資源所屬資源群組的名稱。 必要。

name
str
必要

App Service 環境的名稱。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

反覆運算器,例如 WorkerPoolResource 實例或 cls (回應的結果)

傳回類型

例外狀況

list_multi_role_usages

取得App Service 環境多重角色集區的使用量計量。

取得App Service 環境多重角色集區使用計量的描述。

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

參數

resource_group_name
str
必要

資源所屬資源群組的名稱。 必要。

name
str
必要

App Service 環境的名稱。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

反覆運算器,例如 Usage 實例或 cls 的結果, (回應)

傳回類型

例外狀況

list_operations

列出目前在App Service 環境上執行的所有作業。

列出目前在App Service 環境上執行的所有作業的描述。

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

參數

resource_group_name
str
必要

資源所屬資源群組的名稱。 必要。

name
str
必要

App Service 環境的名稱。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

作業清單或 cls (回應結果的清單)

傳回類型

例外狀況

list_usages

取得App Service 環境的全域使用計量。

取得App Service 環境全域使用計量的描述。

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

參數

resource_group_name
str
必要

資源所屬資源群組的名稱。 必要。

name
str
必要

App Service 環境的名稱。 必要。

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 and timeGrain eq duration'[Hour|分鐘|Day]'。 預設值為 [無]。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

例如 CsmUsageQuota 實例或 cls (回應結果的反覆運算器)

傳回類型

例外狀況

list_web_apps

取得App Service 環境中的所有應用程式。

取得App Service 環境中所有應用程式的描述。

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
必要

App Service 環境的名稱。 必要。

properties_to_include
str
必要

要包含的應用程式屬性逗號分隔清單。 預設值為 [無]。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

反覆運算器,例如 Site 的實例或 cls 的結果 (回應)

傳回類型

例外狀況

list_web_worker_metric_definitions

取得App Service 環境背景工作集區的計量定義。

取得App Service 環境背景工作集區之計量定義的描述。

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
必要

App Service 環境的名稱。 必要。

worker_pool_name
str
必要

背景工作集區的名稱。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

反覆運算器,例如 ResourceMetricDefinition 的實例或 cls 的結果 (回應)

傳回類型

例外狀況

list_web_worker_usages

取得App Service 環境背景工作集區的使用計量。

取得App Service 環境背景工作集區使用計量的描述。

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

參數

resource_group_name
str
必要

資源所屬資源群組的名稱。 必要。

name
str
必要

App Service 環境的名稱。 必要。

worker_pool_name
str
必要

背景工作集區的名稱。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

反覆運算器,例如 Usage 實例或 cls 的結果, (回應)

傳回類型

例外狀況

list_worker_pool_instance_metric_definitions

取得App Service 環境之背景工作集區特定實例的計量定義。

針對App Service 環境之背景工作集區的特定實例取得計量定義的描述。

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
必要

App Service 環境的名稱。 必要。

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) -> Iterable[SkuInfo]

參數

resource_group_name
str
必要

資源所屬資源群組的名稱。 必要。

name
str
必要

App Service 環境的名稱。 必要。

worker_pool_name
str
必要

背景工作集區的名稱。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

像是 SkuInfo 實例或 cls (回應結果的反覆運算器)

傳回類型

例外狀況

list_worker_pools

取得App Service 環境的所有背景工作集區。

取得App Service 環境之所有背景工作集區的描述。

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

參數

resource_group_name
str
必要

資源所屬資源群組的名稱。 必要。

name
str
必要

App Service 環境的名稱。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

反覆運算器,例如 WorkerPoolResource 實例或 cls (回應的結果)

傳回類型

例外狀況

reboot

重新開機App Service 環境中的所有機器。

App Service 環境中重新開機所有機器的描述。

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

參數

resource_group_name
str
必要

資源所屬資源群組的名稱。 必要。

name
str
必要

App Service 環境的名稱。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

無或 cls (回應的結果)

傳回類型

例外狀況

test_upgrade_available_notification

傳送測試通知,指出升級可供此App Service 環境使用。

傳送測試通知,指出升級可供此App Service 環境使用。

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

參數

resource_group_name
str
必要

資源所屬資源群組的名稱。 必要。

name
str
必要

App Service 環境的名稱。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

無或 cls (回應的結果)

傳回類型

例外狀況

update

建立或更新App Service 環境。

建立或更新App Service 環境的描述。

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
必要

App Service 環境的名稱。 必要。

hosting_environment_envelope
AppServiceEnvironmentPatchResourceIO
必要

App Service 環境的組態詳細資料。 這是 AppServiceEnvironmentPatchResource 類型或 IO 類型。 必要。

content_type
str

Body 參數內容類型。 已知值為:'application/json'。 預設值為 [無]。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

AppServiceEnvironmentResource 或 cls (回應的結果)

傳回類型

例外狀況

update_ase_custom_dns_suffix_configuration

更新App Service 環境的自訂 Dns 尾碼組態。

更新App Service 環境的自訂 Dns 尾碼組態。

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
必要

App Service 環境的名稱。 必要。

custom_dns_suffix_configuration
CustomDnsSuffixConfigurationIO
必要

這是 CustomDnsSuffixConfiguration 類型或 IO 類型。 必要。

content_type
str

Body 參數內容類型。 已知值為:'application/json'。 預設值為 [無]。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

CustomDnsSuffixConfiguration 或 cls (回應的結果)

傳回類型

例外狀況

update_ase_networking_configuration

更新App Service 環境的網路設定。

更新App Service 環境的網路設定描述。

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
必要

App Service 環境的名稱。 必要。

ase_networking_configuration
AseV3NetworkingConfigurationIO
必要

這是 AseV3NetworkingConfiguration 類型或 IO 類型。 必要。

content_type
str

Body 參數內容類型。 已知值為:'application/json'。 預設值為 [無]。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

AseV3NetworkingConfiguration 或 cls 的結果 (回應)

傳回類型

例外狀況

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

參數

resource_group_name
str
必要

資源所屬資源群組的名稱。 必要。

name
str
必要

App Service 環境的名稱。 必要。

multi_role_pool_envelope
WorkerPoolResourceIO
必要

多重角色集區的屬性。 這是 WorkerPoolResource 類型或 IO 類型。 必要。

content_type
str

Body 參數內容類型。 已知值為:'application/json'。 預設值為 [無]。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

WorkerPoolResource 或 cls 的結果 (回應)

傳回類型

例外狀況

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

參數

resource_group_name
str
必要

資源所屬資源群組的名稱。 必要。

name
str
必要

App Service 環境的名稱。 必要。

worker_pool_name
str
必要

背景工作集區的名稱。 必要。

worker_pool_envelope
WorkerPoolResourceIO
必要

背景工作集區的屬性。 這是 WorkerPoolResource 類型或 IO 類型。 必要。

content_type
str

本文參數內容類型。 已知值為:'application/json'。 預設值為 [無]。

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'>