# azure.mgmt.web.models module

class `azure.mgmt.web.models.``ArmPlan`(name=None, publisher=None, product=None, promotion_code=None, version=None)

  Bases: `msrest.serialization.Model`

  The plan object in an ARM, represents a marketplace plan.

  Parameters:

  - name (str) – The name
  - publisher (str) – The publisher
  - product (str) – The product
  - promotion_code (str) – The promotion code
  - version (str) – Version of product

class `azure.mgmt.web.models.``CertificateOrderCertificate`(location, id=None, name=None, kind=None, type=None, tags=None, key_vault_id=None, key_vault_secret_name=None, provisioning_state=None)

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

  Class representing the Key Vault container for certificate purchased through Azure.

  Parameters:

  - id (str) – Resource Id
  - 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
  - provisioning_state (str or `KeyVaultSecretStatus`) – Status of the Key Vault secret. Possible values include: ‘Initialized’, ‘WaitingOnCertificateOrder’, ‘Succeeded’, ‘CertificateOrderFailed’, ‘OperationNotPermittedOnKeyVault’, ‘AzureServiceUnauthorizedToAccessKeyVault’, ‘KeyVaultDoesNotExist’, ‘KeyVaultSecretDoesNotExist’, ‘UnknownError’, ‘Unknown’

class `azure.mgmt.web.models.``SkuDescription`(name=None, tier=None, size=None, family=None, capacity=None)

  Bases: `msrest.serialization.Model`

  Describes 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

class `azure.mgmt.web.models.``CertificateOrder`(location, id=None, name=None, kind=None, type=None, tags=None, certificates=None, distinguished_name=None, domain_verification_token=None, validity_in_years=None, key_size=None, product_type=None, auto_renew=None, provisioning_state=None, status=None, signed_certificate=None, csr=None, intermediate=None, root=None, serial_number=None, last_certificate_issuance_time=None, expiration_time=None)

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

  Certificate purchase order.

  Parameters:

  - id (str) – Resource Id
  - 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
  - domain_verification_token (str) – Domain Verification Token
  - validity_in_years (int) – Duration in years (must be between 1 and 3)
  - key_size (int) – Certificate Key Size
  - product_type (str or `CertificateProductType`) – Certificate product type. Possible values include: ‘StandardDomainValidatedSsl’, ‘StandardDomainValidatedWildCardSsl’
  - auto_renew (bool) – Auto renew
  - 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
  - csr (str) – Last CSR that was created for this order
  - 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

class `azure.mgmt.web.models.``CertificateDetails`(location, id=None, name=None, kind=None, type=None, tags=None, version=None, serial_number=None, thumbprint=None, subject=None, not_before=None, not_after=None, signature_algorithm=None, issuer=None, raw_data=None)

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

  Certificate Details.

  Parameters:

  - id (str) – Resource Id
  - name (str) – Resource Name
  - kind (str) – Kind of resource
  - location (str) – Resource Location
  - type (str) – Resource type
  - tags (dict) – Resource tags
  - 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.``ReissueCertificateOrderRequest`(location, id=None, name=None, kind=None, type=None, tags=None, key_size=None, delay_existing_revoke_in_hours=None)

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

  Class representing certificate reissue request.

  Parameters:

  - id (str) – Resource Id
  - 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

class `azure.mgmt.web.models.``RenewCertificateOrderRequest`(location, id=None, name=None, kind=None, type=None, tags=None, key_size=None)

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

  Class representing certificate renew request.

  Parameters:

  - id (str) – Resource Id
  - 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

class `azure.mgmt.web.models.``CertificateOrderAction`(location, id=None, name=None, kind=None, type=None, tags=None, certificate_order_action_type=None, created_at=None)

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

  Represents a certificate action.

  Parameters:

  - id (str) – Resource Id
  - 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`) – Type. Possible values include: ‘CertificateIssued’, ‘CertificateOrderCanceled’, ‘CertificateOrderCreated’, ‘CertificateRevoked’, ‘DomainValidationComplete’, ‘FraudDetected’, ‘OrgNameChange’, ‘OrgValidationComplete’, ‘SanDrop’
  - created_at (datetime) – Time at which the certificate action was performed

class `azure.mgmt.web.models.``CertificateEmail`(location, id=None, name=None, kind=None, type=None, tags=None, email_id=None, time_stamp=None)

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

  Certificate Email.

  Parameters:

  - id (str) – Resource Id
  - 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.``Certificate`(location, id=None, name=None, kind=None, type=None, tags=None, friendly_name=None, subject_name=None, host_names=None, pfx_blob=None, site_name=None, self_link=None, issuer=None, issue_date=None, expiration_date=None, password=None, thumbprint=None, valid=None, cer_blob=None, public_key_hash=None, hosting_environment_profile=None)

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

  App certificate.

  Parameters:

  - id (str) – Resource Id
  - name (str) – Resource Name
  - kind (str) – Kind of resource
  - location (str) – Resource Location
  - type (str) – Resource type
  - tags (dict) – Resource tags
  - friendly_name (str) – Friendly name of the certificate
  - subject_name (str) – Subject name of the certificate
  - host_names (list of str) – Host names the certificate applies to
  - pfx_blob (str) – Pfx blob
  - 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
  - password (str) – Certificate password
  - thumbprint (str) – Certificate thumbprint
  - valid (bool) – Is the certificate valid?
  - cer_blob (str) – Raw bytes of .cer file
  - public_key_hash (str) – Public key hash
  - hosting_environment_profile (`HostingEnvironmentProfile`) – Specification for the hosting environment (App Service Environment) to use for the certificate

class `azure.mgmt.web.models.``HostingEnvironmentProfile`(id=None, name=None, type=None)

  Bases: `msrest.serialization.Model`

  Specification for a hostingEnvironment (App Service Environment) to use for this resource.

  Parameters:

  - id (str) – Resource id of the hostingEnvironment (App Service Environment)
  - name (str) – Name of the hostingEnvironment (App Service Environment) (read only)
  - type (str) – Resource type of the hostingEnvironment (App Service Environment) (read only)

class `azure.mgmt.web.models.``Csr`(location, id=None, 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)

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

  Certificate signing request object.

  Parameters:

  - id (str) – Resource Id
  - 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 certificates public key
  - hosting_environment (str) – Hosting environment

class `azure.mgmt.web.models.``ClassicMobileService`(location, id=None, name=None, kind=None, type=None, tags=None, classic_mobile_service_name=None)

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

  A mobile service.

  Parameters:

  - id (str) – Resource Id
  - name (str) – Resource Name
  - kind (str) – Kind of resource
  - location (str) – Resource Location
  - type (str) – Resource type
  - tags (dict) – Resource tags
  - classic_mobile_service_name (str) – Name of the mobile service

class `azure.mgmt.web.models.``Domain`(location, id=None, name=None, kind=None, type=None, tags=None, contact_admin=None, contact_billing=None, contact_registrant=None, contact_tech=None, registration_status=None, provisioning_state=None, name_servers=None, privacy=None, created_time=None, expiration_time=None, last_renewed_time=None, auto_renew=None, ready_for_dns_record_management=None, managed_host_names=None, consent=None, domain_not_renewable_reasons=None)

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

  Represents a domain.

  Parameters:

  - id (str) – Resource Id
  - name (str) – Resource Name
  - kind (str) – Kind of resource
  - location (str) – Resource Location
  - type (str) – Resource type
  - tags (dict) – Resource tags
  - contact_admin (`Contact`) – Admin contact information
  - contact_billing (`Contact`) – Billing contact information
  - contact_registrant (`Contact`) – Registrant contact information
  - contact_tech (`Contact`) – Technical contact information
  - 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’
  - name_servers (list of str) – Name servers
  - privacy (bool) – If true then domain privacy is enabled for this domain
  - created_time (datetime) – Domain creation timestamp
  - expiration_time (datetime) – Domain expiration timestamp
  - last_renewed_time (datetime) – Timestamp when the domain was renewed last time
  - auto_renew (bool) – If true then domain will renewed automatically
  - ready_for_dns_record_management (bool) – If true then Azure can assign this domain to Web Apps. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to
  - 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.``Contact`(address_mailing=None, email=None, fax=None, job_title=None, name_first=None, name_last=None, name_middle=None, organization=None, phone=None)

  Bases: `msrest.serialization.Model`

  Contact information for domain registration. If ‘Domain Privacy’ option is not selected then the contact information will be be 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.``Address`(address1=None, address2=None, city=None, country=None, postal_code=None, state=None)

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

  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 sites the hostname is assigned to. This list will have more than one site 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 website 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)

  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 TopLevelDomain resource
  - agreed_by (str) – Client IP address
  - agreed_at (datetime) – Timestamp when the agreements were accepted

class `azure.mgmt.web.models.``User`(location, id=None, name=None, kind=None, type=None, tags=None, user_name=None, publishing_user_name=None, publishing_password=None, scm_uri=None)

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

  Represents user crendentials used for publishing activity.

  Parameters:

  - id (str) – Resource Id
  - 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 (internal)
  - publishing_user_name (str) – Username used for publishing
  - publishing_password (str) – Password used for publishing
  - scm_uri (str) – Service Control Manager URI, including username and password

class `azure.mgmt.web.models.``GeoRegion`(location, id=None, name=None, kind=None, type=None, tags=None, geo_region_name=None, description=None, display_name=None)

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

  Geographical region.

  Parameters:

  - id (str) – Resource Id
  - name (str) – Resource Name
  - kind (str) – Kind of resource
  - location (str) – Resource Location
  - type (str) – Resource type
  - tags (dict) – Resource tags
  - geo_region_name (str) – Region name
  - description (str) – Region description
  - display_name (str) – Display name for region

class `azure.mgmt.web.models.``ServerFarmWithRichSku`(location, id=None, name=None, kind=None, type=None, tags=None, server_farm_with_rich_sku_name=None, worker_tier_name=None, admin_site_name=None, hosting_environment_profile=None, maximum_number_of_workers=None, per_site_scaling=None, sku=None)

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

  App Service Plan Model.

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

  Parameters:

  - id (str) – Resource Id
  - name (str) – Resource Name
  - kind (str) – Kind of resource
  - location (str) – Resource Location
  - type (str) – Resource type
  - tags (dict) – Resource tags
  - server_farm_with_rich_sku_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 hosting environment (App Service Environment) to use for the App Service Plan
  - maximum_number_of_workers (int) – Maximum number of instances that can be assigned to this App Service Plan
  - per_site_scaling (bool) – If True apps assigned to this App Service Plan can be scaled independently If False apps assigned to this App Service Plan will scale to all instances of the plan
  - sku (`SkuDescription`) –

  Variables:

  - status (str or `StatusOptions`) – App Service Plan Status. Possible values include: ‘Ready’, ‘Pending’
  - subscription (str) – App Service Plan Subscription
  - geo_region (str) – Geographical location for the App Service Plan
  - number_of_sites (int) – Number of web apps assigned to this App Service Plan
  - resource_group (str) – Resource group of the serverfarm

class `azure.mgmt.web.models.``SiteCollection`(value=None, next_link=None)

  Bases: `msrest.serialization.Model`

  Collection of sites.

  Parameters:

  - value (list of `Site`) – Collection of resources
  - next_link (str) – Link to next page of resources

class `azure.mgmt.web.models.``Site`(location, id=None, name=None, kind=None, type=None, tags=None, site_name=None, enabled=None, host_name_ssl_states=None, server_farm_id=None, site_config=None, scm_site_also_stopped=None, hosting_environment_profile=None, micro_service=None, gateway_site_name=None, client_affinity_enabled=None, client_cert_enabled=None, host_names_disabled=None, container_size=None, max_number_of_workers=None, cloning_info=None)

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

  Represents a web app.

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

  Parameters:

  - id (str) – Resource Id
  - name (str) – Resource Name
  - kind (str) – Kind of resource
  - location (str) – Resource Location
  - type (str) – Resource type
  - tags (dict) – Resource tags
  - site_name (str) – Name of web app
  - enabled (bool) – True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line).
  - host_name_ssl_states (list of `HostNameSslState`) – Hostname SSL states are used to manage the SSL bindings for site’s hostnames.
  - server_farm_id (str) –
  - site_config (`SiteConfig`) – Configuration of web app
  - scm_site_also_stopped (bool) – If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false.
  - hosting_environment_profile (`HostingEnvironmentProfile`) – Specification for the hosting environment (App Service Environment) to use for the web app
  - micro_service (str) –
  - gateway_site_name (str) – Name of gateway app associated with web app
  - client_affinity_enabled (bool) – Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app
  - client_cert_enabled (bool) – Specifies if the client certificate is enabled for the web app
  - host_names_disabled (bool) – Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process
  - container_size (int) – Size of a function container
  - max_number_of_workers (int) – Maximum number of workers This only applies to function container
  - cloning_info (`CloningInfo`) – This is only valid for web app creation. If specified, web app is cloned from a source web app

  Variables:

  - state (str) – State of the web app
  - host_names (list of str) – Hostnames associated with web app
  - repository_site_name (str) – Name of repository site
  - usage_state (str or `UsageState`) – State indicating whether web app has exceeded its quota usage. Possible values include: ‘Normal’, ‘Exceeded’
  - enabled_host_names (list of str) – Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames
  - availability_state (str or `SiteAvailabilityState`) – Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. Possible values include: ‘Normal’, ‘Limited’, ‘DisasterRecoveryMode’
  - last_modified_time_utc (datetime) – Last time web app was modified in UTC
  - traffic_manager_host_names (list of str) – Read-only list of Azure Traffic manager hostnames associated with web app
  - premium_app_deployed (bool) – If set indicates whether web app is deployed as a premium app
  - target_swap_slot (str) – Read-only property that specifies which slot this app will swap into
  - outbound_ip_addresses (str) – List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app.
  - resource_group (str) – Resource group web app belongs to
  - is_default_container (bool) – Site is a default container
  - default_host_name (str) – Default hostname of the web app

class `azure.mgmt.web.models.``HostNameSslState`(ssl_state, name=None, virtual_ip=None, thumbprint=None, to_update=None)

  Bases: `msrest.serialization.Model`

  Object that represents a SSL-enabled host name.

  Parameters:

  - name (str) – Host name
  - ssl_state (str or `SslState`) – SSL type. Possible values include: ‘Disabled’, ‘SniEnabled’, ‘IpBasedEnabled’
  - virtual_ip (str) – Virtual IP address assigned to the host name if IP based SSL is enabled
  - thumbprint (str) – SSL cert thumbprint
  - to_update (bool) – Set this flag to update existing host name

class `azure.mgmt.web.models.``SiteConfig`(location, id=None, name=None, kind=None, type=None, tags=None, number_of_workers=None, default_documents=None, net_framework_version=None, php_version=None, python_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, publishing_password=None, app_settings=None, metadata=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, 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, api_definition=None, auto_swap_slot_name=None, local_my_sql_enabled=None, ip_security_restrictions=None)

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

  Configuration of Azure web site.

  Parameters:

  - id (str) – Resource Id
  - 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
  - php_version (str) – Version of PHP
  - python_version (str) – Version of Python
  - request_tracing_enabled (bool) – Enable request tracing
  - request_tracing_expiration_time (datetime) – Request tracing expiration time
  - remote_debugging_enabled (bool) – Remote Debugging Enabled
  - remote_debugging_version (str) – Remote Debugging Version
  - http_logging_enabled (bool) – HTTP logging Enabled
  - logs_directory_size_limit (int) – HTTP Logs Directory size limit
  - detailed_error_logging_enabled (bool) – Detailed error logging enabled
  - publishing_username (str) – Publishing user name
  - publishing_password (str) – Publishing password
  - app_settings (list of `NameValuePair`) – Application Settings
  - metadata (list of `NameValuePair`) – Site Metadata
  - connection_strings (list of `ConnStringInfo`) – Connection strings
  - handler_mappings (list of `HandlerMapping`) – Handler mappings
  - document_root (str) – Document root
  - scm_type (str) – SCM type
  - use32_bit_worker_process (bool) – Use 32 bit worker process
  - web_sockets_enabled (bool) – Web socket enabled.
  - always_on (bool) – Always On
  - java_version (str) – Java version
  - java_container (str) – Java container
  - java_container_version (str) – Java container version
  - 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) – Auto heal enabled
  - auto_heal_rules (`AutoHealRules`) – Auto heal rules
  - tracing_options (str) – Tracing options
  - vnet_name (str) – Vnet name
  - cors (`CorsSettings`) – Cross-Origin Resource Sharing (CORS) settings.
  - api_definition (`ApiDefinitionInfo`) – Information about the formal API definition for the web app.
  - auto_swap_slot_name (str) – Auto swap slot name
  - local_my_sql_enabled (bool) – Local mysql enabled
  - ip_security_restrictions (list of `IpSecurityRestriction`) – Ip Security restrictions

class `azure.mgmt.web.models.``NameValuePair`(name=None, value=None)

  Bases: `msrest.serialization.Model`

  Name value pair.

  Parameters:

  - name (str) – Pair name
  - value (str) – Pair value

class `azure.mgmt.web.models.``ConnStringInfo`(type, name=None, connection_string=None)

  Bases: `msrest.serialization.Model`

  Represents database connection string information.

  Parameters:

  - name (str) – Name of connection string
  - connection_string (str) – Connection string value
  - type (str or `DatabaseServerType`) – Type of database. Possible values include: ‘MySql’, ‘SQLServer’, ‘SQLAzure’, ‘Custom’

class `azure.mgmt.web.models.``HandlerMapping`(extension=None, script_processor=None, arguments=None)

  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.``VirtualApplication`(virtual_path=None, physical_path=None, preload_enabled=None, virtual_directories=None)

  Bases: `msrest.serialization.Model`

  VirtualApplication.

  Parameters:

  - virtual_path (str) –
  - physical_path (str) –
  - preload_enabled (bool) –
  - virtual_directories (list of `VirtualDirectory`) –

class `azure.mgmt.web.models.``VirtualDirectory`(virtual_path=None, physical_path=None)

  Bases: `msrest.serialization.Model`

  VirtualDirectory.

  Parameters:

  - virtual_path (str) –
  - physical_path (str) –

class `azure.mgmt.web.models.``Experiments`(ramp_up_rules=None)

  Bases: `msrest.serialization.Model`

  Class containing Routing in production experiments.

  Parameters: | ramp_up_rules (list of `RampUpRule`) – List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects.

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)

  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. mysite-stage.azurewebsites.net
  - reroute_percentage (float) – Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName}
  - change_step (float) – [Optional] In auto ramp up scenario this is the step to to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specificed in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl}
  - change_interval_in_minutes (int) – [Optional] Specifies interval in mimuntes to reevaluate ReroutePercentage
  - min_reroute_percentage (float) – [Optional] Specifies lower boundary above which ReroutePercentage will stay.
  - max_reroute_percentage (float) – [Optional] 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.``SiteLimits`(max_percentage_cpu=None, max_memory_in_mb=None, max_disk_size_in_mb=None)

  Bases: `msrest.serialization.Model`

  Represents metric limits set on a web 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.``AutoHealRules`(triggers=None, actions=None)

  Bases: `msrest.serialization.Model`

  AutoHealRules - describes the rules which can be defined for auto-heal.

  Parameters:

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

class `azure.mgmt.web.models.``AutoHealTriggers`(requests=None, private_bytes_in_kb=None, status_codes=None, slow_requests=None)

  Bases: `msrest.serialization.Model`

  AutoHealTriggers - describes the triggers for auto-heal.

  Parameters:

  - requests (`RequestsBasedTrigger`) – Requests - Defines a rule based on total requests
  - private_bytes_in_kb (int) – PrivateBytesInKB - Defines a rule based on private bytes
  - status_codes (list of `StatusCodesBasedTrigger`) – StatusCodes - Defines a rule based on status codes
  - slow_requests (`SlowRequestsBasedTrigger`) – SlowRequests - Defines a rule based on request execution time

class `azure.mgmt.web.models.``RequestsBasedTrigger`(count=None, time_interval=None)

  Bases: `msrest.serialization.Model`

  RequestsBasedTrigger.

  Parameters:

  - count (int) – Count
  - time_interval (str) – TimeInterval

class `azure.mgmt.web.models.``StatusCodesBasedTrigger`(status=None, sub_status=None, win32_status=None, count=None, time_interval=None)

  Bases: `msrest.serialization.Model`

  StatusCodeBasedTrigger.

  Parameters:

  - status (int) – HTTP status code
  - sub_status (int) – SubStatus
  - win32_status (int) – Win32 error code
  - count (int) – Count
  - time_interval (str) – TimeInterval

class `azure.mgmt.web.models.``SlowRequestsBasedTrigger`(time_taken=None, count=None, time_interval=None)

  Bases: `msrest.serialization.Model`

  SlowRequestsBasedTrigger.

  Parameters:

  - time_taken (str) – TimeTaken
  - count (int) – Count
  - time_interval (str) – TimeInterval

class `azure.mgmt.web.models.``AutoHealActions`(action_type, custom_action=None, min_process_execution_time=None)

  Bases: `msrest.serialization.Model`

  AutoHealActions - Describes the actions which can be taken by the auto-heal module when a rule is triggered.

  Parameters:

  - action_type (str or `AutoHealActionType`) – ActionType - predefined action to be taken. Possible values include: ‘Recycle’, ‘LogEvent’, ‘CustomAction’
  - custom_action (`AutoHealCustomAction`) – CustomAction - custom action to be taken
  - min_process_execution_time (str) – MinProcessExecutionTime - minimum time the process must execute before taking the action

class `azure.mgmt.web.models.``AutoHealCustomAction`(exe=None, parameters=None)

  Bases: `msrest.serialization.Model`

  AutoHealCustomAction - Describes the 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.``CorsSettings`(allowed_origins=None)

  Bases: `msrest.serialization.Model`

  Cross-Origin Resource Sharing (CORS) settings for the web 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.``ApiDefinitionInfo`(url=None)

  Bases: `msrest.serialization.Model`

  Information about the formal API definition for the web app.

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

class `azure.mgmt.web.models.``IpSecurityRestriction`(ip_address=None, subnet_mask=None)

  Bases: `msrest.serialization.Model`

  Represents an ip security restriction on a web 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.``CloningInfo`(correlation_id=None, overwrite=None, clone_custom_host_names=None, clone_source_control=None, source_web_app_id=None, hosting_environment=None, app_settings_overrides=None, configure_load_balancing=None, traffic_manager_profile_id=None, traffic_manager_profile_name=None)

  Bases: `msrest.serialization.Model`

  Represents 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) – Overwrite destination web app
  - clone_custom_host_names (bool) – If true, clone custom hostnames from source web app
  - clone_source_control (bool) – Clone source control from source web app
  - source_web_app_id (str) – ARM resource id of the source web app. Web 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) – Hosting environment
  - app_settings_overrides (dict) – Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained.
  - configure_load_balancing (bool) – If specified configure load balancing for source and clone site
  - 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.``SiteProperties`(metadata=None, properties=None, app_settings=None)

  Bases: `msrest.serialization.Model`

  SiteProperties.

  Parameters:

  - metadata (list of `NameValuePair`) –
  - properties (list of `NameValuePair`) –
  - app_settings (list of `NameValuePair`) –

class `azure.mgmt.web.models.``RoutingRule`(name=None)

  Bases: `msrest.serialization.Model`

  Routing rules for TiP.

  Parameters: | 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.``SiteAuthSettings`(enabled=None, http_api_prefix_path=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, aad_client_id=None, open_id_issuer=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)

  Bases: `msrest.serialization.Model`

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

  Parameters:

  - enabled (bool) – Gets or sets a value indicating whether the Authentication / Authorization feature is enabled for the current app.
  - http_api_prefix_path (str) – Gets or sets the relative path prefix used by platform HTTP APIs. Changing this value is not recommended except for compatibility reasons.
  - unauthenticated_client_action (str or `UnauthenticatedClientAction`) – Gets or sets the action to take when an unauthenticated client attempts to access the app. Possible values include: ‘RedirectToLoginPage’, ‘AllowAnonymous’
  - token_store_enabled (bool) – Gets or sets a value indicating whether to durably store platform-specific security tokens obtained during login flows. This capability is disabled by default.
  - allowed_external_redirect_urls (list of str) – Gets or sets a collection of external URLs that can be redirected to as part of logging in or logging out of the web 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`) – Gets or sets 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) – Gets or sets 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) – Gets or sets 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) – Gets or sets 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) – Gets or sets 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) – Gets or sets a list of allowed audience values to consider when validating JWTs issued by Azure Active Directory. Note that the {Microsoft.Web.Hosting.Administration.SiteAuthSettings.ClientId} value is always considered an allowed audience, regardless of this setting.
  - additional_login_params (list of str) – Gets or sets a list of login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form “key=value”.
  - aad_client_id (str) –
  - open_id_issuer (str) –
  - google_client_id (str) – Gets or sets 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) – Gets or sets 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) – Gets or sets 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) – Gets or sets 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) – Gets or sets 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) – Gets or sets 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) – Gets or sets 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) – Gets or sets 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) – Gets or sets 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) – Gets or sets 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) – Gets or sets 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.``HostingEnvironment`(location, id=None, name=None, kind=None, type=None, tags=None, hosting_environment_name=None, hosting_environment_location=None, provisioning_state=None, status=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, database_edition=None, database_service_objective=None, upgrade_domains=None, subscription_id=None, dns_suffix=None, last_action=None, last_action_result=None, allowed_multi_sizes=None, allowed_worker_sizes=None, maximum_number_of_machines=None, vip_mappings=None, environment_capacities=None, network_access_control_list=None, environment_is_healthy=None, environment_status=None, resource_group=None, api_management_account_id=None, suspended=None, cluster_settings=None)

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

  Description of an hostingEnvironment (App Service Environment).

  Parameters:

  - id (str) – Resource Id
  - name (str) – Resource Name
  - kind (str) – Kind of resource
  - location (str) – Resource Location
  - type (str) – Resource type
  - tags (dict) – Resource tags
  - hosting_environment_name (str) – Name of the hostingEnvironment (App Service Environment)
  - hosting_environment_location (str) – Location of the hostingEnvironment (App Service Environment), e.g. “West US”
  - provisioning_state (str or `ProvisioningState`) – Provisioning state of the hostingEnvironment (App Service Environment). Possible values include: ‘Succeeded’, ‘Failed’, ‘Canceled’, ‘InProgress’, ‘Deleting’
  - status (str or `HostingEnvironmentStatus`) – Current status of the hostingEnvironment (App Service Environment). Possible values include: ‘Preparing’, ‘Ready’, ‘Scaling’, ‘Deleting’
  - vnet_name (str) – Name of the hostingEnvironment’s (App Service Environment) virtual network
  - vnet_resource_group_name (str) – Resource group of the hostingEnvironment’s (App Service Environment) virtual network
  - vnet_subnet_name (str) – Subnet of the hostingEnvironment’s (App Service Environment) virtual network
  - virtual_network (`VirtualNetworkProfile`) – Description of the hostingEnvironment’s (App Service Environment) virtual network
  - internal_load_balancing_mode (str or `InternalLoadBalancingMode`) – Specifies which endpoints to serve internally in the hostingEnvironment’s (App Service Environment) VNET. 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 this hostingEnvironment (App Service Environment)
  - database_edition (str) – Edition of the metadata database for the hostingEnvironment (App Service Environment) e.g. “Standard”
  - database_service_objective (str) – Service objective of the metadata database for the hostingEnvironment (App Service Environment) e.g. “S0”
  - upgrade_domains (int) – Number of upgrade domains of this hostingEnvironment (App Service Environment)
  - subscription_id (str) – Subscription of the hostingEnvironment (App Service Environment)
  - dns_suffix (str) – DNS suffix of the hostingEnvironment (App Service Environment)
  - last_action (str) – Last deployment action on this hostingEnvironment (App Service Environment)
  - last_action_result (str) – Result of the last deployment action on this hostingEnvironment (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 this hostingEnvironment (App Service Environment)
  - vip_mappings (list of `VirtualIPMapping`) – Description of IP SSL mapping for this hostingEnvironment (App Service Environment)
  - environment_capacities (list of `StampCapacity`) – Current total, used, and available worker capacities
  - network_access_control_list (list of `NetworkAccessControlEntry`) – Access control list for controlling traffic to the hostingEnvironment (App Service Environment)
  - environment_is_healthy (bool) – True/false indicating whether the hostingEnvironment (App Service Environment) is healthy
  - environment_status (str) – Detailed message about with results of the last check of the hostingEnvironment (App Service Environment)
  - resource_group (str) – Resource group of the hostingEnvironment (App Service Environment)
  - api_management_account_id (str) – Api Management Account associated with this Hosting Environment
  - suspended (bool) – True/false indicating whether the hostingEnvironment 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 hosting environment

class `azure.mgmt.web.models.``VirtualNetworkProfile`(id=None, name=None, type=None, subnet=None)

  Bases: `msrest.serialization.Model`

  Specification for using a virtual network.

  Parameters:

  - id (str) – Resource id of the virtual network
  - name (str) – Name of the virtual network (read-only)
  - type (str) – Resource type of the virtual network (read-only)
  - subnet (str) – Subnet within the virtual network

class `azure.mgmt.web.models.``WorkerPool`(location, id=None, name=None, kind=None, type=None, tags=None, worker_size_id=None, compute_mode=None, worker_size=None, worker_count=None, instance_names=None, sku=None)

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

  Worker pool of a hostingEnvironment (App Service Environment).

  Parameters:

  - id (str) – Resource Id
  - 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 web 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
  - instance_names (list of str) – Names of all instances in the worker pool (read only)
  - sku (`SkuDescription`) –

class `azure.mgmt.web.models.``VirtualIPMapping`(virtual_ip=None, internal_http_port=None, internal_https_port=None, in_use=None)

  Bases: `msrest.serialization.Model`

  Class that represents a VIP 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 VIP mapping in use

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)

  Bases: `msrest.serialization.Model`

  Class containing 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 true it includes basic sites Basic sites are not used for capacity allocation.
  - is_applicable_for_all_compute_modes (bool) – Is capacity applicable for all sites?
  - site_mode (str) – Shared or Dedicated

class `azure.mgmt.web.models.``NetworkAccessControlEntry`(action=None, description=None, order=None, remote_subnet=None)

  Bases: `msrest.serialization.Model`

  NetworkAccessControlEntry.

  Parameters:

  - action (str or `AccessControlEntryAction`) – Possible values include: ‘Permit’, ‘Deny’
  - description (str) –
  - order (int) –
  - remote_subnet (str) –

class `azure.mgmt.web.models.``ManagedHostingEnvironment`(location, id=None, name=None, kind=None, type=None, tags=None, managed_hosting_environment_name=None, managed_hosting_environment_location=None, status=None, virtual_network=None, ipssl_address_count=None, dns_suffix=None, subscription_id=None, resource_group=None, environment_is_healthy=None, environment_status=None, suspended=None, api_management_account=None)

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

  Description of a managed hosting environment.

  Parameters:

  - id (str) – Resource Id
  - name (str) – Resource Name
  - kind (str) – Kind of resource
  - location (str) – Resource Location
  - type (str) – Resource type
  - tags (dict) – Resource tags
  - managed_hosting_environment_name (str) – Name of the managed hosting environment
  - managed_hosting_environment_location (str) – Location of the managed hosting environment e.g. “West US”
  - status (str or `ManagedHostingEnvironmentStatus`) – Current status of the managed hosting environment. Possible values include: ‘Preparing’, ‘Ready’, ‘Deleting’
  - virtual_network (`VirtualNetworkProfile`) – Description of the managed hosting environment’s virtual network
  - ipssl_address_count (int) – Number of ip ssl addresses reserved for the managed hosting environment
  - dns_suffix (str) – DNS suffix of the managed hosting environment
  - subscription_id (str) – Subscription of the managed hosting environment (read only)
  - resource_group (str) – Resource group of the managed hosting environment (read only)
  - environment_is_healthy (bool) – True/false indicating whether the managed hosting environment is healthy
  - environment_status (str) – Detailed message about with results of the last check of the managed hosting environment
  - suspended (bool) – True/false indicating whether the managed hosting 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)
  - api_management_account (str) – Resource id of the api management account associated with this managed hosting environment (read only)

class `azure.mgmt.web.models.``ResourceNameAvailabilityRequest`(name=None, type=None, is_fqdn=None)

  Bases: `msrest.serialization.Model`

  Resource name availability request content.

  Parameters:

  - name (str) – Resource name to verify
  - type (str) – Resource type used for verification
  - is_fqdn (bool) – Is fully qualified domain name

class `azure.mgmt.web.models.``ResourceNameAvailability`(name_available=None, reason=None, message=None)

  Bases: `msrest.serialization.Model`

  Describes if a resource name is available.

  Parameters:

  - name_available (bool) – True indicates name is valid and available. False indicates the name is invalid, unavailable, or both.
  - reason (str) – Required if nameAvailable is false. ‘Invalid’ indicates the name provided does not match Azure WebApp service’s naming requirements. ‘AlreadyExists’ indicates that the name is already in use and is therefore unavailable.
  - message (str) –

class `azure.mgmt.web.models.``DomainControlCenterSsoRequest`(url=None, post_parameter_key=None, post_parameter_value=None)

  Bases: `msrest.serialization.Model`

  Single sign on request information for domain management.

  Parameters:

  - 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.``DomainRegistrationInput`(location, id=None, name=None, kind=None, type=None, tags=None, domain_registration_input_name=None, contact_admin=None, contact_billing=None, contact_registrant=None, contact_tech=None, registration_status=None, provisioning_state=None, name_servers=None, privacy=None, created_time=None, expiration_time=None, last_renewed_time=None, auto_renew=None, ready_for_dns_record_management=None, managed_host_names=None, consent=None, domain_not_renewable_reasons=None)

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

  Domain registration input for validation Api.

  Parameters:

  - id (str) – Resource Id
  - name (str) – Resource Name
  - kind (str) – Kind of resource
  - location (str) – Resource Location
  - type (str) – Resource type
  - tags (dict) – Resource tags
  - domain_registration_input_name (str) – Name of the domain
  - contact_admin (`Contact`) – Admin contact information
  - contact_billing (`Contact`) – Billing contact information
  - contact_registrant (`Contact`) – Registrant contact information
  - contact_tech (`Contact`) – Technical contact information
  - 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’
  - name_servers (list of str) – Name servers
  - privacy (bool) – If true then domain privacy is enabled for this domain
  - created_time (datetime) – Domain creation timestamp
  - expiration_time (datetime) – Domain expiration timestamp
  - last_renewed_time (datetime) – Timestamp when the domain was renewed last time
  - auto_renew (bool) – If true then domain will renewed automatically
  - ready_for_dns_record_management (bool) – If true then Azure can assign this domain to Web Apps. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to
  - 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.``NameIdentifier`(name=None)

  Bases: `msrest.serialization.Model`

  Identifies an object.

  Parameters: | name (str) – Name of the object

class `azure.mgmt.web.models.``DomainAvailablilityCheckResult`(name=None, available=None, domain_type=None)

  Bases: `msrest.serialization.Model`

  Domain availablility check result.

  Parameters:

  - name (str) – Name of the domain
  - available (bool) – If true then domain can be purchased using CreateDomain Api
  - domain_type (str or `DomainType`) – Domain type. Possible values include: ‘Regular’, ‘SoftDeleted’

class `azure.mgmt.web.models.``DomainRecommendationSearchParameters`(keywords=None, max_domain_recommendations=None)

  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.``CsmMoveResourceEnvelope`(target_resource_group=None, resources=None)

  Bases: `msrest.serialization.Model`

  Class containing 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.``HostingEnvironmentDiagnostics`(name=None, diagnosics_output=None)

  Bases: `msrest.serialization.Model`

  Diagnostics for a hosting environment (App Service Environment).

  Parameters:

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

class `azure.mgmt.web.models.``AddressResponse`(service_ip_address=None, internal_ip_address=None, outbound_ip_addresses=None, vip_mappings=None)

  Bases: `msrest.serialization.Model`

  Describes main public ip address and any extra vips.

  Parameters:

  - service_ip_address (str) – Main public vip
  - internal_ip_address (str) – VNET internal ip address of the hostingEnvironment (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 vips

class `azure.mgmt.web.models.``ResourceMetric`(name=None, unit=None, time_grain=None, start_time=None, end_time=None, resource_id=None, metric_values=None, properties=None)

  Bases: `msrest.serialization.Model`

  Object representing a metric for any resource.

  Parameters:

  - name (`ResourceMetricName`) – Name of metric
  - unit (str) – Metric unit
  - time_grain (str) – Metric granularity. E.g PT1H, PT5M, P1D
  - start_time (datetime) – Metric start time
  - end_time (datetime) – Metric end time
  - resource_id (str) – Metric resource Id
  - metric_values (list of `ResourceMetricValue`) – Metric values
  - properties (list of `KeyValuePairStringString`) – Properties

class `azure.mgmt.web.models.``ResourceMetricName`(value=None, localized_value=None)

  Bases: `msrest.serialization.Model`

  Name of a metric for any resource.

  Parameters:

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

class `azure.mgmt.web.models.``ResourceMetricValue`(time_stamp=None, average=None, minimum=None, maximum=None, total=None, count=None)

  Bases: `msrest.serialization.Model`

  Value of resource metric.

  Parameters:

  - time_stamp (str) – Value timestamp
  - average (float) – Value average
  - minimum (float) – Value minimum
  - maximum (float) – Value maximum
  - total (float) – Value total
  - count (float) – Value count

class `azure.mgmt.web.models.``KeyValuePairStringString`

  Bases: `msrest.serialization.Model`

  KeyValuePairStringString.

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

  Variables:

  - key (str) –
  - value (str) –

class `azure.mgmt.web.models.``MetricDefinition`(location, id=None, name=None, kind=None, type=None, tags=None, metric_definition_name=None, unit=None, primary_aggregation_type=None, metric_availabilities=None, display_name=None)

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

  Class repesenting metadata for the metrics.

  Parameters:

  - id (str) – Resource Id
  - name (str) – Resource Name
  - kind (str) – Kind of resource
  - location (str) – Resource Location
  - type (str) – Resource type
  - tags (dict) – Resource tags
  - 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

class `azure.mgmt.web.models.``MetricAvailabilily`(time_grain=None, retention=None)

  Bases: `msrest.serialization.Model`

  Class repesenting metrics availability and retention.

  Parameters:

  - time_grain (str) – Time grain
  - retention (str) – Retention period for the current {Microsoft.Web.Hosting.Administration.MetricAvailabilily.TimeGrain}

class `azure.mgmt.web.models.``CsmUsageQuota`(unit=None, next_reset_time=None, current_value=None, limit=None, name=None)

  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.``LocalizableString`(value=None, localized_value=None)

  Bases: `msrest.serialization.Model`

  LocalizableString object containing the name and a localized value.

  Parameters:

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

class `azure.mgmt.web.models.``Usage`(location, id=None, name=None, kind=None, type=None, tags=None, display_name=None, usage_name=None, resource_name=None, unit=None, current_value=None, limit=None, next_reset_time=None, compute_mode=None, site_mode=None)

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

  Class that represents usage of the quota resource.

  Parameters:

  - id (str) – Resource Id
  - name (str) – Resource Name
  - kind (str) – Kind of resource
  - location (str) – Resource Location
  - type (str) – Resource type
  - tags (dict) – Resource tags
  - 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`) – ComputeMode used for this usage. Possible values include: ‘Shared’, ‘Dedicated’, ‘Dynamic’
  - site_mode (str) – SiteMode used for this usage

class `azure.mgmt.web.models.``SkuInfo`(resource_type=None, sku=None, capacity=None)

  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.``SkuCapacity`(minimum=None, maximum=None, default=None, scale_type=None)

  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.``SourceControl`(location, id=None, name=None, kind=None, type=None, tags=None, source_control_name=None, token=None, token_secret=None, refresh_token=None, expiration_time=None)

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

  Describes the Source Control OAuth Token.

  Parameters:

  - id (str) – Resource Id
  - 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.``Recommendation`(level, channels, creation_time=None, recommendation_id=None, resource_id=None, resource_scope=None, rule_name=None, display_name=None, message=None, tags=None, action_name=None, enabled=None, start_time=None, end_time=None, next_notification_time=None, notification_expiration_time=None, notified_time=None, score=None)

  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) – Name of a resource type this recommendation applies, e.g. Subscription, ServerFarm, Site.
  - rule_name (str) – Unique name of the rule
  - display_name (str) – UI friendly name of the rule (may not be unique)
  - message (str) – Localized text of recommendation, good for UI.
  - 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’, ‘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.
  - enabled (int) – On/off flag indicating the rule is currently enabled or disabled.
  - start_time (datetime) – The beginning time of a range that the recommendation refers to.
  - end_time (datetime) – The end time of a range that the recommendation refers to.
  - next_notification_time (datetime) – When to notify this recommendation next. Null means that this will never be notified anymore.
  - notification_expiration_time (datetime) – Date and time when this notification expires.
  - notified_time (datetime) – Last timestamp 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`(level, channels, name=None, display_name=None, message=None, recommendation_id=None, description=None, action_name=None, enabled=None, tags=None)

  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
  - enabled (int) – On/off flag indicating the rule is currently enabled or disabled.
  - 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’, ‘All’
  - tags (list of str) – An array of category tags that the rule contains.

class `azure.mgmt.web.models.``VnetInfo`(location, id=None, name=None, kind=None, type=None, tags=None, vnet_resource_id=None, cert_thumbprint=None, cert_blob=None, routes=None, resync_required=None, dns_servers=None)

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

  VNETInfo contract. This contract is public and is a stripped down version of VNETInfoInternal.

  Parameters:

  - id (str) – Resource Id
  - 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 vnet resource id
  - cert_thumbprint (str) – The client certificate thumbprint
  - 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.
  - routes (list of `VnetRoute`) – The routes that this virtual network connection uses.
  - resync_required (bool) – Flag to determine if a resync is required
  - dns_servers (str) – Dns servers to be used by this VNET. This should be a comma-separated list of IP addresses.

class `azure.mgmt.web.models.``VnetRoute`(location, id=None, name=None, kind=None, type=None, tags=None, vnet_route_name=None, start_address=None, end_address=None, route_type=None)

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

  VnetRoute contract used to pass routing information for a vnet.

  Parameters:

  - id (str) – Resource Id
  - 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) – The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App’s routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes.

class `azure.mgmt.web.models.``VnetGateway`(location, id=None, name=None, kind=None, type=None, tags=None, vnet_name=None, vpn_package_uri=None)

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

  The VnetGateway contract. This is used to give the vnet gateway access to the VPN package.

  Parameters:

  - id (str) – Resource Id
  - 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 VNET name.
  - vpn_package_uri (str) – The URI where the Vpn package can be downloaded

class `azure.mgmt.web.models.``NetworkFeatures`(location, id=None, name=None, kind=None, type=None, tags=None, virtual_network_name=None, virtual_network_connection=None, hybrid_connections=None)

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

  This is an object used to store a full view of network features (presently VNET integration and Hybrid Connections) for a web app.

  Parameters:

  - id (str) – Resource Id
  - name (str) – Resource Name
  - kind (str) – Kind of resource
  - location (str) – Resource Location
  - type (str) – Resource type
  - tags (dict) – Resource tags
  - virtual_network_name (str) – The Vnet Name
  - virtual_network_connection (`VnetInfo`) – The Vnet Summary view
  - hybrid_connections (list of `RelayServiceConnectionEntity`) – The Hybrid Connections Summary view

class `azure.mgmt.web.models.``RelayServiceConnectionEntity`(location, id=None, 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)

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

  Class that represents a Biztalk Hybrid Connection.

  Parameters:

  - id (str) – Resource Id
  - 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.``CsmSlotEntity`(target_slot=None, preserve_vnet=None)

  Bases: `msrest.serialization.Model`

  Class containing deployment slot parameters.

  Parameters:

  - target_slot (str) – Set the destination deployment slot during swap operation
  - preserve_vnet (bool) – Get or set the flag indicating it should preserve VNet to the slot during swap

class `azure.mgmt.web.models.``SlotDifference`(location, id=None, name=None, kind=None, type=None, tags=None, slot_difference_type=None, setting_type=None, diff_rule=None, setting_name=None, value_in_current_slot=None, value_in_target_slot=None, description=None)

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

  An object describing the difference in setting values between two web app slots.

  Parameters:

  - id (str) – Resource Id
  - name (str) – Resource Name
  - kind (str) – Kind of resource
  - location (str) – Resource Location
  - type (str) – Resource type
  - tags (dict) – Resource tags
  - slot_difference_type (str) – Indicates the type of the difference: Information, Warning or Error.
  - setting_type (str) – The type of the settings: General, AppSetting or ConnectionString
  - diff_rule (str) – Rule that describes how to process the difference in settings during web app slot swap.
  - setting_name (str) – Name of the setting
  - value_in_current_slot (str) – Value of the setting in the current web app slot
  - value_in_target_slot (str) – Value of the setting in the target web app slot
  - description (str) – Description of the difference

class `azure.mgmt.web.models.``SlotConfigNamesResource`(location, id=None, name=None, kind=None, type=None, tags=None, connection_string_names=None, app_setting_names=None)

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

  Slot Config names azure resource.

  Parameters:

  - id (str) – Resource Id
  - 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.``SlotConfigNames`(connection_string_names=None, app_setting_names=None)

  Bases: `msrest.serialization.Model`

  Class containing names for connection strings and application settings to be marked as sticky to the slot and not moved during swap operation This is valid for all deployment slots under the site.

  Parameters:

  - 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.``SiteCloneability`(result, blocking_features=None, unsupported_features=None, blocking_characteristics=None)

  Bases: `msrest.serialization.Model`

  Represents whether or not a web app is cloneable.

  Parameters:

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

class `azure.mgmt.web.models.``SiteCloneabilityCriterion`(name=None, description=None)

  Bases: `msrest.serialization.Model`

  Represents a site cloneability criterion.

  Parameters:

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

class `azure.mgmt.web.models.``CsmSiteRecoveryEntity`(snapshot_time=None, recover_config=None, site_name=None, slot_name=None)

  Bases: `msrest.serialization.Model`

  Class containting details about site recovery operation.

  Parameters:

  - snapshot_time (datetime) – Point in time in which the site recover should be attempted.
  - recover_config (bool) – If true, then the website’s configuration will be reverted to its state at SnapshotTime
  - site_name (str) – [Optional] Destination web app name into which web app should be recovered. This is case when new web app should be created instead.
  - slot_name (str) – [Optional] Destination web app slot name into which web app should be recovered

class `azure.mgmt.web.models.``DeletedSite`(location, id=None, name=None, kind=None, type=None, tags=None, deleted_timestamp=None, deleted_site_name=None, enabled=None, host_name_ssl_states=None, server_farm_id=None, site_config=None, scm_site_also_stopped=None, hosting_environment_profile=None, micro_service=None, gateway_site_name=None, client_affinity_enabled=None, client_cert_enabled=None, host_names_disabled=None, container_size=None, max_number_of_workers=None, cloning_info=None)

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

  Reports deleted site including the timestamp of operation.

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

  Parameters:

  - id (str) – Resource Id
  - name (str) – Resource Name
  - kind (str) – Kind of resource
  - location (str) – Resource Location
  - type (str) – Resource type
  - tags (dict) – Resource tags
  - deleted_timestamp (datetime) – Time when the site was deleted
  - deleted_site_name (str) – Name of web app
  - enabled (bool) – True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line).
  - host_name_ssl_states (list of `HostNameSslState`) – Hostname SSL states are used to manage the SSL bindings for site’s hostnames.
  - server_farm_id (str) –
  - site_config (`SiteConfig`) – Configuration of web app
  - scm_site_also_stopped (bool) – If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false.
  - hosting_environment_profile (`HostingEnvironmentProfile`) – Specification for the hosting environment (App Service Environment) to use for the web app
  - micro_service (str) –
  - gateway_site_name (str) – Name of gateway app associated with web app
  - client_affinity_enabled (bool) – Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app
  - client_cert_enabled (bool) – Specifies if the client certificate is enabled for the web app
  - host_names_disabled (bool) – Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process
  - container_size (int) – Size of a function container
  - max_number_of_workers (int) – Maximum number of workers This only applies to function container
  - cloning_info (`CloningInfo`) – This is only valid for web app creation. If specified, web app is cloned from a source web app

  Variables:

  - state (str) – State of the web app
  - host_names (list of str) – Hostnames associated with web app
  - repository_site_name (str) – Name of repository site
  - usage_state (str or `UsageState`) – State indicating whether web app has exceeded its quota usage. Possible values include: ‘Normal’, ‘Exceeded’
  - enabled_host_names (list of str) – Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames
  - availability_state (str or `SiteAvailabilityState`) – Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. Possible values include: ‘Normal’, ‘Limited’, ‘DisasterRecoveryMode’
  - last_modified_time_utc (datetime) – Last time web app was modified in UTC
  - traffic_manager_host_names (list of str) – Read-only list of Azure Traffic manager hostnames associated with web app
  - premium_app_deployed (bool) – If set indicates whether web app is deployed as a premium app
  - target_swap_slot (str) – Read-only property that specifies which slot this app will swap into
  - outbound_ip_addresses (str) – List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app.
  - resource_group (str) – Resource group web app belongs to
  - is_default_container (bool) – Site is a default container
  - default_host_name (str) – Default hostname of the web app

class `azure.mgmt.web.models.``Deployment`(location, id=None, 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)

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

  Represents user crendentials used for publishing activity.

  Parameters:

  - id (str) – Resource Id
  - 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) – AuthorEmail
  - start_time (datetime) – StartTime
  - end_time (datetime) – EndTime
  - active (bool) – Active
  - details (str) – Detail

class `azure.mgmt.web.models.``SiteInstance`(location, id=None, name=None, kind=None, type=None, tags=None, site_instance_name=None)

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

  Instance of a web app.

  Parameters:

  - id (str) – Resource Id
  - name (str) – Resource Name
  - kind (str) – Kind of resource
  - location (str) – Resource Location
  - type (str) – Resource type
  - tags (dict) – Resource tags
  - site_instance_name (str) – Name of instance

class `azure.mgmt.web.models.``HostNameBinding`(location, id=None, 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)

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

  A host name binding object.

  Parameters:

  - id (str) – Resource Id
  - 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) – Web 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`) – Host name type. Possible values include: ‘Verified’, ‘Managed’

class `azure.mgmt.web.models.``SiteSourceControl`(location, id=None, name=None, kind=None, type=None, tags=None, repo_url=None, branch=None, is_manual_integration=None, deployment_rollback_enabled=None, is_mercurial=None)

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

  Describes the source control configuration for web app.

  Parameters:

  - id (str) – Resource Id
  - 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) – Whether to manual or continuous integration
  - deployment_rollback_enabled (bool) – Whether to manual or continuous integration
  - is_mercurial (bool) – Mercurial or Git repository type

class `azure.mgmt.web.models.``StringDictionary`(location, id=None, name=None, kind=None, type=None, tags=None, properties=None)

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

  String dictionary resource.

  Parameters:

  - id (str) – Resource Id
  - 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.``ConnectionStringDictionary`(location, id=None, name=None, kind=None, type=None, tags=None, properties=None)

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

  String dictionary resource.

  Parameters:

  - id (str) – Resource Id
  - 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.``ConnStringValueTypePair`(type, value=None)

  Bases: `msrest.serialization.Model`

  Database connection string value to type pair.

  Parameters:

  - value (str) – Value of pair
  - type (str or `DatabaseServerType`) – Type of database. Possible values include: ‘MySql’, ‘SQLServer’, ‘SQLAzure’, ‘Custom’

class `azure.mgmt.web.models.``SiteLogsConfig`(location, id=None, name=None, kind=None, type=None, tags=None, application_logs=None, http_logs=None, failed_requests_tracing=None, detailed_error_messages=None)

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

  Configuration of Azure web site.

  Parameters:

  - id (str) – Resource Id
  - 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.``ApplicationLogsConfig`(file_system=None, azure_table_storage=None, azure_blob_storage=None)

  Bases: `msrest.serialization.Model`

  Application logs configuration.

  Parameters:

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

class `azure.mgmt.web.models.``FileSystemApplicationLogsConfig`(level=None)

  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’

class `azure.mgmt.web.models.``AzureTableStorageApplicationLogsConfig`(level=None, sas_url=None)

  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)

  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.``HttpLogsConfig`(file_system=None, azure_blob_storage=None)

  Bases: `msrest.serialization.Model`

  Http logs configuration.

  Parameters:

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

class `azure.mgmt.web.models.``FileSystemHttpLogsConfig`(retention_in_mb=None, retention_in_days=None, enabled=None)

  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.``AzureBlobStorageHttpLogsConfig`(sas_url=None, retention_in_days=None, enabled=None)

  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.``EnabledConfig`(enabled=None)

  Bases: `msrest.serialization.Model`

  Enabled configuration.

  Parameters: | enabled (bool) – Enabled

class `azure.mgmt.web.models.``PremierAddOnRequest`(location=None, tags=None, plan=None, properties=None, sku=None)

  Bases: `msrest.serialization.Model`

  PremierAddOnRequest.

  Parameters:

  - location (str) – Geo region resource belongs to e.g. SouthCentralUS, SouthEastAsia
  - tags (dict) – Tags associated with resource
  - plan (`ArmPlan`) – Azure resource manager plan
  - properties (object) – Resource specific properties
  - sku (`SkuDescription`) – Sku description of the resource

class `azure.mgmt.web.models.``BackupRequest`(location, id=None, 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)

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

  Description of a backup which will be performed.

  Parameters:

  - id (str) – Resource Id
  - 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.``BackupSchedule`(frequency_unit, frequency_interval=None, keep_at_least_one_backup=None, retention_period_in_days=None, start_time=None, last_execution_time=None)

  Bases: `msrest.serialization.Model`

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

  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)
  - frequency_unit (str or `FrequencyUnit`) – 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’
  - 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.
  - retention_period_in_days (int) – After how many days backups should be deleted
  - start_time (datetime) – When the schedule should start working
  - last_execution_time (datetime) – The last time when this schedule was triggered

class `azure.mgmt.web.models.``DatabaseBackupSetting`(database_type=None, name=None, connection_string_name=None, connection_string=None)

  Bases: `msrest.serialization.Model`

  Note: properties are serialized in JSON format and stored in DB. if new properties are added they might not be in the previous data rows so please handle nulls.

  Parameters:

  - database_type (str) – SqlAzure / MySql
  - 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/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, id=None, name=None, kind=None, type=None, tags=None, backup_item_id=None, storage_account_url=None, blob_name=None, backup_item_name=None, status=None, size_in_bytes=None, created=None, log=None, databases=None, scheduled=None, last_restore_time_stamp=None, finished_time_stamp=None, correlation_id=None, website_size_in_bytes=None)

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

  Backup description.

  Parameters:

  - id (str) – Resource Id
  - name (str) – Resource Name
  - kind (str) – Kind of resource
  - location (str) – Resource Location
  - type (str) – Resource type
  - tags (dict) – Resource tags
  - backup_item_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

class `azure.mgmt.web.models.``RestoreRequest`(location, id=None, 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=None, operation_type=None, adjust_connection_strings=None, hosting_environment=None)

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

  Description of a restore request.

  Parameters:

  - id (str) – Resource Id
  - 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) – True if the restore operation can overwrite target site. “True” needed if trying to restore over an existing site.
  - site_name (str) – Name of a site (Web App)
  - databases (list of `DatabaseBackupSetting`) – Collection of databses 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 a site with custom domains. If “true”, custom domains are removed automatically. If “false”, custom domains are added to the site object when it is being restored, but that might fail due to conflicts during the operation.
  - operation_type (str or `BackupRestoreOperationType`) – Operation type. Possible values include: ‘Default’, ‘Clone’, ‘Relocation’
  - adjust_connection_strings (bool) – Gets or sets a flag showing if SiteConfig.ConnectionStrings should be set in new site
  - hosting_environment (str) – App Service Environment name, if needed (only when restoring a site to an App Service Environment)

class `azure.mgmt.web.models.``RestoreResponse`(location, id=None, name=None, kind=None, type=None, tags=None, operation_id=None)

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

  Response for a restore site request.

  Parameters:

  - id (str) – Resource Id
  - name (str) – Resource Name
  - kind (str) – Kind of resource
  - location (str) – Resource Location
  - type (str) – Resource type
  - tags (dict) – Resource tags
  - operation_id (str) – When server starts the restore process, it will return an OperationId identifying that particular restore operation

class `azure.mgmt.web.models.``CsmPublishingProfileOptions`(format=None)

  Bases: `msrest.serialization.Model`

  Publishing options for requested profile.

  Parameters: | format (str) – Name of the format. Valid values are: FileZilla3 WebDeploy – default Ftp

class `azure.mgmt.web.models.``TopLevelDomain`(location, id=None, name=None, kind=None, type=None, tags=None, top_level_domain_name=None, privacy=None)

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

  A top level domain object.

  Parameters:

  - id (str) – Resource Id
  - name (str) – Resource Name
  - kind (str) – Kind of resource
  - location (str) – Resource Location
  - type (str) – Resource type
  - tags (dict) – Resource tags
  - top_level_domain_name (str) – Name of the top level domain
  - privacy (bool) – If true then the top level domain supports domain privacy

class `azure.mgmt.web.models.``TopLevelDomainAgreementOption`(include_privacy=None)

  Bases: `msrest.serialization.Model`

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

  Parameters: | include_privacy (bool) – If true then the list of agreements will inclue agreements for domain privacy as well.

class `azure.mgmt.web.models.``TldLegalAgreement`(agreement_key=None, title=None, content=None, url=None)

  Bases: `msrest.serialization.Model`

  Represents a legal agreement for 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.``Resource`(location, id=None, name=None, kind=None, type=None, tags=None)

  Bases: `msrest.serialization.Model`

  Resource.

  Parameters:

  - id (str) – Resource Id
  - 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.``CertificateOrderPaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of CertificateOrder object

class `azure.mgmt.web.models.``CertificateOrderCertificatePaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of CertificateOrderCertificate object

class `azure.mgmt.web.models.``CertificatePaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of Certificate object

class `azure.mgmt.web.models.``ClassicMobileServicePaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of ClassicMobileService object

class `azure.mgmt.web.models.``DomainPaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of Domain object

class `azure.mgmt.web.models.``GeoRegionPaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of GeoRegion object

class `azure.mgmt.web.models.``ServerFarmWithRichSkuPaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of ServerFarmWithRichSku object

class `azure.mgmt.web.models.``SitePaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of Site object

class `azure.mgmt.web.models.``HostingEnvironmentPaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of HostingEnvironment object

class `azure.mgmt.web.models.``ManagedHostingEnvironmentPaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of ManagedHostingEnvironment object

class `azure.mgmt.web.models.``NameIdentifierPaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of NameIdentifier object

class `azure.mgmt.web.models.``StampCapacityPaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of StampCapacity object

class `azure.mgmt.web.models.``ResourceMetricPaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of ResourceMetric object

class `azure.mgmt.web.models.``CsmUsageQuotaPaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of CsmUsageQuota object

class `azure.mgmt.web.models.``MetricDefinitionPaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of MetricDefinition object

class `azure.mgmt.web.models.``UsagePaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of Usage object

class `azure.mgmt.web.models.``WorkerPoolPaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of WorkerPool object

class `azure.mgmt.web.models.``SkuInfoPaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of SkuInfo object

class `azure.mgmt.web.models.``SourceControlPaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of SourceControl object

class `azure.mgmt.web.models.``SlotDifferencePaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of SlotDifference object

class `azure.mgmt.web.models.``DeletedSitePaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of DeletedSite object

class `azure.mgmt.web.models.``DeploymentPaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of Deployment object

class `azure.mgmt.web.models.``SiteInstancePaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of SiteInstance object

class `azure.mgmt.web.models.``HostNameBindingPaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of HostNameBinding object

class `azure.mgmt.web.models.``BackupItemPaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of BackupItem object

class `azure.mgmt.web.models.``TopLevelDomainPaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of TopLevelDomain object

class `azure.mgmt.web.models.``TldLegalAgreementPaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of TldLegalAgreement object

class `azure.mgmt.web.models.``KeyVaultSecretStatus`

  Bases: `enum.Enum`

  `azure_service_unauthorized_to_access_key_vault` = 'AzureServiceUnauthorizedToAccessKeyVault'
  `certificate_order_failed` = 'CertificateOrderFailed'
  `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`

  Bases: `enum.Enum`

  `standard_domain_validated_ssl` = 'StandardDomainValidatedSsl'
  `standard_domain_validated_wild_card_ssl` = 'StandardDomainValidatedWildCardSsl'

class `azure.mgmt.web.models.``ProvisioningState`

  Bases: `enum.Enum`

  `canceled` = 'Canceled'
  `deleting` = 'Deleting'
  `failed` = 'Failed'
  `in_progress` = 'InProgress'
  `succeeded` = 'Succeeded'

class `azure.mgmt.web.models.``CertificateOrderStatus`

  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`

  Bases: `enum.Enum`

  `certificate_issued` = 'CertificateIssued'
  `certificate_order_canceled` = 'CertificateOrderCanceled'
  `certificate_order_created` = 'CertificateOrderCreated'
  `certificate_revoked` = 'CertificateRevoked'
  `domain_validation_complete` = 'DomainValidationComplete'
  `fraud_detected` = 'FraudDetected'
  `org_name_change` = 'OrgNameChange'
  `org_validation_complete` = 'OrgValidationComplete'
  `san_drop` = 'SanDrop'

class `azure.mgmt.web.models.``DomainStatus`

  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`

  Bases: `enum.Enum`

  `traffic_manager` = 'TrafficManager'
  `website` = 'Website'

class `azure.mgmt.web.models.``CustomHostNameDnsRecordType`

  Bases: `enum.Enum`

  `a` = 'A'
  `cname` = 'CName'

class `azure.mgmt.web.models.``HostNameType`

  Bases: `enum.Enum`

  `managed` = 'Managed'
  `verified` = 'Verified'

class `azure.mgmt.web.models.``StatusOptions`

  Bases: `enum.Enum`

  `pending` = 'Pending'
  `ready` = 'Ready'

class `azure.mgmt.web.models.``UsageState`

  Bases: `enum.Enum`

  `exceeded` = 'Exceeded'
  `normal` = 'Normal'

class `azure.mgmt.web.models.``SiteAvailabilityState`

  Bases: `enum.Enum`

  `disaster_recovery_mode` = 'DisasterRecoveryMode'
  `limited` = 'Limited'
  `normal` = 'Normal'

class `azure.mgmt.web.models.``SslState`

  Bases: `enum.Enum`

  `disabled` = 'Disabled'
  `ip_based_enabled` = 'IpBasedEnabled'
  `sni_enabled` = 'SniEnabled'

class `azure.mgmt.web.models.``DatabaseServerType`

  Bases: `enum.Enum`

  `custom` = 'Custom'
  `my_sql` = 'MySql'
  `sql_azure` = 'SQLAzure'
  `sql_server` = 'SQLServer'

class `azure.mgmt.web.models.``ManagedPipelineMode`

  Bases: `enum.Enum`

  `classic` = 'Classic'
  `integrated` = 'Integrated'

class `azure.mgmt.web.models.``SiteLoadBalancing`

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

  Bases: `enum.Enum`

  `custom_action` = 'CustomAction'
  `log_event` = 'LogEvent'
  `recycle` = 'Recycle'

class `azure.mgmt.web.models.``UnauthenticatedClientAction`

  Bases: `enum.Enum`

  `allow_anonymous` = 'AllowAnonymous'
  `redirect_to_login_page` = 'RedirectToLoginPage'

class `azure.mgmt.web.models.``BuiltInAuthenticationProvider`

  Bases: `enum.Enum`

  `azure_active_directory` = 'AzureActiveDirectory'
  `facebook` = 'Facebook'
  `google` = 'Google'
  `microsoft_account` = 'MicrosoftAccount'
  `twitter` = 'Twitter'

class `azure.mgmt.web.models.``HostingEnvironmentStatus`

  Bases: `enum.Enum`

  `deleting` = 'Deleting'
  `preparing` = 'Preparing'
  `ready` = 'Ready'
  `scaling` = 'Scaling'

class `azure.mgmt.web.models.``InternalLoadBalancingMode`

  Bases: `enum.Enum`

  `none` = 'None'
  `publishing` = 'Publishing'
  `web` = 'Web'

class `azure.mgmt.web.models.``ComputeModeOptions`

  Bases: `enum.Enum`

  `dedicated` = 'Dedicated'
  `dynamic` = 'Dynamic'
  `shared` = 'Shared'

class `azure.mgmt.web.models.``WorkerSizeOptions`

  Bases: `enum.Enum`

  `default` = 'Default'
  `large` = 'Large'
  `medium` = 'Medium'
  `small` = 'Small'

class `azure.mgmt.web.models.``AccessControlEntryAction`

  Bases: `enum.Enum`

  `deny` = 'Deny'
  `permit` = 'Permit'

class `azure.mgmt.web.models.``ManagedHostingEnvironmentStatus`

  Bases: `enum.Enum`

  `deleting` = 'Deleting'
  `preparing` = 'Preparing'
  `ready` = 'Ready'

class `azure.mgmt.web.models.``DomainType`

  Bases: `enum.Enum`

  `regular` = 'Regular'
  `soft_deleted` = 'SoftDeleted'

class `azure.mgmt.web.models.``NotificationLevel`

  Bases: `enum.Enum`

  `critical` = 'Critical'
  `information` = 'Information'
  `non_urgent_suggestion` = 'NonUrgentSuggestion'
  `warning` = 'Warning'

class `azure.mgmt.web.models.``Channels`

  Bases: `enum.Enum`

  `all` = 'All'
  `api` = 'Api'
  `email` = 'Email'
  `notification` = 'Notification'

class `azure.mgmt.web.models.``CloneAbilityResult`

  Bases: `enum.Enum`

  `cloneable` = 'Cloneable'
  `not_cloneable` = 'NotCloneable'
  `partially_cloneable` = 'PartiallyCloneable'

class `azure.mgmt.web.models.``LogLevel`

  Bases: `enum.Enum`

  `error` = 'Error'
  `information` = 'Information'
  `off` = 'Off'
  `verbose` = 'Verbose'
  `warning` = 'Warning'

class `azure.mgmt.web.models.``FrequencyUnit`

  Bases: `enum.Enum`

  `day` = 'Day'
  `hour` = 'Hour'

class `azure.mgmt.web.models.``BackupRestoreOperationType`

  Bases: `enum.Enum`

  `clone` = 'Clone'
  `default` = 'Default'
  `relocation` = 'Relocation'

class `azure.mgmt.web.models.``BackupItemStatus`

  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'