共用方式為


AppServicePlansOperations 類別

警告

請勿直接具現化此類別。

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

WebSiteManagementClient's

<xref:app_service_plans> 屬性。

繼承
builtins.object
AppServicePlansOperations

建構函式

AppServicePlansOperations(*args, **kwargs)

方法

begin_create_or_update

建立或更新App Service方案。

建立或更新App Service方案。

create_or_update_vnet_route

在App Service方案中建立或更新虛擬網路路由。

在App Service方案中建立或更新虛擬網路路由。

delete

刪除App Service計畫。

刪除App Service計畫。

delete_hybrid_connection

刪除App Service方案中使用的混合式連線。

刪除App Service方案中使用的混合式連線。

delete_vnet_route

刪除App Service方案中的虛擬網路路由。

刪除App Service方案中的虛擬網路路由。

get

取得App Service方案。

取得App Service方案。

get_hybrid_connection

擷取在App Service方案中使用的混合式連線。

擷取在App Service方案中使用的混合式連線。

get_hybrid_connection_plan_limit

取得App Service方案中允許的混合式連線數目上限。

取得App Service方案中允許的混合式連線數目上限。

get_route_for_vnet

取得App Service方案中的虛擬網路路線。

取得App Service方案中的虛擬網路路線。

get_server_farm_skus

取得指定App Service方案的所有可選取 SKU。

取得指定App Service方案的所有可選取 SKU。

get_vnet_from_server_farm

取得與App Service方案相關聯的虛擬網路。

取得與App Service方案相關聯的虛擬網路。

get_vnet_gateway

取得虛擬網路閘道。

取得虛擬網路閘道。

list

取得訂用帳戶的所有App Service方案。

取得訂用帳戶的所有App Service方案。

list_by_resource_group

取得資源群組中的所有App Service計畫。

取得資源群組中的所有App Service計畫。

list_capabilities

列出App Service計畫的所有功能。

列出App Service計畫的所有功能。

list_hybrid_connection_keys

取得混合式連線的傳送金鑰名稱和值。

取得混合式連線的傳送金鑰名稱和值。

list_hybrid_connections

擷取App Service方案中使用的所有混合式連線。

擷取App Service方案中使用的所有混合式連線。

list_metric_defintions

取得可查詢App Service計畫的計量及其定義。

取得可查詢App Service計畫的計量及其定義。

list_metrics

取得App Service方案的計量。

取得App Service方案的計量。

list_routes_for_vnet

取得與App Service計畫中虛擬網路相關聯的所有路由。

取得與App Service計畫中虛擬網路相關聯的所有路由。

list_usages

取得伺服器陣列使用資訊。

取得伺服器陣列使用資訊。

list_vnets

取得與App Service方案相關聯的所有虛擬網路。

取得與App Service方案相關聯的所有虛擬網路。

list_web_apps

取得與App Service方案相關聯的所有應用程式。

取得與App Service方案相關聯的所有應用程式。

list_web_apps_by_hybrid_connection

取得在App Service方案中使用混合式連線的所有應用程式。

取得在App Service方案中使用混合式連線的所有應用程式。

reboot_worker

在App Service計畫中重新開機背景工作角色電腦。

在App Service計畫中重新開機背景工作角色電腦。

restart_web_apps

重新開機App Service方案中的所有應用程式。

重新開機App Service方案中的所有應用程式。

update

建立或更新App Service方案。

建立或更新App Service方案。

update_vnet_gateway

更新虛擬網路閘道。

更新虛擬網路閘道。

update_vnet_route

在App Service方案中建立或更新虛擬網路路由。

在App Service方案中建立或更新虛擬網路路由。

begin_create_or_update

建立或更新App Service方案。

建立或更新App Service方案。

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 方案的名稱。 必要。

app_service_plan
AppServicePlanIO
必要

App Service計畫的詳細資料。 這是 AppServicePlan 類型或 IO 類型。 必要。

content_type
str

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

cls
callable

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

continuation_token
str

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

polling
boolPollingMethod

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

polling_interval
int

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

傳回

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

傳回類型

例外狀況

create_or_update_vnet_route

在App Service方案中建立或更新虛擬網路路由。

在App Service方案中建立或更新虛擬網路路由。

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

App Service 方案的名稱。 必要。

vnet_name
str
必要

虛擬網路的名稱。 必要。

route_name
str
必要

虛擬網路路由的名稱。 必要。

route
VnetRouteIO
必要

虛擬網路路由的定義。 這是 VnetRoute 類型或 IO 類型。 必要。

content_type
str

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

cls
callable

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

傳回

VnetRoute 或 None 或 cls 的結果 (回應)

傳回類型

例外狀況

delete

刪除App Service計畫。

刪除App Service計畫。

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

參數

resource_group_name
str
必要

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

name
str
必要

App Service 方案的名稱。 必要。

cls
callable

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

傳回

無或 cls (回應的結果)

傳回類型

例外狀況

delete_hybrid_connection

刪除App Service方案中使用的混合式連線。

刪除App Service方案中使用的混合式連線。

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

參數

resource_group_name
str
必要

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

name
str
必要

App Service 方案的名稱。 必要。

namespace_name
str
必要

服務匯流排命名空間的名稱。 必要。

relay_name
str
必要

服務匯流排轉送的名稱。 必要。

cls
callable

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

傳回

無或 cls (回應的結果)

傳回類型

例外狀況

delete_vnet_route

刪除App Service方案中的虛擬網路路由。

刪除App Service方案中的虛擬網路路由。

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

參數

resource_group_name
str
必要

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

name
str
必要

App Service 方案的名稱。 必要。

vnet_name
str
必要

虛擬網路的名稱。 必要。

route_name
str
必要

虛擬網路路由的名稱。 必要。

cls
callable

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

傳回

無或 cls (回應的結果)

傳回類型

例外狀況

get

取得App Service方案。

取得App Service方案。

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

參數

resource_group_name
str
必要

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

name
str
必要

App Service 方案的名稱。 必要。

cls
callable

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

傳回

AppServicePlan 或 None 或 cls 的結果 (回應)

傳回類型

例外狀況

get_hybrid_connection

擷取在App Service方案中使用的混合式連線。

擷取在App Service方案中使用的混合式連線。

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

參數

resource_group_name
str
必要

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

name
str
必要

App Service 方案的名稱。 必要。

namespace_name
str
必要

服務匯流排命名空間的名稱。 必要。

relay_name
str
必要

服務匯流排轉送的名稱。 必要。

cls
callable

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

傳回

HybridConnection 或 cls 的結果 (回應)

傳回類型

例外狀況

get_hybrid_connection_plan_limit

取得App Service方案中允許的混合式連線數目上限。

取得App Service方案中允許的混合式連線數目上限。

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

參數

resource_group_name
str
必要

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

name
str
必要

App Service 方案的名稱。 必要。

cls
callable

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

傳回

HybridConnectionLimits 或 cls 的結果 (回應)

傳回類型

例外狀況

get_route_for_vnet

取得App Service方案中的虛擬網路路線。

取得App Service方案中的虛擬網路路線。

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

App Service 方案的名稱。 必要。

vnet_name
str
必要

虛擬網路的名稱。 必要。

route_name
str
必要

虛擬網路路由的名稱。 必要。

cls
callable

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

傳回

VnetRoute 或 None 或 cls (回應結果的清單)

傳回類型

例外狀況

get_server_farm_skus

取得指定App Service方案的所有可選取 SKU。

取得指定App Service方案的所有可選取 SKU。

get_server_farm_skus(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_vnet_from_server_farm

取得與App Service方案相關聯的虛擬網路。

取得與App Service方案相關聯的虛擬網路。

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

參數

resource_group_name
str
必要

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

name
str
必要

App Service 方案的名稱。 必要。

vnet_name
str
必要

虛擬網路的名稱。 必要。

cls
callable

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

傳回

VnetInfo 或 None 或 cls 的結果 (回應)

傳回類型

例外狀況

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

App Service 方案的名稱。 必要。

vnet_name
str
必要

虛擬網路的名稱。 必要。

gateway_name
str
必要

閘道的名稱。 僅支援「主要」閘道。 必要。

cls
callable

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

傳回

VnetGateway 或 cls (回應的結果)

傳回類型

例外狀況

list

取得訂用帳戶的所有App Service方案。

取得訂用帳戶的所有App Service方案。

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

參數

detailed
bool
必要

指定 <code>true</code> 以傳回所有App Service計畫屬性。 預設值為 <code>false</code> ,其會傳回屬性的子集。

擷取所有屬性可能會增加 API 延遲。 預設值為 [無]。

cls
callable

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

傳回

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

傳回類型

例外狀況

list_by_resource_group

取得資源群組中的所有App Service計畫。

取得資源群組中的所有App Service計畫。

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

參數

resource_group_name
str
必要

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

cls
callable

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

傳回

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

傳回類型

例外狀況

list_capabilities

列出App Service計畫的所有功能。

列出App Service計畫的所有功能。

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

參數

resource_group_name
str
必要

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

name
str
必要

App Service 方案的名稱。 必要。

cls
callable

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

傳回

功能清單或 cls 的結果 (回應)

傳回類型

例外狀況

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

App Service 方案的名稱。 必要。

namespace_name
str
必要

服務匯流排命名空間的名稱。 必要。

relay_name
str
必要

服務匯流排轉送的名稱。 必要。

cls
callable

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

傳回

HybridConnectionKey 或 cls 的結果 (回應)

傳回類型

例外狀況

list_hybrid_connections

擷取App Service方案中使用的所有混合式連線。

擷取App Service方案中使用的所有混合式連線。

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

參數

resource_group_name
str
必要

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

name
str
必要

App Service 方案的名稱。 必要。

cls
callable

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

傳回

HybridConnection 實例或 cls (回應結果等反覆運算器)

傳回類型

例外狀況

list_metric_defintions

取得可查詢App Service計畫的計量及其定義。

取得可查詢App Service計畫的計量及其定義。

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

參數

resource_group_name
str
必要

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

name
str
必要

App Service 方案的名稱。 必要。

cls
callable

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

傳回

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

傳回類型

例外狀況

list_metrics

取得App Service方案的計量。

取得App Service方案的計量。

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

App Service 方案的名稱。 必要。

details
bool
必要

指定 <code>true</code> 以包含實例詳細資料。 預設值為 <code>false</code>。 預設值為 [無]。

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

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

傳回

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

傳回類型

例外狀況

list_routes_for_vnet

取得與App Service計畫中虛擬網路相關聯的所有路由。

取得與App Service計畫中虛擬網路相關聯的所有路由。

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

參數

resource_group_name
str
必要

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

name
str
必要

App Service 方案的名稱。 必要。

vnet_name
str
必要

虛擬網路的名稱。 必要。

cls
callable

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

傳回

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

傳回類型

例外狀況

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 Service方案的名稱。 必要。

filter
str
必要

只傳回篩選中指定的使用方式/計量。 篩選準則符合 odata 語法。 範例:$filter= (name.value eq 'Metric1' 或 name.value eq 'Metric2') 。 預設值為 [無]。

cls
callable

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

傳回

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

傳回類型

例外狀況

list_vnets

取得與App Service方案相關聯的所有虛擬網路。

取得與App Service方案相關聯的所有虛擬網路。

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

參數

resource_group_name
str
必要

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

name
str
必要

App Service 方案的名稱。 必要。

cls
callable

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

傳回

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

傳回類型

例外狀況

list_web_apps

取得與App Service方案相關聯的所有應用程式。

取得與App Service方案相關聯的所有應用程式。

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

App Service 方案的名稱。 必要。

skip_token
str
必要

跳至與 App Service 方案相關聯的 Web 應用程式清單中的 Web 應用程式。 如果指定,產生的清單會包含從 (開始的 Web 應用程式,包括 skipToken) 。 否則,產生的清單會包含清單開頭的 Web 應用程式。 預設值為 [無]。

filter
str
必要

支援的篩選:$filter=state eq 執行中。 只傳回目前正在執行的 Web 應用程式。 預設值為 [無]。

top
str
必要

清單頁面大小。 如果指定,則會分頁顯示結果。 預設值為 [無]。

cls
callable

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

傳回

月臺實例或 cls (回應結果之類的反覆運算器)

傳回類型

例外狀況

list_web_apps_by_hybrid_connection

取得在App Service方案中使用混合式連線的所有應用程式。

取得在App Service方案中使用混合式連線的所有應用程式。

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

App Service 方案的名稱。 必要。

namespace_name
str
必要

混合式連線命名空間的名稱。 必要。

relay_name
str
必要

混合式連線轉送的名稱。 必要。

cls
callable

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

傳回

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

傳回類型

例外狀況

reboot_worker

在App Service計畫中重新開機背景工作角色電腦。

在App Service計畫中重新開機背景工作角色電腦。

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

參數

resource_group_name
str
必要

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

name
str
必要

App Service 方案的名稱。 必要。

worker_name
str
必要

背景工作電腦的名稱,通常以 RD 開頭。 必要。

cls
callable

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

傳回

無或 cls (回應的結果)

傳回類型

例外狀況

restart_web_apps

重新開機App Service方案中的所有應用程式。

重新開機App Service方案中的所有應用程式。

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

參數

resource_group_name
str
必要

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

name
str
必要

App Service 方案的名稱。 必要。

soft_restart
bool
必要

指定 <code>true</code> 以執行軟重新開機、套用組態設定,並視需要重新開機應用程式。 預設值為 <code>false</code> ,一律會重新開機並重新布建應用程式。 預設值為 [無]。

cls
callable

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

傳回

無或 cls (回應的結果)

傳回類型

例外狀況

update

建立或更新App Service方案。

建立或更新App Service方案。

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 方案的名稱。 必要。

app_service_plan
AppServicePlanPatchResourceIO
必要

App Service計畫的詳細資料。 這是 AppServicePlanPatchResource 類型或 IO 類型。 必要。

content_type
str

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

cls
callable

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

傳回

AppServicePlan 或 cls 的結果 (回應)

傳回類型

例外狀況

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

App Service 方案的名稱。 必要。

vnet_name
str
必要

虛擬網路的名稱。 必要。

gateway_name
str
必要

閘道的名稱。 僅支援「主要」閘道。 必要。

connection_envelope
VnetGatewayIO
必要

閘道的定義。 這是 VnetGateway 類型或 IO 類型。 必要。

content_type
str

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

cls
callable

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

傳回

VnetGateway 或 cls (回應的結果)

傳回類型

例外狀況

update_vnet_route

在App Service方案中建立或更新虛擬網路路由。

在App Service方案中建立或更新虛擬網路路由。

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

App Service 方案的名稱。 必要。

vnet_name
str
必要

虛擬網路的名稱。 必要。

route_name
str
必要

虛擬網路路由的名稱。 必要。

route
VnetRouteIO
必要

虛擬網路路由的定義。 這是 VnetRoute 類型或 IO 類型。 必要。

content_type
str

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

cls
callable

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

傳回

VnetRoute 或 None 或 cls 的結果 (回應)

傳回類型

例外狀況

屬性

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