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 プランでVirtual Network ルートを作成または更新します。

App Service プランでVirtual Network ルートを作成または更新します。

delete

App Serviceプランを削除します。

App Serviceプランを削除します。

delete_hybrid_connection

App Service プランで使用中のハイブリッド接続を削除します。

App Service プランで使用中のハイブリッド接続を削除します。

delete_vnet_route

App Service プランのVirtual Network ルートを削除します。

App Service プランのVirtual Network ルートを削除します。

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 プランでVirtual Network ルートを取得します。

App Service プランでVirtual Network ルートを取得します。

get_server_farm_skus

特定のApp Service プランに対して選択可能なすべての SKU を取得します。

特定のApp Service プランに対して選択可能なすべての SKU を取得します。

get_vnet_from_server_farm

App Service プランに関連付けられているVirtual Networkを取得します。

App Service プランに関連付けられているVirtual Networkを取得します。

get_vnet_gateway

Virtual Network ゲートウェイを取得します。

Virtual Network ゲートウェイを取得します。

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_routes_for_vnet

App Service プランのVirtual Networkに関連付けられているすべてのルートを取得します。

App Service プランのVirtual Networkに関連付けられているすべてのルートを取得します。

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

Virtual Network ゲートウェイを更新します。

Virtual Network ゲートウェイを更新します。

update_vnet_route

App Service プランでVirtual Network ルートを作成または更新します。

App Service プランでVirtual Network ルートを作成または更新します。

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
AppServicePlan または IO
必須

App Serviceプランの詳細。 AppServicePlan 型または IO 型のいずれかです。 必須。

content_type
str

Body Parameter content-type。 既知の値は、'application/json' です。 既定値は [なし] です。

cls
callable

直接応答が渡されるカスタム型または関数

continuation_token
str

保存された状態からポーリングを再開するための継続トークン。

polling
bool または PollingMethod

既定では、ポーリング メソッドは ARMPolling になります。 この操作に対して False を渡してポーリングを行わないか、個人のポーリング戦略のために独自に初期化されたポーリング オブジェクトを渡します。

polling_interval
int

Retry-After ヘッダーがない場合、LRO 操作の 2 つのポーリング間の既定の待機時間。

戻り値

AppServicePlan または cls(response) の結果を返す LROPoller のインスタンス

の戻り値の型 :

例外

create_or_update_vnet_route

App Service プランでVirtual Network ルートを作成または更新します。

App Service プランでVirtual Network ルートを作成または更新します。

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

Virtual Networkの名前。 必須。

route_name
str
必須

Virtual Network ルートの名前。 必須。

route
VnetRoute または IO
必須

Virtual Network ルートの定義。 VnetRoute 型または IO 型のいずれかです。 必須。

content_type
str

Body Parameter content-type。 既知の値は、'application/json' です。 既定値は [なし] です。

cls
callable

直接応答が渡されるカスタム型または関数

戻り値

VnetRoute または None、または cls(response) の結果

の戻り値の型 :

例外

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(response) の結果

の戻り値の型 :

例外

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

Service Bus 名前空間の名前。 必須。

relay_name
str
必須

Service Bus リレーの名前。 必須。

cls
callable

直接応答が渡されるカスタム型または関数

戻り値

なしまたは cls(response) の結果

の戻り値の型 :

例外

delete_vnet_route

App Service プランのVirtual Network ルートを削除します。

App Service プランのVirtual Network ルートを削除します。

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

Virtual Networkの名前。 必須。

route_name
str
必須

Virtual Network ルートの名前。 必須。

cls
callable

直接応答が渡されるカスタム型または関数

戻り値

なしまたは cls(response) の結果

の戻り値の型 :

例外

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(response) の結果

の戻り値の型 :

例外

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

Service Bus 名前空間の名前。 必須。

relay_name
str
必須

Service Bus リレーの名前。 必須。

cls
callable

直接応答が渡されるカスタム型または関数

戻り値

HybridConnection または cls(response) の結果

の戻り値の型 :

例外

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(response) の結果

の戻り値の型 :

例外

get_route_for_vnet

App Service プランでVirtual Network ルートを取得します。

App Service プランでVirtual Network ルートを取得します。

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

Virtual Networkの名前。 必須。

route_name
str
必須

Virtual Network ルートの名前。 必須。

cls
callable

直接応答に渡されるカスタム型または関数

戻り値

VnetRoute または None のリスト、または cls(response) の結果

の戻り値の型 :

例外

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(response) の結果

の戻り値の型 :

<xref:JSON>

例外

get_vnet_from_server_farm

App Service プランに関連付けられているVirtual Networkを取得します。

App Service プランに関連付けられているVirtual Networkを取得します。

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

Virtual Networkの名前。 必須。

cls
callable

直接応答に渡されるカスタム型または関数

戻り値

VnetInfo または None、または cls(response) の結果

の戻り値の型 :

例外

get_vnet_gateway

Virtual Network ゲートウェイを取得します。

Virtual Network ゲートウェイを取得します。

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

Virtual Networkの名前。 必須。

gateway_name
str
必須

ゲートウェイの名前。 "プライマリ" ゲートウェイのみがサポートされています。 必須。

cls
callable

直接応答に渡されるカスタム型または関数

戻り値

VnetGateway または cls(response) の結果

の戻り値の型 :

例外

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(response) の結果のような反復子

の戻り値の型 :

例外

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(response) の結果のような反復子

の戻り値の型 :

例外

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(response) の結果

の戻り値の型 :

例外

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

Service Bus 名前空間の名前。 必須。

relay_name
str
必須

Service Bus リレーの名前。 必須。

cls
callable

直接応答に渡されるカスタム型または関数

戻り値

HybridConnectionKey または cls(response) の結果

の戻り値の型 :

例外

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(response) の結果のような反復子

の戻り値の型 :

例外

list_routes_for_vnet

App Service プランのVirtual Networkに関連付けられているすべてのルートを取得します。

App Service プランのVirtual Networkに関連付けられているすべてのルートを取得します。

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

Virtual Networkの名前。 必須。

cls
callable

直接応答に渡されるカスタム型または関数

戻り値

VnetRoute の一覧または cls(response) の結果

の戻り値の型 :

例外

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(response) の結果のような反復子

の戻り値の型 :

例外

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(response) の結果

の戻り値の型 :

例外

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 アプリにスキップします。 指定した場合、結果のリストには skipToken から始まる (含む) Web アプリが含まれます。 それ以外の場合、結果のリストには、リストの先頭から Web アプリが含まれます。 既定値は [なし] です。

filter
str
必須

サポートされているフィルター: $filter=state eq running。 現在実行中の Web アプリのみを返します。 既定値は [なし] です。

top
str
必須

ページ サイズを一覧表示します。 指定した場合、結果はページングされます。 既定値は [なし] です。

cls
callable

直接応答に渡されるカスタム型または関数

戻り値

Site のインスタンスや cls(response) の結果のような反復子

の戻り値の型 :

例外

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(response) の結果のインスタンスのような反復子

の戻り値の型 :

例外

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(response) の結果

の戻り値の型 :

例外

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(response) の結果

の戻り値の型 :

例外

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
AppServicePlanPatchResource または IO
必須

App Serviceプランの詳細。 AppServicePlanPatchResource 型または IO 型です。 必須。

content_type
str

Body Parameter content-type。 既知の値は、'application/json' です。 既定値は [なし] です。

cls
callable

直接応答に渡されるカスタム型または関数

戻り値

AppServicePlan または cls(response) の結果

の戻り値の型 :

例外

update_vnet_gateway

Virtual Network ゲートウェイを更新します。

Virtual Network ゲートウェイを更新します。

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

Virtual Networkの名前。 必須。

gateway_name
str
必須

ゲートウェイの名前。 "プライマリ" ゲートウェイのみがサポートされています。 必須。

connection_envelope
VnetGateway または IO
必須

ゲートウェイの定義。 VnetGateway 型または IO 型のいずれかです。 必須。

content_type
str

Body Parameter content-type。 既知の値は、'application/json' です。 既定値は [なし] です。

cls
callable

直接応答に渡されるカスタム型または関数

戻り値

VnetGateway または cls(response) の結果

の戻り値の型 :

例外

update_vnet_route

App Service プランでVirtual Network ルートを作成または更新します。

App Service プランでVirtual Network ルートを作成または更新します。

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

Virtual Networkの名前。 必須。

route_name
str
必須

Virtual Network ルートの名前。 必須。

route
VnetRoute または IO
必須

Virtual Network ルートの定義。 VnetRoute 型または IO 型のいずれかです。 必須。

content_type
str

Body Parameter content-type。 既知の値は、'application/json' です。 既定値は [なし] です。

cls
callable

直接応答に渡されるカスタム型または関数

戻り値

VnetRoute または None、または cls(response) の結果

の戻り値の型 :

例外

属性

models

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