azure.mgmt.web.models module

class azure.mgmt.web.models.AppServiceCertificate(location, name=None, kind=None, type=None, tags=None, key_vault_id=None, key_vault_secret_name=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

Key Vault container for a certificate that is purchased through Azure.

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

Variables:
  • id (str) – Resource Id.
  • provisioning_state (str or KeyVaultSecretStatus) – Status of the Key Vault secret. Possible values include: ‘Initialized’, ‘WaitingOnCertificateOrder’, ‘Succeeded’, ‘CertificateOrderFailed’, ‘OperationNotPermittedOnKeyVault’, ‘AzureServiceUnauthorizedToAccessKeyVault’, ‘KeyVaultDoesNotExist’, ‘KeyVaultSecretDoesNotExist’, ‘UnknownError’, ‘ExternalPrivateKey’, ‘Unknown’
Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
  • key_vault_id (str) – Key Vault Csm resource Id.
  • key_vault_secret_name (str) – Key Vault secret name.
class azure.mgmt.web.models.CertificateDetails[source]

Bases: msrest.serialization.Model

SSL certificate details.

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

Variables:
  • version (int) – Version.
  • serial_number (str) – Serial Number.
  • thumbprint (str) – Thumbprint.
  • subject (str) – Subject.
  • not_before (datetime) – Valid from.
  • not_after (datetime) – Valid to.
  • signature_algorithm (str) – Signature algorithm.
  • issuer (str) – Issuer.
  • raw_data (str) – Raw certificate data.
class azure.mgmt.web.models.AppServiceCertificateOrder(location, name=None, kind=None, type=None, tags=None, certificates=None, distinguished_name=None, validity_in_years=1, key_size=2048, product_type=None, auto_renew=True, csr=None, is_private_key_external=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

SSL certificate purchase order.

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

Variables:
  • id (str) – Resource Id.
  • domain_verification_token (str) – Domain verification token.
  • provisioning_state (str or ProvisioningState) – Status of certificate order. Possible values include: ‘Succeeded’, ‘Failed’, ‘Canceled’, ‘InProgress’, ‘Deleting’
  • status (str or CertificateOrderStatus) – Current order status. Possible values include: ‘Pendingissuance’, ‘Issued’, ‘Revoked’, ‘Canceled’, ‘Denied’, ‘Pendingrevocation’, ‘PendingRekey’, ‘Unused’, ‘Expired’, ‘NotSubmitted’
  • signed_certificate (CertificateDetails) – Signed certificate.
  • intermediate (CertificateDetails) – Intermediate certificate.
  • root (CertificateDetails) – Root certificate.
  • serial_number (str) – Current serial number of the certificate.
  • last_certificate_issuance_time (datetime) – Certificate last issuance time.
  • expiration_time (datetime) – Certificate expiration time.
Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
  • certificates (dict) – State of the Key Vault secret.
  • distinguished_name (str) – Certificate distinguished name.
  • validity_in_years (int) – Duration in years (must be between 1 and 3). Default value: 1 .
  • key_size (int) – Certificate key size. Default value: 2048 .
  • product_type (str or CertificateProductType) – Certificate product type. Possible values include: ‘StandardDomainValidatedSsl’, ‘StandardDomainValidatedWildCardSsl’
  • auto_renew (bool) – <code>true</code> if the certificate should be automatically renewed when it expires; otherwise, <code>false</code>. Default value: True .
  • csr (str) – Last CSR that was created for this order.
  • is_private_key_external (bool) – <code>true</code> if private key is external; otherwise, <code>false</code>.
class azure.mgmt.web.models.CertificateEmail(location, name=None, kind=None, type=None, tags=None, email_id=None, time_stamp=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

SSL certificate email.

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

Variables:

id (str) – Resource Id.

Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
  • email_id (str) – Email id.
  • time_stamp (datetime) – Time stamp.
class azure.mgmt.web.models.CertificateOrderAction(location, name=None, kind=None, type=None, tags=None, certificate_order_action_type=None, created_at=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

Certificate order action.

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

Variables:

id (str) – Resource Id.

Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
  • certificate_order_action_type (str or CertificateOrderActionType) – Action type. Possible values include: ‘CertificateIssued’, ‘CertificateOrderCanceled’, ‘CertificateOrderCreated’, ‘CertificateRevoked’, ‘DomainValidationComplete’, ‘FraudDetected’, ‘OrgNameChange’, ‘OrgValidationComplete’, ‘SanDrop’, ‘FraudCleared’, ‘CertificateExpired’, ‘CertificateExpirationWarning’, ‘FraudDocumentationRequired’, ‘Unknown’
  • created_at (datetime) – Time at which the certificate action was performed.
class azure.mgmt.web.models.NameIdentifier(name=None)[source]

Bases: msrest.serialization.Model

Identifies an object.

Parameters:name (str) – Name of the object.
class azure.mgmt.web.models.ReissueCertificateOrderRequest(location, name=None, kind=None, type=None, tags=None, key_size=None, delay_existing_revoke_in_hours=None, csr=None, is_private_key_external=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

Class representing certificate reissue request.

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

Variables:

id (str) – Resource Id.

Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
  • key_size (int) – Certificate Key Size.
  • delay_existing_revoke_in_hours (int) – Delay in hours to revoke existing certificate after the new certificate is issued.
  • csr (str) – Csr to be used for re-key operation.
  • is_private_key_external (bool) – Should we change the ASC type (from managed private key to external private key and vice versa).
class azure.mgmt.web.models.RenewCertificateOrderRequest(location, name=None, kind=None, type=None, tags=None, key_size=None, csr=None, is_private_key_external=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

Class representing certificate renew request.

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

Variables:

id (str) – Resource Id.

Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
  • key_size (int) – Certificate Key Size.
  • csr (str) – Csr to be used for re-key operation.
  • is_private_key_external (bool) – Should we change the ASC type (from managed private key to external private key and vice versa).
class azure.mgmt.web.models.Resource(location, name=None, kind=None, type=None, tags=None)[source]

Bases: msrest.serialization.Model

Azure resource.

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

Variables:

id (str) – Resource Id.

Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
class azure.mgmt.web.models.SiteSeal(html)[source]

Bases: msrest.serialization.Model

Site seal.

Parameters:html (str) – HTML snippet
class azure.mgmt.web.models.SiteSealRequest(light_theme=None, locale=None)[source]

Bases: msrest.serialization.Model

Site seal request.

Parameters:
  • light_theme (bool) – Theme
  • locale (str) – Locale
class azure.mgmt.web.models.VirtualIPMapping(virtual_ip=None, internal_http_port=None, internal_https_port=None, in_use=None)[source]

Bases: msrest.serialization.Model

Virtual IP mapping.

Parameters:
  • virtual_ip (str) – Virtual IP address.
  • internal_http_port (int) – Internal HTTP port.
  • internal_https_port (int) – Internal HTTPS port.
  • in_use (bool) – Is virtual IP mapping in use.
class azure.mgmt.web.models.AddressResponse(service_ip_address=None, internal_ip_address=None, outbound_ip_addresses=None, vip_mappings=None)[source]

Bases: msrest.serialization.Model

Describes main public IP address and any extra virtual IPs.

Parameters:
  • service_ip_address (str) – Main public virtual IP.
  • internal_ip_address (str) – Virtual Network internal IP address of the App Service Environment if it is in internal load-balancing mode.
  • outbound_ip_addresses (list of str) – IP addresses appearing on outbound connections.
  • vip_mappings (list of VirtualIPMapping) – Additional virtual IPs.
class azure.mgmt.web.models.ApiDefinitionInfo(url=None)[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.models.VirtualNetworkProfile(id=None, subnet=None)[source]

Bases: msrest.serialization.Model

Specification for using a Virtual Network.

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

Parameters:
  • id (str) – Resource id of the Virtual Network.
  • subnet (str) – Subnet within the Virtual Network.
Variables:
  • name (str) – Name of the Virtual Network (read-only).
  • type (str) – Resource type of the Virtual Network (read-only).
class azure.mgmt.web.models.SkuCapacity(minimum=None, maximum=None, default=None, scale_type=None)[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.models.Capability(name=None, value=None, reason=None)[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.models.SkuDescription(name=None, tier=None, size=None, family=None, capacity=None, sku_capacity=None, locations=None, capabilities=None)[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 of str) – Locations of the SKU.
  • capabilities (list of Capability) – Capabilities of the SKU, e.g., is traffic manager enabled?
class azure.mgmt.web.models.WorkerPool(location, name=None, kind=None, type=None, tags=None, worker_size_id=None, compute_mode=None, worker_size=None, worker_count=None, sku=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

Worker pool of an App Service Environment.

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

Variables:
  • id (str) – Resource Id.
  • instance_names (list of str) – Names of all instances in the worker pool (read only).
Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
  • worker_size_id (int) – Worker size ID for referencing this worker pool.
  • compute_mode (str or ComputeModeOptions) – Shared or dedicated app hosting. Possible values include: ‘Shared’, ‘Dedicated’, ‘Dynamic’
  • worker_size (str) – VM size of the worker pool instances.
  • worker_count (int) – Number of instances in the worker pool.
  • sku (SkuDescription) –
class azure.mgmt.web.models.StampCapacity(name=None, available_capacity=None, total_capacity=None, unit=None, compute_mode=None, worker_size=None, worker_size_id=None, exclude_from_capacity_allocation=None, is_applicable_for_all_compute_modes=None, site_mode=None)[source]

Bases: msrest.serialization.Model

Stamp capacity information.

Parameters:
  • name (str) – Name of the stamp.
  • available_capacity (long) – Available capacity (# of machines, bytes of storage etc...).
  • total_capacity (long) – Total capacity (# of machines, bytes of storage etc...).
  • unit (str) – Name of the unit.
  • compute_mode (str or ComputeModeOptions) – Shared/dedicated workers. Possible values include: ‘Shared’, ‘Dedicated’, ‘Dynamic’
  • worker_size (str or WorkerSizeOptions) – Size of the machines. Possible values include: ‘Default’, ‘Small’, ‘Medium’, ‘Large’
  • worker_size_id (int) – Size ID of machines: 0 - Small 1 - Medium 2 - Large
  • exclude_from_capacity_allocation (bool) – If <code>true</code>, it includes basic apps. Basic apps are not used for capacity allocation.
  • is_applicable_for_all_compute_modes (bool) – <code>true</code> if capacity is applicable for all apps; otherwise, <code>false</code>.
  • site_mode (str) – Shared or Dedicated.
class azure.mgmt.web.models.NetworkAccessControlEntry(action=None, description=None, order=None, remote_subnet=None)[source]

Bases: msrest.serialization.Model

Network access control entry.

Parameters:
  • action (str or AccessControlEntryAction) – Action object. Possible values include: ‘Permit’, ‘Deny’
  • description (str) – Description.
  • order (int) – Order of precedence.
  • remote_subnet (str) – Remote subnet.
class azure.mgmt.web.models.NameValuePair(name=None, value=None)[source]

Bases: msrest.serialization.Model

Name value pair.

Parameters:
  • name (str) – Pair name.
  • value (str) – Pair value.
class azure.mgmt.web.models.AppServiceEnvironment(location, name=None, kind=None, type=None, tags=None, app_service_environment_name=None, app_service_environment_location=None, vnet_name=None, vnet_resource_group_name=None, vnet_subnet_name=None, virtual_network=None, internal_load_balancing_mode=None, multi_size=None, multi_role_count=None, worker_pools=None, ipssl_address_count=None, dns_suffix=None, network_access_control_list=None, front_end_scale_factor=None, api_management_account_id=None, suspended=None, dynamic_cache_enabled=None, cluster_settings=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

Description of an App Service Environment.

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

Variables:
  • id (str) – Resource Id.
  • provisioning_state (str or ProvisioningState) – Provisioning state of the App Service Environment. Possible values include: ‘Succeeded’, ‘Failed’, ‘Canceled’, ‘InProgress’, ‘Deleting’
  • status (str or HostingEnvironmentStatus) – Current status of the App Service Environment. Possible values include: ‘Preparing’, ‘Ready’, ‘Scaling’, ‘Deleting’
  • database_edition (str) – Edition of the metadata database for the App Service Environment, e.g. “Standard”.
  • database_service_objective (str) – Service objective of the metadata database for the App Service Environment, e.g. “S0”.
  • upgrade_domains (int) – Number of upgrade domains of the App Service Environment.
  • subscription_id (str) – Subscription of the App Service Environment.
  • last_action (str) – Last deployment action on the App Service Environment.
  • last_action_result (str) – Result of the last deployment action on the App Service Environment.
  • allowed_multi_sizes (str) – List of comma separated strings describing which VM sizes are allowed for front-ends.
  • allowed_worker_sizes (str) – List of comma separated strings describing which VM sizes are allowed for workers.
  • maximum_number_of_machines (int) – Maximum number of VMs in the App Service Environment.
  • vip_mappings (list of VirtualIPMapping) – Description of IP SSL mapping for the App Service Environment.
  • environment_capacities (list of StampCapacity) – Current total, used, and available worker capacities.
  • environment_is_healthy (bool) – True/false indicating whether the App Service Environment is healthy.
  • environment_status (str) – Detailed message about with results of the last check of the App Service Environment.
  • resource_group (str) – Resource group of the App Service Environment.
  • default_front_end_scale_factor (int) – Default Scale Factor for FrontEnds.
Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
  • app_service_environment_name (str) – Name of the App Service Environment.
  • app_service_environment_location (str) – Location of the App Service Environment, e.g. “West US”.
  • vnet_name (str) – Name of the Virtual Network for the App Service Environment.
  • vnet_resource_group_name (str) – Resource group of the Virtual Network.
  • vnet_subnet_name (str) – Subnet of the Virtual Network.
  • virtual_network (VirtualNetworkProfile) – Description of the Virtual Network.
  • internal_load_balancing_mode (str or InternalLoadBalancingMode) – Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. Possible values include: ‘None’, ‘Web’, ‘Publishing’
  • multi_size (str) – Front-end VM size, e.g. “Medium”, “Large”.
  • multi_role_count (int) – Number of front-end instances.
  • worker_pools (list of WorkerPool) – Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool.
  • ipssl_address_count (int) – Number of IP SSL addresses reserved for the App Service Environment.
  • dns_suffix (str) – DNS suffix of the App Service Environment.
  • network_access_control_list (list of NetworkAccessControlEntry) – Access control list for controlling traffic to the App Service Environment.
  • front_end_scale_factor (int) – Scale factor for front-ends.
  • api_management_account_id (str) – API Management Account associated with the App Service Environment.
  • suspended (bool) – <code>true</code> if the App Service Environment is suspended; otherwise, <code>false</code>. The environment can be suspended, e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).
  • dynamic_cache_enabled (bool) – True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).
  • cluster_settings (list of NameValuePair) – Custom settings for changing the behavior of the App Service Environment.
class azure.mgmt.web.models.HostingEnvironmentProfile(id=None)[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.models.AppServicePlan(location, name=None, kind=None, type=None, tags=None, app_service_plan_name=None, worker_tier_name=None, admin_site_name=None, hosting_environment_profile=None, per_site_scaling=False, reserved=False, target_worker_count=None, target_worker_size_id=None, sku=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

App Service plan.

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

Variables:
  • id (str) – Resource Id.
  • status (str or StatusOptions) – App Service plan status. Possible values include: ‘Ready’, ‘Pending’
  • 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:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
  • app_service_plan_name (str) – 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 .
  • reserved (bool) – Reserved. 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.models.AutoHealCustomAction(exe=None, parameters=None)[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.models.AutoHealActions(action_type=None, custom_action=None, min_process_execution_time=None)[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.models.RequestsBasedTrigger(count=None, time_interval=None)[source]

Bases: msrest.serialization.Model

Trigger based on total requests.

Parameters:
  • count (int) – Count.
  • time_interval (str) – Time interval.
class azure.mgmt.web.models.StatusCodesBasedTrigger(status=None, sub_status=None, win32_status=None, count=None, time_interval=None)[source]

Bases: msrest.serialization.Model

Trigger based on status code.

Parameters:
  • status (int) – HTTP status code.
  • sub_status (int) – SubStatus.
  • win32_status (int) – Win32 error code.
  • count (int) – Count.
  • time_interval (str) – Time interval.
class azure.mgmt.web.models.SlowRequestsBasedTrigger(time_taken=None, count=None, time_interval=None)[source]

Bases: msrest.serialization.Model

Trigger based on request execution time.

Parameters:
  • time_taken (str) – Time taken.
  • count (int) – Count.
  • time_interval (str) – Time interval.
class azure.mgmt.web.models.AutoHealTriggers(requests=None, private_bytes_in_kb=None, status_codes=None, slow_requests=None)[source]

Bases: msrest.serialization.Model

Triggers for auto-heal.

Parameters:
class azure.mgmt.web.models.AutoHealRules(triggers=None, actions=None)[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.models.CloningInfo(source_web_app_id, correlation_id=None, overwrite=None, clone_custom_host_names=None, clone_source_control=None, hosting_environment=None, app_settings_overrides=None, configure_load_balancing=None, traffic_manager_profile_id=None, traffic_manager_profile_name=None)[source]

Bases: msrest.serialization.Model

Information needed for cloning operation.

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) – 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) – 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.
class azure.mgmt.web.models.ConnStringInfo(name=None, connection_string=None, type=None)[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’
class azure.mgmt.web.models.CorsSettings(allowed_origins=None)[source]

Bases: msrest.serialization.Model

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

Parameters:allowed_origins (list of 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.models.LocalizableString(value=None, localized_value=None)[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.models.CsmUsageQuota(unit=None, next_reset_time=None, current_value=None, limit=None, name=None)[source]

Bases: msrest.serialization.Model

Usage of the quota resource.

Parameters:
  • unit (str) – Units of measurement for the quota resourse.
  • 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.models.ErrorEntity(code=None, message=None, extended_code=None, message_template=None, parameters=None, inner_errors=None)[source]

Bases: msrest.serialization.Model

Body of the error response returned from the API.

Parameters:
  • code (str) – Basic error code.
  • message (str) – Any details of the error.
  • extended_code (str) – Type of error.
  • message_template (str) – Message template.
  • parameters (list of str) – Parameters for the template.
  • inner_errors (list of ErrorEntity) – Inner errors.
class azure.mgmt.web.models.RampUpRule(action_host_name=None, reroute_percentage=None, change_step=None, change_interval_in_minutes=None, min_reroute_percentage=None, max_reroute_percentage=None, change_decision_callback_url=None, name=None)[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 to add/remove from <code>ReroutePercentage</code> until it reaches <code>MinReroutePercentage</code> or <code>MaxReroutePercentage</code>. Site metrics are checked every N minutes specificed 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 mimuntes 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.models.Experiments(ramp_up_rules=None)[source]

Bases: msrest.serialization.Model

Routing rules in production experiments.

Parameters:ramp_up_rules (list of RampUpRule) – List of ramp-up rules.
class azure.mgmt.web.models.HandlerMapping(extension=None, script_processor=None, arguments=None)[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.models.HostNameSslState(name=None, ssl_state=None, virtual_ip=None, thumbprint=None, to_update=None, host_type=None)[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.models.HostingEnvironmentDiagnostics(name=None, diagnosics_output=None)[source]

Bases: msrest.serialization.Model

Diagnostics for an App Service Environment.

Parameters:
  • name (str) – Name/identifier of the diagnostics.
  • diagnosics_output (str) – Diagnostics output.
class azure.mgmt.web.models.IpSecurityRestriction(ip_address, subnet_mask=None)[source]

Bases: msrest.serialization.Model

IP security restriction on an app.

Parameters:
  • ip_address (str) – 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.models.MetricAvailabilily(time_grain=None, retention=None)[source]

Bases: msrest.serialization.Model

Metric availability and retention.

Parameters:
  • time_grain (str) – Time grain.
  • retention (str) – Retention period for the current time grain.
class azure.mgmt.web.models.MetricDefinition(location, name=None, kind=None, type=None, tags=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

Metadata for a metric.

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

Variables:
  • id (str) – Resource Id.
  • metric_definition_name (str) – Name of the metric.
  • unit (str) – Unit of the metric.
  • primary_aggregation_type (str) – Primary aggregation type.
  • metric_availabilities (list of MetricAvailabilily) – List of time grains supported for the metric together with retention period.
  • display_name (str) – Friendly name shown in the UI.
Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
class azure.mgmt.web.models.Operation(id=None, name=None, status=None, errors=None, created_time=None, modified_time=None, expiration_time=None, geo_master_operation_id=None)[source]

Bases: msrest.serialization.Model

Operation.

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 of 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.models.PushSettings(is_push_enabled, tag_whitelist_json=None, tags_requiring_auth=None, dynamic_tags_json=None)[source]

Bases: msrest.serialization.Model

Push settings for the App.

Parameters:
  • is_push_enabled (bool) – 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.models.ResourceMetricName[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.models.ResourceMetricProperty(key=None, value=None)[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.models.ResourceMetricValue[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:
class azure.mgmt.web.models.ResourceMetric[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:
class azure.mgmt.web.models.ResourceMetricAvailability[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.models.ResourceMetricDefinition(location, name=None, kind=None, type=None, tags=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

Metadata for the metrics.

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

Variables:
  • id (str) – Resource Id.
  • 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 of 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) – Properties.
Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
class azure.mgmt.web.models.SiteMachineKey(validation=None, validation_key=None, decryption=None, decryption_key=None)[source]

Bases: msrest.serialization.Model

MachineKey of an app.

Parameters:
  • validation (str) – MachineKey validation.
  • validation_key (str) – Validation key.
  • decryption (str) – Decryption.
  • decryption_key (str) – Decryption key.
class azure.mgmt.web.models.VirtualDirectory(virtual_path=None, physical_path=None)[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.models.VirtualApplication(virtual_path=None, physical_path=None, preload_enabled=None, virtual_directories=None)[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 of VirtualDirectory) – Virtual directories for virtual application.
class azure.mgmt.web.models.SiteLimits(max_percentage_cpu=None, max_memory_in_mb=None, max_disk_size_in_mb=None)[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.models.SiteConfig(location, name=None, kind=None, type=None, tags=None, number_of_workers=None, default_documents=None, net_framework_version='v4.6', php_version=None, python_version=None, node_version=None, linux_fx_version=None, request_tracing_enabled=None, request_tracing_expiration_time=None, remote_debugging_enabled=None, remote_debugging_version=None, http_logging_enabled=None, logs_directory_size_limit=None, detailed_error_logging_enabled=None, publishing_username=None, app_settings=None, connection_strings=None, handler_mappings=None, document_root=None, scm_type=None, use32_bit_worker_process=None, web_sockets_enabled=None, always_on=None, java_version=None, java_container=None, java_container_version=None, app_command_line=None, managed_pipeline_mode=None, virtual_applications=None, load_balancing=None, experiments=None, limits=None, auto_heal_enabled=None, auto_heal_rules=None, tracing_options=None, vnet_name=None, cors=None, push=None, api_definition=None, auto_swap_slot_name=None, local_my_sql_enabled=False, ip_security_restrictions=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

Configuration of an App Service app.

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

Variables:
Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
  • number_of_workers (int) – Number of workers.
  • default_documents (list of 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 of NameValuePair) – Application settings.
  • connection_strings (list of ConnStringInfo) – Connection strings.
  • handler_mappings (list of 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 of 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 polymophic 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 of IpSecurityRestriction) – IP security restrictions.
class azure.mgmt.web.models.SlotSwapStatus[source]

Bases: msrest.serialization.Model

The status of the last successfull 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.models.Site(location, name=None, kind=None, type=None, tags=None, enabled=None, host_name_ssl_states=None, server_farm_id=None, reserved=False, site_config=None, scm_site_also_stopped=False, hosting_environment_profile=None, micro_service='false', gateway_site_name=None, client_affinity_enabled=None, client_cert_enabled=None, host_names_disabled=None, container_size=None, daily_memory_time_quota=None, cloning_info=None)[source]

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

Variables:
  • id (str) – Resource Id.
  • state (str) – Current state of the app.
  • host_names (list of 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 of 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 of str) – Azure Traffic Manager hostnames associated with the app. Read-only.
  • premium_app_deployed (bool) – Indicates whether app is deployed as a premium app.
  • 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). 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:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – 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 of 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.
  • micro_service (str) – Micro services like apps, logic apps. Default value: “false” .
  • gateway_site_name (str) – Name of gateway app associated with 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.
class azure.mgmt.web.models.SkuInfo(resource_type=None, sku=None, capacity=None)[source]

Bases: msrest.serialization.Model

SKU discovery information.

Parameters:
  • resource_type (str) – Resource type that this SKU applies to.
  • sku (SkuDescription) – Name and tier of the SKU.
  • capacity (SkuCapacity) – Min, max, and default scale values of the SKU.
class azure.mgmt.web.models.Usage(location, name=None, kind=None, type=None, tags=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

Usage of the quota resource.

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

Variables:
  • id (str) – Resource Id.
  • display_name (str) – Friendly name shown in the UI.
  • usage_name (str) – Name of the quota.
  • resource_name (str) – Name of the quota resource.
  • unit (str) – Units of measurement for the quota resource.
  • current_value (long) – The current value of the resource counter.
  • limit (long) – The resource limit.
  • next_reset_time (datetime) – Next reset time for the resource counter.
  • compute_mode (str or ComputeModeOptions) – Compute mode used for this usage. Possible values include: ‘Shared’, ‘Dedicated’, ‘Dynamic’
  • site_mode (str) – Site mode used for this usage.
Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
class azure.mgmt.web.models.WebAppCollection(value, next_link=None)[source]

Bases: msrest.serialization.Model

Collection of App Service apps.

Parameters:
  • value (list of Site) – Collection of resources.
  • next_link (str) – Link to next page of resources.
class azure.mgmt.web.models.HybridConnection(location, name=None, kind=None, type=None, tags=None, service_bus_namespace=None, relay_name=None, relay_arm_uri=None, hostname=None, port=None, send_key_name=None, send_key_value=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

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.

Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
  • 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.
class azure.mgmt.web.models.HybridConnectionKey(location, name=None, kind=None, type=None, tags=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

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.
  • send_key_name (str) – The name of the send key.
  • send_key_value (str) – The value of the send key.
Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
class azure.mgmt.web.models.HybridConnectionLimits(location, name=None, kind=None, type=None, tags=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

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

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

Variables:
  • id (str) – Resource Id.
  • current (int) – The current number of Hybrid Connections.
  • maximum (int) – The maximum number of Hybrid Connections allowed.
Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
class azure.mgmt.web.models.VnetGateway(location, name=None, kind=None, type=None, tags=None, vnet_name=None, vpn_package_uri=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

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.

Variables:

id (str) – Resource Id.

Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
  • vnet_name (str) – The Virtual Network name.
  • vpn_package_uri (str) – The URI where the VPN package can be downloaded.
class azure.mgmt.web.models.VnetRoute(location, name=None, kind=None, type=None, tags=None, vnet_route_name=None, start_address=None, end_address=None, route_type=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

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.

Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
  • 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.models.VnetInfo(location, name=None, kind=None, type=None, tags=None, vnet_resource_id=None, cert_blob=None, dns_servers=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

Virtual Network information contract.

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

Variables:
  • id (str) – Resource Id.
  • cert_thumbprint (str) – The client certificate thumbprint.
  • routes (list of 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:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
  • vnet_resource_id (str) – The Virtual Network’s resource ID.
  • cert_blob (str) – 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.models.Certificate(location, name=None, kind=None, type=None, tags=None, host_names=None, pfx_blob=None, password=None, cer_blob=None, key_vault_id=None, key_vault_secret_name=None, server_farm_id=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

SSL certificate for an app.

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

Variables:
  • id (str) – Resource Id.
  • friendly_name (str) – Friendly name of the certificate.
  • subject_name (str) – Subject name of the certificate.
  • site_name (str) – App name.
  • self_link (str) – Self link.
  • issuer (str) – Certificate issuer.
  • issue_date (datetime) – Certificate issue Date.
  • expiration_date (datetime) – Certificate expriration date.
  • thumbprint (str) – Certificate thumbprint.
  • valid (bool) – Is the certificate valid?.
  • public_key_hash (str) – Public key hash.
  • hosting_environment_profile (HostingEnvironmentProfile) – Specification for the App Service Environment to use for the certificate.
  • key_vault_secret_status (str or KeyVaultSecretStatus) – Status of the Key Vault secret. Possible values include: ‘Initialized’, ‘WaitingOnCertificateOrder’, ‘Succeeded’, ‘CertificateOrderFailed’, ‘OperationNotPermittedOnKeyVault’, ‘AzureServiceUnauthorizedToAccessKeyVault’, ‘KeyVaultDoesNotExist’, ‘KeyVaultSecretDoesNotExist’, ‘UnknownError’, ‘ExternalPrivateKey’, ‘Unknown’
Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
  • host_names (list of str) – Host names the certificate applies to.
  • pfx_blob (bytearray) – Pfx blob.
  • password (str) – Certificate password.
  • cer_blob (str) – Raw bytes of .cer file
  • key_vault_id (str) – Key Vault Csm resource Id.
  • key_vault_secret_name (str) – Key Vault secret name.
  • server_farm_id (str) – Resource ID of the associated App Service plan, formatted as: “/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}”.
class azure.mgmt.web.models.Csr(location, name=None, kind=None, type=None, tags=None, csr_name=None, distinguished_name=None, csr_string=None, pfx_blob=None, password=None, public_key_hash=None, hosting_environment=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

Certificate signing request.

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

Variables:

id (str) – Resource Id.

Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
  • csr_name (str) – Name used to locate CSR object.
  • distinguished_name (str) – Distinguished name of certificate to be created.
  • csr_string (str) – Actual CSR string created.
  • pfx_blob (str) – PFX certifcate of created certificate.
  • password (str) – PFX password.
  • public_key_hash (str) – Hash of the certificate’s public key.
  • hosting_environment (str) – App Service Environment.
class azure.mgmt.web.models.Address(address1, city, country, postal_code, state, address2=None)[source]

Bases: msrest.serialization.Model

Address information for domain registration.

Parameters:
  • address1 (str) – Address 1.
  • address2 (str) – Address 2.
  • city (str) – City.
  • country (str) – Country.
  • postal_code (str) – Postal code.
  • state (str) – State.
class azure.mgmt.web.models.Contact(email, name_first, name_last, phone, address_mailing=None, fax=None, job_title=None, name_middle=None, organization=None)[source]

Bases: msrest.serialization.Model

Contact information for domain registration. If ‘Domain Privacy’ option is not selected then the contact information is made publicly available through the Whois directories as per ICANN requirements.

Parameters:
  • address_mailing (Address) – Mailing address.
  • email (str) – Email address.
  • fax (str) – Fax number.
  • job_title (str) – Job title.
  • name_first (str) – First name.
  • name_last (str) – Last name.
  • name_middle (str) – Middle name.
  • organization (str) – Organization.
  • phone (str) – Phone number.
class azure.mgmt.web.models.HostName(name=None, site_names=None, azure_resource_name=None, azure_resource_type=None, custom_host_name_dns_record_type=None, host_name_type=None)[source]

Bases: msrest.serialization.Model

Details of a hostname derived from a domain.

Parameters:
  • name (str) – Name of the hostname.
  • site_names (list of str) – List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager.
  • azure_resource_name (str) – Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name.
  • azure_resource_type (str or AzureResourceType) – Type of the Azure resource the hostname is assigned to. Possible values include: ‘Website’, ‘TrafficManager’
  • custom_host_name_dns_record_type (str or CustomHostNameDnsRecordType) – Type of the DNS record. Possible values include: ‘CName’, ‘A’
  • host_name_type (str or HostNameType) – Type of the hostname. Possible values include: ‘Verified’, ‘Managed’
class azure.mgmt.web.models.DomainPurchaseConsent(agreement_keys=None, agreed_by=None, agreed_at=None)[source]

Bases: msrest.serialization.Model

Domain purchase consent object, representing acceptance of applicable legal agreements.

Parameters:
  • agreement_keys (list of str) – List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under <code>TopLevelDomain</code> resource.
  • agreed_by (str) – Client IP address.
  • agreed_at (datetime) – Timestamp when the agreements were accepted.
class azure.mgmt.web.models.Domain(location, name=None, kind=None, type=None, tags=None, contact_admin=None, contact_billing=None, contact_registrant=None, contact_tech=None, name_servers=None, privacy=None, auto_renew=True, managed_host_names=None, consent=None, domain_not_renewable_reasons=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

Information about a domain.

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

Variables:
  • id (str) – Resource Id.
  • registration_status (str or DomainStatus) – Domain registration status. Possible values include: ‘Active’, ‘Awaiting’, ‘Cancelled’, ‘Confiscated’, ‘Disabled’, ‘Excluded’, ‘Expired’, ‘Failed’, ‘Held’, ‘Locked’, ‘Parked’, ‘Pending’, ‘Reserved’, ‘Reverted’, ‘Suspended’, ‘Transferred’, ‘Unknown’, ‘Unlocked’, ‘Unparked’, ‘Updated’, ‘JsonConverterFailed’
  • provisioning_state (str or ProvisioningState) – Domain provisioning state. Possible values include: ‘Succeeded’, ‘Failed’, ‘Canceled’, ‘InProgress’, ‘Deleting’
  • created_time (datetime) – Domain creation timestamp.
  • expiration_time (datetime) – Domain expiration timestamp.
  • last_renewed_time (datetime) – Timestamp when the domain was renewed last time.
  • ready_for_dns_record_management (bool) – <code>true</code> if Azure can assign this domain to App Service apps; otherwise, <code>false</code>. This value will be <code>true</code> if domain registration status is active and it is hosted on name servers Azure has programmatic access to.
Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
  • contact_admin (Contact) – Administrative contact.
  • contact_billing (Contact) – Billing contact.
  • contact_registrant (Contact) – Registrant contact.
  • contact_tech (Contact) – Technical contact.
  • name_servers (list of str) – Name servers.
  • privacy (bool) – <code>true</code> if domain privacy is enabled for this domain; otherwise, <code>false</code>.
  • auto_renew (bool) – <code>true</code> if the domain should be automatically renewed; otherwise, <code>false</code>. Default value: True .
  • managed_host_names (list of HostName) – All hostnames derived from the domain and assigned to Azure resources.
  • consent (DomainPurchaseConsent) – Legal agreement consent.
  • domain_not_renewable_reasons (list of str) – Reasons why domain is not renewable.
class azure.mgmt.web.models.DomainAvailablilityCheckResult(name=None, available=None, domain_type=None)[source]

Bases: msrest.serialization.Model

Domain availablility check result.

Parameters:
  • name (str) – Name of the domain.
  • available (bool) – <code>true</code> if domain can be purchased using CreateDomain API; otherwise, <code>false</code>.
  • domain_type (str or DomainType) – Valid values are Regular domain: Azure will charge the full price of domain registration, SoftDeleted: Purchasing this domain will simply restore it and this operation will not cost anything. Possible values include: ‘Regular’, ‘SoftDeleted’
class azure.mgmt.web.models.DomainControlCenterSsoRequest[source]

Bases: msrest.serialization.Model

Single sign-on request information for domain management.

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

Variables:
  • url (str) – URL where the single sign-on request is to be made.
  • post_parameter_key (str) – Post parameter key.
  • post_parameter_value (str) – Post parameter value. Client should use ‘application/x-www-form-urlencoded’ encoding for this value.
class azure.mgmt.web.models.DomainOwnershipIdentifier(location, name=None, kind=None, type=None, tags=None, ownership_id=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

Domain ownership Identifier.

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

Variables:

id (str) – Resource Id.

Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
  • ownership_id (str) – Ownership Id.
class azure.mgmt.web.models.DomainRecommendationSearchParameters(keywords=None, max_domain_recommendations=None)[source]

Bases: msrest.serialization.Model

Domain recommendation search parameters.

Parameters:
  • keywords (str) – Keywords to be used for generating domain recommendations.
  • max_domain_recommendations (int) – Maximum number of recommendations.
class azure.mgmt.web.models.Recommendation(creation_time=None, recommendation_id=None, resource_id=None, resource_scope=None, rule_name=None, display_name=None, message=None, level=None, channels=None, tags=None, action_name=None, start_time=None, end_time=None, next_notification_time=None, notification_expiration_time=None, notified_time=None, score=None)[source]

Bases: msrest.serialization.Model

Represents a recommendation result generated by the recommendation engine.

Parameters:
  • creation_time (datetime) – Timestamp when this instance was created.
  • recommendation_id (str) – A GUID value that each recommendation object is associated with.
  • resource_id (str) – Full ARM resource ID string that this recommendation object is associated with.
  • resource_scope (str or ResourceScopeType) – Name of a resource type this recommendation applies, e.g. Subscription, ServerFarm, Site. Possible values include: ‘ServerFarm’, ‘Subscription’, ‘WebSite’
  • rule_name (str) – Unique name of the rule.
  • display_name (str) – UI friendly name of the rule (may not be unique).
  • message (str) – Recommendation text.
  • level (str or NotificationLevel) – Level indicating how critical this recommendation can impact. Possible values include: ‘Critical’, ‘Warning’, ‘Information’, ‘NonUrgentSuggestion’
  • channels (str or Channels) – List of channels that this recommendation can apply. Possible values include: ‘Notification’, ‘Api’, ‘Email’, ‘Webhook’, ‘All’
  • tags (list of str) – The list of category tags that this recommendation belongs to.
  • action_name (str) – Name of action recommended by this object.
  • start_time (datetime) – The beginning time in UTC of a range that the recommendation refers to.
  • end_time (datetime) – The end time in UTC of a range that the recommendation refers to.
  • next_notification_time (datetime) – When to notify this recommendation next in UTC. Null means that this will never be notified anymore.
  • notification_expiration_time (datetime) – Date and time in UTC when this notification expires.
  • notified_time (datetime) – Last timestamp in UTC this instance was actually notified. Null means that this recommendation hasn’t been notified yet.
  • score (float) – A metric value measured by the rule.
class azure.mgmt.web.models.RecommendationRule(name=None, display_name=None, message=None, recommendation_id=None, description=None, action_name=None, level=None, channels=None, tags=None)[source]

Bases: msrest.serialization.Model

Represents a recommendation rule that the recommendation engine can perform.

Parameters:
  • name (str) – Unique name of the rule.
  • display_name (str) – UI friendly name of the rule.
  • message (str) – Localized name of the rule (Good for UI).
  • recommendation_id (str) – Recommendation ID of an associated recommendation object tied to the rule, if exists. If such an object doesn’t exist, it is set to null.
  • description (str) – Localized detailed description of the rule.
  • action_name (str) – Name of action that is recommended by this rule in string.
  • level (str or NotificationLevel) – Level of impact indicating how critical this rule is. Possible values include: ‘Critical’, ‘Warning’, ‘Information’, ‘NonUrgentSuggestion’
  • channels (str or Channels) – List of available channels that this rule applies. Possible values include: ‘Notification’, ‘Api’, ‘Email’, ‘Webhook’, ‘All’
  • tags (list of str) – An array of category tags that the rule contains.
class azure.mgmt.web.models.CsmMoveResourceEnvelope(target_resource_group=None, resources=None)[source]

Bases: msrest.serialization.Model

Object with a list of the resources that need to be moved and the resource group they should be moved to.

Parameters:
  • target_resource_group (str) –
  • resources (list of str) –
class azure.mgmt.web.models.GeoRegion(location, name=None, kind=None, type=None, tags=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

Geographical region.

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

Variables:
  • id (str) – Resource Id.
  • geo_region_name (str) – Region name.
  • description (str) – Region description.
  • display_name (str) – Display name for region.
Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
class azure.mgmt.web.models.GlobalCsmSkuDescription(name=None, tier=None, capacity=None, locations=None, capabilities=None)[source]

Bases: msrest.serialization.Model

A Global SKU Description.

Parameters:
  • name (str) – Name of the resource SKU.
  • tier (str) – Service Tier of the resource SKU.
  • capacity (SkuCapacity) – Min, max, and default scale values of the SKU.
  • locations (list of str) – Locations of the SKU.
  • capabilities (list of Capability) – Capabilities of the SKU, e.g., is traffic manager enabled?
class azure.mgmt.web.models.PremierAddOnOffer(location, name=None, kind=None, type=None, tags=None, sku=None, product=None, vendor=None, premier_add_on_offer_name=None, promo_code_required=None, quota=None, web_hosting_plan_restrictions=None, privacy_policy_url=None, legal_terms_url=None, marketplace_publisher=None, marketplace_offer=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

Premier add-on offer.

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

Variables:

id (str) – Resource Id.

Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
  • sku (str) – SKU.
  • product (str) – Product.
  • vendor (str) – Vendor.
  • premier_add_on_offer_name (str) – Name.
  • promo_code_required (bool) – <code>true</code> if promotion code is required; otherwise, <code>false</code>.
  • quota (int) – Quota.
  • web_hosting_plan_restrictions (str or AppServicePlanRestrictions) – App Service plans this offer is restricted to. Possible values include: ‘None’, ‘Free’, ‘Shared’, ‘Basic’, ‘Standard’, ‘Premium’
  • privacy_policy_url (str) – Privacy policy URL.
  • legal_terms_url (str) – Legal terms URL.
  • marketplace_publisher (str) – Marketplace publisher.
  • marketplace_offer (str) – Marketplace offer.
class azure.mgmt.web.models.ResourceNameAvailability(name_available=None, reason=None, message=None)[source]

Bases: msrest.serialization.Model

Information regarding availbility of a resource name.

Parameters:
  • name_available (bool) – <code>true</code> indicates name is valid and available. <code>false</code> indicates the name is invalid, unavailable, or both.
  • reason (str or InAvailabilityReasonType) – <code>Invalid</code> indicates the name provided does not match Azure App Service naming requirements. <code>AlreadyExists</code> indicates that the name is already in use and is therefore unavailable. Possible values include: ‘Invalid’, ‘AlreadyExists’
  • message (str) – If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that resource name is already in use, and direct them to select a different name.
class azure.mgmt.web.models.ResourceNameAvailabilityRequest(name, type, is_fqdn=None)[source]

Bases: msrest.serialization.Model

Resource name availability request content.

Parameters:
  • name (str) – Resource name to verify.
  • type (str or CheckNameResourceTypes) – Resource type used for verification. Possible values include: ‘Site’, ‘Slot’, ‘HostingEnvironment’
  • is_fqdn (bool) – Is fully qualified domain name.
class azure.mgmt.web.models.SkuInfos(resource_type=None, skus=None)[source]

Bases: msrest.serialization.Model

Collection of SKU information.

Parameters:
  • resource_type (str) – Resource type that this SKU applies to.
  • skus (list of GlobalCsmSkuDescription) – List of SKUs the subscription is able to use.
class azure.mgmt.web.models.SourceControl(location, name=None, kind=None, type=None, tags=None, source_control_name=None, token=None, token_secret=None, refresh_token=None, expiration_time=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

The source control OAuth token.

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

Variables:

id (str) – Resource Id.

Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
  • source_control_name (str) – Name or source control type.
  • token (str) – OAuth access token.
  • token_secret (str) – OAuth access token secret.
  • refresh_token (str) – OAuth refresh token.
  • expiration_time (datetime) – OAuth token expiration.
class azure.mgmt.web.models.User(location, name=None, kind=None, type=None, tags=None, user_name=None, publishing_user_name=None, publishing_password=None, publishing_password_hash=None, publishing_password_hash_salt=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

User crendentials used for publishing activity.

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

Variables:

id (str) – Resource Id.

Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
  • user_name (str) – Username
  • publishing_user_name (str) – 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.models.ValidateRequest(name, type, location, server_farm_id=None, sku_name=None, need_linux_workers=None, capacity=None, hosting_environment=None)[source]

Bases: msrest.serialization.Model

Resource validation request content.

Parameters:
  • name (str) – Resource name to verify.
  • type (str or ValidateResourceTypes) – Resource type used for verification. Possible values include: ‘ServerFarm’, ‘Site’
  • location (str) – Expected location of the resource.
  • server_farm_id (str) – ARM resource ID of an App Service plan that would host the app.
  • sku_name (str) – Name of the target SKU for the App Service plan.
  • need_linux_workers (bool) – <code>true</code> if App Service plan is for Linux workers; otherwise, <code>false</code>.
  • capacity (int) – Target capacity of the App Service plan (number of VM’s).
  • hosting_environment (str) – Name of App Service Environment where app or App Service plan should be created.
class azure.mgmt.web.models.ValidateResponseError(code=None, message=None)[source]

Bases: msrest.serialization.Model

Error details for when validation fails.

Parameters:
  • code (str) – Validation error code.
  • message (str) – Validation error message.
class azure.mgmt.web.models.ValidateResponse(status=None, error=None)[source]

Bases: msrest.serialization.Model

Describes the result of resource validation.

Parameters:
  • status (str) – Result of validation.
  • error (ValidateResponseError) – Error details for the case when validation fails.
class azure.mgmt.web.models.TldLegalAgreement(agreement_key, title, content, url=None)[source]

Bases: msrest.serialization.Model

Legal agreement for a top level domain.

Parameters:
  • agreement_key (str) – Unique identifier for the agreement.
  • title (str) – Agreement title.
  • content (str) – Agreement details.
  • url (str) – URL where a copy of the agreement details is hosted.
class azure.mgmt.web.models.TopLevelDomain(location, name=None, kind=None, type=None, tags=None, privacy=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

A top level domain object.

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

Variables:
  • id (str) – Resource Id.
  • domain_name (str) – Name of the top level domain.
Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
  • privacy (bool) – If <code>true</code>, then the top level domain supports domain privacy; otherwise, <code>false</code>.
class azure.mgmt.web.models.TopLevelDomainAgreementOption(include_privacy=None)[source]

Bases: msrest.serialization.Model

Options for retrieving the list of top level domain legal agreements.

Parameters:include_privacy (bool) – If <code>true</code>, then the list of agreements will include agreements for domain privacy as well; otherwise, <code>false</code>.
class azure.mgmt.web.models.FileSystemApplicationLogsConfig(level='Off')[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.models.AzureTableStorageApplicationLogsConfig(sas_url, level=None)[source]

Bases: msrest.serialization.Model

Application logs to Azure table storage configuration.

Parameters:
  • level (str or LogLevel) – Log level. Possible values include: ‘Off’, ‘Verbose’, ‘Information’, ‘Warning’, ‘Error’
  • sas_url (str) – SAS URL to an Azure table with add/query/delete permissions.
class azure.mgmt.web.models.AzureBlobStorageApplicationLogsConfig(level=None, sas_url=None, retention_in_days=None)[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.models.ApplicationLogsConfig(file_system=None, azure_table_storage=None, azure_blob_storage=None)[source]

Bases: msrest.serialization.Model

Application logs configuration.

Parameters:
class azure.mgmt.web.models.AzureBlobStorageHttpLogsConfig(sas_url=None, retention_in_days=None, enabled=None)[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) – Enabled.
class azure.mgmt.web.models.DatabaseBackupSetting(database_type, name=None, connection_string_name=None, connection_string=None)[source]

Bases: msrest.serialization.Model

Database backup settings.

Parameters:
  • database_type (str or DatabaseType) – Database type (e.g. SqlAzure / MySql). Possible values include: ‘SqlAzure’, ‘MySql’, ‘LocalMySql’
  • 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.models.BackupItem(location, name=None, kind=None, type=None, tags=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

Backup description.

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

Variables:
  • id (str) – Resource Id.
  • 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 of 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:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
class azure.mgmt.web.models.BackupSchedule(frequency_interval=7, frequency_unit='Day', keep_at_least_one_backup=True, retention_period_in_days=90, start_time=None)[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.

Parameters:
  • frequency_interval (int) – How often should be the backup 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) – The unit of time for how often should be the backup 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) – 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) – After how many days backups should be deleted. Default value: 90 .
  • 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.models.BackupRequest(location, name=None, kind=None, type=None, tags=None, backup_request_name=None, enabled=None, storage_account_url=None, backup_schedule=None, databases=None, backup_request_type=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

Description of a backup which will be performed.

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

Variables:

id (str) – Resource Id.

Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
  • backup_request_name (str) – 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) – SAS URL to the container.
  • backup_schedule (BackupSchedule) – Schedule for the backup if it is executed periodically.
  • databases (list of DatabaseBackupSetting) – Databases included in the backup.
  • backup_request_type (str or BackupRestoreOperationType) – Type of the backup. Possible values include: ‘Default’, ‘Clone’, ‘Relocation’
class azure.mgmt.web.models.ConnStringValueTypePair(value, type)[source]

Bases: msrest.serialization.Model

Database connection string value to type pair.

Parameters:
  • value (str) – Value of pair.
  • type (str or ConnectionStringType) – Type of database. Possible values include: ‘MySql’, ‘SQLServer’, ‘SQLAzure’, ‘Custom’, ‘NotificationHub’, ‘ServiceBus’, ‘EventHub’, ‘ApiHub’, ‘DocDb’, ‘RedisCache’
class azure.mgmt.web.models.ConnectionStringDictionary(location, name=None, kind=None, type=None, tags=None, properties=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

String dictionary resource.

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

Variables:

id (str) – Resource Id.

Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
  • properties (dict) – Connection strings.
class azure.mgmt.web.models.CsmPublishingProfileOptions(format=None)[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.models.CsmSiteRecoveryEntity(snapshot_time=None, site_name=None, slot_name=None)[source]

Bases: msrest.serialization.Model

Details about app recovery operation.

Parameters:
  • snapshot_time (datetime) – Point in time in which the app recovery should be attempted.
  • site_name (str) – [Optional] Destination app name into which app should be recovered. This is case when new app should be created instead.
  • slot_name (str) – [Optional] Destination app slot name into which app should be recovered.
class azure.mgmt.web.models.CsmSlotEntity(target_slot, preserve_vnet)[source]

Bases: msrest.serialization.Model

Deployment slot parameters.

Parameters:
  • target_slot (str) – Destination deployment slot during swap operation.
  • preserve_vnet (bool) – <code>true</code> to preserve Virtual Network to the slot during swap; otherwise, <code>false</code>.
class azure.mgmt.web.models.CustomHostnameAnalysisResult(location, name=None, kind=None, type=None, tags=None, c_name_records=None, txt_records=None, a_records=None, alternate_cname_records=None, alternate_txt_records=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

Custom domain analysis.

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

Variables:
  • id (str) – Resource Id.
  • 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 htere 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:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
  • c_name_records (list of str) – CName records controller can see for this hostname.
  • txt_records (list of str) – TXT records controller can see for this hostname.
  • a_records (list of str) – A records controller can see for this hostname.
  • alternate_cname_records (list of str) – Alternate CName records controller can see for this hostname.
  • alternate_txt_records (list of str) – Alternate TXT records controller can see for this hostname.
class azure.mgmt.web.models.Deployment(location, name=None, kind=None, type=None, tags=None, deployment_id=None, status=None, message=None, author=None, deployer=None, author_email=None, start_time=None, end_time=None, active=None, details=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

User crendentials used for publishing activity.

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

Variables:

id (str) – Resource Id.

Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
  • deployment_id (str) – ID.
  • status (int) – Status.
  • message (str) – Message.
  • author (str) – Author.
  • deployer (str) – Deployer.
  • author_email (str) – Author email.
  • start_time (datetime) – Start time.
  • end_time (datetime) – End time.
  • active (bool) – Active.
  • details (str) – Detail.
class azure.mgmt.web.models.EnabledConfig(enabled=None)[source]

Bases: msrest.serialization.Model

Enabled configuration.

Parameters:enabled (bool) – Enabled.
class azure.mgmt.web.models.FileSystemHttpLogsConfig(retention_in_mb=None, retention_in_days=None, enabled=None)[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) – Enabled.
class azure.mgmt.web.models.HostNameBinding(location, name=None, kind=None, type=None, tags=None, host_name_binding_name=None, site_name=None, domain_id=None, azure_resource_name=None, azure_resource_type=None, custom_host_name_dns_record_type=None, host_name_type=None, ssl_state=None, thumbprint=None, virtual_ip=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

A hostname binding object.

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

Variables:

id (str) – Resource Id.

Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
  • host_name_binding_name (str) – Hostname.
  • 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
  • virtual_ip (str) – Virtual IP address assigned to the hostname if IP based SSL is enabled.
class azure.mgmt.web.models.HttpLogsConfig(file_system=None, azure_blob_storage=None)[source]

Bases: msrest.serialization.Model

Http logs configuration.

Parameters:
class azure.mgmt.web.models.Identifier(location, name=None, kind=None, type=None, tags=None, identifier_id=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

Identifier.

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

Variables:

id (str) – Resource Id.

Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
  • identifier_id (str) – ID.
class azure.mgmt.web.models.MigrateMySqlRequest(location, name=None, kind=None, type=None, tags=None, connection_string=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

MySQL migration request.

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

Variables:

id (str) – Resource Id.

Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
  • connection_string (str) – Connection string to the remote MySQL database to which data should be migrated.
class azure.mgmt.web.models.RelayServiceConnectionEntity(location, name=None, kind=None, type=None, tags=None, entity_name=None, entity_connection_string=None, resource_type=None, resource_connection_string=None, hostname=None, port=None, biztalk_uri=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

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.

Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
  • 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.models.NetworkFeatures(location, name=None, kind=None, type=None, tags=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

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.
  • virtual_network_name (str) – The Virtual Network name.
  • virtual_network_connection (VnetInfo) – The Virtual Network summary view.
  • hybrid_connections (list of RelayServiceConnectionEntity) – The Hybrid Connections summary view.
  • hybrid_connections_v2 (list of HybridConnection) – The Hybrid Connection V2 (Service Bus) view.
Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
class azure.mgmt.web.models.PerfMonSample(time=None, instance_name=None, value=None)[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.
class azure.mgmt.web.models.PerfMonSet(name=None, start_time=None, end_time=None, time_grain=None, values=None)[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 of PerfMonSample) – Collection of workers that are active during this time.
class azure.mgmt.web.models.PerfMonResponse(code=None, message=None, data=None)[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.models.PremierAddOn(location, name=None, kind=None, type=None, tags=None, sku=None, product=None, vendor=None, premier_add_on_name=None, premier_add_on_location=None, premier_add_on_tags=None, marketplace_publisher=None, marketplace_offer=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

Premier add-on.

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

Variables:

id (str) – Resource Id.

Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
  • sku (str) – SKU.
  • product (str) – Product.
  • vendor (str) – Vendor.
  • premier_add_on_name (str) – Name.
  • premier_add_on_location (str) – Location.
  • premier_add_on_tags (dict) – Tags.
  • marketplace_publisher (str) – Marketplace publisher.
  • marketplace_offer (str) – Marketplace offer.
class azure.mgmt.web.models.RecoverResponse(location, name=None, kind=None, type=None, tags=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

Response for an app recovery request.

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

Variables:
  • id (str) – Resource Id.
  • operation_id (str) – ID of the recovery operation. Can be used to check the status of the corresponding operation.
Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
class azure.mgmt.web.models.RestoreRequest(location, name=None, kind=None, type=None, tags=None, storage_account_url=None, blob_name=None, overwrite=None, site_name=None, databases=None, ignore_conflicting_host_names=False, operation_type='Default', adjust_connection_strings=None, hosting_environment=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

Description of a restore request.

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

Variables:

id (str) – Resource Id.

Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
  • storage_account_url (str) – SAS URL to the container.
  • blob_name (str) – Name of a blob which contains the backup.
  • overwrite (bool) – <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 of 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 .
  • operation_type (str or BackupRestoreOperationType) – Operation type. Possible values include: ‘Default’, ‘Clone’, ‘Relocation’. 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.models.RestoreResponse(location, name=None, kind=None, type=None, tags=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

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.
  • operation_id (str) – When server starts the restore process, it will return an operation ID identifying that particular restore operation.
Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
class azure.mgmt.web.models.SiteAuthSettings(enabled=None, runtime_version=None, unauthenticated_client_action=None, token_store_enabled=None, allowed_external_redirect_urls=None, default_provider=None, token_refresh_extension_hours=None, client_id=None, client_secret=None, issuer=None, allowed_audiences=None, additional_login_params=None, google_client_id=None, google_client_secret=None, google_oauth_scopes=None, facebook_app_id=None, facebook_app_secret=None, facebook_oauth_scopes=None, twitter_consumer_key=None, twitter_consumer_secret=None, microsoft_account_client_id=None, microsoft_account_client_secret=None, microsoft_account_oauth_scopes=None)[source]

Bases: msrest.serialization.Model

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

Parameters:
  • 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 of 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 of 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 of 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 of 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 of 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 of 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.models.SiteCloneabilityCriterion(name=None, description=None)[source]

Bases: msrest.serialization.Model

An app cloneability criterion.

Parameters:
  • name (str) – Name of criterion.
  • description (str) – Description of criterion.
class azure.mgmt.web.models.SiteCloneability(result=None, blocking_features=None, unsupported_features=None, blocking_characteristics=None)[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 of SiteCloneabilityCriterion) – List of features enabled on app that prevent cloning.
  • unsupported_features (list of 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 of SiteCloneabilityCriterion) – List of blocking application characteristics.
class azure.mgmt.web.models.SiteConfigurationSnapshotInfo(location, name=None, kind=None, type=None, tags=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

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.
  • time (datetime) – The time the snapshot was taken.
  • site_configuration_snapshot_info_id (int) – The id of the snapshot
Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
class azure.mgmt.web.models.SiteInstance(location, name=None, kind=None, type=None, tags=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

Instance of an app.

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

Variables:
  • id (str) – Resource Id.
  • site_instance_name (str) – Name of instance.
Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
class azure.mgmt.web.models.SiteLogsConfig(location, name=None, kind=None, type=None, tags=None, application_logs=None, http_logs=None, failed_requests_tracing=None, detailed_error_messages=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

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.

Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
  • 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.models.SitePhpErrorLogFlag(location, name=None, kind=None, type=None, tags=None, local_log_errors=None, master_log_errors=None, local_log_errors_max_length=None, master_log_errors_max_length=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

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.

Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
  • 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.models.SiteSourceControl(location, name=None, kind=None, type=None, tags=None, repo_url=None, branch=None, is_manual_integration=None, deployment_rollback_enabled=None, is_mercurial=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

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.

Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
  • 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.models.SlotConfigNamesResource(location, name=None, kind=None, type=None, tags=None, connection_string_names=None, app_setting_names=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

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.

Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
  • connection_string_names (list of str) – List of connection string names.
  • app_setting_names (list of str) – List of application settings names.
class azure.mgmt.web.models.SlotDifference(location, name=None, kind=None, type=None, tags=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

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.
  • 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:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
class azure.mgmt.web.models.Snapshot(location, name=None, kind=None, type=None, tags=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

A snapshot of an app.

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

Variables:
Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
class azure.mgmt.web.models.StorageMigrationOptions(location, name=None, kind=None, type=None, tags=None, azurefiles_connection_string=None, azurefiles_share=None, switch_site_after_migration=False, block_write_access_to_site=False)[source]

Bases: azure.mgmt.web.models.resource.Resource

Options for app content migration.

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

Variables:

id (str) – Resource Id.

Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
  • azurefiles_connection_string (str) – AzureFiles connection string.
  • azurefiles_share (str) – 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.models.StorageMigrationResponse(location, name=None, kind=None, type=None, tags=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

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.
  • operation_id (str) – When server starts the migration process, it will return an operation ID identifying that particular migration operation.
Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
class azure.mgmt.web.models.StringDictionary(location, name=None, kind=None, type=None, tags=None, properties=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

String dictionary resource.

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

Variables:

id (str) – Resource Id.

Parameters:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – Resource tags.
  • properties (dict) – Settings.
class azure.mgmt.web.models.DeletedSite(location, name=None, kind=None, type=None, tags=None, enabled=None, host_name_ssl_states=None, server_farm_id=None, reserved=False, site_config=None, scm_site_also_stopped=False, hosting_environment_profile=None, micro_service='false', gateway_site_name=None, client_affinity_enabled=None, client_cert_enabled=None, host_names_disabled=None, container_size=None, daily_memory_time_quota=None, cloning_info=None)[source]

Bases: azure.mgmt.web.models.resource.Resource

A deleted app.

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

Variables:
  • id (str) – Resource Id.
  • deleted_timestamp (datetime) – Time in UTC when the app was deleted.
  • state (str) – Current state of the app.
  • host_names (list of 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 of 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 of str) – Azure Traffic Manager hostnames associated with the app. Read-only.
  • premium_app_deployed (bool) – Indicates whether app is deployed as a premium app.
  • 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). 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:
  • name (str) – Resource Name.
  • kind (str) – Kind of resource.
  • location (str) – Resource Location.
  • type (str) – Resource type.
  • tags (dict) – 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 of 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.
  • micro_service (str) – Micro services like apps, logic apps. Default value: “false” .
  • gateway_site_name (str) – Name of gateway app associated with 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.
class azure.mgmt.web.models.AppServiceCertificateOrderPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of AppServiceCertificateOrder object

class azure.mgmt.web.models.AppServiceCertificatePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of AppServiceCertificate object

class azure.mgmt.web.models.AppServiceEnvironmentPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of AppServiceEnvironment object

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of StampCapacity object

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of ResourceMetric object

class azure.mgmt.web.models.WorkerPoolPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of WorkerPool object

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of ResourceMetricDefinition object

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of SkuInfo object

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of Usage object

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of Site object

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of AppServicePlan object

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of CsmUsageQuota object

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of str object

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of HybridConnection object

class azure.mgmt.web.models.CertificatePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Certificate object

class azure.mgmt.web.models.CsrPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Csr object

class azure.mgmt.web.models.DomainPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Domain object

class azure.mgmt.web.models.NameIdentifierPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of NameIdentifier object

class azure.mgmt.web.models.DomainOwnershipIdentifierPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of DomainOwnershipIdentifier object

class azure.mgmt.web.models.SourceControlPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of SourceControl object

class azure.mgmt.web.models.GeoRegionPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of GeoRegion object

class azure.mgmt.web.models.PremierAddOnOfferPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of PremierAddOnOffer object

class azure.mgmt.web.models.TopLevelDomainPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of TopLevelDomain object

class azure.mgmt.web.models.TldLegalAgreementPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of TldLegalAgreement object

class azure.mgmt.web.models.BackupItemPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of BackupItem object

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of Deployment object

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of Identifier object

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of HostNameBinding object

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of SiteInstance object

class azure.mgmt.web.models.PerfMonResponsePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of PerfMonResponse object

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of SlotDifference object

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of Snapshot object

class azure.mgmt.web.models.DeletedSitePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of DeletedSite object

class azure.mgmt.web.models.KeyVaultSecretStatus[source]

Bases: enum.Enum

azure_service_unauthorized_to_access_key_vault = 'AzureServiceUnauthorizedToAccessKeyVault'
certificate_order_failed = 'CertificateOrderFailed'
external_private_key = 'ExternalPrivateKey'
initialized = 'Initialized'
key_vault_does_not_exist = 'KeyVaultDoesNotExist'
key_vault_secret_does_not_exist = 'KeyVaultSecretDoesNotExist'
operation_not_permitted_on_key_vault = 'OperationNotPermittedOnKeyVault'
succeeded = 'Succeeded'
unknown = 'Unknown'
unknown_error = 'UnknownError'
waiting_on_certificate_order = 'WaitingOnCertificateOrder'
class azure.mgmt.web.models.CertificateProductType[source]

Bases: enum.Enum

standard_domain_validated_ssl = 'StandardDomainValidatedSsl'
standard_domain_validated_wild_card_ssl = 'StandardDomainValidatedWildCardSsl'
class azure.mgmt.web.models.ProvisioningState[source]

Bases: enum.Enum

canceled = 'Canceled'
deleting = 'Deleting'
failed = 'Failed'
in_progress = 'InProgress'
succeeded = 'Succeeded'
class azure.mgmt.web.models.CertificateOrderStatus[source]

Bases: enum.Enum

canceled = 'Canceled'
denied = 'Denied'
expired = 'Expired'
issued = 'Issued'
not_submitted = 'NotSubmitted'
pending_rekey = 'PendingRekey'
pendingissuance = 'Pendingissuance'
pendingrevocation = 'Pendingrevocation'
revoked = 'Revoked'
unused = 'Unused'
class azure.mgmt.web.models.CertificateOrderActionType[source]

Bases: enum.Enum

certificate_expiration_warning = 'CertificateExpirationWarning'
certificate_expired = 'CertificateExpired'
certificate_issued = 'CertificateIssued'
certificate_order_canceled = 'CertificateOrderCanceled'
certificate_order_created = 'CertificateOrderCreated'
certificate_revoked = 'CertificateRevoked'
domain_validation_complete = 'DomainValidationComplete'
fraud_cleared = 'FraudCleared'
fraud_detected = 'FraudDetected'
fraud_documentation_required = 'FraudDocumentationRequired'
org_name_change = 'OrgNameChange'
org_validation_complete = 'OrgValidationComplete'
san_drop = 'SanDrop'
unknown = 'Unknown'
class azure.mgmt.web.models.HostingEnvironmentStatus[source]

Bases: enum.Enum

deleting = 'Deleting'
preparing = 'Preparing'
ready = 'Ready'
scaling = 'Scaling'
class azure.mgmt.web.models.InternalLoadBalancingMode[source]

Bases: enum.Enum

none = 'None'
publishing = 'Publishing'
web = 'Web'
class azure.mgmt.web.models.ComputeModeOptions[source]

Bases: enum.Enum

dedicated = 'Dedicated'
dynamic = 'Dynamic'
shared = 'Shared'
class azure.mgmt.web.models.WorkerSizeOptions[source]

Bases: enum.Enum

default = 'Default'
large = 'Large'
medium = 'Medium'
small = 'Small'
class azure.mgmt.web.models.AccessControlEntryAction[source]

Bases: enum.Enum

deny = 'Deny'
permit = 'Permit'
class azure.mgmt.web.models.StatusOptions[source]

Bases: enum.Enum

pending = 'Pending'
ready = 'Ready'
class azure.mgmt.web.models.AutoHealActionType[source]

Bases: enum.Enum

custom_action = 'CustomAction'
log_event = 'LogEvent'
recycle = 'Recycle'
class azure.mgmt.web.models.ConnectionStringType[source]

Bases: enum.Enum

api_hub = 'ApiHub'
custom = 'Custom'
doc_db = 'DocDb'
event_hub = 'EventHub'
my_sql = 'MySql'
notification_hub = 'NotificationHub'
redis_cache = 'RedisCache'
service_bus = 'ServiceBus'
sql_azure = 'SQLAzure'
sql_server = 'SQLServer'
class azure.mgmt.web.models.SslState[source]

Bases: enum.Enum

disabled = 'Disabled'
ip_based_enabled = 'IpBasedEnabled'
sni_enabled = 'SniEnabled'
class azure.mgmt.web.models.HostType[source]

Bases: enum.Enum

repository = 'Repository'
standard = 'Standard'
class azure.mgmt.web.models.OperationStatus[source]

Bases: enum.Enum

created = 'Created'
failed = 'Failed'
in_progress = 'InProgress'
succeeded = 'Succeeded'
timed_out = 'TimedOut'
class azure.mgmt.web.models.UsageState[source]

Bases: enum.Enum

exceeded = 'Exceeded'
normal = 'Normal'
class azure.mgmt.web.models.SiteAvailabilityState[source]

Bases: enum.Enum

disaster_recovery_mode = 'DisasterRecoveryMode'
limited = 'Limited'
normal = 'Normal'
class azure.mgmt.web.models.ScmType[source]

Bases: enum.Enum

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.models.ManagedPipelineMode[source]

Bases: enum.Enum

classic = 'Classic'
integrated = 'Integrated'
class azure.mgmt.web.models.SiteLoadBalancing[source]

Bases: enum.Enum

least_requests = 'LeastRequests'
least_response_time = 'LeastResponseTime'
request_hash = 'RequestHash'
weighted_round_robin = 'WeightedRoundRobin'
weighted_total_traffic = 'WeightedTotalTraffic'
class azure.mgmt.web.models.RouteType[source]

Bases: enum.Enum

default = 'DEFAULT'
inherited = 'INHERITED'
static = 'STATIC'
class azure.mgmt.web.models.DomainStatus[source]

Bases: enum.Enum

active = 'Active'
awaiting = 'Awaiting'
cancelled = 'Cancelled'
confiscated = 'Confiscated'
disabled = 'Disabled'
excluded = 'Excluded'
expired = 'Expired'
failed = 'Failed'
held = 'Held'
json_converter_failed = 'JsonConverterFailed'
locked = 'Locked'
parked = 'Parked'
pending = 'Pending'
reserved = 'Reserved'
reverted = 'Reverted'
suspended = 'Suspended'
transferred = 'Transferred'
unknown = 'Unknown'
unlocked = 'Unlocked'
unparked = 'Unparked'
updated = 'Updated'
class azure.mgmt.web.models.AzureResourceType[source]

Bases: enum.Enum

traffic_manager = 'TrafficManager'
website = 'Website'
class azure.mgmt.web.models.CustomHostNameDnsRecordType[source]

Bases: enum.Enum

a = 'A'
cname = 'CName'
class azure.mgmt.web.models.HostNameType[source]

Bases: enum.Enum

managed = 'Managed'
verified = 'Verified'
class azure.mgmt.web.models.DomainType[source]

Bases: enum.Enum

regular = 'Regular'
soft_deleted = 'SoftDeleted'
class azure.mgmt.web.models.ResourceScopeType[source]

Bases: enum.Enum

server_farm = 'ServerFarm'
subscription = 'Subscription'
web_site = 'WebSite'
class azure.mgmt.web.models.NotificationLevel[source]

Bases: enum.Enum

critical = 'Critical'
information = 'Information'
non_urgent_suggestion = 'NonUrgentSuggestion'
warning = 'Warning'
class azure.mgmt.web.models.Channels[source]

Bases: enum.Enum

all = 'All'
api = 'Api'
email = 'Email'
notification = 'Notification'
webhook = 'Webhook'
class azure.mgmt.web.models.AppServicePlanRestrictions[source]

Bases: enum.Enum

basic = 'Basic'
free = 'Free'
none = 'None'
premium = 'Premium'
shared = 'Shared'
standard = 'Standard'
class azure.mgmt.web.models.InAvailabilityReasonType[source]

Bases: enum.Enum

already_exists = 'AlreadyExists'
invalid = 'Invalid'
class azure.mgmt.web.models.CheckNameResourceTypes[source]

Bases: enum.Enum

hosting_environment = 'HostingEnvironment'
site = 'Site'
slot = 'Slot'
class azure.mgmt.web.models.ValidateResourceTypes[source]

Bases: enum.Enum

server_farm = 'ServerFarm'
site = 'Site'
class azure.mgmt.web.models.LogLevel[source]

Bases: enum.Enum

error = 'Error'
information = 'Information'
off = 'Off'
verbose = 'Verbose'
warning = 'Warning'
class azure.mgmt.web.models.BackupItemStatus[source]

Bases: enum.Enum

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.models.DatabaseType[source]

Bases: enum.Enum

local_my_sql = 'LocalMySql'
my_sql = 'MySql'
sql_azure = 'SqlAzure'
class azure.mgmt.web.models.FrequencyUnit[source]

Bases: enum.Enum

day = 'Day'
hour = 'Hour'
class azure.mgmt.web.models.BackupRestoreOperationType[source]

Bases: enum.Enum

clone = 'Clone'
default = 'Default'
relocation = 'Relocation'
class azure.mgmt.web.models.PublishingProfileFormat[source]

Bases: enum.Enum

file_zilla3 = 'FileZilla3'
ftp = 'Ftp'
web_deploy = 'WebDeploy'
class azure.mgmt.web.models.DnsVerificationTestResult[source]

Bases: enum.Enum

failed = 'Failed'
passed = 'Passed'
skipped = 'Skipped'
class azure.mgmt.web.models.UnauthenticatedClientAction[source]

Bases: enum.Enum

allow_anonymous = 'AllowAnonymous'
redirect_to_login_page = 'RedirectToLoginPage'
class azure.mgmt.web.models.BuiltInAuthenticationProvider[source]

Bases: enum.Enum

azure_active_directory = 'AzureActiveDirectory'
facebook = 'Facebook'
google = 'Google'
microsoft_account = 'MicrosoftAccount'
twitter = 'Twitter'
class azure.mgmt.web.models.CloneAbilityResult[source]

Bases: enum.Enum

cloneable = 'Cloneable'
not_cloneable = 'NotCloneable'
partially_cloneable = 'PartiallyCloneable'
class azure.mgmt.web.models.SkuName[source]

Bases: enum.Enum

basic = 'Basic'
dynamic = 'Dynamic'
free = 'Free'
premium = 'Premium'
shared = 'Shared'
standard = 'Standard'