azure.mgmt.web.v2016_09_01.models module¶

class azure.mgmt.web.v2016_09_01.models.AddressResponse(*, service_ip_address: str = None, internal_ip_address: str = None, outbound_ip_addresses=None, vip_mappings=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Describes main public IP address and any extra virtual IPs.

Parameters

service_ip_address (str) – Main public virtual IP.
internal_ip_address (str) – Virtual Network internal IP address of the App Service Environment if it is in internal load-balancing mode.
outbound_ip_addresses (list[str]) – IP addresses appearing on outbound connections.
vip_mappings (list[VirtualIPMapping]) – Additional virtual IPs.

class azure.mgmt.web.v2016_09_01.models.ApiDefinitionInfo(*, url: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Information about the formal API definition for the app.

Parameters: url (str) – The URL of the API definition.

class azure.mgmt.web.v2016_09_01.models.AppServiceEnvironmentPatchResource(*, app_service_environment_patch_resource_name: str, location: str, virtual_network, worker_pools, kind: str = None, vnet_name: str = None, vnet_resource_group_name: str = None, vnet_subnet_name: str = None, internal_load_balancing_mode=None, multi_size: str = None, multi_role_count: int = None, ipssl_address_count: int = None, dns_suffix: str = None, network_access_control_list=None, front_end_scale_factor: int = None, api_management_account_id: str = None, suspended: bool = None, dynamic_cache_enabled: bool = None, cluster_settings=None, user_whitelisted_ip_ranges=None, **kwargs)[source]¶

Bases: azure.mgmt.web.v2016_09_01.models._models_py3.ProxyOnlyResource

ARM resource for a app service environment.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – Resource Id.
name (str) – Resource Name.
type (str) – Resource type.
provisioning_state (str or ProvisioningState) – Provisioning state of the App Service Environment. Possible values include: ‘Succeeded’, ‘Failed’, ‘Canceled’, ‘InProgress’, ‘Deleting’
status (str or HostingEnvironmentStatus) – Current status of the App Service Environment. Possible values include: ‘Preparing’, ‘Ready’, ‘Scaling’, ‘Deleting’
database_edition (str) – Edition of the metadata database for the App Service Environment, e.g. “Standard”.
database_service_objective (str) – Service objective of the metadata database for the App Service Environment, e.g. “S0”.
upgrade_domains (int) – Number of upgrade domains of the App Service Environment.
subscription_id (str) – Subscription of the App Service Environment.
last_action (str) – Last deployment action on the App Service Environment.
last_action_result (str) – Result of the last deployment action on the App Service Environment.
allowed_multi_sizes (str) – List of comma separated strings describing which VM sizes are allowed for front-ends.
allowed_worker_sizes (str) – List of comma separated strings describing which VM sizes are allowed for workers.
maximum_number_of_machines (int) – Maximum number of VMs in the App Service Environment.
vip_mappings (list[VirtualIPMapping]) – Description of IP SSL mapping for the App Service Environment.
environment_capacities (list[StampCapacity]) – Current total, used, and available worker capacities.
environment_is_healthy (bool) – True/false indicating whether the App Service Environment is healthy.
environment_status (str) – Detailed message about with results of the last check of the App Service Environment.
resource_group (str) – Resource group of the App Service Environment.
default_front_end_scale_factor (int) – Default Scale Factor for FrontEnds.

Parameters

kind (str) – Kind of resource.
app_service_environment_patch_resource_name (str) – Required. Name of the App Service Environment.
location (str) – Required. Location of the App Service Environment, e.g. “West US”.
vnet_name (str) – Name of the Virtual Network for the App Service Environment.
vnet_resource_group_name (str) – Resource group of the Virtual Network.
vnet_subnet_name (str) – Subnet of the Virtual Network.
virtual_network (VirtualNetworkProfile) – Required. Description of the Virtual Network.
internal_load_balancing_mode (str or InternalLoadBalancingMode) – Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. Possible values include: ‘None’, ‘Web’, ‘Publishing’
multi_size (str) – Front-end VM size, e.g. “Medium”, “Large”.
multi_role_count (int) – Number of front-end instances.
worker_pools (list[WorkerPool]) – Required. Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool.
ipssl_address_count (int) – Number of IP SSL addresses reserved for the App Service Environment.
dns_suffix (str) – DNS suffix of the App Service Environment.
network_access_control_list (list[NetworkAccessControlEntry]) – Access control list for controlling traffic to the App Service Environment.
front_end_scale_factor (int) – Scale factor for front-ends.
api_management_account_id (str) – API Management Account associated with the App Service Environment.
suspended (bool) – <code>true</code> if the App Service Environment is suspended; otherwise, <code>false</code>. The environment can be suspended, e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).
dynamic_cache_enabled (bool) – True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).
cluster_settings (list[NameValuePair]) – Custom settings for changing the behavior of the App Service Environment.
user_whitelisted_ip_ranges (list[str]) – User added ip ranges to whitelist on ASE db

class azure.mgmt.web.v2016_09_01.models.AppServiceEnvironmentResource(*, location: str, app_service_environment_resource_name: str, app_service_environment_resource_location: str, virtual_network, worker_pools, kind: str = None, tags=None, vnet_name: str = None, vnet_resource_group_name: str = None, vnet_subnet_name: str = None, internal_load_balancing_mode=None, multi_size: str = None, multi_role_count: int = None, ipssl_address_count: int = None, dns_suffix: str = None, network_access_control_list=None, front_end_scale_factor: int = None, api_management_account_id: str = None, suspended: bool = None, dynamic_cache_enabled: bool = None, cluster_settings=None, user_whitelisted_ip_ranges=None, **kwargs)[source]¶

Bases: azure.mgmt.web.v2016_09_01.models._models_py3.Resource

App Service Environment ARM resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – Resource Id.
name (str) – Resource Name.
type (str) – Resource type.
provisioning_state (str or ProvisioningState) – Provisioning state of the App Service Environment. Possible values include: ‘Succeeded’, ‘Failed’, ‘Canceled’, ‘InProgress’, ‘Deleting’
status (str or HostingEnvironmentStatus) – Current status of the App Service Environment. Possible values include: ‘Preparing’, ‘Ready’, ‘Scaling’, ‘Deleting’
database_edition (str) – Edition of the metadata database for the App Service Environment, e.g. “Standard”.
database_service_objective (str) – Service objective of the metadata database for the App Service Environment, e.g. “S0”.
upgrade_domains (int) – Number of upgrade domains of the App Service Environment.
subscription_id (str) – Subscription of the App Service Environment.
last_action (str) – Last deployment action on the App Service Environment.
last_action_result (str) – Result of the last deployment action on the App Service Environment.
allowed_multi_sizes (str) – List of comma separated strings describing which VM sizes are allowed for front-ends.
allowed_worker_sizes (str) – List of comma separated strings describing which VM sizes are allowed for workers.
maximum_number_of_machines (int) – Maximum number of VMs in the App Service Environment.
vip_mappings (list[VirtualIPMapping]) – Description of IP SSL mapping for the App Service Environment.
environment_capacities (list[StampCapacity]) – Current total, used, and available worker capacities.
environment_is_healthy (bool) – True/false indicating whether the App Service Environment is healthy.
environment_status (str) – Detailed message about with results of the last check of the App Service Environment.
resource_group (str) – Resource group of the App Service Environment.
default_front_end_scale_factor (int) – Default Scale Factor for FrontEnds.

Parameters

kind (str) – Kind of resource.
location (str) – Required. Resource Location.
tags (dict[str, str]) – Resource tags.
app_service_environment_resource_name (str) – Required. Name of the App Service Environment.
app_service_environment_resource_location (str) – Required. Location of the App Service Environment, e.g. “West US”.
vnet_name (str) – Name of the Virtual Network for the App Service Environment.
vnet_resource_group_name (str) – Resource group of the Virtual Network.
vnet_subnet_name (str) – Subnet of the Virtual Network.
virtual_network (VirtualNetworkProfile) – Required. Description of the Virtual Network.
internal_load_balancing_mode (str or InternalLoadBalancingMode) – Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. Possible values include: ‘None’, ‘Web’, ‘Publishing’
multi_size (str) – Front-end VM size, e.g. “Medium”, “Large”.
multi_role_count (int) – Number of front-end instances.
worker_pools (list[WorkerPool]) – Required. Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool.
ipssl_address_count (int) – Number of IP SSL addresses reserved for the App Service Environment.
dns_suffix (str) – DNS suffix of the App Service Environment.
network_access_control_list (list[NetworkAccessControlEntry]) – Access control list for controlling traffic to the App Service Environment.
front_end_scale_factor (int) – Scale factor for front-ends.
api_management_account_id (str) – API Management Account associated with the App Service Environment.
suspended (bool) – <code>true</code> if the App Service Environment is suspended; otherwise, <code>false</code>. The environment can be suspended, e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).
dynamic_cache_enabled (bool) – True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).
cluster_settings (list[NameValuePair]) – Custom settings for changing the behavior of the App Service Environment.
user_whitelisted_ip_ranges (list[str]) – User added ip ranges to whitelist on ASE db

class azure.mgmt.web.v2016_09_01.models.AppServicePlan(*, location: str, app_service_plan_name: str, kind: str = None, tags=None, worker_tier_name: str = None, admin_site_name: str = None, hosting_environment_profile=None, per_site_scaling: bool = False, is_spot: bool = None, spot_expiration_time=None, reserved: bool = False, target_worker_count: int = None, target_worker_size_id: int = None, sku=None, **kwargs)[source]¶

Bases: azure.mgmt.web.v2016_09_01.models._models_py3.Resource

App Service plan.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – Resource Id.
name (str) – Resource Name.
type (str) – Resource type.
status (str or StatusOptions) – App Service plan status. Possible values include: ‘Ready’, ‘Pending’, ‘Creating’
subscription (str) – App Service plan subscription.
maximum_number_of_workers (int) – Maximum number of instances that can be assigned to this App Service plan.
geo_region (str) – Geographical location for the App Service plan.
number_of_sites (int) – Number of apps assigned to this App Service plan.
resource_group (str) – Resource group of the App Service plan.
provisioning_state (str or ProvisioningState) – Provisioning state of the App Service Environment. Possible values include: ‘Succeeded’, ‘Failed’, ‘Canceled’, ‘InProgress’, ‘Deleting’

Parameters

kind (str) – Kind of resource.
location (str) – Required. Resource Location.
tags (dict[str, str]) – Resource tags.
app_service_plan_name (str) – Required. Name for the App Service plan.
worker_tier_name (str) – Target worker tier assigned to the App Service plan.
admin_site_name (str) – App Service plan administration site.
hosting_environment_profile (HostingEnvironmentProfile) – Specification for the App Service Environment to use for the App Service plan.
per_site_scaling (bool) – If <code>true</code>, apps assigned to this App Service plan can be scaled independently. If <code>false</code>, apps assigned to this App Service plan will scale to all instances of the plan. Default value: False .
is_spot (bool) – If <code>true</code>, this App Service Plan owns spot instances.
spot_expiration_time (datetime) – The time when the server farm expires. Valid only if it is a spot server farm.
reserved (bool) – If Linux app service plan <code>true</code>, <code>false</code> otherwise. Default value: False .
target_worker_count (int) – Scaling worker count.
target_worker_size_id (int) – Scaling worker size ID.
sku (SkuDescription) –

class azure.mgmt.web.v2016_09_01.models.AppServicePlanPatchResource(*, app_service_plan_patch_resource_name: str, kind: str = None, worker_tier_name: str = None, admin_site_name: str = None, hosting_environment_profile=None, per_site_scaling: bool = False, is_spot: bool = None, spot_expiration_time=None, reserved: bool = False, target_worker_count: int = None, target_worker_size_id: int = None, **kwargs)[source]¶

Bases: azure.mgmt.web.v2016_09_01.models._models_py3.ProxyOnlyResource

ARM resource for a app service plan.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – Resource Id.
name (str) – Resource Name.
type (str) – Resource type.
status (str or StatusOptions) – App Service plan status. Possible values include: ‘Ready’, ‘Pending’, ‘Creating’
subscription (str) – App Service plan subscription.
maximum_number_of_workers (int) – Maximum number of instances that can be assigned to this App Service plan.
geo_region (str) – Geographical location for the App Service plan.
number_of_sites (int) – Number of apps assigned to this App Service plan.
resource_group (str) – Resource group of the App Service plan.
provisioning_state (str or ProvisioningState) – Provisioning state of the App Service Environment. Possible values include: ‘Succeeded’, ‘Failed’, ‘Canceled’, ‘InProgress’, ‘Deleting’

Parameters

kind (str) – Kind of resource.
app_service_plan_patch_resource_name (str) – Required. Name for the App Service plan.
worker_tier_name (str) – Target worker tier assigned to the App Service plan.
admin_site_name (str) – App Service plan administration site.
hosting_environment_profile (HostingEnvironmentProfile) – Specification for the App Service Environment to use for the App Service plan.
per_site_scaling (bool) – If <code>true</code>, apps assigned to this App Service plan can be scaled independently. If <code>false</code>, apps assigned to this App Service plan will scale to all instances of the plan. Default value: False .
is_spot (bool) – If <code>true</code>, this App Service Plan owns spot instances.
spot_expiration_time (datetime) – The time when the server farm expires. Valid only if it is a spot server farm.
reserved (bool) – If Linux app service plan <code>true</code>, <code>false</code> otherwise. Default value: False .
target_worker_count (int) – Scaling worker count.
target_worker_size_id (int) – Scaling worker size ID.

class azure.mgmt.web.v2016_09_01.models.AutoHealActions(*, action_type=None, custom_action=None, min_process_execution_time: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Actions which to take by the auto-heal module when a rule is triggered.

Parameters

action_type (str or AutoHealActionType) – Predefined action to be taken. Possible values include: ‘Recycle’, ‘LogEvent’, ‘CustomAction’
custom_action (AutoHealCustomAction) – Custom action to be taken.
min_process_execution_time (str) – Minimum time the process must execute before taking the action

class azure.mgmt.web.v2016_09_01.models.AutoHealCustomAction(*, exe: str = None, parameters: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Custom action to be executed when an auto heal rule is triggered.

Parameters

exe (str) – Executable to be run.
parameters (str) – Parameters for the executable.

class azure.mgmt.web.v2016_09_01.models.AutoHealRules(*, triggers=None, actions=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Rules that can be defined for auto-heal.

Parameters

triggers (AutoHealTriggers) – Conditions that describe when to execute the auto-heal actions.
actions (AutoHealActions) – Actions to be executed when a rule is triggered.

class azure.mgmt.web.v2016_09_01.models.AutoHealTriggers(*, requests=None, private_bytes_in_kb: int = None, status_codes=None, slow_requests=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Triggers for auto-heal.

Parameters

requests (RequestsBasedTrigger) – A rule based on total requests.
private_bytes_in_kb (int) – A rule based on private bytes.
status_codes (list[StatusCodesBasedTrigger]) – A rule based on status codes.
slow_requests (SlowRequestsBasedTrigger) – A rule based on request execution time.

class azure.mgmt.web.v2016_09_01.models.Capability(*, name: str = None, value: str = None, reason: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Describes the capabilities/features allowed for a specific SKU.

Parameters

name (str) – Name of the SKU capability.
value (str) – Value of the SKU capability.
reason (str) – Reason of the SKU capability.

class azure.mgmt.web.v2016_09_01.models.CloningInfo(*, source_web_app_id: str, correlation_id: str = None, overwrite: bool = None, clone_custom_host_names: bool = None, clone_source_control: bool = None, hosting_environment: str = None, app_settings_overrides=None, configure_load_balancing: bool = None, traffic_manager_profile_id: str = None, traffic_manager_profile_name: str = None, ignore_quotas: bool = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Information needed for cloning operation.

All required parameters must be populated in order to send to Azure.

Parameters

correlation_id (str) – Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot.
overwrite (bool) – <code>true</code> to overwrite destination app; otherwise, <code>false</code>.
clone_custom_host_names (bool) – <code>true</code> to clone custom hostnames from source app; otherwise, <code>false</code>.
clone_source_control (bool) – <code>true</code> to clone source control from source app; otherwise, <code>false</code>.
source_web_app_id (str) – Required. ARM resource ID of the source app. App resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.
hosting_environment (str) – App Service Environment.
app_settings_overrides (dict[str, str]) – Application setting overrides for cloned app. If specified, these settings override the settings cloned from source app. Otherwise, application settings from source app are retained.
configure_load_balancing (bool) – <code>true</code> to configure load balancing for source and destination app.
traffic_manager_profile_id (str) – ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}.
traffic_manager_profile_name (str) – Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.
ignore_quotas (bool) – <code>true</code> if quotas should be ignored; otherwise, <code>false</code>.

class azure.mgmt.web.v2016_09_01.models.ConnStringInfo(*, name: str = None, connection_string: str = None, type=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Database connection string information.

Parameters

name (str) – Name of connection string.
connection_string (str) – Connection string value.
type (str or ConnectionStringType) – Type of database. Possible values include: ‘MySql’, ‘SQLServer’, ‘SQLAzure’, ‘Custom’, ‘NotificationHub’, ‘ServiceBus’, ‘EventHub’, ‘ApiHub’, ‘DocDb’, ‘RedisCache’, ‘PostgreSQL’

class azure.mgmt.web.v2016_09_01.models.CorsSettings(*, allowed_origins=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Cross-Origin Resource Sharing (CORS) settings for the app.

Parameters: allowed_origins (list[str]) – Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use “*” to allow all.

class azure.mgmt.web.v2016_09_01.models.CsmUsageQuota(*, unit: str = None, next_reset_time=None, current_value: int = None, limit: int = None, name=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Usage of the quota resource.

Parameters

unit (str) – Units of measurement for the quota resource.
next_reset_time (datetime) – Next reset time for the resource counter.
current_value (long) – The current value of the resource counter.
limit (long) – The resource limit.
name (LocalizableString) – Quota name.

class azure.mgmt.web.v2016_09_01.models.ErrorEntity(*, extended_code: str = None, message_template: str = None, parameters=None, inner_errors=None, code: str = None, message: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Body of the error response returned from the API.

Parameters

extended_code (str) – Type of error.
message_template (str) – Message template.
parameters (list[str]) – Parameters for the template.
inner_errors (list[ErrorEntity]) – Inner errors.
code (str) – Basic error code.
message (str) – Any details of the error.

class azure.mgmt.web.v2016_09_01.models.Experiments(*, ramp_up_rules=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Routing rules in production experiments.

Parameters: ramp_up_rules (list[RampUpRule]) – List of ramp-up rules.

class azure.mgmt.web.v2016_09_01.models.HandlerMapping(*, extension: str = None, script_processor: str = None, arguments: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The IIS handler mappings used to define which handler processes HTTP requests with certain extension. For example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension.

Parameters

extension (str) – Requests with this extension will be handled using the specified FastCGI application.
script_processor (str) – The absolute path to the FastCGI application.
arguments (str) – Command-line arguments to be passed to the script processor.

class azure.mgmt.web.v2016_09_01.models.HostingEnvironmentDiagnostics(*, name: str = None, diagnosics_output: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Diagnostics for an App Service Environment.

Parameters

name (str) – Name/identifier of the diagnostics.
diagnosics_output (str) – Diagnostics output.

class azure.mgmt.web.v2016_09_01.models.HostingEnvironmentProfile(*, id: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Specification for an App Service Environment to use for this resource.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

id (str) – Resource ID of the App Service Environment.

Variables

name (str) – Name of the App Service Environment.
type (str) – Resource type of the App Service Environment.

class azure.mgmt.web.v2016_09_01.models.HostNameSslState(*, name: str = None, ssl_state=None, virtual_ip: str = None, thumbprint: str = None, to_update: bool = None, host_type=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

SSL-enabled hostname.

Parameters

name (str) – Hostname.
ssl_state (str or SslState) – SSL type. Possible values include: ‘Disabled’, ‘SniEnabled’, ‘IpBasedEnabled’
virtual_ip (str) – Virtual IP address assigned to the hostname if IP based SSL is enabled.
thumbprint (str) – SSL certificate thumbprint.
to_update (bool) – Set to <code>true</code> to update existing hostname.
host_type (str or HostType) – Indicates whether the hostname is a standard or repository hostname. Possible values include: ‘Standard’, ‘Repository’

class azure.mgmt.web.v2016_09_01.models.HybridConnection(*, kind: str = None, service_bus_namespace: str = None, relay_name: str = None, relay_arm_uri: str = None, hostname: str = None, port: int = None, send_key_name: str = None, send_key_value: str = None, service_bus_suffix: str = None, **kwargs)[source]¶

Bases: azure.mgmt.web.v2016_09_01.models._models_py3.ProxyOnlyResource

Hybrid Connection contract. This is used to configure a Hybrid Connection.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id.
name (str) – Resource Name.
type (str) – Resource type.

Parameters

kind (str) – Kind of resource.
service_bus_namespace (str) – The name of the Service Bus namespace.
relay_name (str) – The name of the Service Bus relay.
relay_arm_uri (str) – The ARM URI to the Service Bus relay.
hostname (str) – The hostname of the endpoint.
port (int) – The port of the endpoint.
send_key_name (str) – The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.
send_key_value (str) – The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned normally, use the POST /listKeys API instead.
service_bus_suffix (str) – The suffix for the service bus endpoint. By default this is .servicebus.windows.net

class azure.mgmt.web.v2016_09_01.models.HybridConnectionKey(*, kind: str = None, **kwargs)[source]¶

Bases: azure.mgmt.web.v2016_09_01.models._models_py3.ProxyOnlyResource

Hybrid Connection key contract. This has the send key name and value for a Hybrid Connection.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id.
name (str) – Resource Name.
type (str) – Resource type.
send_key_name (str) – The name of the send key.
send_key_value (str) – The value of the send key.

Parameters

kind (str) – Kind of resource.

class azure.mgmt.web.v2016_09_01.models.HybridConnectionLimits(*, kind: str = None, **kwargs)[source]¶

Bases: azure.mgmt.web.v2016_09_01.models._models_py3.ProxyOnlyResource

Hybrid Connection limits contract. This is used to return the plan limits of Hybrid Connections.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id.
name (str) – Resource Name.
type (str) – Resource type.
current (int) – The current number of Hybrid Connections.
maximum (int) – The maximum number of Hybrid Connections allowed.

Parameters

kind (str) – Kind of resource.

class azure.mgmt.web.v2016_09_01.models.Identifier(*, kind: str = None, identifier_id: str = None, **kwargs)[source]¶

Bases: azure.mgmt.web.v2016_09_01.models._models_py3.ProxyOnlyResource

A domain specific resource identifier.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id.
name (str) – Resource Name.
type (str) – Resource type.

Parameters

kind (str) – Kind of resource.
identifier_id (str) – String representation of the identity.

class azure.mgmt.web.v2016_09_01.models.IpSecurityRestriction(*, ip_address: str, subnet_mask: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

IP security restriction on an app.

All required parameters must be populated in order to send to Azure.

Parameters

ip_address (str) – Required. IP address the security restriction is valid for.
subnet_mask (str) – Subnet mask for the range of IP addresses the restriction is valid for.

class azure.mgmt.web.v2016_09_01.models.LocalizableString(*, value: str = None, localized_value: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Localizable string object containing the name and a localized value.

Parameters

value (str) – Non-localized name.
localized_value (str) – Localized name.

class azure.mgmt.web.v2016_09_01.models.ManagedServiceIdentity(*, type=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Managed service identity.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

type (str or ManagedServiceIdentityType) – Type of managed service identity. Possible values include: ‘SystemAssigned’

Variables

tenant_id (str) – Tenant of managed service identity.
principal_id (str) – Principal Id of managed service identity.

class azure.mgmt.web.v2016_09_01.models.MetricAvailabilily(*, time_grain: str = None, retention: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Metric availability and retention.

Parameters

time_grain (str) – Time grain.
retention (str) – Retention period for the current time grain.

class azure.mgmt.web.v2016_09_01.models.MetricDefinition(*, kind: str = None, **kwargs)[source]¶

Bases: azure.mgmt.web.v2016_09_01.models._models_py3.ProxyOnlyResource

Metadata for a metric.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id.
name (str) – Resource Name.
type (str) – Resource type.
metric_definition_name (str) – Name of the metric.
unit (str) – Unit of the metric.
primary_aggregation_type (str) – Primary aggregation type.
metric_availabilities (list[MetricAvailabilily]) – List of time grains supported for the metric together with retention period.
display_name (str) – Friendly name shown in the UI.

Parameters

kind (str) – Kind of resource.

class azure.mgmt.web.v2016_09_01.models.NameValuePair(*, name: str = None, value: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Name value pair.

Parameters

name (str) – Pair name.
value (str) – Pair value.

class azure.mgmt.web.v2016_09_01.models.NetworkAccessControlEntry(*, action=None, description: str = None, order: int = None, remote_subnet: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Network access control entry.

Parameters

action (str or AccessControlEntryAction) – Action object. Possible values include: ‘Permit’, ‘Deny’
description (str) – Description of network access control entry.
order (int) – Order of precedence.
remote_subnet (str) – Remote subnet.

class azure.mgmt.web.v2016_09_01.models.Operation(*, id: str = None, name: str = None, status=None, errors=None, created_time=None, modified_time=None, expiration_time=None, geo_master_operation_id: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

An operation on a resource.

Parameters

id (str) – Operation ID.
name (str) – Operation name.
status (str or OperationStatus) – The current status of the operation. Possible values include: ‘InProgress’, ‘Failed’, ‘Succeeded’, ‘TimedOut’, ‘Created’
errors (list[ErrorEntity]) – Any errors associate with the operation.
created_time (datetime) – Time when operation has started.
modified_time (datetime) – Time when operation has been updated.
expiration_time (datetime) – Time when operation will expire.
geo_master_operation_id (str) – Applicable only for stamp operation ids.

class azure.mgmt.web.v2016_09_01.models.ProxyOnlyResource(*, kind: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Azure proxy only resource. This resource is not tracked by Azure Resource Manager.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id.
name (str) – Resource Name.
type (str) – Resource type.

Parameters

kind (str) – Kind of resource.

class azure.mgmt.web.v2016_09_01.models.PushSettings(*, is_push_enabled: bool, kind: str = None, tag_whitelist_json: str = None, tags_requiring_auth: str = None, dynamic_tags_json: str = None, **kwargs)[source]¶

Bases: azure.mgmt.web.v2016_09_01.models._models_py3.ProxyOnlyResource

Push settings for the App.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – Resource Id.
name (str) – Resource Name.
type (str) – Resource type.

Parameters

kind (str) – Kind of resource.
is_push_enabled (bool) – Required. Gets or sets a flag indicating whether the Push endpoint is enabled.
tag_whitelist_json (str) – Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.
tags_requiring_auth (str) – Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: ‘_’, ‘@’, ‘#’, ‘.’, ‘:’, ‘-‘. Validation should be performed at the PushRequestHandler.
dynamic_tags_json (str) – Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.

class azure.mgmt.web.v2016_09_01.models.RampUpRule(*, action_host_name: str = None, reroute_percentage: float = None, change_step: float = None, change_interval_in_minutes: int = None, min_reroute_percentage: float = None, max_reroute_percentage: float = None, change_decision_callback_url: str = None, name: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.

Parameters

action_host_name (str) – Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.
reroute_percentage (float) – Percentage of the traffic which will be redirected to <code>ActionHostName</code>.
change_step (float) – In auto ramp up scenario this is the step to add/remove from <code>ReroutePercentage</code> until it reaches <code>MinReroutePercentage</code> or <code>MaxReroutePercentage</code>. Site metrics are checked every N minutes specified in <code>ChangeIntervalInMinutes</code>. Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified in <code>ChangeDecisionCallbackUrl</code>.
change_interval_in_minutes (int) – Specifies interval in minutes to reevaluate ReroutePercentage.
min_reroute_percentage (float) – Specifies lower boundary above which ReroutePercentage will stay.
max_reroute_percentage (float) – Specifies upper boundary below which ReroutePercentage will stay.
change_decision_callback_url (str) – Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts. https://www.siteextensions.net/packages/TiPCallback/
name (str) – Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.

class azure.mgmt.web.v2016_09_01.models.RequestsBasedTrigger(*, count: int = None, time_interval: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Trigger based on total requests.

Parameters

count (int) – Request Count.
time_interval (str) – Time interval.

class azure.mgmt.web.v2016_09_01.models.Resource(*, location: str, kind: str = None, tags=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Azure resource. This resource is tracked in Azure Resource Manager.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – Resource Id.
name (str) – Resource Name.
type (str) – Resource type.

Parameters

kind (str) – Kind of resource.
location (str) – Required. Resource Location.
tags (dict[str, str]) – Resource tags.

class azure.mgmt.web.v2016_09_01.models.ResourceMetric(**kwargs)[source]¶

Bases: msrest.serialization.Model

Object representing a metric for any resource .

Variables are only populated by the server, and will be ignored when sending a request.

Variables

name (ResourceMetricName) – Name of metric.
unit (str) – Metric unit.
time_grain (str) – Metric granularity. E.g PT1H, PT5M, P1D
start_time (datetime) – Metric start time.
end_time (datetime) – Metric end time.
resource_id (str) – Metric resource Id.
id (str) – Resource Id.
metric_values (list[ResourceMetricValue]) – Metric values.
properties (list[ResourceMetricProperty]) – Resource metric properties collection.

class azure.mgmt.web.v2016_09_01.models.ResourceMetricAvailability(**kwargs)[source]¶

Bases: msrest.serialization.Model

Metrics availability and retention.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

time_grain (str) – Time grain .
retention (str) – Retention period for the current time grain.

class azure.mgmt.web.v2016_09_01.models.ResourceMetricDefinition(*, kind: str = None, **kwargs)[source]¶

Bases: azure.mgmt.web.v2016_09_01.models._models_py3.ProxyOnlyResource

Metadata for the metrics.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id.
name (str) – Resource Name.
type (str) – Resource type.
resource_metric_definition_name (ResourceMetricName) – Name of the metric.
unit (str) – Unit of the metric.
primary_aggregation_type (str) – Primary aggregation type.
metric_availabilities (list[ResourceMetricAvailability]) – List of time grains supported for the metric together with retention period.
resource_uri (str) – Resource URI.
resource_metric_definition_id (str) – Resource ID.
properties (dict[str, str]) – Resource metric definition properties.

Parameters

kind (str) – Kind of resource.

class azure.mgmt.web.v2016_09_01.models.ResourceMetricName(**kwargs)[source]¶

Bases: msrest.serialization.Model

Name of a metric for any resource .

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (str) – metric name value.
localized_value (str) – Localized metric name value.

class azure.mgmt.web.v2016_09_01.models.ResourceMetricProperty(*, key: str = None, value: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Resource metric property.

Parameters

key (str) – Key for resource metric property.
value (str) – Value of pair.

class azure.mgmt.web.v2016_09_01.models.ResourceMetricValue(**kwargs)[source]¶

Bases: msrest.serialization.Model

Value of resource metric.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

timestamp (str) – Value timestamp.
average (float) – Value average.
minimum (float) – Value minimum.
maximum (float) – Value maximum.
total (float) – Value total.
count (float) – Value count.
properties (list[ResourceMetricProperty]) – Resource metric properties collection.

class azure.mgmt.web.v2016_09_01.models.Site(*, location: str, kind: str = None, tags=None, enabled: bool = None, host_name_ssl_states=None, server_farm_id: str = None, reserved: bool = False, site_config=None, scm_site_also_stopped: bool = False, hosting_environment_profile=None, client_affinity_enabled: bool = None, client_cert_enabled: bool = None, host_names_disabled: bool = None, container_size: int = None, daily_memory_time_quota: int = None, cloning_info=None, snapshot_info=None, https_only: bool = None, identity=None, **kwargs)[source]¶

Bases: azure.mgmt.web.v2016_09_01.models._models_py3.Resource

A web app, a mobile app backend, or an API app.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – Resource Id.
name (str) – Resource Name.
type (str) – Resource type.
state (str) – Current state of the app.
host_names (list[str]) – Hostnames associated with the app.
repository_site_name (str) – Name of the repository site.
usage_state (str or UsageState) – State indicating whether the app has exceeded its quota usage. Read-only. Possible values include: ‘Normal’, ‘Exceeded’
enabled_host_names (list[str]) – Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames.
availability_state (str or SiteAvailabilityState) – Management information availability state for the app. Possible values include: ‘Normal’, ‘Limited’, ‘DisasterRecoveryMode’
last_modified_time_utc (datetime) – Last time the app was modified, in UTC. Read-only.
traffic_manager_host_names (list[str]) – Azure Traffic Manager hostnames associated with the app. Read-only.
target_swap_slot (str) – Specifies which deployment slot this app will swap into. Read-only.
outbound_ip_addresses (str) – List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only.
possible_outbound_ip_addresses (str) – List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only.
suspended_till (datetime) – App suspended till in case memory-time quota is exceeded.
max_number_of_workers (int) – Maximum number of workers. This only applies to Functions container.
resource_group (str) – Name of the resource group the app belongs to. Read-only.
is_default_container (bool) – <code>true</code> if the app is a default container; otherwise, <code>false</code>.
default_host_name (str) – Default hostname of the app. Read-only.
slot_swap_status (SlotSwapStatus) – Status of the last deployment slot swap operation.

Parameters

kind (str) – Kind of resource.
location (str) – Required. Resource Location.
tags (dict[str, str]) – Resource tags.
enabled (bool) – <code>true</code> if the app is enabled; otherwise, <code>false</code>. Setting this value to false disables the app (takes the app offline).
host_name_ssl_states (list[HostNameSslState]) – Hostname SSL states are used to manage the SSL bindings for app’s hostnames.
server_farm_id (str) – Resource ID of the associated App Service plan, formatted as: “/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}”.
reserved (bool) – <code>true</code> if reserved; otherwise, <code>false</code>. Default value: False .
site_config (SiteConfig) – Configuration of the app.
scm_site_also_stopped (bool) – <code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>. The default is <code>false</code>. Default value: False .
hosting_environment_profile (HostingEnvironmentProfile) – App Service Environment to use for the app.
client_affinity_enabled (bool) – <code>true</code> to enable client affinity; <code>false</code> to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is <code>true</code>.
client_cert_enabled (bool) – <code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>.
host_names_disabled (bool) – <code>true</code> to disable the public hostnames of the app; otherwise, <code>false</code>. If <code>true</code>, the app is only accessible via API management process.
container_size (int) – Size of the function container.
daily_memory_time_quota (int) – Maximum allowed daily memory-time quota (applicable on dynamic apps only).
cloning_info (CloningInfo) – If specified during app creation, the app is cloned from a source app.
snapshot_info (SnapshotRecoveryRequest) – If specified during app creation, the app is created from a previous snapshot.
https_only (bool) – HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests
identity (ManagedServiceIdentity) –

class azure.mgmt.web.v2016_09_01.models.SiteConfig(*, number_of_workers: int = None, default_documents=None, net_framework_version: str = 'v4.6', php_version: str = None, python_version: str = None, node_version: str = None, linux_fx_version: str = None, request_tracing_enabled: bool = None, request_tracing_expiration_time=None, remote_debugging_enabled: bool = None, remote_debugging_version: str = None, http_logging_enabled: bool = None, logs_directory_size_limit: int = None, detailed_error_logging_enabled: bool = None, publishing_username: str = None, app_settings=None, connection_strings=None, handler_mappings=None, document_root: str = None, scm_type=None, use32_bit_worker_process: bool = None, web_sockets_enabled: bool = None, always_on: bool = None, java_version: str = None, java_container: str = None, java_container_version: str = None, app_command_line: str = None, managed_pipeline_mode=None, virtual_applications=None, load_balancing=None, experiments=None, limits=None, auto_heal_enabled: bool = None, auto_heal_rules=None, tracing_options: str = None, vnet_name: str = None, cors=None, push=None, api_definition=None, auto_swap_slot_name: str = None, local_my_sql_enabled: bool = False, ip_security_restrictions=None, http20_enabled: bool = True, min_tls_version=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Configuration of an App Service app.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

number_of_workers (int) – Number of workers.
default_documents (list[str]) – Default documents.
net_framework_version (str) – .NET Framework version. Default value: “v4.6” .
php_version (str) – Version of PHP.
python_version (str) – Version of Python.
node_version (str) – Version of Node.js.
linux_fx_version (str) – Linux App Framework and version
request_tracing_enabled (bool) – <code>true</code> if request tracing is enabled; otherwise, <code>false</code>.
request_tracing_expiration_time (datetime) – Request tracing expiration time.
remote_debugging_enabled (bool) – <code>true</code> if remote debugging is enabled; otherwise, <code>false</code>.
remote_debugging_version (str) – Remote debugging version.
http_logging_enabled (bool) – <code>true</code> if HTTP logging is enabled; otherwise, <code>false</code>.
logs_directory_size_limit (int) – HTTP logs directory size limit.
detailed_error_logging_enabled (bool) – <code>true</code> if detailed error logging is enabled; otherwise, <code>false</code>.
publishing_username (str) – Publishing user name.
app_settings (list[NameValuePair]) – Application settings.
connection_strings (list[ConnStringInfo]) – Connection strings.
handler_mappings (list[HandlerMapping]) – Handler mappings.
document_root (str) – Document root.
scm_type (str or ScmType) – SCM type. Possible values include: ‘None’, ‘Dropbox’, ‘Tfs’, ‘LocalGit’, ‘GitHub’, ‘CodePlexGit’, ‘CodePlexHg’, ‘BitbucketGit’, ‘BitbucketHg’, ‘ExternalGit’, ‘ExternalHg’, ‘OneDrive’, ‘VSO’
use32_bit_worker_process (bool) – <code>true</code> to use 32-bit worker process; otherwise, <code>false</code>.
web_sockets_enabled (bool) – <code>true</code> if WebSocket is enabled; otherwise, <code>false</code>.
always_on (bool) – <code>true</code> if Always On is enabled; otherwise, <code>false</code>.
java_version (str) – Java version.
java_container (str) – Java container.
java_container_version (str) – Java container version.
app_command_line (str) – App command line to launch.
managed_pipeline_mode (str or ManagedPipelineMode) – Managed pipeline mode. Possible values include: ‘Integrated’, ‘Classic’
virtual_applications (list[VirtualApplication]) – Virtual applications.
load_balancing (str or SiteLoadBalancing) – Site load balancing. Possible values include: ‘WeightedRoundRobin’, ‘LeastRequests’, ‘LeastResponseTime’, ‘WeightedTotalTraffic’, ‘RequestHash’
experiments (Experiments) – This is work around for polymorphic types.
limits (SiteLimits) – Site limits.
auto_heal_enabled (bool) – <code>true</code> if Auto Heal is enabled; otherwise, <code>false</code>.
auto_heal_rules (AutoHealRules) – Auto Heal rules.
tracing_options (str) – Tracing options.
vnet_name (str) – Virtual Network name.
cors (CorsSettings) – Cross-Origin Resource Sharing (CORS) settings.
push (PushSettings) – Push endpoint settings.
api_definition (ApiDefinitionInfo) – Information about the formal API definition for the app.
auto_swap_slot_name (str) – Auto-swap slot name.
local_my_sql_enabled (bool) – <code>true</code> to enable local MySQL; otherwise, <code>false</code>. Default value: False .
ip_security_restrictions (list[IpSecurityRestriction]) – IP security restrictions.
http20_enabled (bool) – Http20Enabled: configures a web site to allow clients to connect over http2.0. Default value: True .
min_tls_version (str or SupportedTlsVersions) – MinTlsVersion: configures the minimum version of TLS required for SSL requests. Possible values include: ‘1.0’, ‘1.1’, ‘1.2’

Variables

machine_key (SiteMachineKey) – Site MachineKey.

class azure.mgmt.web.v2016_09_01.models.SiteLimits(*, max_percentage_cpu: float = None, max_memory_in_mb: int = None, max_disk_size_in_mb: int = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Metric limits set on an app.

Parameters

max_percentage_cpu (float) – Maximum allowed CPU usage percentage.
max_memory_in_mb (long) – Maximum allowed memory usage in MB.
max_disk_size_in_mb (long) – Maximum allowed disk size usage in MB.

class azure.mgmt.web.v2016_09_01.models.SiteMachineKey(*, validation: str = None, validation_key: str = None, decryption: str = None, decryption_key: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

MachineKey of an app.

Parameters

validation (str) – MachineKey validation.
validation_key (str) – Validation key.
decryption (str) – Algorithm used for decryption.
decryption_key (str) – Decryption key.

class azure.mgmt.web.v2016_09_01.models.SkuCapacity(*, minimum: int = None, maximum: int = None, default: int = None, scale_type: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Description of the App Service plan scale options.

Parameters

minimum (int) – Minimum number of workers for this App Service plan SKU.
maximum (int) – Maximum number of workers for this App Service plan SKU.
default (int) – Default number of workers for this App Service plan SKU.
scale_type (str) – Available scale configurations for an App Service plan.

class azure.mgmt.web.v2016_09_01.models.SkuDescription(*, name: str = None, tier: str = None, size: str = None, family: str = None, capacity: int = None, sku_capacity=None, locations=None, capabilities=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Description of a SKU for a scalable resource.

Parameters

name (str) – Name of the resource SKU.
tier (str) – Service tier of the resource SKU.
size (str) – Size specifier of the resource SKU.
family (str) – Family code of the resource SKU.
capacity (int) – Current number of instances assigned to the resource.
sku_capacity (SkuCapacity) – Min, max, and default scale values of the SKU.
locations (list[str]) – Locations of the SKU.
capabilities (list[Capability]) – Capabilities of the SKU, e.g., is traffic manager enabled?

class azure.mgmt.web.v2016_09_01.models.SkuInfo(*, resource_type: str = None, sku=None, capacity=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

SKU discovery information.

Parameters

resource_type (str) – Resource type that this SKU applies to.
sku (SkuDescription) – Name and tier of the SKU.
capacity (SkuCapacity) – Min, max, and default scale values of the SKU.

class azure.mgmt.web.v2016_09_01.models.SlotSwapStatus(**kwargs)[source]¶

Bases: msrest.serialization.Model

The status of the last successful slot swap operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

timestamp_utc (datetime) – The time the last successful slot swap completed.
source_slot_name (str) – The source slot of the last swap operation.
destination_slot_name (str) – The destination slot of the last swap operation.

class azure.mgmt.web.v2016_09_01.models.SlowRequestsBasedTrigger(*, time_taken: str = None, count: int = None, time_interval: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Trigger based on request execution time.

Parameters

time_taken (str) – Time taken.
count (int) – Request Count.
time_interval (str) – Time interval.

class azure.mgmt.web.v2016_09_01.models.SnapshotRecoveryRequest(*, overwrite: bool, kind: str = None, snapshot_time: str = None, recovery_target=None, recover_configuration: bool = None, ignore_conflicting_host_names: bool = None, **kwargs)[source]¶

Bases: azure.mgmt.web.v2016_09_01.models._models_py3.ProxyOnlyResource

Details about app recovery operation.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – Resource Id.
name (str) – Resource Name.
type (str) – Resource type.

Parameters

kind (str) – Kind of resource.
snapshot_time (str) – Point in time in which the app recovery should be attempted, formatted as a DateTime string.
recovery_target (SnapshotRecoveryTarget) – Specifies the web app that snapshot contents will be written to.
overwrite (bool) – Required. If <code>true</code> the recovery operation can overwrite source app; otherwise, <code>false</code>.
recover_configuration (bool) – If true, site configuration, in addition to content, will be reverted.
ignore_conflicting_host_names (bool) – If true, custom hostname conflicts will be ignored when recovering to a target web app. This setting is only necessary when RecoverConfiguration is enabled.

class azure.mgmt.web.v2016_09_01.models.SnapshotRecoveryTarget(*, location: str = None, id: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Specifies the web app that snapshot contents will be written to.

Parameters

location (str) – Geographical location of the target web app, e.g. SouthEastAsia, SouthCentralUS
id (str) – ARM resource ID of the target app. /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.

class azure.mgmt.web.v2016_09_01.models.StampCapacity(*, name: str = None, available_capacity: int = None, total_capacity: int = None, unit: str = None, compute_mode=None, worker_size=None, worker_size_id: int = None, exclude_from_capacity_allocation: bool = None, is_applicable_for_all_compute_modes: bool = None, site_mode: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Stamp capacity information.

Parameters

name (str) – Name of the stamp.
available_capacity (long) – Available capacity (# of machines, bytes of storage etc…).
total_capacity (long) – Total capacity (# of machines, bytes of storage etc…).
unit (str) – Name of the unit.
compute_mode (str or ComputeModeOptions) – Shared/dedicated workers. Possible values include: ‘Shared’, ‘Dedicated’, ‘Dynamic’
worker_size (str or WorkerSizeOptions) – Size of the machines. Possible values include: ‘Default’, ‘Small’, ‘Medium’, ‘Large’, ‘D1’, ‘D2’, ‘D3’
worker_size_id (int) – Size ID of machines: 0 - Small 1 - Medium 2 - Large
exclude_from_capacity_allocation (bool) – If <code>true</code>, it includes basic apps. Basic apps are not used for capacity allocation.
is_applicable_for_all_compute_modes (bool) – <code>true</code> if capacity is applicable for all apps; otherwise, <code>false</code>.
site_mode (str) – Shared or Dedicated.

class azure.mgmt.web.v2016_09_01.models.StatusCodesBasedTrigger(*, status: int = None, sub_status: int = None, win32_status: int = None, count: int = None, time_interval: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Trigger based on status code.

Parameters

status (int) – HTTP status code.
sub_status (int) – Request Sub Status.
win32_status (int) – Win32 error code.
count (int) – Request Count.
time_interval (str) – Time interval.

class azure.mgmt.web.v2016_09_01.models.Usage(*, kind: str = None, **kwargs)[source]¶

Bases: azure.mgmt.web.v2016_09_01.models._models_py3.ProxyOnlyResource

Usage of the quota resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id.
name (str) – Resource Name.
type (str) – Resource type.
display_name (str) – Friendly name shown in the UI.
usage_name (str) – Name of the quota.
resource_name (str) – Name of the quota resource.
unit (str) – Units of measurement for the quota resource.
current_value (long) – The current value of the resource counter.
limit (long) – The resource limit.
next_reset_time (datetime) – Next reset time for the resource counter.
compute_mode (str or ComputeModeOptions) – Compute mode used for this usage. Possible values include: ‘Shared’, ‘Dedicated’, ‘Dynamic’
site_mode (str) – Site mode used for this usage.

Parameters

kind (str) – Kind of resource.

class azure.mgmt.web.v2016_09_01.models.User(*, publishing_user_name: str, kind: str = None, user_name: str = None, publishing_password: str = None, publishing_password_hash: str = None, publishing_password_hash_salt: str = None, **kwargs)[source]¶

Bases: azure.mgmt.web.v2016_09_01.models._models_py3.ProxyOnlyResource

User credentials used for publishing activity.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – Resource Id.
name (str) – Resource Name.
type (str) – Resource type.

Parameters

kind (str) – Kind of resource.
user_name (str) – Username
publishing_user_name (str) – Required. Username used for publishing.
publishing_password (str) – Password used for publishing.
publishing_password_hash (str) – Password hash used for publishing.
publishing_password_hash_salt (str) – Password hash salt used for publishing.

class azure.mgmt.web.v2016_09_01.models.VirtualApplication(*, virtual_path: str = None, physical_path: str = None, preload_enabled: bool = None, virtual_directories=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Virtual application in an app.

Parameters

virtual_path (str) – Virtual path.
physical_path (str) – Physical path.
preload_enabled (bool) – <code>true</code> if preloading is enabled; otherwise, <code>false</code>.
virtual_directories (list[VirtualDirectory]) – Virtual directories for virtual application.

class azure.mgmt.web.v2016_09_01.models.VirtualDirectory(*, virtual_path: str = None, physical_path: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Directory for virtual application.

Parameters

virtual_path (str) – Path to virtual application.
physical_path (str) – Physical path.

class azure.mgmt.web.v2016_09_01.models.VirtualIPMapping(*, virtual_ip: str = None, internal_http_port: int = None, internal_https_port: int = None, in_use: bool = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Virtual IP mapping.

Parameters

virtual_ip (str) – Virtual IP address.
internal_http_port (int) – Internal HTTP port.
internal_https_port (int) – Internal HTTPS port.
in_use (bool) – Is virtual IP mapping in use.

class azure.mgmt.web.v2016_09_01.models.VirtualNetworkProfile(*, id: str = None, subnet: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Specification for using a Virtual Network.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

id (str) – Resource id of the Virtual Network.
subnet (str) – Subnet within the Virtual Network.

Variables

name (str) – Name of the Virtual Network (read-only).
type (str) – Resource type of the Virtual Network (read-only).

class azure.mgmt.web.v2016_09_01.models.VnetGateway(*, vpn_package_uri: str, kind: str = None, vnet_name: str = None, **kwargs)[source]¶

Bases: azure.mgmt.web.v2016_09_01.models._models_py3.ProxyOnlyResource

The Virtual Network gateway contract. This is used to give the Virtual Network gateway access to the VPN package.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – Resource Id.
name (str) – Resource Name.
type (str) – Resource type.

Parameters

kind (str) – Kind of resource.
vnet_name (str) – The Virtual Network name.
vpn_package_uri (str) – Required. The URI where the VPN package can be downloaded.

class azure.mgmt.web.v2016_09_01.models.VnetInfo(*, kind: str = None, vnet_resource_id: str = None, cert_blob: bytearray = None, dns_servers: str = None, **kwargs)[source]¶

Bases: azure.mgmt.web.v2016_09_01.models._models_py3.ProxyOnlyResource

Virtual Network information contract.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id.
name (str) – Resource Name.
type (str) – Resource type.
cert_thumbprint (str) – The client certificate thumbprint.
routes (list[VnetRoute]) – The routes that this Virtual Network connection uses.
resync_required (bool) – <code>true</code> if a resync is required; otherwise, <code>false</code>.

Parameters

kind (str) – Kind of resource.
vnet_resource_id (str) – The Virtual Network’s resource ID.
cert_blob (bytearray) – A certificate file (.cer) blob containing the public key of the private key used to authenticate a Point-To-Site VPN connection.
dns_servers (str) – DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses.

class azure.mgmt.web.v2016_09_01.models.VnetRoute(*, kind: str = None, vnet_route_name: str = None, start_address: str = None, end_address: str = None, route_type=None, **kwargs)[source]¶

Bases: azure.mgmt.web.v2016_09_01.models._models_py3.ProxyOnlyResource

Virtual Network route contract used to pass routing information for a Virtual Network.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id.
name (str) – Resource Name.
type (str) – Resource type.

Parameters

kind (str) – Kind of resource.
vnet_route_name (str) – The name of this route. This is only returned by the server and does not need to be set by the client.
start_address (str) – The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.
end_address (str) – The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.
route_type (str or RouteType) – The type of route this is: DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 INHERITED - Routes inherited from the real Virtual Network routes STATIC - Static route set on the app only These values will be used for syncing an app’s routes with those from a Virtual Network. Possible values include: ‘DEFAULT’, ‘INHERITED’, ‘STATIC’

class azure.mgmt.web.v2016_09_01.models.WebAppCollection(*, value, **kwargs)[source]¶

Bases: msrest.serialization.Model

Collection of App Service apps.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters: value (list[Site]) – Required. Collection of resources.
Variables: next_link (str) – Link to next page of resources.

class azure.mgmt.web.v2016_09_01.models.WorkerPool(*, worker_size_id: int = None, compute_mode=None, worker_size: str = None, worker_count: int = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Worker pool of an App Service Environment.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

worker_size_id (int) – Worker size ID for referencing this worker pool.
compute_mode (str or ComputeModeOptions) – Shared or dedicated app hosting. Possible values include: ‘Shared’, ‘Dedicated’, ‘Dynamic’
worker_size (str) – VM size of the worker pool instances.
worker_count (int) – Number of instances in the worker pool.

Variables

instance_names (list[str]) – Names of all instances in the worker pool (read only).

class azure.mgmt.web.v2016_09_01.models.WorkerPoolResource(*, kind: str = None, worker_size_id: int = None, compute_mode=None, worker_size: str = None, worker_count: int = None, sku=None, **kwargs)[source]¶

Bases: azure.mgmt.web.v2016_09_01.models._models_py3.ProxyOnlyResource

Worker pool of an App Service Environment ARM resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id.
name (str) – Resource Name.
type (str) – Resource type.
instance_names (list[str]) – Names of all instances in the worker pool (read only).

Parameters

kind (str) – Kind of resource.
worker_size_id (int) – Worker size ID for referencing this worker pool.
compute_mode (str or ComputeModeOptions) – Shared or dedicated app hosting. Possible values include: ‘Shared’, ‘Dedicated’, ‘Dynamic’
worker_size (str) – VM size of the worker pool instances.
worker_count (int) – Number of instances in the worker pool.
sku (SkuDescription) –

class azure.mgmt.web.v2016_09_01.models.AppServiceEnvironmentResourcePaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of AppServiceEnvironmentResource object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.web.v2016_09_01.models.StampCapacityPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of StampCapacity object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.web.v2016_09_01.models.ResourceMetricPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of ResourceMetric object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.web.v2016_09_01.models.WorkerPoolResourcePaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of WorkerPoolResource object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.web.v2016_09_01.models.ResourceMetricDefinitionPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of ResourceMetricDefinition object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.web.v2016_09_01.models.SkuInfoPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of SkuInfo object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.web.v2016_09_01.models.UsagePaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of Usage object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.web.v2016_09_01.models.AppServicePlanPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of AppServicePlan object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.web.v2016_09_01.models.SitePaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of Site object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.web.v2016_09_01.models.CsmUsageQuotaPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of CsmUsageQuota object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.web.v2016_09_01.models.StrPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of str object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.web.v2016_09_01.models.HybridConnectionPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of HybridConnection object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.web.v2016_09_01.models.ProvisioningState[source]¶

Bases: str, enum.Enum

An enumeration.

canceled = 'Canceled'¶

deleting = 'Deleting'¶

failed = 'Failed'¶

in_progress = 'InProgress'¶

succeeded = 'Succeeded'¶

class azure.mgmt.web.v2016_09_01.models.HostingEnvironmentStatus[source]¶

Bases: str, enum.Enum

An enumeration.

deleting = 'Deleting'¶

preparing = 'Preparing'¶

ready = 'Ready'¶

scaling = 'Scaling'¶

class azure.mgmt.web.v2016_09_01.models.InternalLoadBalancingMode[source]¶

Bases: str, enum.Enum

An enumeration.

none = 'None'¶

publishing = 'Publishing'¶

web = 'Web'¶

class azure.mgmt.web.v2016_09_01.models.ComputeModeOptions[source]¶

Bases: str, enum.Enum

An enumeration.

dedicated = 'Dedicated'¶

dynamic = 'Dynamic'¶

shared = 'Shared'¶

class azure.mgmt.web.v2016_09_01.models.WorkerSizeOptions[source]¶

Bases: str, enum.Enum

An enumeration.

d1 = 'D1'¶

d2 = 'D2'¶

d3 = 'D3'¶

default = 'Default'¶

large = 'Large'¶

medium = 'Medium'¶

small = 'Small'¶

class azure.mgmt.web.v2016_09_01.models.AccessControlEntryAction[source]¶

Bases: str, enum.Enum

An enumeration.

deny = 'Deny'¶

permit = 'Permit'¶

class azure.mgmt.web.v2016_09_01.models.RouteType[source]¶

Bases: str, enum.Enum

An enumeration.

default = 'DEFAULT'¶

inherited = 'INHERITED'¶

static = 'STATIC'¶

class azure.mgmt.web.v2016_09_01.models.ManagedServiceIdentityType[source]¶

Bases: str, enum.Enum

An enumeration.

system_assigned = 'SystemAssigned'¶

class azure.mgmt.web.v2016_09_01.models.AutoHealActionType[source]¶

Bases: str, enum.Enum

An enumeration.

custom_action = 'CustomAction'¶

log_event = 'LogEvent'¶

recycle = 'Recycle'¶

class azure.mgmt.web.v2016_09_01.models.ConnectionStringType[source]¶

Bases: str, enum.Enum

An enumeration.

api_hub = 'ApiHub'¶

custom = 'Custom'¶

doc_db = 'DocDb'¶

event_hub = 'EventHub'¶

my_sql = 'MySql'¶

notification_hub = 'NotificationHub'¶

postgre_sql = 'PostgreSQL'¶

redis_cache = 'RedisCache'¶

service_bus = 'ServiceBus'¶

sql_azure = 'SQLAzure'¶

sql_server = 'SQLServer'¶

class azure.mgmt.web.v2016_09_01.models.ScmType[source]¶

Bases: str, enum.Enum

An enumeration.

bitbucket_git = 'BitbucketGit'¶

bitbucket_hg = 'BitbucketHg'¶

code_plex_git = 'CodePlexGit'¶

code_plex_hg = 'CodePlexHg'¶

dropbox = 'Dropbox'¶

external_git = 'ExternalGit'¶

external_hg = 'ExternalHg'¶

git_hub = 'GitHub'¶

local_git = 'LocalGit'¶

none = 'None'¶

one_drive = 'OneDrive'¶

tfs = 'Tfs'¶

vso = 'VSO'¶

class azure.mgmt.web.v2016_09_01.models.ManagedPipelineMode[source]¶

Bases: str, enum.Enum

An enumeration.

classic = 'Classic'¶

integrated = 'Integrated'¶

class azure.mgmt.web.v2016_09_01.models.SiteLoadBalancing[source]¶

Bases: str, enum.Enum

An enumeration.

least_requests = 'LeastRequests'¶

least_response_time = 'LeastResponseTime'¶

request_hash = 'RequestHash'¶

weighted_round_robin = 'WeightedRoundRobin'¶

weighted_total_traffic = 'WeightedTotalTraffic'¶

class azure.mgmt.web.v2016_09_01.models.SupportedTlsVersions[source]¶

Bases: str, enum.Enum

An enumeration.

one_full_stop_one = '1.1'¶

one_full_stop_two = '1.2'¶

one_full_stop_zero = '1.0'¶

class azure.mgmt.web.v2016_09_01.models.SslState[source]¶

Bases: str, enum.Enum

An enumeration.

disabled = 'Disabled'¶

ip_based_enabled = 'IpBasedEnabled'¶

sni_enabled = 'SniEnabled'¶

class azure.mgmt.web.v2016_09_01.models.HostType[source]¶

Bases: str, enum.Enum

An enumeration.

repository = 'Repository'¶

standard = 'Standard'¶

class azure.mgmt.web.v2016_09_01.models.UsageState[source]¶

Bases: str, enum.Enum

An enumeration.

exceeded = 'Exceeded'¶

normal = 'Normal'¶

class azure.mgmt.web.v2016_09_01.models.SiteAvailabilityState[source]¶

Bases: str, enum.Enum

An enumeration.

disaster_recovery_mode = 'DisasterRecoveryMode'¶

limited = 'Limited'¶

normal = 'Normal'¶

class azure.mgmt.web.v2016_09_01.models.StatusOptions[source]¶

Bases: str, enum.Enum

An enumeration.

creating = 'Creating'¶

pending = 'Pending'¶

ready = 'Ready'¶

class azure.mgmt.web.v2016_09_01.models.OperationStatus[source]¶

Bases: str, enum.Enum

An enumeration.

created = 'Created'¶

failed = 'Failed'¶

in_progress = 'InProgress'¶

succeeded = 'Succeeded'¶

timed_out = 'TimedOut'¶