azure.mgmt.web.v2016_09_01.operations module¶

class azure.mgmt.web.v2016_09_01.operations.AppServiceEnvironmentsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

AppServiceEnvironmentsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – API Version. Constant value: “2016-09-01”.

create_or_update(resource_group_name, name, hosting_environment_envelope, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Create or update an App Service Environment.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service Environment.
hosting_environment_envelope (AppServiceEnvironmentResource) – Configuration details of the App Service Environment.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns AppServiceEnvironmentResource or ClientRawResponse<AppServiceEnvironmentResource> if raw==True

Return type

AzureOperationPoller[AppServiceEnvironmentResource] or AzureOperationPoller[ClientRawResponse[AppServiceEnvironmentResource]]

Raises

CloudError

create_or_update_multi_role_pool(resource_group_name, name, multi_role_pool_envelope, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Create or update a multi-role pool.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service Environment.
multi_role_pool_envelope (WorkerPoolResource) – Properties of the multi-role pool.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns WorkerPoolResource or ClientRawResponse<WorkerPoolResource> if raw==True

Return type

AzureOperationPoller[WorkerPoolResource] or AzureOperationPoller[ClientRawResponse[WorkerPoolResource]]

Raises

CloudError

create_or_update_worker_pool(resource_group_name, name, worker_pool_name, worker_pool_envelope, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Create or update a worker pool.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service Environment.
worker_pool_name (str) – Name of the worker pool.
worker_pool_envelope (WorkerPoolResource) – Properties of the worker pool.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns WorkerPoolResource or ClientRawResponse<WorkerPoolResource> if raw==True

Return type

AzureOperationPoller[WorkerPoolResource] or AzureOperationPoller[ClientRawResponse[WorkerPoolResource]]

Raises

CloudError

delete(resource_group_name, name, force_delete=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Delete an App Service Environment.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service Environment.
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>.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶

Get the properties of an App Service Environment.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service Environment.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

AppServiceEnvironmentResource or ClientRawResponse if raw=true

Return type

AppServiceEnvironmentResource or ClientRawResponse

Raises

CloudError

get_diagnostics_item(resource_group_name, name, diagnostics_name, custom_headers=None, raw=False, **operation_config)[source]¶

Get a diagnostics item for an App Service Environment.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service Environment.
diagnostics_name (str) – Name of the diagnostics item.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

HostingEnvironmentDiagnostics or ClientRawResponse if raw=true

Return type

HostingEnvironmentDiagnostics or ClientRawResponse

Raises

CloudError

get_multi_role_pool(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶

Get properties of a multi-role pool.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service Environment.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

WorkerPoolResource or ClientRawResponse if raw=true

Return type

WorkerPoolResource or ClientRawResponse

Raises

CloudError

get_worker_pool(resource_group_name, name, worker_pool_name, custom_headers=None, raw=False, **operation_config)[source]¶

Get properties of a worker pool.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service Environment.
worker_pool_name (str) – Name of the worker pool.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

WorkerPoolResource or ClientRawResponse if raw=true

Return type

WorkerPoolResource or ClientRawResponse

Raises

CloudError

list(custom_headers=None, raw=False, **operation_config)[source]¶

Get all App Service Environments for a subscription.

Parameters

custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of AppServiceEnvironmentResource

Return type

AppServiceEnvironmentResourcePaged[AppServiceEnvironmentResource]

Raises

CloudError

list_app_service_plans(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶

Get all App Service plans in an App Service Environment.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service Environment.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of AppServicePlan

Return type

AppServicePlanPaged[AppServicePlan]

Raises

CloudError

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Get all App Service Environments in a resource group.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of AppServiceEnvironmentResource

Return type

AppServiceEnvironmentResourcePaged[AppServiceEnvironmentResource]

Raises

CloudError

list_capacities(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service Environment.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of StampCapacity

Return type

StampCapacityPaged[StampCapacity]

Raises

CloudError

list_diagnostics(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶

Get diagnostic information for an App Service Environment.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service Environment.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[HostingEnvironmentDiagnostics] or ClientRawResponse

Raises

CloudError

list_metric_definitions(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶

Get global metric definitions of an App Service Environment.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service Environment.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

MetricDefinition or ClientRawResponse if raw=true

Return type

MetricDefinition or ClientRawResponse

Raises

CloudError

list_metrics(resource_group_name, name, details=None, filter=None, custom_headers=None, raw=False, **operation_config)[source]¶

Get global metrics of an App Service Environment.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service Environment.
details (bool) – Specify <code>true</code> to include instance details. The default is <code>false</code>.
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]’.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ResourceMetric

Return type

ResourceMetricPaged[ResourceMetric]

Raises

CloudError

list_multi_role_metric_definitions(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service Environment.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ResourceMetricDefinition

Return type

ResourceMetricDefinitionPaged[ResourceMetricDefinition]

Raises

CloudError

list_multi_role_metrics(resource_group_name, name, start_time=None, end_time=None, time_grain=None, details=None, filter=None, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service Environment.
start_time (str) – Beginning time of the metrics query.
end_time (str) – End time of the metrics query.
time_grain (str) – Time granularity of the metrics query.
details (bool) – Specify <code>true</code> to include instance details. The default is <code>false</code>.
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]’.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ResourceMetric

Return type

ResourceMetricPaged[ResourceMetric]

Raises

CloudError

list_multi_role_pool_instance_metric_definitions(resource_group_name, name, instance, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service Environment.
instance (str) – Name of the instance in the multi-role pool.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ResourceMetricDefinition

Return type

ResourceMetricDefinitionPaged[ResourceMetricDefinition]

Raises

CloudError

list_multi_role_pool_instance_metrics(resource_group_name, name, instance, details=None, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service Environment.
instance (str) – Name of the instance in the multi-role pool.
details (bool) – Specify <code>true</code> to include instance details. The default is <code>false</code>.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ResourceMetric

Return type

ResourceMetricPaged[ResourceMetric]

Raises

CloudError

list_multi_role_pool_skus(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶

Get available SKUs for scaling a multi-role pool.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service Environment.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of SkuInfo

Return type

SkuInfoPaged[SkuInfo]

Raises

CloudError

list_multi_role_pools(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶

Get all multi-role pools.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service Environment.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of WorkerPoolResource

Return type

WorkerPoolResourcePaged[WorkerPoolResource]

Raises

CloudError

list_multi_role_usages(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service Environment.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of Usage

Return type

UsagePaged[Usage]

Raises

CloudError

list_operations(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶

List all currently running operations on the App Service Environment.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service Environment.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[Operation] or ClientRawResponse

Raises

CloudError

list_usages(resource_group_name, name, filter=None, custom_headers=None, raw=False, **operation_config)[source]¶

Get global usage metrics of an App Service Environment.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service Environment.
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]’.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of CsmUsageQuota

Return type

CsmUsageQuotaPaged[CsmUsageQuota]

Raises

CloudError

list_vips(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶

Get IP addresses assigned to an App Service Environment.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service Environment.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

AddressResponse or ClientRawResponse if raw=true

Return type

AddressResponse or ClientRawResponse

Raises

CloudError

list_web_apps(resource_group_name, name, properties_to_include=None, custom_headers=None, raw=False, **operation_config)[source]¶

Get all apps in an App Service Environment.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service Environment.
properties_to_include (str) – Comma separated list of app properties to include.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of Site

Return type

SitePaged[Site]

Raises

CloudError

list_web_worker_metric_definitions(resource_group_name, name, worker_pool_name, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service Environment.
worker_pool_name (str) – Name of the worker pool.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ResourceMetricDefinition

Return type

ResourceMetricDefinitionPaged[ResourceMetricDefinition]

Raises

CloudError

list_web_worker_metrics(resource_group_name, name, worker_pool_name, details=None, filter=None, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service Environment.
worker_pool_name (str) – Name of worker pool
details (bool) – Specify <code>true</code> to include instance details. The default is <code>false</code>.
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]’.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ResourceMetric

Return type

ResourceMetricPaged[ResourceMetric]

Raises

CloudError

list_web_worker_usages(resource_group_name, name, worker_pool_name, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service Environment.
worker_pool_name (str) – Name of the worker pool.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of Usage

Return type

UsagePaged[Usage]

Raises

CloudError

list_worker_pool_instance_metric_definitions(resource_group_name, name, worker_pool_name, instance, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service Environment.
worker_pool_name (str) – Name of the worker pool.
instance (str) – Name of the instance in the worker pool.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ResourceMetricDefinition

Return type

ResourceMetricDefinitionPaged[ResourceMetricDefinition]

Raises

CloudError

list_worker_pool_instance_metrics(resource_group_name, name, worker_pool_name, instance, details=None, filter=None, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service Environment.
worker_pool_name (str) – Name of the worker pool.
instance (str) – Name of the instance in the worker pool.
details (bool) – Specify <code>true</code> to include instance details. The default is <code>false</code>.
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]’.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ResourceMetric

Return type

ResourceMetricPaged[ResourceMetric]

Raises

CloudError

list_worker_pool_skus(resource_group_name, name, worker_pool_name, custom_headers=None, raw=False, **operation_config)[source]¶

Get available SKUs for scaling a worker pool.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service Environment.
worker_pool_name (str) – Name of the worker pool.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of SkuInfo

Return type

SkuInfoPaged[SkuInfo]

Raises

CloudError

list_worker_pools(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶

Get all worker pools of an App Service Environment.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service Environment.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of WorkerPoolResource

Return type

WorkerPoolResourcePaged[WorkerPoolResource]

Raises

CloudError

reboot(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶

Reboot all machines in an App Service Environment.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service Environment.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

resume(resource_group_name, name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Resume an App Service Environment.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service Environment.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns WebAppCollection or ClientRawResponse<WebAppCollection> if raw==True

Return type

AzureOperationPoller[WebAppCollection] or AzureOperationPoller[ClientRawResponse[WebAppCollection]]

Raises

CloudError

suspend(resource_group_name, name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Suspend an App Service Environment.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service Environment.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns WebAppCollection or ClientRawResponse<WebAppCollection> if raw==True

Return type

AzureOperationPoller[WebAppCollection] or AzureOperationPoller[ClientRawResponse[WebAppCollection]]

Raises

CloudError

update(resource_group_name, name, hosting_environment_envelope, custom_headers=None, raw=False, **operation_config)[source]¶

Create or update an App Service Environment.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service Environment.
hosting_environment_envelope (AppServiceEnvironmentPatchResource) – Configuration details of the App Service Environment.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

AppServiceEnvironmentResource or ClientRawResponse if raw=true

Return type

AppServiceEnvironmentResource or ClientRawResponse

Raises

CloudError

update_multi_role_pool(resource_group_name, name, multi_role_pool_envelope, custom_headers=None, raw=False, **operation_config)[source]¶

Create or update a multi-role pool.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service Environment.
multi_role_pool_envelope (WorkerPoolResource) – Properties of the multi-role pool.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

WorkerPoolResource or ClientRawResponse if raw=true

Return type

WorkerPoolResource or ClientRawResponse

Raises

CloudError

update_worker_pool(resource_group_name, name, worker_pool_name, worker_pool_envelope, custom_headers=None, raw=False, **operation_config)[source]¶

Create or update a worker pool.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service Environment.
worker_pool_name (str) – Name of the worker pool.
worker_pool_envelope (WorkerPoolResource) – Properties of the worker pool.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

WorkerPoolResource or ClientRawResponse if raw=true

Return type

WorkerPoolResource or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.web.v2016_09_01.models' from '/home/vsts/work/1/s/sdk/appservice/azure-mgmt-web/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/web/v2016_09_01/models/__init__.py'>¶

class azure.mgmt.web.v2016_09_01.operations.AppServicePlansOperations(client, config, serializer, deserializer)[source]¶

Bases: object

AppServicePlansOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – API Version. Constant value: “2016-09-01”.

create_or_update(resource_group_name, name, app_service_plan, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates an App Service Plan.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service plan.
app_service_plan (AppServicePlan) – Details of the App Service plan.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns AppServicePlan or ClientRawResponse<AppServicePlan> if raw==True

Return type

AzureOperationPoller[AppServicePlan] or AzureOperationPoller[ClientRawResponse[AppServicePlan]]

Raises

CloudError

create_or_update_vnet_route(resource_group_name, name, vnet_name, route_name, route, custom_headers=None, raw=False, **operation_config)[source]¶

Create or update a Virtual Network route in an App Service plan.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service plan.
vnet_name (str) – Name of the Virtual Network.
route_name (str) – Name of the Virtual Network route.
route (VnetRoute) – Definition of the Virtual Network route.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

VnetRoute or ClientRawResponse if raw=true

Return type

VnetRoute or ClientRawResponse

Raises

CloudError

delete(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶

Delete an App Service plan.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service plan.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

delete_hybrid_connection(resource_group_name, name, namespace_name, relay_name, custom_headers=None, raw=False, **operation_config)[source]¶

Delete a Hybrid Connection in use in an App Service plan.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service plan.
namespace_name (str) – Name of the Service Bus namespace.
relay_name (str) – Name of the Service Bus relay.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

delete_vnet_route(resource_group_name, name, vnet_name, route_name, custom_headers=None, raw=False, **operation_config)[source]¶

Delete a Virtual Network route in an App Service plan.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service plan.
vnet_name (str) – Name of the Virtual Network.
route_name (str) – Name of the Virtual Network route.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶

Get an App Service plan.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service plan.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

AppServicePlan or ClientRawResponse if raw=true

Return type

AppServicePlan or ClientRawResponse

Raises

CloudError

get_hybrid_connection(resource_group_name, name, namespace_name, relay_name, custom_headers=None, raw=False, **operation_config)[source]¶

Retrieve a Hybrid Connection in use in an App Service plan.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service plan.
namespace_name (str) – Name of the Service Bus namespace.
relay_name (str) – Name of the Service Bus relay.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

HybridConnection or ClientRawResponse if raw=true

Return type

HybridConnection or ClientRawResponse

Raises

CloudError

get_hybrid_connection_plan_limit(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶

Get the maximum number of Hybrid Connections allowed in an App Service plan.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service plan.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

HybridConnectionLimits or ClientRawResponse if raw=true

Return type

HybridConnectionLimits or ClientRawResponse

Raises

CloudError

get_route_for_vnet(resource_group_name, name, vnet_name, route_name, custom_headers=None, raw=False, **operation_config)[source]¶

Get a Virtual Network route in an App Service plan.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service plan.
vnet_name (str) – Name of the Virtual Network.
route_name (str) – Name of the Virtual Network route.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[VnetRoute] or ClientRawResponse

Raises

CloudError

get_server_farm_skus(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all selectable SKUs for a given App Service Plan.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of App Service Plan
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

object or ClientRawResponse if raw=true

Return type

object or ClientRawResponse

Raises

CloudError

get_vnet_from_server_farm(resource_group_name, name, vnet_name, custom_headers=None, raw=False, **operation_config)[source]¶

Get a Virtual Network associated with an App Service plan.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service plan.
vnet_name (str) – Name of the Virtual Network.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

VnetInfo or ClientRawResponse if raw=true

Return type

VnetInfo or ClientRawResponse

Raises

CloudError

get_vnet_gateway(resource_group_name, name, vnet_name, gateway_name, custom_headers=None, raw=False, **operation_config)[source]¶

Get a Virtual Network gateway.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service plan.
vnet_name (str) – Name of the Virtual Network.
gateway_name (str) – Name of the gateway. Only the ‘primary’ gateway is supported.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

VnetGateway or ClientRawResponse if raw=true

Return type

VnetGateway or ClientRawResponse

Raises

CloudError

list(detailed=None, custom_headers=None, raw=False, **operation_config)[source]¶

Get all App Service plans for a subscription.

Parameters

detailed (bool) – Specify <code>true</code> to return all App Service plan properties. The default is <code>false</code>, which returns a subset of the properties. Retrieval of all properties may increase the API latency.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of AppServicePlan

Return type

AppServicePlanPaged[AppServicePlan]

Raises

CloudError

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Get all App Service plans in a resource group.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of AppServicePlan

Return type

AppServicePlanPaged[AppServicePlan]

Raises

CloudError

list_capabilities(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶

List all capabilities of an App Service plan.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service plan.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[Capability] or ClientRawResponse

Raises

CloudError

list_hybrid_connection_keys(resource_group_name, name, namespace_name, relay_name, custom_headers=None, raw=False, **operation_config)[source]¶

Get the send key name and value of a Hybrid Connection.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service plan.
namespace_name (str) – The name of the Service Bus namespace.
relay_name (str) – The name of the Service Bus relay.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

HybridConnectionKey or ClientRawResponse if raw=true

Return type

HybridConnectionKey or ClientRawResponse

Raises

CloudError

list_hybrid_connections(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶

Retrieve all Hybrid Connections in use in an App Service plan.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service plan.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of HybridConnection

Return type

HybridConnectionPaged[HybridConnection]

Raises

CloudError

list_metric_defintions(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶

Get metrics that can be queried for an App Service plan, and their definitions.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service plan.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ResourceMetricDefinition

Return type

ResourceMetricDefinitionPaged[ResourceMetricDefinition]

Raises

CloudError

list_metrics(resource_group_name, name, details=None, filter=None, custom_headers=None, raw=False, **operation_config)[source]¶

Get metrics for an App Service plan.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service plan.
details (bool) – Specify <code>true</code> to include instance details. The default is <code>false</code>.
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]’.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ResourceMetric

Return type

ResourceMetricPaged[ResourceMetric]

Raises

CloudError

list_routes_for_vnet(resource_group_name, name, vnet_name, custom_headers=None, raw=False, **operation_config)[source]¶

Get all routes that are associated with a Virtual Network in an App Service plan.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service plan.
vnet_name (str) – Name of the Virtual Network.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[VnetRoute] or ClientRawResponse

Raises

CloudError

list_usages(resource_group_name, name, filter=None, custom_headers=None, raw=False, **operation_config)[source]¶

Gets server farm usage information.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of App Service Plan
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’).
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of CsmUsageQuota

Return type

CsmUsageQuotaPaged[CsmUsageQuota]

Raises

CloudError

list_vnets(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶

Get all Virtual Networks associated with an App Service plan.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service plan.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[VnetInfo] or ClientRawResponse

Raises

CloudError

list_web_apps(resource_group_name, name, skip_token=None, filter=None, top=None, custom_headers=None, raw=False, **operation_config)[source]¶

Get all apps associated with an App Service plan.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service plan.
skip_token (str) – Skip to a web app in the list of webapps associated with app service plan. If specified, the resulting list will contain web apps starting from (including) the skipToken. Otherwise, the resulting list contains web apps from the start of the list
filter (str) – Supported filter: $filter=state eq running. Returns only web apps that are currently running
top (str) – List page size. If specified, results are paged.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of Site

Return type

SitePaged[Site]

Raises

CloudError

list_web_apps_by_hybrid_connection(resource_group_name, name, namespace_name, relay_name, custom_headers=None, raw=False, **operation_config)[source]¶

Get all apps that use a Hybrid Connection in an App Service Plan.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service plan.
namespace_name (str) – Name of the Hybrid Connection namespace.
relay_name (str) – Name of the Hybrid Connection relay.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of str

Return type

StrPaged[str]

Raises

CloudError

reboot_worker(resource_group_name, name, worker_name, custom_headers=None, raw=False, **operation_config)[source]¶

Reboot a worker machine in an App Service plan.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service plan.
worker_name (str) – Name of worker machine, which typically starts with RD.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

restart_web_apps(resource_group_name, name, soft_restart=None, custom_headers=None, raw=False, **operation_config)[source]¶

Restart all apps in an App Service plan.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service plan.
soft_restart (bool) – Specify <code>true</code> to perform a soft restart, applies the configuration settings and restarts the apps if necessary. The default is <code>false</code>, which always restarts and reprovisions the apps
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

update(resource_group_name, name, app_service_plan, custom_headers=None, raw=False, **operation_config)[source]¶

Creates or updates an App Service Plan.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service plan.
app_service_plan (AppServicePlanPatchResource) – Details of the App Service plan.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

AppServicePlan or ClientRawResponse if raw=true

Return type

AppServicePlan or ClientRawResponse

Raises

CloudError

update_vnet_gateway(resource_group_name, name, vnet_name, gateway_name, connection_envelope, custom_headers=None, raw=False, **operation_config)[source]¶

Update a Virtual Network gateway.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service plan.
vnet_name (str) – Name of the Virtual Network.
gateway_name (str) – Name of the gateway. Only the ‘primary’ gateway is supported.
connection_envelope (VnetGateway) – Definition of the gateway.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

VnetGateway or ClientRawResponse if raw=true

Return type

VnetGateway or ClientRawResponse

Raises

CloudError

update_vnet_route(resource_group_name, name, vnet_name, route_name, route, custom_headers=None, raw=False, **operation_config)[source]¶

Create or update a Virtual Network route in an App Service plan.

Parameters

resource_group_name (str) – Name of the resource group to which the resource belongs.
name (str) – Name of the App Service plan.
vnet_name (str) – Name of the Virtual Network.
route_name (str) – Name of the Virtual Network route.
route (VnetRoute) – Definition of the Virtual Network route.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

VnetRoute or ClientRawResponse if raw=true

Return type

VnetRoute or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.web.v2016_09_01.models' from '/home/vsts/work/1/s/sdk/appservice/azure-mgmt-web/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/web/v2016_09_01/models/__init__.py'>¶