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 Environmentを別の VNET に移動します。

「App Service Environmentを別の VNET に移動する」の説明。

begin_create_or_update

App Service Environmentを作成または更新します。

「App Service Environmentを作成または更新する」の説明。

begin_create_or_update_multi_role_pool

マルチロール プールを作成または更新します。

「マルチロール プールを作成または更新する」の説明。

begin_create_or_update_worker_pool

ワーカー プールを作成または更新します。

ワーカー プールの作成または更新に関する説明。

begin_delete

App Service Environmentを削除します。

「App Service Environmentを削除する」の説明。

begin_delete_private_endpoint_connection

プライベート エンドポイント接続を削除します。

の説明 プライベート エンドポイント接続を削除します。

begin_resume

App Service Environmentを再開します。

App Service Environmentの再開に関する説明。

begin_suspend

App Service Environmentを中断します。

[App Service Environmentの中断] の説明。

begin_upgrade

App Service Environmentが使用可能な場合は、アップグレードを開始します。

「App Service Environmentのアップグレードを開始する (使用可能な場合)」の説明。

delete_ase_custom_dns_suffix_configuration

App Service Environmentのカスタム Dns サフィックス構成を削除します。

App Service Environmentのカスタム Dns サフィックス構成を削除します。

get

App Service Environmentのプロパティを取得します。

「App Service Environmentのプロパティを取得する」の説明。

get_ase_custom_dns_suffix_configuration

App Service Environmentのカスタム Dns サフィックス構成を取得します。

App Service Environmentのカスタム Dns サフィックス構成を取得します。

get_ase_v3_networking_configuration

App Service Environmentのネットワーク構成を取得します。

「App Service Environmentのネットワーク構成を取得する」の説明。

get_diagnostics_item

App Service Environmentの診断項目を取得します。

「App Service Environmentの診断項目を取得する」の説明。

get_inbound_network_dependencies_endpoints

App Service Environmentのすべての受信依存関係のネットワーク エンドポイントを取得します。

「App Service Environmentのすべての受信依存関係のネットワーク エンドポイントを取得する」の説明。

get_multi_role_pool

複数ロール プールのプロパティを取得します。

「複数ロール プールのプロパティを取得する」の説明。

get_outbound_network_dependencies_endpoints

App Service Environmentのすべての送信依存関係のネットワーク エンドポイントを取得します。

「App Service Environmentのすべての送信依存関係のネットワーク エンドポイントを取得する」の説明。

get_private_endpoint_connection

プライベート エンドポイント接続を取得します。

「プライベート エンドポイント接続を取得する」の説明。

get_private_endpoint_connection_list

ホスティング環境に関連付けられているプライベート エンドポイントの一覧を取得します。

説明: ホスティング環境に関連付けられているプライベート エンドポイントの一覧を取得します。

get_private_link_resources

プライベート リンク リソースを取得します。

[説明] プライベート リンク リソースを取得します。

get_vip_info

App Service Environmentに割り当てられた IP アドレスを取得します。

App Service Environmentに割り当てられた IP アドレスの取得に関する説明。

get_worker_pool

ワーカー プールのプロパティを取得します。

「ワーカー プールのプロパティを取得する」の説明。

list

サブスクリプションのすべてのApp Service環境を取得します。

「サブスクリプションのすべてのApp Service環境を取得する」の説明。

list_app_service_plans

App Service Environment内のすべてのApp Serviceプランを取得します。

「App Service Environment内のすべてのApp Serviceプランを取得する」の説明。

list_by_resource_group

リソース グループ内のすべてのApp Service環境を取得します。

「リソース グループ内のすべてのApp Service環境を取得する」の説明。

list_capacities

App Service Environmentの使用済み、使用可能、および合計ワーカー容量を取得します。

「App Service Environmentの使用済み、使用可能、および合計ワーカー容量を取得する」の説明。

list_diagnostics

App Service Environmentの診断情報を取得します。

「App Service Environmentの診断情報を取得する」の説明。

list_multi_role_metric_definitions

App Service Environmentの複数ロール プールのメトリック定義を取得します。

「App Service Environmentの複数ロール プールのメトリック定義を取得する」の説明。

list_multi_role_pool_instance_metric_definitions

App Service Environmentの複数ロール プールの特定のインスタンスのメトリック定義を取得します。

「App Service Environmentの複数ロール プールの特定のインスタンスのメトリック定義を取得する」の説明。

list_multi_role_pool_skus

マルチロール プールのスケーリングに使用できる SKU を取得します。

「複数ロール プールのスケーリングに使用できる SKU を取得する」の説明。

list_multi_role_pools

すべてのマルチロール プールを取得します。

「すべてのマルチロール プールを取得する」の説明。

list_multi_role_usages

App Service Environmentの複数ロール プールの使用状況メトリックを取得します。

「App Service Environmentの複数ロール プールの使用状況メトリックを取得する」の説明。

list_operations

App Service Environmentで現在実行中のすべての操作を一覧表示します。

「App Service Environmentで現在実行中のすべての操作を一覧表示する」の説明。

list_usages

App Service Environmentのグローバル使用状況メトリックを取得します。

「App Service Environmentのグローバル使用状況メトリックを取得する」の説明。

list_web_apps

App Service Environment内のすべてのアプリを取得します。

「App Service Environment内のすべてのアプリを取得する」の説明。

list_web_worker_metric_definitions

App Service Environmentのワーカー プールのメトリック定義を取得します。

「App Service Environmentのワーカー プールのメトリック定義を取得する」の説明。

list_web_worker_usages

App Service Environmentのワーカー プールの使用状況メトリックを取得します。

「App Service Environmentのワーカー プールの使用状況メトリックを取得する」の説明。

list_worker_pool_instance_metric_definitions

App Service Environmentのワーカー プールの特定のインスタンスのメトリック定義を取得します。

「App Service Environmentのワーカー プールの特定のインスタンスのメトリック定義を取得する」の説明。

list_worker_pool_skus

ワーカー プールのスケーリングに使用できる SKU を取得します。

「ワーカー プールをスケーリングするために使用可能な SKU を取得する」の説明。

list_worker_pools

App Service Environmentのすべてのワーカー プールを取得します。

「App Service Environmentのすべてのワーカー プールを取得する」の説明。

reboot

App Service Environment内のすべてのマシンを再起動します。

「App Service Environment内のすべてのマシンを再起動する」の説明。

test_upgrade_available_notification

このApp Service Environmentにアップグレードが使用可能であることをテスト通知で送信します。

このApp Service Environmentにアップグレードが使用可能であることをテスト通知で送信します。

update

App Service Environmentを作成または更新します。

「App Service Environmentを作成または更新する」の説明。

update_ase_custom_dns_suffix_configuration

App Service Environmentのカスタム DNS サフィックス構成を更新します。

App Service Environmentのカスタム DNS サフィックス構成を更新します。

update_ase_networking_configuration

App Service Environment のネットワーク構成を更新します。

「App Service Environmentのネットワーク構成を更新する」の説明。

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 Environmentの名前。 必須。

private_endpoint_connection_name
str
必須

必須。

private_endpoint_wrapper
PrivateLinkConnectionApprovalRequestResource または IO
必須

PrivateLinkConnectionApprovalRequestResource 型または 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 つのポーリング間の既定の待機時間。

戻り値

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

の戻り値の型 :

例外

begin_change_vnet

App Service Environmentを別の VNET に移動します。

「App Service Environmentを別の 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 Environmentの名前。 必須。

vnet_info
VirtualNetworkProfile または IO
必須

新しい仮想ネットワークの詳細。 VirtualNetworkProfile 型または 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 つのポーリング間の既定の待機時間。

戻り値

WebAppCollection のインスタンスや cls(response) の結果などの反復子を返す LROPoller のインスタンス

の戻り値の型 :

例外

begin_create_or_update

App Service Environmentを作成または更新します。

「App Service Environmentを作成または更新する」の説明。

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 Environmentの名前。 必須。

hosting_environment_envelope
AppServiceEnvironmentResource または IO
必須

App Service Environmentの構成の詳細。 AppServiceEnvironmentResource 型または 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 つのポーリング間の既定の待機時間。

戻り値

AppServiceEnvironmentResource または cls(response) の結果を返す 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 Environmentの名前。 必須。

multi_role_pool_envelope
WorkerPoolResource または IO
必須

マルチロール プールのプロパティ。 WorkerPoolResource 型または 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 つのポーリング間の既定の待機時間。

戻り値

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

の戻り値の型 :

例外

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 Environmentの名前。 必須。

worker_pool_name
str
必須

ワーカー プールの名前。 必須。

worker_pool_envelope
WorkerPoolResource または IO
必須

ワーカー プールのプロパティ。 WorkerPoolResource 型または 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 つのポーリング間の既定の待機時間。

戻り値

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

の戻り値の型 :

例外

begin_delete

App Service Environmentを削除します。

「App Service Environmentを削除する」の説明。

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 Environmentの名前。 必須。

force_delete
bool
必須

を指定<code>true</code>すると、App Service Environmentにリソースが含まれている場合でも強制的に削除されます。 既定値は、<code>false</code> です。 既定値は [なし] です。

cls
callable

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

continuation_token
str

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

polling
bool または PollingMethod

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

polling_interval
int

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

戻り値

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

の戻り値の型 :

例外

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 Environmentの名前。 必須。

private_endpoint_connection_name
str
必須

必須。

cls
callable

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

continuation_token
str

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

polling
bool または PollingMethod

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

polling_interval
int

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

戻り値

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

の戻り値の型 :

LROPoller[<xref:JSON>]

例外

begin_resume

App Service Environmentを再開します。

App Service Environmentの再開に関する説明。

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

パラメーター

resource_group_name
str
必須

リソースが属しているリソース グループの名前。 必須。

name
str
必須

App Service Environmentの名前。 必須。

cls
callable

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

continuation_token
str

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

polling
bool または PollingMethod

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

polling_interval
int

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

戻り値

WebAppCollection のインスタンスや cls(response) の結果などの反復子を返す LROPoller のインスタンス

の戻り値の型 :

例外

begin_suspend

App Service Environmentを中断します。

[App Service Environmentの中断] の説明。

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

パラメーター

resource_group_name
str
必須

リソースが属しているリソース グループの名前。 必須。

name
str
必須

App Service Environmentの名前。 必須。

cls
callable

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

continuation_token
str

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

polling
bool または PollingMethod

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

polling_interval
int

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

戻り値

WebAppCollection のインスタンスや cls(response) の結果などの反復子を返す LROPoller のインスタンス

の戻り値の型 :

例外

begin_upgrade

App Service Environmentが使用可能な場合は、アップグレードを開始します。

「App Service Environmentのアップグレードを開始する (使用可能な場合)」の説明。

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

パラメーター

resource_group_name
str
必須

リソースが属しているリソース グループの名前。 必須。

name
str
必須

App Service Environmentの名前。 必須。

cls
callable

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

continuation_token
str

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

polling
bool または PollingMethod

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

polling_interval
int

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

戻り値

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

の戻り値の型 :

例外

delete_ase_custom_dns_suffix_configuration

App Service Environmentのカスタム Dns サフィックス構成を削除します。

App Service Environmentのカスタム 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 Environmentの名前。 必須。

cls
callable

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

戻り値

JSON または cls(response) の結果

の戻り値の型 :

<xref:JSON>

例外

get

App Service Environmentのプロパティを取得します。

「App Service Environmentのプロパティを取得する」の説明。

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

パラメーター

resource_group_name
str
必須

リソースが属しているリソース グループの名前。 必須。

name
str
必須

App Service Environmentの名前。 必須。

cls
callable

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

戻り値

AppServiceEnvironmentResource または cls(response) の結果

の戻り値の型 :

例外

get_ase_custom_dns_suffix_configuration

App Service Environmentのカスタム Dns サフィックス構成を取得します。

App Service Environmentのカスタム Dns サフィックス構成を取得します。

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

パラメーター

resource_group_name
str
必須

リソースが属しているリソース グループの名前。 必須。

name
str
必須

App Service Environmentの名前。 必須。

cls
callable

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

戻り値

CustomDnsSuffixConfiguration または cls(response) の結果

の戻り値の型 :

例外

get_ase_v3_networking_configuration

App Service Environmentのネットワーク構成を取得します。

「App Service Environmentのネットワーク構成を取得する」の説明。

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

パラメーター

resource_group_name
str
必須

リソースが属しているリソース グループの名前。 必須。

name
str
必須

App Service Environmentの名前。 必須。

cls
callable

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

戻り値

AseV3NetworkingConfiguration または cls(response) の結果

の戻り値の型 :

例外

get_diagnostics_item

App Service Environmentの診断項目を取得します。

「App Service Environmentの診断項目を取得する」の説明。

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

パラメーター

resource_group_name
str
必須

リソースが属しているリソース グループの名前。 必須。

name
str
必須

App Service Environmentの名前。 必須。

diagnostics_name
str
必須

診断項目の名前。 必須。

cls
callable

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

戻り値

HostingEnvironmentDiagnostics または cls(response) の結果

の戻り値の型 :

例外

get_inbound_network_dependencies_endpoints

App Service Environmentのすべての受信依存関係のネットワーク エンドポイントを取得します。

「App Service Environmentのすべての受信依存関係のネットワーク エンドポイントを取得する」の説明。

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

パラメーター

resource_group_name
str
必須

リソースが属しているリソース グループの名前。 必須。

name
str
必須

App Service Environmentの名前。 必須。

cls
callable

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

戻り値

InboundEnvironmentEndpoint または cls(response) の結果のインスタンスのような反復子

の戻り値の型 :

例外

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 Environmentの名前。 必須。

cls
callable

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

戻り値

WorkerPoolResource または cls(response) の結果

の戻り値の型 :

例外

get_outbound_network_dependencies_endpoints

App Service Environmentのすべての送信依存関係のネットワーク エンドポイントを取得します。

「App Service Environmentのすべての送信依存関係のネットワーク エンドポイントを取得する」の説明。

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

パラメーター

resource_group_name
str
必須

リソースが属しているリソース グループの名前。 必須。

name
str
必須

App Service Environmentの名前。 必須。

cls
callable

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

戻り値

OutboundEnvironmentEndpoint または cls(response) の結果のインスタンスのような反復子

の戻り値の型 :

例外

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 Environmentの名前。 必須。

private_endpoint_connection_name
str
必須

プライベート エンドポイント接続の名前。 必須。

cls
callable

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

戻り値

RemotePrivateEndpointConnectionARMResource または cls(response) の結果

の戻り値の型 :

例外

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 Environmentの名前。 必須。

cls
callable

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

戻り値

RemotePrivateEndpointConnectionARMResource または cls(response) の結果のいずれかのインスタンスのような反復子

の戻り値の型 :

例外

プライベート リンク リソースを取得します。

[説明] プライベート リンク リソースを取得します。

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

パラメーター

resource_group_name
str
必須

リソースが属しているリソース グループの名前。 必須。

name
str
必須

App Service Environmentの名前。 必須。

cls
callable

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

戻り値

PrivateLinkResourcesWrapper または cls(response) の結果

の戻り値の型 :

例外

get_vip_info

App Service Environmentに割り当てられた IP アドレスを取得します。

App Service Environmentに割り当てられた IP アドレスの取得に関する説明。

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

パラメーター

resource_group_name
str
必須

リソースが属しているリソース グループの名前。 必須。

name
str
必須

App Service Environmentの名前。 必須。

cls
callable

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

戻り値

AddressResponse または cls(response) の結果

の戻り値の型 :

例外

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 Environmentの名前。 必須。

worker_pool_name
str
必須

ワーカー プールの名前。 必須。

cls
callable

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

戻り値

WorkerPoolResource または cls(response) の結果

の戻り値の型 :

例外

list

サブスクリプションのすべてのApp Service環境を取得します。

「サブスクリプションのすべてのApp Service環境を取得する」の説明。

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

パラメーター

cls
callable

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

戻り値

AppServiceEnvironmentResource または cls(response) の結果のいずれかのインスタンスのような反復子

の戻り値の型 :

例外

list_app_service_plans

App Service Environment内のすべてのApp Serviceプランを取得します。

「App Service Environment内のすべてのApp Serviceプランを取得する」の説明。

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

パラメーター

resource_group_name
str
必須

リソースが属しているリソース グループの名前。 必須。

name
str
必須

App Service Environmentの名前。 必須。

cls
callable

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

戻り値

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

の戻り値の型 :

例外

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

の戻り値の型 :

例外

list_capacities

App Service Environmentの使用済み、使用可能、および合計ワーカー容量を取得します。

「App Service Environmentの使用済み、使用可能、および合計ワーカー容量を取得する」の説明。

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

パラメーター

resource_group_name
str
必須

リソースが属しているリソース グループの名前。 必須。

name
str
必須

App Service Environmentの名前。 必須。

cls
callable

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

戻り値

StampCapacity または cls(response) の結果のいずれかのインスタンスのような反復子

の戻り値の型 :

例外

list_diagnostics

App Service Environmentの診断情報を取得します。

「App Service Environmentの診断情報を取得する」の説明。

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

パラメーター

resource_group_name
str
必須

リソースが属しているリソース グループの名前。 必須。

name
str
必須

App Service Environmentの名前。 必須。

cls
callable

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

戻り値

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

の戻り値の型 :

例外

list_multi_role_metric_definitions

App Service Environmentの複数ロール プールのメトリック定義を取得します。

「App Service Environmentの複数ロール プールのメトリック定義を取得する」の説明。

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

パラメーター

resource_group_name
str
必須

リソースが属しているリソース グループの名前。 必須。

name
str
必須

App Service Environmentの名前。 必須。

cls
callable

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

戻り値

ResourceMetricDefinition または cls(response) の結果のいずれかのインスタンスのような反復子

の戻り値の型 :

例外

list_multi_role_pool_instance_metric_definitions

App Service Environmentの複数ロール プールの特定のインスタンスのメトリック定義を取得します。

「App Service Environmentの複数ロール プールの特定のインスタンスのメトリック定義を取得する」の説明。

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 Environmentの名前。 必須。

instance
str
必須

マルチロール プール内のインスタンスの名前。 必須。

cls
callable

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

戻り値

ResourceMetricDefinition または cls(response) の結果のいずれかのインスタンスのような反復子

の戻り値の型 :

例外

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 Environmentの名前。 必須。

cls
callable

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

戻り値

SkuInfo または cls(response) の結果のいずれかのインスタンスのような反復子

の戻り値の型 :

例外

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 Environmentの名前。 必須。

cls
callable

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

戻り値

WorkerPoolResource または cls(response) の結果のいずれかのインスタンスのような反復子

の戻り値の型 :

例外

list_multi_role_usages

App Service Environmentの複数ロール プールの使用状況メトリックを取得します。

「App Service Environmentの複数ロール プールの使用状況メトリックを取得する」の説明。

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

パラメーター

resource_group_name
str
必須

リソースが属しているリソース グループの名前。 必須。

name
str
必須

App Service Environmentの名前。 必須。

cls
callable

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

戻り値

Usage または cls(response) の結果のいずれかのインスタンスのような反復子

の戻り値の型 :

例外

list_operations

App Service Environmentで現在実行中のすべての操作を一覧表示します。

「App Service Environmentで現在実行中のすべての操作を一覧表示する」の説明。

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

パラメーター

resource_group_name
str
必須

リソースが属しているリソース グループの名前。 必須。

name
str
必須

App Service Environmentの名前。 必須。

cls
callable

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

戻り値

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

の戻り値の型 :

例外

list_usages

App Service Environmentのグローバル使用状況メトリックを取得します。

「App Service Environmentのグローバル使用状況メトリックを取得する」の説明。

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

パラメーター

resource_group_name
str
必須

リソースが属しているリソース グループの名前。 必須。

name
str
必須

App Service Environmentの名前。 必須。

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]'. 既定値は [なし] です。

cls
callable

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

戻り値

CsmUsageQuota または cls(response) の結果のいずれかのインスタンスのような反復子

の戻り値の型 :

例外

list_web_apps

App Service Environment内のすべてのアプリを取得します。

「App Service Environment内のすべてのアプリを取得する」の説明。

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 Environmentの名前。 必須。

properties_to_include
str
必須

含めるアプリ プロパティのコンマ区切りの一覧。 既定値は [なし] です。

cls
callable

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

戻り値

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

の戻り値の型 :

例外

list_web_worker_metric_definitions

App Service Environmentのワーカー プールのメトリック定義を取得します。

「App Service Environmentのワーカー プールのメトリック定義を取得する」の説明。

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 Environmentの名前。 必須。

worker_pool_name
str
必須

ワーカー プールの名前。 必須。

cls
callable

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

戻り値

ResourceMetricDefinition または cls(response) の結果のいずれかのインスタンスのような反復子

の戻り値の型 :

例外

list_web_worker_usages

App Service Environmentのワーカー プールの使用状況メトリックを取得します。

「App Service Environmentのワーカー プールの使用状況メトリックを取得する」の説明。

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 Environmentの名前。 必須。

worker_pool_name
str
必須

ワーカー プールの名前。 必須。

cls
callable

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

戻り値

Usage または cls(response) の結果のインスタンスのような反復子

の戻り値の型 :

例外

list_worker_pool_instance_metric_definitions

App Service Environmentのワーカー プールの特定のインスタンスのメトリック定義を取得します。

「App Service Environmentのワーカー プールの特定のインスタンスのメトリック定義を取得する」の説明。

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 Environmentの名前。 必須。

worker_pool_name
str
必須

ワーカー プールの名前。 必須。

instance
str
必須

ワーカー プール内のインスタンスの名前。 必須。

cls
callable

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

戻り値

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

の戻り値の型 :

例外

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 Environmentの名前。 必須。

worker_pool_name
str
必須

ワーカー プールの名前。 必須。

cls
callable

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

戻り値

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

の戻り値の型 :

例外

list_worker_pools

App Service Environmentのすべてのワーカー プールを取得します。

「App Service Environmentのすべてのワーカー プールを取得する」の説明。

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

パラメーター

resource_group_name
str
必須

リソースが属しているリソース グループの名前。 必須。

name
str
必須

App Service Environmentの名前。 必須。

cls
callable

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

戻り値

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

の戻り値の型 :

例外

reboot

App Service Environment内のすべてのマシンを再起動します。

「App Service Environment内のすべてのマシンを再起動する」の説明。

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

パラメーター

resource_group_name
str
必須

リソースが属しているリソース グループの名前。 必須。

name
str
必須

App Service Environmentの名前。 必須。

cls
callable

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

戻り値

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

の戻り値の型 :

例外

test_upgrade_available_notification

このApp Service Environmentにアップグレードが使用可能であることをテスト通知で送信します。

このApp Service Environmentにアップグレードが使用可能であることをテスト通知で送信します。

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

パラメーター

resource_group_name
str
必須

リソースが属しているリソース グループの名前。 必須。

name
str
必須

App Service Environmentの名前。 必須。

cls
callable

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

戻り値

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

の戻り値の型 :

例外

update

App Service Environmentを作成または更新します。

「App Service Environmentを作成または更新する」の説明。

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 Environmentの名前。 必須。

hosting_environment_envelope
AppServiceEnvironmentPatchResource または IO
必須

App Service Environmentの構成の詳細。 AppServiceEnvironmentPatchResource 型または IO 型です。 必須。

content_type
str

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

cls
callable

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

戻り値

AppServiceEnvironmentResource または cls(response) の結果

の戻り値の型 :

例外

update_ase_custom_dns_suffix_configuration

App Service Environmentのカスタム DNS サフィックス構成を更新します。

App Service Environmentのカスタム 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 Environmentの名前。 必須。

custom_dns_suffix_configuration
CustomDnsSuffixConfiguration または IO
必須

CustomDnsSuffixConfiguration 型または IO 型のいずれかです。 必須。

content_type
str

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

cls
callable

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

戻り値

CustomDnsSuffixConfiguration または cls(response) の結果

の戻り値の型 :

例外

update_ase_networking_configuration

App Service Environment のネットワーク構成を更新します。

「App Service Environmentのネットワーク構成を更新する」の説明。

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 Environmentの名前。 必須。

ase_networking_configuration
AseV3NetworkingConfiguration または IO
必須

AseV3NetworkingConfiguration 型または IO 型のいずれかです。 必須。

content_type
str

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

cls
callable

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

戻り値

AseV3NetworkingConfiguration または cls(response) の結果

の戻り値の型 :

例外

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 Environmentの名前。 必須。

multi_role_pool_envelope
WorkerPoolResource または IO
必須

マルチロール プールのプロパティ。 WorkerPoolResource 型または IO 型です。 必須。

content_type
str

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

cls
callable

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

戻り値

WorkerPoolResource または cls(response) の結果

の戻り値の型 :

例外

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 Environmentの名前。 必須。

worker_pool_name
str
必須

ワーカー プールの名前。 必須。

worker_pool_envelope
WorkerPoolResource または IO
必須

ワーカー プールのプロパティ。 WorkerPoolResource 型または IO 型のいずれかです。 必須。

content_type
str

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

cls
callable

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

戻り値

WorkerPoolResource または cls(response) の結果

の戻り値の型 :

例外

属性

models

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