AppServiceEnvironmentsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

WebSiteManagementClient's

<xref:app_service_environments> attribute.

Inheritance
builtins.object
AppServiceEnvironmentsOperations

Constructor

AppServiceEnvironmentsOperations(*args, **kwargs)

Methods

begin_approve_or_reject_private_endpoint_connection

Approves or rejects a private endpoint connection.

Description for Approves or rejects a private endpoint connection.

begin_change_vnet

Move an App Service Environment to a different VNET.

Description for Move an App Service Environment to a different VNET.

begin_create_or_update

Create or update an App Service Environment.

Description for Create or update an App Service Environment.

begin_create_or_update_multi_role_pool

Create or update a multi-role pool.

Description for Create or update a multi-role pool.

begin_create_or_update_worker_pool

Create or update a worker pool.

Description for Create or update a worker pool.

begin_delete

Delete an App Service Environment.

Description for Delete an App Service Environment.

begin_delete_private_endpoint_connection

Deletes a private endpoint connection.

Description for Deletes a private endpoint connection.

begin_resume

Resume an App Service Environment.

Description for Resume an App Service Environment.

begin_suspend

Suspend an App Service Environment.

Description for Suspend an App Service Environment.

begin_upgrade

Initiate an upgrade of an App Service Environment if one is available.

Description for Initiate an upgrade of an App Service Environment if one is available.

delete_ase_custom_dns_suffix_configuration

Delete Custom Dns Suffix configuration of an App Service Environment.

Delete Custom Dns Suffix configuration of an App Service Environment.

get

Get the properties of an App Service Environment.

Description for Get the properties of an App Service Environment.

get_ase_custom_dns_suffix_configuration

Get Custom Dns Suffix configuration of an App Service Environment.

Get Custom Dns Suffix configuration of an App Service Environment.

get_ase_v3_networking_configuration

Get networking configuration of an App Service Environment.

Description for Get networking configuration of an App Service Environment.

get_diagnostics_item

Get a diagnostics item for an App Service Environment.

Description for Get a diagnostics item for an App Service Environment.

get_inbound_network_dependencies_endpoints

Get the network endpoints of all inbound dependencies of an App Service Environment.

Description for Get the network endpoints of all inbound dependencies of an App Service Environment.

get_multi_role_pool

Get properties of a multi-role pool.

Description for Get properties of a multi-role pool.

get_outbound_network_dependencies_endpoints

Get the network endpoints of all outbound dependencies of an App Service Environment.

Description for Get the network endpoints of all outbound dependencies of an App Service Environment.

get_private_endpoint_connection

Gets a private endpoint connection.

Description for Gets a private endpoint connection.

get_private_endpoint_connection_list

Gets the list of private endpoints associated with a hosting environment.

Description for Gets the list of private endpoints associated with a hosting environment.

get_private_link_resources

Gets the private link resources.

Description for Gets the private link resources.

get_vip_info

Get IP addresses assigned to an App Service Environment.

Description for Get IP addresses assigned to an App Service Environment.

get_worker_pool

Get properties of a worker pool.

Description for Get properties of a worker pool.

list

Get all App Service Environments for a subscription.

Description for Get all App Service Environments for a subscription.

list_app_service_plans

Get all App Service plans in an App Service Environment.

Description for Get all App Service plans in an App Service Environment.

list_by_resource_group

Get all App Service Environments in a resource group.

Description for Get all App Service Environments in a resource group.

list_capacities

Get the used, available, and total worker capacity an App Service Environment.

Description for Get the used, available, and total worker capacity an App Service Environment.

list_diagnostics

Get diagnostic information for an App Service Environment.

Description for Get diagnostic information for an App Service Environment.

list_multi_role_metric_definitions

Get metric definitions for a multi-role pool of an App Service Environment.

Description for Get metric definitions for a multi-role pool of an App Service Environment.

list_multi_role_pool_instance_metric_definitions

Get metric definitions for a specific instance of a multi-role pool of an App Service Environment.

Description for Get metric definitions for a specific instance of a multi-role pool of an App Service Environment.

list_multi_role_pool_skus

Get available SKUs for scaling a multi-role pool.

Description for Get available SKUs for scaling a multi-role pool.

list_multi_role_pools

Get all multi-role pools.

Description for Get all multi-role pools.

list_multi_role_usages

Get usage metrics for a multi-role pool of an App Service Environment.

Description for Get usage metrics for a multi-role pool of an App Service Environment.

list_operations

List all currently running operations on the App Service Environment.

Description for List all currently running operations on the App Service Environment.

list_usages

Get global usage metrics of an App Service Environment.

Description for Get global usage metrics of an App Service Environment.

list_web_apps

Get all apps in an App Service Environment.

Description for Get all apps in an App Service Environment.

list_web_worker_metric_definitions

Get metric definitions for a worker pool of an App Service Environment.

Description for Get metric definitions for a worker pool of an App Service Environment.

list_web_worker_usages

Get usage metrics for a worker pool of an App Service Environment.

Description for Get usage metrics for a worker pool of an App Service Environment.

list_worker_pool_instance_metric_definitions

Get metric definitions for a specific instance of a worker pool of an App Service Environment.

Description for Get metric definitions for a specific instance of a worker pool of an App Service Environment.

list_worker_pool_skus

Get available SKUs for scaling a worker pool.

Description for Get available SKUs for scaling a worker pool.

list_worker_pools

Get all worker pools of an App Service Environment.

Description for Get all worker pools of an App Service Environment.

reboot

Reboot all machines in an App Service Environment.

Description for Reboot all machines in an App Service Environment.

test_upgrade_available_notification

Send a test notification that an upgrade is available for this App Service Environment.

Send a test notification that an upgrade is available for this App Service Environment.

update

Create or update an App Service Environment.

Description for Create or update an App Service Environment.

update_ase_custom_dns_suffix_configuration

Update Custom Dns Suffix configuration of an App Service Environment.

Update Custom Dns Suffix configuration of an App Service Environment.

update_ase_networking_configuration

Update networking configuration of an App Service Environment.

Description for Update networking configuration of an App Service Environment.

update_multi_role_pool

Create or update a multi-role pool.

Description for Create or update a multi-role pool.

update_worker_pool

Create or update a worker pool.

Description for Create or update a worker pool.

begin_approve_or_reject_private_endpoint_connection

Approves or rejects a private endpoint connection.

Description for Approves or rejects a 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.RemotePrivateEndpointConnectionARMResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.RemotePrivateEndpointConnectionARMResource]

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

private_endpoint_connection_name
Required
str

Required.

private_endpoint_wrapper
Required

Is either a RemotePrivateEndpointConnectionARMResource type or a IO[bytes] type. Required.

Returns

Type Description

An instance of LROPoller that returns either RemotePrivateEndpointConnectionARMResource or the result of cls(response)

Exceptions

Type Description

begin_change_vnet

Move an App Service Environment to a different VNET.

Description for Move an App Service Environment to a different 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']]

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

vnet_info
Required

Details for the new virtual network. Is either a VirtualNetworkProfile type or a IO[bytes] type. Required.

Returns

Type Description

An instance of LROPoller that returns an iterator like instance of either WebAppCollection or the result of cls(response)

Exceptions

Type Description

begin_create_or_update

Create or update an App Service Environment.

Description for Create or update an 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]

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

hosting_environment_envelope
Required

Configuration details of the App Service Environment. Is either a AppServiceEnvironmentResource type or a IO[bytes] type. Required.

Returns

Type Description

An instance of LROPoller that returns either AppServiceEnvironmentResource or the result of cls(response)

Exceptions

Type Description

begin_create_or_update_multi_role_pool

Create or update a multi-role pool.

Description for Create or update a 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]

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

multi_role_pool_envelope
Required

Properties of the multi-role pool. Is either a WorkerPoolResource type or a IO[bytes] type. Required.

Returns

Type Description

An instance of LROPoller that returns either WorkerPoolResource or the result of cls(response)

Exceptions

Type Description

begin_create_or_update_worker_pool

Create or update a worker pool.

Description for Create or update a 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]

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

worker_pool_name
Required
str

Name of the worker pool. Required.

worker_pool_envelope
Required

Properties of the worker pool. Is either a WorkerPoolResource type or a IO[bytes] type. Required.

Returns

Type Description

An instance of LROPoller that returns either WorkerPoolResource or the result of cls(response)

Exceptions

Type Description

begin_delete

Delete an App Service Environment.

Description for Delete an App Service Environment.

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

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

force_delete
Required

Specify <code>true</code> to force the deletion even if the App Service Environment contains resources. The default is <code>false</code>. Default value is None.

Returns

Type Description

An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type Description

begin_delete_private_endpoint_connection

Deletes a private endpoint connection.

Description for Deletes a 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]]

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

private_endpoint_connection_name
Required
str

Required.

Returns

Type Description
LROPoller[<xref:JSON>]

An instance of LROPoller that returns either JSON or the result of cls(response)

Exceptions

Type Description

begin_resume

Resume an App Service Environment.

Description for Resume an App Service Environment.

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

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

Returns

Type Description

An instance of LROPoller that returns an iterator like instance of either WebAppCollection or the result of cls(response)

Exceptions

Type Description

begin_suspend

Suspend an App Service Environment.

Description for Suspend an App Service Environment.

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

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

Returns

Type Description

An instance of LROPoller that returns an iterator like instance of either WebAppCollection or the result of cls(response)

Exceptions

Type Description

begin_upgrade

Initiate an upgrade of an App Service Environment if one is available.

Description for Initiate an upgrade of an App Service Environment if one is available.

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

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

Returns

Type Description

An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type Description

delete_ase_custom_dns_suffix_configuration

Delete Custom Dns Suffix configuration of an App Service Environment.

Delete Custom Dns Suffix configuration of an App Service Environment.

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

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

Returns

Type Description
<xref:JSON>

JSON or the result of cls(response)

Exceptions

Type Description

get

Get the properties of an App Service Environment.

Description for Get the properties of an App Service Environment.

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

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

Returns

Type Description

AppServiceEnvironmentResource or the result of cls(response)

Exceptions

Type Description

get_ase_custom_dns_suffix_configuration

Get Custom Dns Suffix configuration of an App Service Environment.

Get Custom Dns Suffix configuration of an App Service Environment.

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

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

Returns

Type Description

CustomDnsSuffixConfiguration or the result of cls(response)

Exceptions

Type Description

get_ase_v3_networking_configuration

Get networking configuration of an App Service Environment.

Description for Get networking configuration of an App Service Environment.

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

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

Returns

Type Description

AseV3NetworkingConfiguration or the result of cls(response)

Exceptions

Type Description

get_diagnostics_item

Get a diagnostics item for an App Service Environment.

Description for Get a diagnostics item for an App Service Environment.

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

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

diagnostics_name
Required
str

Name of the diagnostics item. Required.

Returns

Type Description

HostingEnvironmentDiagnostics or the result of cls(response)

Exceptions

Type Description

get_inbound_network_dependencies_endpoints

Get the network endpoints of all inbound dependencies of an App Service Environment.

Description for Get the network endpoints of all inbound dependencies of an App Service Environment.

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

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

Returns

Type Description

An iterator like instance of either InboundEnvironmentEndpoint or the result of cls(response)

Exceptions

Type Description

get_multi_role_pool

Get properties of a multi-role pool.

Description for Get properties of a multi-role pool.

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

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

Returns

Type Description

WorkerPoolResource or the result of cls(response)

Exceptions

Type Description

get_outbound_network_dependencies_endpoints

Get the network endpoints of all outbound dependencies of an App Service Environment.

Description for Get the network endpoints of all outbound dependencies of an App Service Environment.

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

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

Returns

Type Description

An iterator like instance of either OutboundEnvironmentEndpoint or the result of cls(response)

Exceptions

Type Description

get_private_endpoint_connection

Gets a private endpoint connection.

Description for Gets a private endpoint connection.

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

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

private_endpoint_connection_name
Required
str

Name of the private endpoint connection. Required.

Returns

Type Description

RemotePrivateEndpointConnectionARMResource or the result of cls(response)

Exceptions

Type Description

get_private_endpoint_connection_list

Gets the list of private endpoints associated with a hosting environment.

Description for Gets the list of private endpoints associated with a hosting environment.

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

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

Returns

Type Description

An iterator like instance of either RemotePrivateEndpointConnectionARMResource or the result of cls(response)

Exceptions

Type Description

Gets the private link resources.

Description for Gets the private link resources.

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

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

Returns

Type Description

PrivateLinkResourcesWrapper or the result of cls(response)

Exceptions

Type Description

get_vip_info

Get IP addresses assigned to an App Service Environment.

Description for Get IP addresses assigned to an App Service Environment.

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

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

Returns

Type Description

AddressResponse or the result of cls(response)

Exceptions

Type Description

get_worker_pool

Get properties of a worker pool.

Description for Get properties of a worker pool.

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

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

worker_pool_name
Required
str

Name of the worker pool. Required.

Returns

Type Description

WorkerPoolResource or the result of cls(response)

Exceptions

Type Description

list

Get all App Service Environments for a subscription.

Description for Get all App Service Environments for a subscription.

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

Returns

Type Description

An iterator like instance of either AppServiceEnvironmentResource or the result of cls(response)

Exceptions

Type Description

list_app_service_plans

Get all App Service plans in an App Service Environment.

Description for Get all App Service plans in an App Service Environment.

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

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

Returns

Type Description

An iterator like instance of either AppServicePlan or the result of cls(response)

Exceptions

Type Description

list_by_resource_group

Get all App Service Environments in a resource group.

Description for Get all App Service Environments in a resource group.

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

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

Returns

Type Description

An iterator like instance of either AppServiceEnvironmentResource or the result of cls(response)

Exceptions

Type Description

list_capacities

Get the used, available, and total worker capacity an App Service Environment.

Description for Get the used, available, and total worker capacity an App Service Environment.

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

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

Returns

Type Description

An iterator like instance of either StampCapacity or the result of cls(response)

Exceptions

Type Description

list_diagnostics

Get diagnostic information for an App Service Environment.

Description for Get diagnostic information for an App Service Environment.

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

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

Returns

Type Description

list of HostingEnvironmentDiagnostics or the result of cls(response)

Exceptions

Type Description

list_multi_role_metric_definitions

Get metric definitions for a multi-role pool of an App Service Environment.

Description for Get metric definitions for a multi-role pool of an App Service Environment.

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

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

Returns

Type Description

An iterator like instance of either ResourceMetricDefinition or the result of cls(response)

Exceptions

Type Description

list_multi_role_pool_instance_metric_definitions

Get metric definitions for a specific instance of a multi-role pool of an App Service Environment.

Description for Get metric definitions for a specific instance of a multi-role pool of an App Service Environment.

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

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

instance
Required
str

Name of the instance in the multi-role pool. Required.

Returns

Type Description

An iterator like instance of either ResourceMetricDefinition or the result of cls(response)

Exceptions

Type Description

list_multi_role_pool_skus

Get available SKUs for scaling a multi-role pool.

Description for Get available SKUs for scaling a multi-role pool.

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

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

Returns

Type Description

An iterator like instance of either SkuInfo or the result of cls(response)

Exceptions

Type Description

list_multi_role_pools

Get all multi-role pools.

Description for Get all multi-role pools.

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

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

Returns

Type Description

An iterator like instance of either WorkerPoolResource or the result of cls(response)

Exceptions

Type Description

list_multi_role_usages

Get usage metrics for a multi-role pool of an App Service Environment.

Description for Get usage metrics for a multi-role pool of an App Service Environment.

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

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

Returns

Type Description

An iterator like instance of either Usage or the result of cls(response)

Exceptions

Type Description

list_operations

List all currently running operations on the App Service Environment.

Description for List all currently running operations on the App Service Environment.

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

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

Returns

Type Description

list of Operation or the result of cls(response)

Exceptions

Type Description

list_usages

Get global usage metrics of an App Service Environment.

Description for Get global usage metrics of an App Service Environment.

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

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

filter
Required
str

Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $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|Minute|Day]'. Default value is None.

Returns

Type Description

An iterator like instance of either CsmUsageQuota or the result of cls(response)

Exceptions

Type Description

list_web_apps

Get all apps in an App Service Environment.

Description for Get all apps in an App Service Environment.

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

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

properties_to_include
Required
str

Comma separated list of app properties to include. Default value is None.

Returns

Type Description

An iterator like instance of either Site or the result of cls(response)

Exceptions

Type Description

list_web_worker_metric_definitions

Get metric definitions for a worker pool of an App Service Environment.

Description for Get metric definitions for a worker pool of an App Service Environment.

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

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

worker_pool_name
Required
str

Name of the worker pool. Required.

Returns

Type Description

An iterator like instance of either ResourceMetricDefinition or the result of cls(response)

Exceptions

Type Description

list_web_worker_usages

Get usage metrics for a worker pool of an App Service Environment.

Description for Get usage metrics for a worker pool of an App Service Environment.

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

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

worker_pool_name
Required
str

Name of the worker pool. Required.

Returns

Type Description

An iterator like instance of either Usage or the result of cls(response)

Exceptions

Type Description

list_worker_pool_instance_metric_definitions

Get metric definitions for a specific instance of a worker pool of an App Service Environment.

Description for Get metric definitions for a specific instance of a worker pool of an 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]

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

worker_pool_name
Required
str

Name of the worker pool. Required.

instance
Required
str

Name of the instance in the worker pool. Required.

Returns

Type Description

An iterator like instance of either ResourceMetricDefinition or the result of cls(response)

Exceptions

Type Description

list_worker_pool_skus

Get available SKUs for scaling a worker pool.

Description for Get available SKUs for scaling a worker pool.

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

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

worker_pool_name
Required
str

Name of the worker pool. Required.

Returns

Type Description

An iterator like instance of either SkuInfo or the result of cls(response)

Exceptions

Type Description

list_worker_pools

Get all worker pools of an App Service Environment.

Description for Get all worker pools of an App Service Environment.

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

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

Returns

Type Description

An iterator like instance of either WorkerPoolResource or the result of cls(response)

Exceptions

Type Description

reboot

Reboot all machines in an App Service Environment.

Description for Reboot all machines in an App Service Environment.

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

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

Returns

Type Description

None or the result of cls(response)

Exceptions

Type Description

test_upgrade_available_notification

Send a test notification that an upgrade is available for this App Service Environment.

Send a test notification that an upgrade is available for this App Service Environment.

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

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

Returns

Type Description

None or the result of cls(response)

Exceptions

Type Description

update

Create or update an App Service Environment.

Description for Create or update an App Service Environment.

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

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

hosting_environment_envelope
Required

Configuration details of the App Service Environment. Is either a AppServiceEnvironmentPatchResource type or a IO[bytes] type. Required.

Returns

Type Description

AppServiceEnvironmentResource or the result of cls(response)

Exceptions

Type Description

update_ase_custom_dns_suffix_configuration

Update Custom Dns Suffix configuration of an App Service Environment.

Update Custom Dns Suffix configuration of an App Service Environment.

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

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

custom_dns_suffix_configuration
Required

Is either a CustomDnsSuffixConfiguration type or a IO[bytes] type. Required.

Returns

Type Description

CustomDnsSuffixConfiguration or the result of cls(response)

Exceptions

Type Description

update_ase_networking_configuration

Update networking configuration of an App Service Environment.

Description for Update networking configuration of an 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

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

ase_networking_configuration
Required

Is either a AseV3NetworkingConfiguration type or a IO[bytes] type. Required.

Returns

Type Description

AseV3NetworkingConfiguration or the result of cls(response)

Exceptions

Type Description

update_multi_role_pool

Create or update a multi-role pool.

Description for Create or update a 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

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

multi_role_pool_envelope
Required

Properties of the multi-role pool. Is either a WorkerPoolResource type or a IO[bytes] type. Required.

Returns

Type Description

WorkerPoolResource or the result of cls(response)

Exceptions

Type Description

update_worker_pool

Create or update a worker pool.

Description for Create or update a 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

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Name of the App Service Environment. Required.

worker_pool_name
Required
str

Name of the worker pool. Required.

worker_pool_envelope
Required

Properties of the worker pool. Is either a WorkerPoolResource type or a IO[bytes] type. Required.

Returns

Type Description

WorkerPoolResource or the result of cls(response)

Exceptions

Type Description

Attributes

models

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