azure.mgmt.web.v2016_08_01.models module¶

class azure.mgmt.web.v2016_08_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_08_01.models.ApplicationLogsConfig(*, file_system=None, azure_table_storage=None, azure_blob_storage=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Application logs configuration.

Parameters

file_system (FileSystemApplicationLogsConfig) – Application logs to file system configuration.
azure_table_storage (AzureTableStorageApplicationLogsConfig) – Application logs to azure table storage configuration.
azure_blob_storage (AzureBlobStorageApplicationLogsConfig) – Application logs to blob storage configuration.

class azure.mgmt.web.v2016_08_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_08_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_08_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_08_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_08_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_08_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_08_01.models.AzureBlobStorageApplicationLogsConfig(*, level=None, sas_url: str = None, retention_in_days: int = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Application logs azure blob storage configuration.

Parameters

level (str or LogLevel) – Log level. Possible values include: ‘Off’, ‘Verbose’, ‘Information’, ‘Warning’, ‘Error’
sas_url (str) – SAS url to a azure blob container with read/write/list/delete permissions.
retention_in_days (int) – Retention in days. Remove blobs older than X days. 0 or lower means no retention.

class azure.mgmt.web.v2016_08_01.models.AzureBlobStorageHttpLogsConfig(*, sas_url: str = None, retention_in_days: int = None, enabled: bool = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Http logs to azure blob storage configuration.

Parameters

sas_url (str) – SAS url to a azure blob container with read/write/list/delete permissions.
retention_in_days (int) – Retention in days. Remove blobs older than X days. 0 or lower means no retention.
enabled (bool) – True if configuration is enabled, false if it is disabled and null if configuration is not set.

class azure.mgmt.web.v2016_08_01.models.AzureTableStorageApplicationLogsConfig(*, sas_url: str, level=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Application logs to Azure table storage configuration.

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

Parameters

level (str or LogLevel) – Log level. Possible values include: ‘Off’, ‘Verbose’, ‘Information’, ‘Warning’, ‘Error’
sas_url (str) – Required. SAS URL to an Azure table with add/query/delete permissions.

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

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

Backup description.

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.
backup_id (int) – Id of the backup.
storage_account_url (str) – SAS URL for the storage account container which contains this backup.
blob_name (str) – Name of the blob which contains data for this backup.
backup_item_name (str) – Name of this backup.
status (str or BackupItemStatus) – Backup status. Possible values include: ‘InProgress’, ‘Failed’, ‘Succeeded’, ‘TimedOut’, ‘Created’, ‘Skipped’, ‘PartiallySucceeded’, ‘DeleteInProgress’, ‘DeleteFailed’, ‘Deleted’
size_in_bytes (long) – Size of the backup in bytes.
created (datetime) – Timestamp of the backup creation.
log (str) – Details regarding this backup. Might contain an error message.
databases (list[DatabaseBackupSetting]) – List of databases included in the backup.
scheduled (bool) – True if this backup has been created due to a schedule being triggered.
last_restore_time_stamp (datetime) – Timestamp of a last restore operation which used this backup.
finished_time_stamp (datetime) – Timestamp when this backup finished.
correlation_id (str) – Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support.
website_size_in_bytes (long) – Size of the original web app which has been backed up.

Parameters

kind (str) – Kind of resource.

class azure.mgmt.web.v2016_08_01.models.BackupRequest(*, backup_request_name: str, storage_account_url: str, kind: str = None, enabled: bool = None, backup_schedule=None, databases=None, backup_request_type=None, **kwargs)[source]¶

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

Description of a backup which will be performed.

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.
backup_request_name (str) – Required. Name of the backup.
enabled (bool) – True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled.
storage_account_url (str) – Required. SAS URL to the container.
backup_schedule (BackupSchedule) – Schedule for the backup if it is executed periodically.
databases (list[DatabaseBackupSetting]) – Databases included in the backup.
backup_request_type (str or BackupRestoreOperationType) – Type of the backup. Possible values include: ‘Default’, ‘Clone’, ‘Relocation’, ‘Snapshot’

class azure.mgmt.web.v2016_08_01.models.BackupSchedule(*, frequency_interval: int = 7, frequency_unit='Day', keep_at_least_one_backup: bool = True, retention_period_in_days: int = 30, start_time=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy.

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

frequency_interval (int) – Required. How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day). Default value: 7 .
frequency_unit (str or FrequencyUnit) – Required. The unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7). Possible values include: ‘Day’, ‘Hour’. Default value: “Day” .
keep_at_least_one_backup (bool) – Required. True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. Default value: True .
retention_period_in_days (int) – Required. After how many days backups should be deleted. Default value: 30 .
start_time (datetime) – When the schedule should start working.

Variables

last_execution_time (datetime) – Last time when this schedule was triggered.

class azure.mgmt.web.v2016_08_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_08_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_08_01.models.ConnectionStringDictionary(*, kind: str = None, properties=None, **kwargs)[source]¶

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

String dictionary 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.

Parameters

kind (str) – Kind of resource.
properties (dict[str, ConnStringValueTypePair]) – Connection strings.

class azure.mgmt.web.v2016_08_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_08_01.models.ConnStringValueTypePair(*, value: str, type, **kwargs)[source]¶

Bases: msrest.serialization.Model

Database connection string value to type pair.

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

Parameters

value (str) – Required. Value of pair.
type (str or ConnectionStringType) – Required. Type of database. Possible values include: ‘MySql’, ‘SQLServer’, ‘SQLAzure’, ‘Custom’, ‘NotificationHub’, ‘ServiceBus’, ‘EventHub’, ‘ApiHub’, ‘DocDb’, ‘RedisCache’, ‘PostgreSQL’

class azure.mgmt.web.v2016_08_01.models.ContinuousWebJob(*, kind: str = None, status=None, detailed_status: str = None, log_url: str = None, run_command: str = None, url: str = None, extra_info_url: str = None, job_type=None, error: str = None, using_sdk: bool = None, settings=None, **kwargs)[source]¶

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

Continuous Web Job Information.

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.
continuous_web_job_name (str) – Job name. Used as job identifier in ARM resource URI.

Parameters

kind (str) – Kind of resource.
status (str or ContinuousWebJobStatus) – Job status. Possible values include: ‘Initializing’, ‘Starting’, ‘Running’, ‘PendingRestart’, ‘Stopped’
detailed_status (str) – Detailed status.
log_url (str) – Log URL.
run_command (str) – Run command.
url (str) – Job URL.
extra_info_url (str) – Extra Info URL.
job_type (str or WebJobType) – Job type. Possible values include: ‘Continuous’, ‘Triggered’
error (str) – Error information.
using_sdk (bool) – Using SDK?
settings (dict[str, object]) – Job settings.

class azure.mgmt.web.v2016_08_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_08_01.models.CsmPublishingProfileOptions(*, format=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Publishing options for requested profile.

Parameters: format (str or PublishingProfileFormat) – Name of the format. Valid values are: FileZilla3 WebDeploy – default Ftp. Possible values include: ‘FileZilla3’, ‘WebDeploy’, ‘Ftp’

class azure.mgmt.web.v2016_08_01.models.CsmSlotEntity(*, target_slot: str, preserve_vnet: bool, **kwargs)[source]¶

Bases: msrest.serialization.Model

Deployment slot parameters.

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

Parameters

target_slot (str) – Required. Destination deployment slot during swap operation.
preserve_vnet (bool) – Required. <code>true</code> to preserve Virtual Network to the slot during swap; otherwise, <code>false</code>.

class azure.mgmt.web.v2016_08_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_08_01.models.CustomHostnameAnalysisResult(*, kind: str = None, c_name_records=None, txt_records=None, a_records=None, alternate_cname_records=None, alternate_txt_records=None, **kwargs)[source]¶

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

Custom domain analysis.

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.
is_hostname_already_verified (bool) – <code>true</code> if hostname is already verified; otherwise, <code>false</code>.
custom_domain_verification_test (str or DnsVerificationTestResult) – DNS verification test result. Possible values include: ‘Passed’, ‘Failed’, ‘Skipped’
custom_domain_verification_failure_info (ErrorEntity) – Raw failure information if DNS verification fails.
has_conflict_on_scale_unit (bool) – <code>true</code> if there is a conflict on a scale unit; otherwise, <code>false</code>.
has_conflict_across_subscription (bool) – <code>true</code> if there is a conflict across subscriptions; otherwise, <code>false</code>.
conflicting_app_resource_id (str) – Name of the conflicting app on scale unit if it’s within the same subscription.

Parameters

kind (str) – Kind of resource.
c_name_records (list[str]) – CName records controller can see for this hostname.
txt_records (list[str]) – TXT records controller can see for this hostname.
a_records (list[str]) – A records controller can see for this hostname.
alternate_cname_records (list[str]) – Alternate CName records controller can see for this hostname.
alternate_txt_records (list[str]) – Alternate TXT records controller can see for this hostname.

class azure.mgmt.web.v2016_08_01.models.DatabaseBackupSetting(*, database_type, name: str = None, connection_string_name: str = None, connection_string: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Database backup settings.

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

Parameters

database_type (str or DatabaseType) – Required. Database type (e.g. SqlAzure / MySql). Possible values include: ‘SqlAzure’, ‘MySql’, ‘LocalMySql’, ‘PostgreSql’
name (str) –
connection_string_name (str) – Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options.
connection_string (str) – Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one.

class azure.mgmt.web.v2016_08_01.models.Deployment(*, kind: str = None, deployment_id: str = None, status: int = None, message: str = None, author: str = None, deployer: str = None, author_email: str = None, start_time=None, end_time=None, active: bool = None, details: str = None, **kwargs)[source]¶

Bases: azure.mgmt.web.v2016_08_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.

Variables

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

Parameters

kind (str) – Kind of resource.
deployment_id (str) – Identifier for deployment.
status (int) – Deployment status.
message (str) – Details about deployment status.
author (str) – Who authored the deployment.
deployer (str) – Who performed the deployment.
author_email (str) – Author email.
start_time (datetime) – Start time.
end_time (datetime) – End time.
active (bool) – True if deployment is currently active, false if completed and null if not started.
details (str) – Details on deployment.

class azure.mgmt.web.v2016_08_01.models.EnabledConfig(*, enabled: bool = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Enabled configuration.

Parameters: enabled (bool) – True if configuration is enabled, false if it is disabled and null if configuration is not set.

class azure.mgmt.web.v2016_08_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_08_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_08_01.models.FileSystemApplicationLogsConfig(*, level='Off', **kwargs)[source]¶

Bases: msrest.serialization.Model

Application logs to file system configuration.

Parameters: level (str or LogLevel) – Log level. Possible values include: ‘Off’, ‘Verbose’, ‘Information’, ‘Warning’, ‘Error’. Default value: “Off” .

class azure.mgmt.web.v2016_08_01.models.FileSystemHttpLogsConfig(*, retention_in_mb: int = None, retention_in_days: int = None, enabled: bool = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Http logs to file system configuration.

Parameters

retention_in_mb (int) – Maximum size in megabytes that http log files can use. When reached old log files will be removed to make space for new ones. Value can range between 25 and 100.
retention_in_days (int) – Retention in days. Remove files older than X days. 0 or lower means no retention.
enabled (bool) – True if configuration is enabled, false if it is disabled and null if configuration is not set.

class azure.mgmt.web.v2016_08_01.models.FunctionEnvelope(*, kind: str = None, script_root_path_href: str = None, script_href: str = None, config_href: str = None, secrets_file_href: str = None, href: str = None, config=None, files=None, test_data: str = None, **kwargs)[source]¶

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

Web Job Information.

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.
function_envelope_name (str) – Function name.
function_app_id (str) – Function App ID.

Parameters

kind (str) – Kind of resource.
script_root_path_href (str) – Script root path URI.
script_href (str) – Script URI.
config_href (str) – Config URI.
secrets_file_href (str) – Secrets file URI.
href (str) – Function URI.
config (object) – Config information.
files (dict[str, str]) – File list.
test_data (str) – Test data used when testing via the Azure Portal.

class azure.mgmt.web.v2016_08_01.models.FunctionSecrets(*, kind: str = None, key: str = None, trigger_url: str = None, **kwargs)[source]¶

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

Function secrets.

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.
key (str) – Secret key.
trigger_url (str) – Trigger URL.

class azure.mgmt.web.v2016_08_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_08_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_08_01.models.HostNameBinding(*, kind: str = None, site_name: str = None, domain_id: str = None, azure_resource_name: str = None, azure_resource_type=None, custom_host_name_dns_record_type=None, host_name_type=None, ssl_state=None, thumbprint: str = None, **kwargs)[source]¶

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

A hostname binding object.

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.
virtual_ip (str) – Virtual IP address assigned to the hostname if IP based SSL is enabled.

Parameters

kind (str) – Kind of resource.
site_name (str) – App Service app name.
domain_id (str) – Fully qualified ARM domain resource URI.
azure_resource_name (str) – Azure resource name.
azure_resource_type (str or AzureResourceType) – Azure resource type. Possible values include: ‘Website’, ‘TrafficManager’
custom_host_name_dns_record_type (str or CustomHostNameDnsRecordType) – Custom DNS record type. Possible values include: ‘CName’, ‘A’
host_name_type (str or HostNameType) – Hostname type. Possible values include: ‘Verified’, ‘Managed’
ssl_state (str or SslState) – SSL type. Possible values include: ‘Disabled’, ‘SniEnabled’, ‘IpBasedEnabled’
thumbprint (str) – SSL certificate thumbprint

class azure.mgmt.web.v2016_08_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_08_01.models.HttpLogsConfig(*, file_system=None, azure_blob_storage=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Http logs configuration.

Parameters

file_system (FileSystemHttpLogsConfig) – Http logs to file system configuration.
azure_blob_storage (AzureBlobStorageHttpLogsConfig) – Http logs to azure blob storage configuration.

class azure.mgmt.web.v2016_08_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_08_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_08_01.models.HybridConnectionKey(*, kind: str = None, **kwargs)[source]¶

Bases: azure.mgmt.web.v2016_08_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_08_01.models.Identifier(*, kind: str = None, identifier_id: str = None, **kwargs)[source]¶

Bases: azure.mgmt.web.v2016_08_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_08_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_08_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_08_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_08_01.models.MigrateMySqlRequest(*, connection_string: str, migration_type, kind: str = None, **kwargs)[source]¶

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

MySQL migration request.

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.
connection_string (str) – Required. Connection string to the remote MySQL database.
migration_type (str or MySqlMigrationType) – Required. The type of migration operation to be done. Possible values include: ‘LocalToRemote’, ‘RemoteToLocal’

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

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

MySQL migration status.

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.
migration_operation_status (str or OperationStatus) – Status of the migration task. Possible values include: ‘InProgress’, ‘Failed’, ‘Succeeded’, ‘TimedOut’, ‘Created’
operation_id (str) – Operation ID for the migration task.
local_my_sql_enabled (bool) – True if the web app has in app MySql enabled

Parameters

kind (str) – Kind of resource.

class azure.mgmt.web.v2016_08_01.models.MSDeploy(*, kind: str = None, package_uri: str = None, connection_string: str = None, db_type: str = None, set_parameters_xml_file_uri: str = None, set_parameters=None, skip_app_data: bool = None, app_offline: bool = None, **kwargs)[source]¶

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

MSDeploy ARM PUT information.

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.
package_uri (str) – Package URI
connection_string (str) – SQL Connection String
db_type (str) – Database Type
set_parameters_xml_file_uri (str) – URI of MSDeploy Parameters file. Must not be set if SetParameters is used.
set_parameters (dict[str, str]) – MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used.
skip_app_data (bool) – Controls whether the MSDeploy operation skips the App_Data directory. If set to <code>true</code>, the existing App_Data directory on the destination will not be deleted, and any App_Data directory in the source will be ignored. Setting is <code>false</code> by default.
app_offline (bool) – Sets the AppOffline rule while the MSDeploy operation executes. Setting is <code>false</code> by default.

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

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

MSDeploy log.

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.
entries (list[MSDeployLogEntry]) – List of log entry messages

Parameters

kind (str) – Kind of resource.

class azure.mgmt.web.v2016_08_01.models.MSDeployLogEntry(**kwargs)[source]¶

Bases: msrest.serialization.Model

MSDeploy log entry.

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

Variables

time (datetime) – Timestamp of log entry
type (str or MSDeployLogEntryType) – Log entry type. Possible values include: ‘Message’, ‘Warning’, ‘Error’
message (str) – Log entry message

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

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

MSDeploy ARM response.

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.
deployer (str) – Username of deployer
provisioning_state (str or MSDeployProvisioningState) – Provisioning state. Possible values include: ‘accepted’, ‘running’, ‘succeeded’, ‘failed’, ‘canceled’
start_time (datetime) – Start time of deploy operation
end_time (datetime) – End time of deploy operation
complete (bool) – Whether the deployment operation has completed

Parameters

kind (str) – Kind of resource.

class azure.mgmt.web.v2016_08_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_08_01.models.NetworkFeatures(*, kind: str = None, **kwargs)[source]¶

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

Full view of network features for an app (presently VNET integration and 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.
virtual_network_name (str) – The Virtual Network name.
virtual_network_connection (VnetInfo) – The Virtual Network summary view.
hybrid_connections (list[RelayServiceConnectionEntity]) – The Hybrid Connections summary view.
hybrid_connections_v2 (list[HybridConnection]) – The Hybrid Connection V2 (Service Bus) view.

Parameters

kind (str) – Kind of resource.

class azure.mgmt.web.v2016_08_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_08_01.models.PerfMonResponse(*, code: str = None, message: str = None, data=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Performance monitor API response.

Parameters

code (str) – The response code.
message (str) – The message.
data (PerfMonSet) – The performance monitor counters.

class azure.mgmt.web.v2016_08_01.models.PerfMonSample(*, time=None, instance_name: str = None, value: float = None, core_count: int = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Performance monitor sample in a set.

Parameters

time (datetime) – Point in time for which counter was measured.
instance_name (str) – Name of the server on which the measurement is made.
value (float) – Value of counter at a certain time.
core_count (int) – Core Count of worker. Not a data member

class azure.mgmt.web.v2016_08_01.models.PerfMonSet(*, name: str = None, start_time=None, end_time=None, time_grain: str = None, values=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Metric information.

Parameters

name (str) – Unique key name of the counter.
start_time (datetime) – Start time of the period.
end_time (datetime) – End time of the period.
time_grain (str) – Presented time grain.
values (list[PerfMonSample]) – Collection of workers that are active during this time.

class azure.mgmt.web.v2016_08_01.models.PremierAddOn(*, location: str, kind: str = None, tags=None, sku: str = None, product: str = None, vendor: str = None, premier_add_on_name: str = None, premier_add_on_location: str = None, premier_add_on_tags=None, marketplace_publisher: str = None, marketplace_offer: str = None, **kwargs)[source]¶

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

Premier add-on.

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.
sku (str) – Premier add on SKU.
product (str) – Premier add on Product.
vendor (str) – Premier add on Vendor.
premier_add_on_name (str) – Premier add on Name.
premier_add_on_location (str) – Premier add on Location.
premier_add_on_tags (dict[str, str]) – Premier add on Tags.
marketplace_publisher (str) – Premier add on Marketplace publisher.
marketplace_offer (str) – Premier add on Marketplace offer.

class azure.mgmt.web.v2016_08_01.models.ProcessInfo(*, kind: str = None, process_info_id: int = None, process_info_name: str = None, href: str = None, mini_dump: str = None, is_profile_running: bool = None, is_iis_profile_running: bool = None, iis_profile_timeout_in_seconds: float = None, parent: str = None, children=None, threads=None, open_file_handles=None, modules=None, file_name: str = None, command_line: str = None, user_name: str = None, handle_count: int = None, module_count: int = None, thread_count: int = None, start_time=None, total_processor_time: str = None, user_processor_time: str = None, privileged_processor_time: str = None, working_set64: int = None, peak_working_set64: int = None, private_memory_size64: int = None, virtual_memory_size64: int = None, peak_virtual_memory_size64: int = None, paged_system_memory_size64: int = None, nonpaged_system_memory_size64: int = None, paged_memory_size64: int = None, peak_paged_memory_size64: int = None, time_stamp=None, environment_variables=None, is_scm_site: bool = None, is_web_job: bool = None, description: str = None, **kwargs)[source]¶

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

Process Information.

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.
process_info_id (int) – ARM Identifier for deployment.
process_info_name (str) – Deployment name.
href (str) – HRef URI.
mini_dump (str) – Minidump URI.
is_profile_running (bool) – Is profile running?
is_iis_profile_running (bool) – Is the IIS Profile running?
iis_profile_timeout_in_seconds (float) – IIS Profile timeout (seconds).
parent (str) – Parent process.
children (list[str]) – Child process list.
threads (list[ProcessThreadInfo]) – Thread list.
open_file_handles (list[str]) – List of open files.
modules (list[ProcessModuleInfo]) – List of modules.
file_name (str) – File name of this process.
command_line (str) – Command line.
user_name (str) – User name.
handle_count (int) – Handle count.
module_count (int) – Module count.
thread_count (int) – Thread count.
start_time (datetime) – Start time.
total_processor_time (str) – Total CPU time.
user_processor_time (str) – User CPU time.
privileged_processor_time (str) – Privileged CPU time.
working_set64 (long) – Working set.
peak_working_set64 (long) – Peak working set.
private_memory_size64 (long) – Private memory size.
virtual_memory_size64 (long) – Virtual memory size.
peak_virtual_memory_size64 (long) – Peak virtual memory usage.
paged_system_memory_size64 (long) – Paged system memory.
nonpaged_system_memory_size64 (long) – Non-paged system memory.
paged_memory_size64 (long) – Paged memory.
peak_paged_memory_size64 (long) – Peak paged memory.
time_stamp (datetime) – Time stamp.
environment_variables (dict[str, str]) – List of environment variables.
is_scm_site (bool) – Is this the SCM site?
is_web_job (bool) – Is this a Web Job?
description (str) – Description of process.

class azure.mgmt.web.v2016_08_01.models.ProcessModuleInfo(*, kind: str = None, base_address: str = None, file_name: str = None, href: str = None, file_path: str = None, module_memory_size: int = None, file_version: str = None, file_description: str = None, product: str = None, product_version: str = None, is_debug: bool = None, language: str = None, **kwargs)[source]¶

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

Process Module Information.

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.
base_address (str) – Base address. Used as module identifier in ARM resource URI.
file_name (str) – File name.
href (str) – HRef URI.
file_path (str) – File path.
module_memory_size (int) – Module memory size.
file_version (str) – File version.
file_description (str) – File description.
product (str) – Product name.
product_version (str) – Product version.
is_debug (bool) – Is debug?
language (str) – Module language (locale).

class azure.mgmt.web.v2016_08_01.models.ProcessThreadInfo(*, kind: str = None, process_thread_info_id: int = None, href: str = None, process: str = None, start_address: str = None, current_priority: int = None, priority_level: str = None, base_priority: int = None, start_time=None, total_processor_time: str = None, user_processor_time: str = None, priviledged_processor_time: str = None, state: str = None, wait_reason: str = None, **kwargs)[source]¶

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

Process Thread Information.

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.
process_thread_info_id (int) – ARM Identifier for deployment.
href (str) – HRef URI.
process (str) – Process URI.
start_address (str) – Start address.
current_priority (int) – Current thread priority.
priority_level (str) – Thread priority level.
base_priority (int) – Base priority.
start_time (datetime) – Start time.
total_processor_time (str) – Total processor time.
user_processor_time (str) – User processor time.
priviledged_processor_time (str) – Privileged processor time.
state (str) – Thread state.
wait_reason (str) – Wait reason.

class azure.mgmt.web.v2016_08_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_08_01.models.PublicCertificate(*, kind: str = None, blob: bytearray = None, public_certificate_location=None, **kwargs)[source]¶

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

Public certificate object.

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.
thumbprint (str) – Certificate Thumbprint

Parameters

kind (str) – Kind of resource.
blob (bytearray) – Public Certificate byte array
public_certificate_location (str or PublicCertificateLocation) – Public Certificate Location. Possible values include: ‘CurrentUserMy’, ‘LocalMachineMy’, ‘Unknown’

class azure.mgmt.web.v2016_08_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_08_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_08_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_08_01.models.RelayServiceConnectionEntity(*, kind: str = None, entity_name: str = None, entity_connection_string: str = None, resource_type: str = None, resource_connection_string: str = None, hostname: str = None, port: int = None, biztalk_uri: str = None, **kwargs)[source]¶

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

Hybrid Connection for an App Service app.

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.
entity_name (str) –
entity_connection_string (str) –
resource_type (str) –
resource_connection_string (str) –
hostname (str) –
port (int) –
biztalk_uri (str) –

class azure.mgmt.web.v2016_08_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_08_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_08_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_08_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_08_01.models.ResourceMetricDefinition(*, kind: str = None, **kwargs)[source]¶

Bases: azure.mgmt.web.v2016_08_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_08_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_08_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_08_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_08_01.models.RestoreRequest(*, storage_account_url: str, overwrite: bool, kind: str = None, blob_name: str = None, site_name: str = None, databases=None, ignore_conflicting_host_names: bool = False, ignore_databases: bool = False, app_service_plan: str = None, operation_type='Default', adjust_connection_strings: bool = None, hosting_environment: str = None, **kwargs)[source]¶

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

Description of a restore request.

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.
storage_account_url (str) – Required. SAS URL to the container.
blob_name (str) – Name of a blob which contains the backup.
overwrite (bool) – Required. <code>true</code> if the restore operation can overwrite target app; otherwise, <code>false</code>. <code>true</code> is needed if trying to restore over an existing app.
site_name (str) – Name of an app.
databases (list[DatabaseBackupSetting]) – Collection of databases which should be restored. This list has to match the list of databases included in the backup.
ignore_conflicting_host_names (bool) – Changes a logic when restoring an app with custom domains. <code>true</code> to remove custom domains automatically. If <code>false</code>, custom domains are added to the app’s object when it is being restored, but that might fail due to conflicts during the operation. Default value: False .
ignore_databases (bool) – Ignore the databases and only restore the site content. Default value: False .
app_service_plan (str) – Specify app service plan that will own restored site.
operation_type (str or BackupRestoreOperationType) – Operation type. Possible values include: ‘Default’, ‘Clone’, ‘Relocation’, ‘Snapshot’. Default value: “Default” .
adjust_connection_strings (bool) – <code>true</code> if SiteConfig.ConnectionStrings should be set in new app; otherwise, <code>false</code>.
hosting_environment (str) – App Service Environment name, if needed (only when restoring an app to an App Service Environment).

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

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

Response for an app restore request.

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.
operation_id (str) – When server starts the restore process, it will return an operation ID identifying that particular restore operation.

Parameters

kind (str) – Kind of resource.

class azure.mgmt.web.v2016_08_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_08_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_08_01.models.SiteAuthSettings(*, kind: str = None, enabled: bool = None, runtime_version: str = None, unauthenticated_client_action=None, token_store_enabled: bool = None, allowed_external_redirect_urls=None, default_provider=None, token_refresh_extension_hours: float = None, client_id: str = None, client_secret: str = None, issuer: str = None, allowed_audiences=None, additional_login_params=None, google_client_id: str = None, google_client_secret: str = None, google_oauth_scopes=None, facebook_app_id: str = None, facebook_app_secret: str = None, facebook_oauth_scopes=None, twitter_consumer_key: str = None, twitter_consumer_secret: str = None, microsoft_account_client_id: str = None, microsoft_account_client_secret: str = None, microsoft_account_oauth_scopes=None, **kwargs)[source]¶

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

Configuration settings for the Azure App Service Authentication / Authorization feature.

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.
enabled (bool) – <code>true</code> if the Authentication / Authorization feature is enabled for the current app; otherwise, <code>false</code>.
runtime_version (str) – The RuntimeVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of certain features in the Authentication / Authorization module.
unauthenticated_client_action (str or UnauthenticatedClientAction) – The action to take when an unauthenticated client attempts to access the app. Possible values include: ‘RedirectToLoginPage’, ‘AllowAnonymous’
token_store_enabled (bool) – <code>true</code> to durably store platform-specific security tokens that are obtained during login flows; otherwise, <code>false</code>. The default is <code>false</code>.
allowed_external_redirect_urls (list[str]) – External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored. This is an advanced setting typically only needed by Windows Store application backends. Note that URLs within the current domain are always implicitly allowed.
default_provider (str or BuiltInAuthenticationProvider) – The default authentication provider to use when multiple providers are configured. This setting is only needed if multiple providers are configured and the unauthenticated client action is set to “RedirectToLoginPage”. Possible values include: ‘AzureActiveDirectory’, ‘Facebook’, ‘Google’, ‘MicrosoftAccount’, ‘Twitter’
token_refresh_extension_hours (float) – The number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours.
client_id (str) – The Client ID of this relying party application, known as the client_id. This setting is required for enabling OpenID Connection authentication with Azure Active Directory or other 3rd party OpenID Connect providers. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
client_secret (str) – The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key). This setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users. Otherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
issuer (str) – The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/. This URI is a case-sensitive identifier for the token issuer. More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html
allowed_audiences (list[str]) – Allowed audience values to consider when validating JWTs issued by Azure Active Directory. Note that the <code>ClientID</code> value is always considered an allowed audience, regardless of this setting.
additional_login_params (list[str]) – Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form “key=value”.
google_client_id (str) – The OpenID Connect Client ID for the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/
google_client_secret (str) – The client secret associated with the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/
google_oauth_scopes (list[str]) – The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. This setting is optional. If not specified, “openid”, “profile”, and “email” are used as default scopes. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/
facebook_app_id (str) – The App ID of the Facebook app used for login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login
facebook_app_secret (str) – The App Secret of the Facebook app used for Facebook Login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login
facebook_oauth_scopes (list[str]) – The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication. This setting is optional. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login
twitter_consumer_key (str) – The OAuth 1.0a consumer key of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in
twitter_consumer_secret (str) – The OAuth 1.0a consumer secret of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in
microsoft_account_client_id (str) – The OAuth 2.0 client ID that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm
microsoft_account_client_secret (str) – The OAuth 2.0 client secret that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm
microsoft_account_oauth_scopes (list[str]) – The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. This setting is optional. If not specified, “wl.basic” is used as the default scope. Microsoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx

class azure.mgmt.web.v2016_08_01.models.SiteCloneability(*, result=None, blocking_features=None, unsupported_features=None, blocking_characteristics=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Represents whether or not an app is cloneable.

Parameters

result (str or CloneAbilityResult) – Name of app. Possible values include: ‘Cloneable’, ‘PartiallyCloneable’, ‘NotCloneable’
blocking_features (list[SiteCloneabilityCriterion]) – List of features enabled on app that prevent cloning.
unsupported_features (list[SiteCloneabilityCriterion]) – List of features enabled on app that are non-blocking but cannot be cloned. The app can still be cloned but the features in this list will not be set up on cloned app.
blocking_characteristics (list[SiteCloneabilityCriterion]) – List of blocking application characteristics.

class azure.mgmt.web.v2016_08_01.models.SiteCloneabilityCriterion(*, name: str = None, description: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

An app cloneability criterion.

Parameters

name (str) – Name of criterion.
description (str) – Description of criterion.

class azure.mgmt.web.v2016_08_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_08_01.models.SiteConfigResource(*, kind: str = None, 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: azure.mgmt.web.v2016_08_01.models._models_py3.ProxyOnlyResource

Web app configuration 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.
machine_key (SiteMachineKey) – Site MachineKey.

Parameters

kind (str) – Kind of resource.
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’

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

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

A snapshot of a web app configuration.

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.
time (datetime) – The time the snapshot was taken.
site_configuration_snapshot_info_id (int) – The id of the snapshot

Parameters

kind (str) – Kind of resource.

class azure.mgmt.web.v2016_08_01.models.SiteExtensionInfo(*, kind: str = None, site_extension_info_id: str = None, title: str = None, site_extension_info_type=None, summary: str = None, description: str = None, version: str = None, extension_url: str = None, project_url: str = None, icon_url: str = None, license_url: str = None, feed_url: str = None, authors=None, installation_args: str = None, published_date_time=None, download_count: int = None, local_is_latest_version: bool = None, local_path: str = None, installed_date_time=None, provisioning_state: str = None, comment: str = None, **kwargs)[source]¶

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

Site Extension Information.

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.
site_extension_info_id (str) – Site extension ID.
title (str) – Site extension title.
site_extension_info_type (str or SiteExtensionType) – Site extension type. Possible values include: ‘Gallery’, ‘WebRoot’
summary (str) – Summary description.
description (str) – Detailed description.
version (str) – Version information.
extension_url (str) – Extension URL.
project_url (str) – Project URL.
icon_url (str) – Icon URL.
license_url (str) – License URL.
feed_url (str) – Feed URL.
authors (list[str]) – List of authors.
installation_args (str) – Installer command line parameters.
published_date_time (datetime) – Published timestamp.
download_count (int) – Count of downloads.
local_is_latest_version (bool) – <code>true</code> if the local version is the latest version; <code>false</code> otherwise.
local_path (str) – Local path.
installed_date_time (datetime) – Installed timestamp.
provisioning_state (str) – Provisioning state.
comment (str) – Site Extension comment.

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

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

Instance of an app.

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.
site_instance_name (str) – Name of instance.

Parameters

kind (str) – Kind of resource.

class azure.mgmt.web.v2016_08_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_08_01.models.SiteLogsConfig(*, kind: str = None, application_logs=None, http_logs=None, failed_requests_tracing=None, detailed_error_messages=None, **kwargs)[source]¶

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

Configuration of App Service site logs.

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.
application_logs (ApplicationLogsConfig) – Application logs configuration.
http_logs (HttpLogsConfig) – HTTP logs configuration.
failed_requests_tracing (EnabledConfig) – Failed requests tracing configuration.
detailed_error_messages (EnabledConfig) – Detailed error messages configuration.

class azure.mgmt.web.v2016_08_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_08_01.models.SitePatchResource(*, kind: str = 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, **kwargs)[source]¶

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

ARM resource for a site.

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

class azure.mgmt.web.v2016_08_01.models.SitePhpErrorLogFlag(*, kind: str = None, local_log_errors: str = None, master_log_errors: str = None, local_log_errors_max_length: str = None, master_log_errors_max_length: str = None, **kwargs)[source]¶

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

Used for getting PHP error logging flag.

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.
local_log_errors (str) – Local log_errors setting.
master_log_errors (str) – Master log_errors setting.
local_log_errors_max_length (str) – Local log_errors_max_len setting.
master_log_errors_max_length (str) – Master log_errors_max_len setting.

class azure.mgmt.web.v2016_08_01.models.SiteSourceControl(*, kind: str = None, repo_url: str = None, branch: str = None, is_manual_integration: bool = None, deployment_rollback_enabled: bool = None, is_mercurial: bool = None, **kwargs)[source]¶

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

Source control configuration for an app.

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.
repo_url (str) – Repository or source control URL.
branch (str) – Name of branch to use for deployment.
is_manual_integration (bool) – <code>true</code> to limit to manual integration; <code>false</code> to enable continuous integration (which configures webhooks into online repos like GitHub).
deployment_rollback_enabled (bool) – <code>true</code> to enable deployment rollback; otherwise, <code>false</code>.
is_mercurial (bool) – <code>true</code> for a Mercurial repository; <code>false</code> for a Git repository.

class azure.mgmt.web.v2016_08_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_08_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_08_01.models.SlotConfigNamesResource(*, kind: str = None, connection_string_names=None, app_setting_names=None, **kwargs)[source]¶

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

Slot Config names azure 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.

Parameters

kind (str) – Kind of resource.
connection_string_names (list[str]) – List of connection string names.
app_setting_names (list[str]) – List of application settings names.

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

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

A setting difference between two deployment slots of an app.

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.
slot_difference_type (str) – Type of the difference: Information, Warning or Error.
setting_type (str) – The type of the setting: General, AppSetting or ConnectionString.
diff_rule (str) – Rule that describes how to process the setting difference during a slot swap.
setting_name (str) – Name of the setting.
value_in_current_slot (str) – Value of the setting in the current slot.
value_in_target_slot (str) – Value of the setting in the target slot.
description (str) – Description of the setting difference.

Parameters

kind (str) – Kind of resource.

class azure.mgmt.web.v2016_08_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_08_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_08_01.models.Snapshot(*, kind: str = None, **kwargs)[source]¶

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

A snapshot of an app.

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.
time (str) – The time the snapshot was taken.

Parameters

kind (str) – Kind of resource.

class azure.mgmt.web.v2016_08_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_08_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_08_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_08_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_08_01.models.StorageMigrationOptions(*, azurefiles_connection_string: str, azurefiles_share: str, kind: str = None, switch_site_after_migration: bool = False, block_write_access_to_site: bool = False, **kwargs)[source]¶

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

Options for app content migration.

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.
azurefiles_connection_string (str) – Required. AzureFiles connection string.
azurefiles_share (str) – Required. AzureFiles share.
switch_site_after_migration (bool) – <code>true</code>if the app should be switched over; otherwise, <code>false</code>. Default value: False .
block_write_access_to_site (bool) – <code>true</code> if the app should be read only during copy operation; otherwise, <code>false</code>. Default value: False .

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

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

Response for a migration of app content request.

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.
operation_id (str) – When server starts the migration process, it will return an operation ID identifying that particular migration operation.

Parameters

kind (str) – Kind of resource.

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

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

String dictionary 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.

Parameters

kind (str) – Kind of resource.
properties (dict[str, str]) – Settings.

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

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

Triggered Web Job History. List of Triggered Web Job Run Information elements.

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.
triggered_job_runs (list[TriggeredJobRun]) – List of triggered web job runs.

class azure.mgmt.web.v2016_08_01.models.TriggeredJobRun(*, kind: str = None, triggered_job_run_id: str = None, status=None, start_time=None, end_time=None, duration: str = None, output_url: str = None, error_url: str = None, url: str = None, job_name: str = None, trigger: str = None, **kwargs)[source]¶

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

Triggered Web Job Run Information.

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.
triggered_job_run_name (str) – Job name.

Parameters

kind (str) – Kind of resource.
triggered_job_run_id (str) – Job ID.
status (str or TriggeredWebJobStatus) – Job status. Possible values include: ‘Success’, ‘Failed’, ‘Error’
start_time (datetime) – Start time.
end_time (datetime) – End time.
duration (str) – Job duration.
output_url (str) – Output URL.
error_url (str) – Error URL.
url (str) – Job URL.
job_name (str) – Job name.
trigger (str) – Job trigger.

class azure.mgmt.web.v2016_08_01.models.TriggeredWebJob(*, kind: str = None, latest_run=None, history_url: str = None, scheduler_logs_url: str = None, run_command: str = None, url: str = None, extra_info_url: str = None, job_type=None, error: str = None, using_sdk: bool = None, settings=None, **kwargs)[source]¶

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

Triggered Web Job Information.

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.
triggered_web_job_name (str) – Job name. Used as job identifier in ARM resource URI.

Parameters

kind (str) – Kind of resource.
latest_run (TriggeredJobRun) – Latest job run information.
history_url (str) – History URL.
scheduler_logs_url (str) – Scheduler Logs URL.
run_command (str) – Run command.
url (str) – Job URL.
extra_info_url (str) – Extra Info URL.
job_type (str or WebJobType) – Job type. Possible values include: ‘Continuous’, ‘Triggered’
error (str) – Error information.
using_sdk (bool) – Using SDK?
settings (dict[str, object]) – Job settings.

class azure.mgmt.web.v2016_08_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_08_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_08_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_08_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_08_01.models.VnetGateway(*, vpn_package_uri: str, kind: str = None, vnet_name: str = None, **kwargs)[source]¶

Bases: azure.mgmt.web.v2016_08_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_08_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_08_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_08_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_08_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_08_01.models.WebJob(*, kind: str = None, run_command: str = None, url: str = None, extra_info_url: str = None, job_type=None, error: str = None, using_sdk: bool = None, settings=None, **kwargs)[source]¶

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

Web Job Information.

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.
web_job_name (str) – Job name. Used as job identifier in ARM resource URI.

Parameters

kind (str) – Kind of resource.
run_command (str) – Run command.
url (str) – Job URL.
extra_info_url (str) – Extra Info URL.
job_type (str or WebJobType) – Job type. Possible values include: ‘Continuous’, ‘Triggered’
error (str) – Error information.
using_sdk (bool) – Using SDK?
settings (dict[str, object]) – Job settings.

class azure.mgmt.web.v2016_08_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_08_01.models.BackupItemPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of BackupItem object

Bring async to Paging.

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

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of SiteConfigResource object

Bring async to Paging.

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

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of SiteConfigurationSnapshotInfo object

Bring async to Paging.

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

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of ContinuousWebJob object

Bring async to Paging.

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

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of Deployment object

Bring async to Paging.

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

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of Identifier object

Bring async to Paging.

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

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of FunctionEnvelope object

Bring async to Paging.

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

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of HostNameBinding object

Bring async to Paging.

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

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of SiteInstance object

Bring async to Paging.

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

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of ProcessInfo object

Bring async to Paging.

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

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of ProcessModuleInfo object

Bring async to Paging.

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

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of ProcessThreadInfo object

Bring async to Paging.

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

class azure.mgmt.web.v2016_08_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_08_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_08_01.models.PerfMonResponsePaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of PerfMonResponse object

Bring async to Paging.

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

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of PublicCertificate object

Bring async to Paging.

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

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of SiteExtensionInfo object

Bring async to Paging.

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

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of SlotDifference object

Bring async to Paging.

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

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of Snapshot object

Bring async to Paging.

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

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of TriggeredWebJob object

Bring async to Paging.

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

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of TriggeredJobHistory object

Bring async to Paging.

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

class azure.mgmt.web.v2016_08_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_08_01.models.WebJobPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of WebJob object

Bring async to Paging.

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

class azure.mgmt.web.v2016_08_01.models.LogLevel[source]¶

Bases: str, enum.Enum

An enumeration.

error = 'Error'¶

information = 'Information'¶

off = 'Off'¶

verbose = 'Verbose'¶

warning = 'Warning'¶

class azure.mgmt.web.v2016_08_01.models.BackupItemStatus[source]¶

Bases: str, enum.Enum

An enumeration.

created = 'Created'¶

delete_failed = 'DeleteFailed'¶

delete_in_progress = 'DeleteInProgress'¶

deleted = 'Deleted'¶

failed = 'Failed'¶

in_progress = 'InProgress'¶

partially_succeeded = 'PartiallySucceeded'¶

skipped = 'Skipped'¶

succeeded = 'Succeeded'¶

timed_out = 'TimedOut'¶

class azure.mgmt.web.v2016_08_01.models.DatabaseType[source]¶

Bases: str, enum.Enum

An enumeration.

local_my_sql = 'LocalMySql'¶

my_sql = 'MySql'¶

postgre_sql = 'PostgreSql'¶

sql_azure = 'SqlAzure'¶

class azure.mgmt.web.v2016_08_01.models.FrequencyUnit[source]¶

Bases: str, enum.Enum

An enumeration.

day = 'Day'¶

hour = 'Hour'¶

class azure.mgmt.web.v2016_08_01.models.BackupRestoreOperationType[source]¶

Bases: str, enum.Enum

An enumeration.

clone = 'Clone'¶

default = 'Default'¶

relocation = 'Relocation'¶

snapshot = 'Snapshot'¶

class azure.mgmt.web.v2016_08_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_08_01.models.ContinuousWebJobStatus[source]¶

Bases: str, enum.Enum

An enumeration.

initializing = 'Initializing'¶

pending_restart = 'PendingRestart'¶

running = 'Running'¶

starting = 'Starting'¶

stopped = 'Stopped'¶

class azure.mgmt.web.v2016_08_01.models.WebJobType[source]¶

Bases: str, enum.Enum

An enumeration.

continuous = 'Continuous'¶

triggered = 'Triggered'¶

class azure.mgmt.web.v2016_08_01.models.PublishingProfileFormat[source]¶

Bases: str, enum.Enum

An enumeration.

file_zilla3 = 'FileZilla3'¶

ftp = 'Ftp'¶

web_deploy = 'WebDeploy'¶

class azure.mgmt.web.v2016_08_01.models.DnsVerificationTestResult[source]¶

Bases: str, enum.Enum

An enumeration.

failed = 'Failed'¶

passed = 'Passed'¶

skipped = 'Skipped'¶

class azure.mgmt.web.v2016_08_01.models.AzureResourceType[source]¶

Bases: str, enum.Enum

An enumeration.

traffic_manager = 'TrafficManager'¶

website = 'Website'¶

class azure.mgmt.web.v2016_08_01.models.CustomHostNameDnsRecordType[source]¶

Bases: str, enum.Enum

An enumeration.

a = 'A'¶

cname = 'CName'¶

class azure.mgmt.web.v2016_08_01.models.HostNameType[source]¶

Bases: str, enum.Enum

An enumeration.

managed = 'Managed'¶

verified = 'Verified'¶

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

Bases: str, enum.Enum

An enumeration.

disabled = 'Disabled'¶

ip_based_enabled = 'IpBasedEnabled'¶

sni_enabled = 'SniEnabled'¶

class azure.mgmt.web.v2016_08_01.models.MSDeployLogEntryType[source]¶

Bases: str, enum.Enum

An enumeration.

error = 'Error'¶

message = 'Message'¶

warning = 'Warning'¶

class azure.mgmt.web.v2016_08_01.models.MSDeployProvisioningState[source]¶

Bases: str, enum.Enum

An enumeration.

accepted = 'accepted'¶

canceled = 'canceled'¶

failed = 'failed'¶

running = 'running'¶

succeeded = 'succeeded'¶

class azure.mgmt.web.v2016_08_01.models.MySqlMigrationType[source]¶

Bases: str, enum.Enum

An enumeration.

local_to_remote = 'LocalToRemote'¶

remote_to_local = 'RemoteToLocal'¶

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

Bases: str, enum.Enum

An enumeration.

created = 'Created'¶

failed = 'Failed'¶

in_progress = 'InProgress'¶

succeeded = 'Succeeded'¶

timed_out = 'TimedOut'¶

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

Bases: str, enum.Enum

An enumeration.

default = 'DEFAULT'¶

inherited = 'INHERITED'¶

static = 'STATIC'¶

class azure.mgmt.web.v2016_08_01.models.PublicCertificateLocation[source]¶

Bases: str, enum.Enum

An enumeration.

current_user_my = 'CurrentUserMy'¶

local_machine_my = 'LocalMachineMy'¶

unknown = 'Unknown'¶

class azure.mgmt.web.v2016_08_01.models.UnauthenticatedClientAction[source]¶

Bases: str, enum.Enum

An enumeration.

allow_anonymous = 'AllowAnonymous'¶

redirect_to_login_page = 'RedirectToLoginPage'¶

class azure.mgmt.web.v2016_08_01.models.BuiltInAuthenticationProvider[source]¶

Bases: str, enum.Enum

An enumeration.

azure_active_directory = 'AzureActiveDirectory'¶

facebook = 'Facebook'¶

google = 'Google'¶

microsoft_account = 'MicrosoftAccount'¶

twitter = 'Twitter'¶

class azure.mgmt.web.v2016_08_01.models.CloneAbilityResult[source]¶

Bases: str, enum.Enum

An enumeration.

cloneable = 'Cloneable'¶

not_cloneable = 'NotCloneable'¶

partially_cloneable = 'PartiallyCloneable'¶

class azure.mgmt.web.v2016_08_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_08_01.models.ManagedPipelineMode[source]¶

Bases: str, enum.Enum

An enumeration.

classic = 'Classic'¶

integrated = 'Integrated'¶

class azure.mgmt.web.v2016_08_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_08_01.models.AutoHealActionType[source]¶

Bases: str, enum.Enum

An enumeration.

custom_action = 'CustomAction'¶

log_event = 'LogEvent'¶

recycle = 'Recycle'¶

class azure.mgmt.web.v2016_08_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_08_01.models.SiteExtensionType[source]¶

Bases: str, enum.Enum

An enumeration.

gallery = 'Gallery'¶

web_root = 'WebRoot'¶

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

Bases: str, enum.Enum

An enumeration.

exceeded = 'Exceeded'¶

normal = 'Normal'¶

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

Bases: str, enum.Enum

An enumeration.

disaster_recovery_mode = 'DisasterRecoveryMode'¶

limited = 'Limited'¶

normal = 'Normal'¶

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

Bases: str, enum.Enum

An enumeration.

repository = 'Repository'¶

standard = 'Standard'¶

class azure.mgmt.web.v2016_08_01.models.TriggeredWebJobStatus[source]¶

Bases: str, enum.Enum

An enumeration.

error = 'Error'¶

failed = 'Failed'¶

success = 'Success'¶

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

Bases: str, enum.Enum

An enumeration.

system_assigned = 'SystemAssigned'¶

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

Bases: str, enum.Enum

An enumeration.

creating = 'Creating'¶

pending = 'Pending'¶

ready = 'Ready'¶

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

Bases: str, enum.Enum

An enumeration.

canceled = 'Canceled'¶

deleting = 'Deleting'¶

failed = 'Failed'¶

in_progress = 'InProgress'¶

succeeded = 'Succeeded'¶