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.object

AppServiceEnvironmentsOperations

Constructor

AppServiceEnvironmentsOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

begin_change_vnet	Move an App Service Environment to a different VNET. Move an App Service Environment to a different VNET.
begin_create_or_update	Create or update an App Service Environment. Create or update an App Service Environment.
begin_create_or_update_multi_role_pool	Create or update a multi-role pool. Create or update a multi-role pool.
begin_create_or_update_worker_pool	Create or update a worker pool. Create or update a worker pool.
begin_delete	Delete an App Service Environment. Delete an App Service Environment.
begin_resume	Resume an App Service Environment. Resume an App Service Environment.
begin_suspend	Suspend an App Service Environment. Suspend an App Service Environment.
get	Get the properties of an App Service Environment. Get the properties of an App Service Environment.
get_diagnostics_item	Get a diagnostics item for an App Service Environment. 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. Get the network endpoints of all inbound dependencies of an App Service Environment.
get_multi_role_pool	Get properties of a multi-role pool. 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. Get the network endpoints of all outbound dependencies of an App Service Environment.
get_worker_pool	Get properties of a worker pool. Get properties of a worker pool.
list	Get all App Service Environments for a subscription. Get all App Service Environments for a subscription.
list_app_service_plans	Get all App Service plans in an App Service Environment. Get all App Service plans in an App Service Environment.
list_by_resource_group	Get all App Service Environments in a resource group. Get all App Service Environments in a resource group.
list_capacities	Get the used, available, and total worker capacity an App Service Environment. Get the used, available, and total worker capacity an App Service Environment.
list_diagnostics	Get diagnostic information for an App Service Environment. Get diagnostic information for an App Service Environment.
list_metric_definitions	Get global metric definitions of an App Service Environment. Get global metric definitions of an App Service Environment.
list_metrics	Get global metrics of an App Service Environment. Get global metrics of an App Service Environment.
list_multi_role_metric_definitions	Get metric definitions for a multi-role pool of an App Service Environment. Get metric definitions for a multi-role pool of an App Service Environment.
list_multi_role_metrics	Get metrics for a multi-role pool of an App Service Environment. Get metrics 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. Get metric definitions for a specific instance of a multi-role pool of an App Service Environment.
list_multi_role_pool_instance_metrics	Get metrics for a specific instance of a multi-role pool of an App Service Environment. Get metrics 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. Get available SKUs for scaling a multi-role pool.
list_multi_role_pools	Get all multi-role pools. Get all multi-role pools.
list_multi_role_usages	Get usage metrics for a multi-role pool of an App Service Environment. 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. List all currently running operations on the App Service Environment.
list_usages	Get global usage metrics of an App Service Environment. Get global usage metrics of an App Service Environment.
list_vips	Get IP addresses assigned to an App Service Environment. Get IP addresses assigned to an App Service Environment.
list_web_apps	Get all apps in an App Service Environment. 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. Get metric definitions for a worker pool of an App Service Environment.
list_web_worker_metrics	Get metrics for a worker pool of a AppServiceEnvironment (App Service Environment). Get metrics for a worker pool of a AppServiceEnvironment (App Service Environment).
list_web_worker_usages	Get usage metrics for a worker pool of an App Service Environment. 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. Get metric definitions for a specific instance of a worker pool of an App Service Environment.
list_worker_pool_instance_metrics	Get metrics for a specific instance of a worker pool of an App Service Environment. Get metrics 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. Get available SKUs for scaling a worker pool.
list_worker_pools	Get all worker pools of an App Service Environment. Get all worker pools of an App Service Environment.
reboot	Reboot all machines in an App Service Environment. Reboot all machines in an App Service Environment.
update	Create or update an App Service Environment. Create or update an App Service Environment.
update_multi_role_pool	Create or update a multi-role pool. Create or update a multi-role pool.
update_worker_pool	Create or update a worker pool. Create or update a worker pool.

begin_change_vnet

Move an App Service Environment to a different VNET.

Move an App Service Environment to a different VNET.

async begin_change_vnet(resource_group_name: str, name: str, vnet_info: azure.mgmt.web.v2018_02_01.models._models_py3.VirtualNetworkProfile, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.core.async_paging.AsyncItemPaged[_models.WebAppCollection]]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the App Service Environment.

vnet_info

VirtualNetworkProfile

Required

Details for the new virtual network.

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

AsyncLROPoller[AsyncItemPaged[WebAppCollection]]

Exceptions

HttpResponseError

begin_create_or_update

Create or update an App Service Environment.

Create or update an App Service Environment.

async begin_create_or_update(resource_group_name: str, name: str, hosting_environment_envelope: azure.mgmt.web.v2018_02_01.models._models_py3.AppServiceEnvironmentResource, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.web.v2018_02_01.models._models_py3.AppServiceEnvironmentResource]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the App Service Environment.

hosting_environment_envelope

AppServiceEnvironmentResource

Required

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

AsyncLROPoller[AppServiceEnvironmentResource]

Exceptions

HttpResponseError

begin_create_or_update_multi_role_pool

Create or update a multi-role pool.

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.v2018_02_01.models._models_py3.WorkerPoolResource, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.web.v2018_02_01.models._models_py3.WorkerPoolResource]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the App Service Environment.

multi_role_pool_envelope

WorkerPoolResource

Required

Properties of the multi-role pool.

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

AsyncLROPoller[WorkerPoolResource]

Exceptions

HttpResponseError

begin_create_or_update_worker_pool

Create or update a worker pool.

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.v2018_02_01.models._models_py3.WorkerPoolResource, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.web.v2018_02_01.models._models_py3.WorkerPoolResource]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the App Service Environment.

worker_pool_name

str

Required

Name of the worker pool.

worker_pool_envelope

WorkerPoolResource

Required

Properties of the worker pool.

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

AsyncLROPoller[WorkerPoolResource]

Exceptions

HttpResponseError

begin_delete

Delete an App Service Environment.

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

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the App Service Environment.

force_delete

bool

default value: None

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

AsyncLROPoller[None]

Exceptions

HttpResponseError

begin_resume

Resume an App Service Environment.

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

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name 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 an iterator like instance of either WebAppCollection or the result of cls(response)

Return type

AsyncLROPoller[AsyncItemPaged[WebAppCollection]]

Exceptions

HttpResponseError

begin_suspend

Suspend an App Service Environment.

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

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name 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 an iterator like instance of either WebAppCollection or the result of cls(response)

Return type

AsyncLROPoller[AsyncItemPaged[WebAppCollection]]

Exceptions

HttpResponseError

get

Get the properties of an App Service Environment.

Get the properties of an App Service Environment.

async get(resource_group_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2018_02_01.models._models_py3.AppServiceEnvironmentResource

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name 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

AppServiceEnvironmentResource

Exceptions

HttpResponseError

get_diagnostics_item

Get a diagnostics item for an App Service Environment.

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.v2018_02_01.models._models_py3.HostingEnvironmentDiagnostics

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the App Service Environment.

diagnostics_name

str

Required

Name of the diagnostics item.

cls

callable

A custom type or function that will be passed the direct response

Returns

HostingEnvironmentDiagnostics, or the result of cls(response)

Return type

HostingEnvironmentDiagnostics

Exceptions

HttpResponseError

get_inbound_network_dependencies_endpoints

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

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.v2018_02_01.models._models_py3.InboundEnvironmentEndpointCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the App Service Environment.

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

AsyncItemPaged[InboundEnvironmentEndpointCollection]

Exceptions

HttpResponseError

get_multi_role_pool

Get properties of a multi-role pool.

Get properties of a multi-role pool.

async get_multi_role_pool(resource_group_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2018_02_01.models._models_py3.WorkerPoolResource

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the App Service Environment.

cls

callable

A custom type or function that will be passed the direct response

Returns

WorkerPoolResource, or the result of cls(response)

Return type

WorkerPoolResource

Exceptions

HttpResponseError

get_outbound_network_dependencies_endpoints

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

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.v2018_02_01.models._models_py3.OutboundEnvironmentEndpointCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the App Service Environment.

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

AsyncItemPaged[OutboundEnvironmentEndpointCollection]

Exceptions

HttpResponseError

get_worker_pool

Get properties of a worker pool.

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.v2018_02_01.models._models_py3.WorkerPoolResource

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the App Service Environment.

worker_pool_name

str

Required

Name of the worker pool.

cls

callable

A custom type or function that will be passed the direct response

Returns

WorkerPoolResource, or the result of cls(response)

Return type

WorkerPoolResource

Exceptions

HttpResponseError

list

Get all App Service Environments for a subscription.

Get all App Service Environments for a subscription.

list(**kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2018_02_01.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

AsyncItemPaged[AppServiceEnvironmentCollection]

Exceptions

HttpResponseError

list_app_service_plans

Get all App Service plans in an App Service Environment.

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.v2018_02_01.models._models_py3.AppServicePlanCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the App Service Environment.

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

AsyncItemPaged[AppServicePlanCollection]

Exceptions

HttpResponseError

list_by_resource_group

Get all App Service Environments in a resource group.

Get all App Service Environments in a resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2018_02_01.models._models_py3.AppServiceEnvironmentCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

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

AsyncItemPaged[AppServiceEnvironmentCollection]

Exceptions

HttpResponseError

list_capacities

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

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.v2018_02_01.models._models_py3.StampCapacityCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the App Service Environment.

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

AsyncItemPaged[StampCapacityCollection]

Exceptions

HttpResponseError

list_diagnostics

Get diagnostic information for an App Service Environment.

Get diagnostic information for an App Service Environment.

async list_diagnostics(resource_group_name: str, name: str, **kwargs: Any) -> List[azure.mgmt.web.v2018_02_01.models._models_py3.HostingEnvironmentDiagnostics]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the App Service Environment.

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

list[HostingEnvironmentDiagnostics]

Exceptions

HttpResponseError

list_metric_definitions

Get global metric definitions of an App Service Environment.

Get global metric definitions of an App Service Environment.

async list_metric_definitions(resource_group_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2018_02_01.models._models_py3.MetricDefinition

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the App Service Environment.

cls

callable

A custom type or function that will be passed the direct response

Returns

MetricDefinition, or the result of cls(response)

Return type

MetricDefinition

Exceptions

HttpResponseError

list_metrics

Get global metrics of an App Service Environment.

Get global metrics of an App Service Environment.

list_metrics(resource_group_name: str, name: str, details: Optional[bool] = None, filter: Optional[str] = None, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2018_02_01.models._models_py3.ResourceMetricCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the App Service Environment.

details

bool

default value: None

Specify <code>true</code> to include instance details. The default is <code>false</code>.

filter

str

default value: None

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 ResourceMetricCollection or the result of cls(response)

Return type

AsyncItemPaged[ResourceMetricCollection]

Exceptions

HttpResponseError

list_multi_role_metric_definitions

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

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.v2018_02_01.models._models_py3.ResourceMetricDefinitionCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the App Service Environment.

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

AsyncItemPaged[ResourceMetricDefinitionCollection]

Exceptions

HttpResponseError

list_multi_role_metrics

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

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

list_multi_role_metrics(resource_group_name: str, name: str, start_time: Optional[str] = None, end_time: Optional[str] = None, time_grain: Optional[str] = None, details: Optional[bool] = None, filter: Optional[str] = None, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2018_02_01.models._models_py3.ResourceMetricCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the App Service Environment.

start_time

str

default value: None

Beginning time of the metrics query.

end_time

str

default value: None

End time of the metrics query.

time_grain

str

default value: None

Time granularity of the metrics query.

details

bool

default value: None

Specify <code>true</code> to include instance details. The default is <code>false</code>.

filter

str

default value: None

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 ResourceMetricCollection or the result of cls(response)

Return type

AsyncItemPaged[ResourceMetricCollection]

Exceptions

HttpResponseError

list_multi_role_pool_instance_metric_definitions

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

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.v2018_02_01.models._models_py3.ResourceMetricDefinitionCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the App Service Environment.

instance

str

Required

Name of the instance in the multi-role pool.

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

AsyncItemPaged[ResourceMetricDefinitionCollection]

Exceptions

HttpResponseError

list_multi_role_pool_instance_metrics

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

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

list_multi_role_pool_instance_metrics(resource_group_name: str, name: str, instance: str, details: Optional[bool] = None, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2018_02_01.models._models_py3.ResourceMetricCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the App Service Environment.

instance

str

Required

Name of the instance in the multi-role pool.

details

bool

default value: None

Specify <code>true</code> to include instance details. The default is <code>false</code>.

cls

callable

A custom type or function that will be passed the direct response

Returns

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

Return type

AsyncItemPaged[ResourceMetricCollection]

Exceptions

HttpResponseError

list_multi_role_pool_skus

Get available SKUs for scaling a multi-role pool.

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.v2018_02_01.models._models_py3.SkuInfoCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the App Service Environment.

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

AsyncItemPaged[SkuInfoCollection]

Exceptions

HttpResponseError

list_multi_role_pools

Get all multi-role pools.

Get all multi-role pools.

list_multi_role_pools(resource_group_name: str, name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2018_02_01.models._models_py3.WorkerPoolCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the App Service Environment.

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

AsyncItemPaged[WorkerPoolCollection]

Exceptions

HttpResponseError

list_multi_role_usages

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

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.v2018_02_01.models._models_py3.UsageCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the App Service Environment.

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

AsyncItemPaged[UsageCollection]

Exceptions

HttpResponseError

list_operations

List all currently running operations on the App Service Environment.

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.v2018_02_01.models._models_py3.Operation]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the App Service Environment.

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

list[Operation]

Exceptions

HttpResponseError

list_usages

Get global usage metrics of an App Service Environment.

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.v2018_02_01.models._models_py3.CsmUsageQuotaCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the App Service Environment.

filter

str

default value: None

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

AsyncItemPaged[CsmUsageQuotaCollection]

Exceptions

HttpResponseError

list_vips

Get IP addresses assigned to an App Service Environment.

Get IP addresses assigned to an App Service Environment.

async list_vips(resource_group_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2018_02_01.models._models_py3.AddressResponse

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the App Service Environment.

cls

callable

A custom type or function that will be passed the direct response

Returns

AddressResponse, or the result of cls(response)

Return type

AddressResponse

Exceptions

HttpResponseError

list_web_apps

Get all apps in an App Service Environment.

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.v2018_02_01.models._models_py3.WebAppCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the App Service Environment.

properties_to_include

str

default value: None

Comma separated list of app properties to include.

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

AsyncItemPaged[WebAppCollection]

Exceptions

HttpResponseError

list_web_worker_metric_definitions

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

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.v2018_02_01.models._models_py3.ResourceMetricDefinitionCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the App Service Environment.

worker_pool_name

str

Required

Name of the worker pool.

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

AsyncItemPaged[ResourceMetricDefinitionCollection]

Exceptions

HttpResponseError

list_web_worker_metrics

Get metrics for a worker pool of a AppServiceEnvironment (App Service Environment).

Get metrics for a worker pool of a AppServiceEnvironment (App Service Environment).

list_web_worker_metrics(resource_group_name: str, name: str, worker_pool_name: str, details: Optional[bool] = None, filter: Optional[str] = None, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2018_02_01.models._models_py3.ResourceMetricCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the App Service Environment.

worker_pool_name

str

Required

Name of worker pool.

details

bool

default value: None

Specify <code>true</code> to include instance details. The default is <code>false</code>.

filter

str

default value: None

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 ResourceMetricCollection or the result of cls(response)

Return type

AsyncItemPaged[ResourceMetricCollection]

Exceptions

HttpResponseError

list_web_worker_usages

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

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.v2018_02_01.models._models_py3.UsageCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the App Service Environment.

worker_pool_name

str

Required

Name of the worker pool.

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

AsyncItemPaged[UsageCollection]

Exceptions

HttpResponseError

list_worker_pool_instance_metric_definitions

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

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.v2018_02_01.models._models_py3.ResourceMetricDefinitionCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the App Service Environment.

worker_pool_name

str

Required

Name of the worker pool.

instance

str

Required

Name of the instance in the worker pool.

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

AsyncItemPaged[ResourceMetricDefinitionCollection]

Exceptions

HttpResponseError

list_worker_pool_instance_metrics

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

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

list_worker_pool_instance_metrics(resource_group_name: str, name: str, worker_pool_name: str, instance: str, details: Optional[bool] = None, filter: Optional[str] = None, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2018_02_01.models._models_py3.ResourceMetricCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the App Service Environment.

worker_pool_name

str

Required

Name of the worker pool.

instance

str

Required

Name of the instance in the worker pool.

details

bool

default value: None

Specify <code>true</code> to include instance details. The default is <code>false</code>.

filter

str

default value: None

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 ResourceMetricCollection or the result of cls(response)

Return type

AsyncItemPaged[ResourceMetricCollection]

Exceptions

HttpResponseError

list_worker_pool_skus

Get available SKUs for scaling a worker pool.

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.v2018_02_01.models._models_py3.SkuInfoCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the App Service Environment.

worker_pool_name

str

Required

Name of the worker pool.

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

AsyncItemPaged[SkuInfoCollection]

Exceptions

HttpResponseError

list_worker_pools

Get all worker pools of an App Service Environment.

Get all worker pools of an App Service Environment.

list_worker_pools(resource_group_name: str, name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2018_02_01.models._models_py3.WorkerPoolCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the App Service Environment.

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

AsyncItemPaged[WorkerPoolCollection]

Exceptions

HttpResponseError

reboot

Reboot all machines in an App Service Environment.

Reboot all machines in an App Service Environment.

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

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the App Service Environment.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

update

Create or update an App Service Environment.

Create or update an App Service Environment.

async update(resource_group_name: str, name: str, hosting_environment_envelope: azure.mgmt.web.v2018_02_01.models._models_py3.AppServiceEnvironmentPatchResource, **kwargs: Any) -> Optional[azure.mgmt.web.v2018_02_01.models._models_py3.AppServiceEnvironmentResource]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the App Service Environment.

hosting_environment_envelope

AppServiceEnvironmentPatchResource

Required

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

AppServiceEnvironmentResource,

None

Exceptions

HttpResponseError

update_multi_role_pool

Create or update a multi-role pool.

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.v2018_02_01.models._models_py3.WorkerPoolResource, **kwargs: Any) -> Optional[azure.mgmt.web.v2018_02_01.models._models_py3.WorkerPoolResource]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the App Service Environment.

multi_role_pool_envelope

WorkerPoolResource

Required

Properties of the multi-role pool.

cls

callable

A custom type or function that will be passed the direct response

Returns

WorkerPoolResource, or the result of cls(response)

Return type

WorkerPoolResource,

None

Exceptions

HttpResponseError

update_worker_pool

Create or update a worker pool.

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.v2018_02_01.models._models_py3.WorkerPoolResource, **kwargs: Any) -> Optional[azure.mgmt.web.v2018_02_01.models._models_py3.WorkerPoolResource]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the App Service Environment.

worker_pool_name

str

Required

Name of the worker pool.

worker_pool_envelope

WorkerPoolResource

Required

Properties of the worker pool.

cls

callable

A custom type or function that will be passed the direct response

Returns

WorkerPoolResource, or the result of cls(response)

Return type

WorkerPoolResource,

None

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.web.v2018_02_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\web\\v2018_02_01\\models\\__init__.py'>