AppServiceEnvironmentsOperations Class
AppServiceEnvironmentsOperations async operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Inheritance
-
builtins.objectAppServiceEnvironmentsOperations
Constructor
AppServiceEnvironmentsOperations(client, config, serializer, deserializer)Parameters
- client
Client for service requests.
- config
Configuration of service client.
- serializer
An object model serializer.
- deserializer
An object model deserializer.
Variables
- models
Alias to model classes used in this operation group.
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. |
| get |
Get the properties of an App Service Environment. Description for Get the properties 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. |
| update |
Create or update an App Service Environment. Description for Create or update 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.
async begin_approve_or_reject_private_endpoint_connection(resource_group_name: str, name: str, private_endpoint_connection_name: str, private_endpoint_wrapper: azure.mgmt.web.v2021_01_15.models._models_py3.PrivateLinkConnectionApprovalRequestResource, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.web.v2021_01_15.models._models_py3.RemotePrivateEndpointConnectionARMResource]Parameters
- private_endpoint_connection_name
- str
- private_endpoint_wrapper
- PrivateLinkConnectionApprovalRequestResource
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of AsyncLROPoller that returns either RemotePrivateEndpointConnectionARMResource or the result of cls(response)
Return type
Exceptions
begin_change_vnet
Move an App Service Environment to a different VNET.
Description for Move an App Service Environment to a different VNET.
async begin_change_vnet(resource_group_name: str, name: str, vnet_info: azure.mgmt.web.v2021_01_15.models._models_py3.VirtualNetworkProfile, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.core.async_paging.AsyncItemPaged[_models.WebAppCollection]]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of AsyncLROPoller that returns an iterator like instance of either WebAppCollection or the result of cls(response)
Return type
Exceptions
begin_create_or_update
Create or update an App Service Environment.
Description for Create or update an App Service Environment.
async begin_create_or_update(resource_group_name: str, name: str, hosting_environment_envelope: azure.mgmt.web.v2021_01_15.models._models_py3.AppServiceEnvironmentResource, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.web.v2021_01_15.models._models_py3.AppServiceEnvironmentResource]Parameters
- hosting_environment_envelope
- AppServiceEnvironmentResource
Configuration details of the App Service Environment.
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of AsyncLROPoller that returns either AppServiceEnvironmentResource or the result of cls(response)
Return type
Exceptions
begin_create_or_update_multi_role_pool
Create or update a multi-role pool.
Description for Create or update a multi-role pool.
async begin_create_or_update_multi_role_pool(resource_group_name: str, name: str, multi_role_pool_envelope: azure.mgmt.web.v2021_01_15.models._models_py3.WorkerPoolResource, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.web.v2021_01_15.models._models_py3.WorkerPoolResource]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of AsyncLROPoller that returns either WorkerPoolResource or the result of cls(response)
Return type
Exceptions
begin_create_or_update_worker_pool
Create or update a worker pool.
Description for Create or update a worker pool.
async begin_create_or_update_worker_pool(resource_group_name: str, name: str, worker_pool_name: str, worker_pool_envelope: azure.mgmt.web.v2021_01_15.models._models_py3.WorkerPoolResource, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.web.v2021_01_15.models._models_py3.WorkerPoolResource]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of AsyncLROPoller that returns either WorkerPoolResource or the result of cls(response)
Return type
Exceptions
begin_delete
Delete an App Service Environment.
Description for Delete an App Service Environment.
async begin_delete(resource_group_name: str, name: str, force_delete: Optional[bool] = None, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]Parameters
- force_delete
- bool
Specify <code>true</code> to force the deletion even if the App
Service Environment contains resources. The default is <code>false</code>.
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of AsyncLROPoller that returns either None or the result of cls(response)
Return type
Exceptions
begin_delete_private_endpoint_connection
Deletes a private endpoint connection.
Description for Deletes a private endpoint connection.
async begin_delete_private_endpoint_connection(resource_group_name: str, name: str, private_endpoint_connection_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[Any]Parameters
- private_endpoint_connection_name
- str
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of AsyncLROPoller that returns either any or the result of cls(response)
Return type
Exceptions
begin_resume
Resume an App Service Environment.
Description for Resume an App Service Environment.
async begin_resume(resource_group_name: str, name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.core.async_paging.AsyncItemPaged[_models.WebAppCollection]]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of AsyncLROPoller that returns an iterator like instance of either WebAppCollection or the result of cls(response)
Return type
Exceptions
begin_suspend
Suspend an App Service Environment.
Description for Suspend an App Service Environment.
async begin_suspend(resource_group_name: str, name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.core.async_paging.AsyncItemPaged[_models.WebAppCollection]]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of AsyncLROPoller that returns an iterator like instance of either WebAppCollection or the result of cls(response)
Return type
Exceptions
get
Get the properties of an App Service Environment.
Description for Get the properties of an App Service Environment.
async get(resource_group_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.AppServiceEnvironmentResourceParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
AppServiceEnvironmentResource, or the result of cls(response)
Return type
Exceptions
get_ase_v3_networking_configuration
Get networking configuration of an App Service Environment.
Description for Get networking configuration of an App Service Environment.
async get_ase_v3_networking_configuration(resource_group_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.AseV3NetworkingConfigurationParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
AseV3NetworkingConfiguration, or the result of cls(response)
Return type
Exceptions
get_diagnostics_item
Get a diagnostics item for an App Service Environment.
Description for Get a diagnostics item for an App Service Environment.
async get_diagnostics_item(resource_group_name: str, name: str, diagnostics_name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.HostingEnvironmentDiagnosticsParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
HostingEnvironmentDiagnostics, or the result of cls(response)
Return type
Exceptions
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) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.InboundEnvironmentEndpointCollection]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either InboundEnvironmentEndpointCollection or the result of cls(response)
Return type
Exceptions
get_multi_role_pool
Get properties of a multi-role pool.
Description for Get properties of a multi-role pool.
async get_multi_role_pool(resource_group_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.WorkerPoolResourceParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
WorkerPoolResource, or the result of cls(response)
Return type
Exceptions
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) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.OutboundEnvironmentEndpointCollection]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either OutboundEnvironmentEndpointCollection or the result of cls(response)
Return type
Exceptions
get_private_endpoint_connection
Gets a private endpoint connection.
Description for Gets a private endpoint connection.
async get_private_endpoint_connection(resource_group_name: str, name: str, private_endpoint_connection_name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.RemotePrivateEndpointConnectionARMResourceParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
RemotePrivateEndpointConnectionARMResource, or the result of cls(response)
Return type
Exceptions
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) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.PrivateEndpointConnectionCollection]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either PrivateEndpointConnectionCollection or the result of cls(response)
Return type
Exceptions
get_private_link_resources
Gets the private link resources.
Description for Gets the private link resources.
async get_private_link_resources(resource_group_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.PrivateLinkResourcesWrapperParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
PrivateLinkResourcesWrapper, or the result of cls(response)
Return type
Exceptions
get_vip_info
Get IP addresses assigned to an App Service Environment.
Description for Get IP addresses assigned to an App Service Environment.
async get_vip_info(resource_group_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.AddressResponseParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
AddressResponse, or the result of cls(response)
Return type
Exceptions
get_worker_pool
Get properties of a worker pool.
Description for Get properties of a worker pool.
async get_worker_pool(resource_group_name: str, name: str, worker_pool_name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.WorkerPoolResourceParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
WorkerPoolResource, or the result of cls(response)
Return type
Exceptions
list
Get all App Service Environments for a subscription.
Description for Get all App Service Environments for a subscription.
list(**kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.AppServiceEnvironmentCollection]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either AppServiceEnvironmentCollection or the result of cls(response)
Return type
Exceptions
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) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.AppServicePlanCollection]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either AppServicePlanCollection or the result of cls(response)
Return type
Exceptions
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) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.AppServiceEnvironmentCollection]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either AppServiceEnvironmentCollection or the result of cls(response)
Return type
Exceptions
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) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.StampCapacityCollection]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either StampCapacityCollection or the result of cls(response)
Return type
Exceptions
list_diagnostics
Get diagnostic information for an App Service Environment.
Description for Get diagnostic information for an App Service Environment.
async list_diagnostics(resource_group_name: str, name: str, **kwargs: Any) -> List[azure.mgmt.web.v2021_01_15.models._models_py3.HostingEnvironmentDiagnostics]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
list of HostingEnvironmentDiagnostics, or the result of cls(response)
Return type
Exceptions
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) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.ResourceMetricDefinitionCollection]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either ResourceMetricDefinitionCollection or the result of cls(response)
Return type
Exceptions
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) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.ResourceMetricDefinitionCollection]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either ResourceMetricDefinitionCollection or the result of cls(response)
Return type
Exceptions
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) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.SkuInfoCollection]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either SkuInfoCollection or the result of cls(response)
Return type
Exceptions
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) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.WorkerPoolCollection]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either WorkerPoolCollection or the result of cls(response)
Return type
Exceptions
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) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.UsageCollection]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either UsageCollection or the result of cls(response)
Return type
Exceptions
list_operations
List all currently running operations on the App Service Environment.
Description for List all currently running operations on the App Service Environment.
async list_operations(resource_group_name: str, name: str, **kwargs: Any) -> List[azure.mgmt.web.v2021_01_15.models._models_py3.Operation]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
list of Operation, or the result of cls(response)
Return type
Exceptions
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: Optional[str] = None, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.CsmUsageQuotaCollection]Parameters
- filter
- 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]'.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either CsmUsageQuotaCollection or the result of cls(response)
Return type
Exceptions
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: Optional[str] = None, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.WebAppCollection]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either WebAppCollection or the result of cls(response)
Return type
Exceptions
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) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.ResourceMetricDefinitionCollection]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either ResourceMetricDefinitionCollection or the result of cls(response)
Return type
Exceptions
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) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.UsageCollection]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either UsageCollection or the result of cls(response)
Return type
Exceptions
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) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.ResourceMetricDefinitionCollection]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either ResourceMetricDefinitionCollection or the result of cls(response)
Return type
Exceptions
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) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.SkuInfoCollection]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either SkuInfoCollection or the result of cls(response)
Return type
Exceptions
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) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.WorkerPoolCollection]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either WorkerPoolCollection or the result of cls(response)
Return type
Exceptions
reboot
Reboot all machines in an App Service Environment.
Description for Reboot all machines in an App Service Environment.
async reboot(resource_group_name: str, name: str, **kwargs: Any) -> NoneParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
None, or the result of cls(response)
Return type
Exceptions
update
Create or update an App Service Environment.
Description for Create or update an App Service Environment.
async update(resource_group_name: str, name: str, hosting_environment_envelope: azure.mgmt.web.v2021_01_15.models._models_py3.AppServiceEnvironmentPatchResource, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.AppServiceEnvironmentResourceParameters
- hosting_environment_envelope
- AppServiceEnvironmentPatchResource
Configuration details of the App Service Environment.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
AppServiceEnvironmentResource, or the result of cls(response)
Return type
Exceptions
update_ase_networking_configuration
Update networking configuration of an App Service Environment.
Description for Update networking configuration of an App Service Environment.
async update_ase_networking_configuration(resource_group_name: str, name: str, ase_networking_configuration: azure.mgmt.web.v2021_01_15.models._models_py3.AseV3NetworkingConfiguration, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.AseV3NetworkingConfigurationParameters
- ase_networking_configuration
- AseV3NetworkingConfiguration
- cls
- callable
A custom type or function that will be passed the direct response
Returns
AseV3NetworkingConfiguration, or the result of cls(response)
Return type
Exceptions
update_multi_role_pool
Create or update a multi-role pool.
Description for Create or update a multi-role pool.
async update_multi_role_pool(resource_group_name: str, name: str, multi_role_pool_envelope: azure.mgmt.web.v2021_01_15.models._models_py3.WorkerPoolResource, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.WorkerPoolResourceParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
WorkerPoolResource, or the result of cls(response)
Return type
Exceptions
update_worker_pool
Create or update a worker pool.
Description for Create or update a worker pool.
async update_worker_pool(resource_group_name: str, name: str, worker_pool_name: str, worker_pool_envelope: azure.mgmt.web.v2021_01_15.models._models_py3.WorkerPoolResource, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.WorkerPoolResourceParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
WorkerPoolResource, or the result of cls(response)
Return type
Exceptions
Attributes
models
models = <module 'azure.mgmt.web.v2021_01_15.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\web\\v2021_01_15\\models\\__init__.py'>Feedback
Submit and view feedback for